From d089a36ca97809986bf831f97373a7831236495d Mon Sep 17 00:00:00 2001 From: KongQun Yang Date: Tue, 5 Dec 2017 14:10:52 -0800 Subject: [PATCH] [Doc] Replace basic_usage.md with basic_usage.rst Change-Id: I0b1284041000174809365659631985bcaf9db3f7 --- docs/source/tutorials/basic_usage.md | 61 --------------------------- docs/source/tutorials/basic_usage.rst | 59 ++++++++++++++++++++++++++ docs/source/tutorials/tutorials.rst | 6 +-- 3 files changed, 62 insertions(+), 64 deletions(-) delete mode 100644 docs/source/tutorials/basic_usage.md create mode 100644 docs/source/tutorials/basic_usage.rst diff --git a/docs/source/tutorials/basic_usage.md b/docs/source/tutorials/basic_usage.md deleted file mode 100644 index 259df894e8..0000000000 --- a/docs/source/tutorials/basic_usage.md +++ /dev/null @@ -1,61 +0,0 @@ -# Basic Usage - -## Getting help - -```shell -$ packager --help -``` - -## Media file analysis - -Shaka Packager can be used to inspect the content of a media file and dump basic -stream information. - -```shell -$ packager input=some_content.mp4 --dump_stream_info -``` - -The output looks like: - -```shell -File "some_content.mp4": -Found 2 stream(s). -Stream [0] type: Video - codec_string: avc1.4d001e - time_scale: 24000 - duration: 3002000 (125.1 seconds) - is_encrypted: false - codec: H264 - width: 720 - height: 360 - pixel_aspect_ratio: 8:9 - trick_play_factor: 0 - nalu_length_size: 4 - -Stream [1] type: Audio - codec_string: mp4a.40.2 - time_scale: 44100 - duration: 5517311 (125.1 seconds) - is_encrypted: false - codec: AAC - sample_bits: 16 - num_channels: 2 - sampling_frequency: 44100 - language: eng -``` - -## Basic transmuxing - -Shaka Packager can be used to extract streams, optionally transmuxes the streams -from one container format to another container format. - -Here is a simple command that extracts video and audio from the input file: - -```shell -$ packager in=some_content.mp4,stream=video,out=video.mp4 \ - in=some_content.mp4,stream=audio,out=audio.mp4 -``` - -Shaka Packager is also capable of more complex tasks, such as applying -encryption, packaging contents to DASH or HLS formats, etc. Refer -:doc:`tutorials`. diff --git a/docs/source/tutorials/basic_usage.rst b/docs/source/tutorials/basic_usage.rst new file mode 100644 index 0000000000..ade33ab12c --- /dev/null +++ b/docs/source/tutorials/basic_usage.rst @@ -0,0 +1,59 @@ +Basic Usage +=========== + +Getting help +------------ + +:: + + $ packager --help + +Media file analysis +------------------- + +Shaka Packager can be used to inspect the content of a media file and dump basic +stream information:: + + $ packager input=some_content.mp4 --dump_stream_info + +The output looks like:: + + File "some_content.mp4": + Found 2 stream(s). + Stream [0] type: Video + codec_string: avc1.4d001e + time_scale: 24000 + duration: 3002000 (125.1 seconds) + is_encrypted: false + codec: H264 + width: 720 + height: 360 + pixel_aspect_ratio: 8:9 + trick_play_factor: 0 + nalu_length_size: 4 + + Stream [1] type: Audio + codec_string: mp4a.40.2 + time_scale: 44100 + duration: 5517311 (125.1 seconds) + is_encrypted: false + codec: AAC + sample_bits: 16 + num_channels: 2 + sampling_frequency: 44100 + language: eng + +Basic transmuxing +----------------- + +Shaka Packager can be used to extract streams, optionally transmuxes the streams +from one container format to another container format. + +Here is a simple command that extracts video and audio from the input file:: + + $ packager in=some_content.mp4,stream=video,out=video.mp4 \ + in=some_content.mp4,stream=audio,out=audio.mp4 + +Shaka Packager is also capable of more complex tasks, such as applying +encryption, packaging contents to DASH or HLS formats, etc. Refer to +:doc:`tutorials`. diff --git a/docs/source/tutorials/tutorials.rst b/docs/source/tutorials/tutorials.rst index ad16fd6c9d..c5786155c0 100644 --- a/docs/source/tutorials/tutorials.rst +++ b/docs/source/tutorials/tutorials.rst @@ -4,9 +4,9 @@ Tutorials .. toctree:: :maxdepth: 2 - basic_usage.md + basic_usage.rst dash.rst - hls.md - live.md + hls.rst + live.rst drm.rst ffmpeg_piping.rst