X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=doc%2Fffprobe.texi;h=a49c3f803cbd5b28e7d0e05f38dea26e368760b2;hb=757473831c3e1cc231fb985bcaed622d66fd6b2e;hp=89b270d7bb56aafd5e09bb3cd006dddfde6cc2d0;hpb=49b909b980eb18f1049d9b31ee99f177c58165ae;p=ffmpeg diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi index 89b270d7bb5..a49c3f803cb 100644 --- a/doc/ffprobe.texi +++ b/doc/ffprobe.texi @@ -94,6 +94,11 @@ For example for printing the output in JSON format, specify: For more details on the available output printing formats, see the Writers section below. +@item -show_error +Show information about the error found when trying to probe the input. + +The error information is printed within a section with name "ERROR". + @item -show_format Show information about the container format of the input multimedia stream. @@ -108,6 +113,13 @@ stream. The information for each single packet is printed within a dedicated section with name "PACKET". +@item -show_frames +Show information about each video frame contained in the input multimedia +stream. + +The information for each single frame is printed within a dedicated +section with name "FRAME". + @item -show_streams Show information about each media stream contained in the input multimedia stream. @@ -115,6 +127,12 @@ multimedia stream. Each media stream information is printed within a dedicated section with name "STREAM". +@item -show_private_data, -private +Show private data, that is data depending on the format of the +particular shown element. +This option is enabled by default, but you may need to disable it +for specific uses, for example when creating XSD-compliant XML output. + @item -i @var{input_file} Read @var{input_file}. @@ -124,7 +142,7 @@ Read @var{input_file}. @chapter Writers @c man begin WRITERS -A writer defines the output format adopted by @file{ffprobe}, and will be +A writer defines the output format adopted by @command{ffprobe}, and will be used for printing all the parts of the output. A writer may accept one or more arguments, which specify the options to @@ -212,6 +230,39 @@ Each section is printed using JSON notation. For more information about JSON, see @url{http://www.json.org/}. +@section xml +XML based format. + +The XML output is described in the XML schema description file +@file{ffprobe.xsd} installed in the FFmpeg datadir. + +Note that the output issued will be compliant to the +@file{ffprobe.xsd} schema only when no special global output options +(@option{unit}, @option{prefix}, @option{byte_binary_prefix}, +@option{sexagesimal} etc.) are specified. + +This writer accepts options as a list of @var{key}=@var{value} pairs, +separated by ":". + +The description of the accepted options follows. + +@table @option + +@item fully_qualified, q +If set to 1 specify if the output should be fully qualified. Default +value is 0. +This is required for generating an XML file which can be validated +through an XSD file. + +@item xsd_compliant, x +If set to 1 perform more checks for ensuring that the output is XSD +compliant. Default value is 0. +This option automatically sets @option{fully_qualified} to 1. +@end table + +For more information about the XML format, see +@url{http://www.w3.org/XML/}. + @c man end WRITERS @include decoders.texi