diff mbox series

[FFmpeg-devel] doc/ffprobe: add a useful one-liner example to get essential input information as JSON

Message ID 20231210025708.866512-1-marth64@proxyid.net
State New
Headers show
Series [FFmpeg-devel] doc/ffprobe: add a useful one-liner example to get essential input information as JSON | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Marth64 Dec. 10, 2023, 2:57 a.m. UTC
Signed-off-by: Marth64 <marth64@proxyid.net>

This could be useful for folks who are just learning ffmpeg or have simple needs for parsing input information as JSON.

---
 doc/ffprobe.texi | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Stefano Sabatini Dec. 12, 2023, 12:01 a.m. UTC | #1
On date Saturday 2023-12-09 20:57:09 -0600, Marth64 wrote:
> Signed-off-by: Marth64 <marth64@proxyid.net>
> 
> This could be useful for folks who are just learning ffmpeg or have simple needs for parsing input information as JSON.
> 
> ---
>  doc/ffprobe.texi | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
> index b74ff650ac..ed88e619f6 100644
> --- a/doc/ffprobe.texi
> +++ b/doc/ffprobe.texi
> @@ -572,6 +572,12 @@ printed on a single line. Default value is 0.
>  
>  For more information about JSON, see @url{http://www.json.org/}.
>  
> +@subsection Examples
> +Output format, stream, and chapter information of an input as JSON:
> +@example
> +ffprobe -of json -show_format -show_streams -show_chapters INPUT
> +@end example

Not convinced this is the right place for it (because the writers
section is mostly about the writers).

Probably we miss an overall generic section showing complete examples
(which might well contain your example).
diff mbox series

Patch

diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
index b74ff650ac..ed88e619f6 100644
--- a/doc/ffprobe.texi
+++ b/doc/ffprobe.texi
@@ -572,6 +572,12 @@  printed on a single line. Default value is 0.
 
 For more information about JSON, see @url{http://www.json.org/}.
 
+@subsection Examples
+Output format, stream, and chapter information of an input as JSON:
+@example
+ffprobe -of json -show_format -show_streams -show_chapters INPUT
+@end example
+
 @section xml
 XML based format.