From 59cc6ad51157b794845e2fedf9ec9dc8fac8879d Mon Sep 17 00:00:00 2001 From: KongQun Yang Date: Wed, 15 Aug 2018 17:44:19 -0700 Subject: [PATCH] Clean up in documentation Bug: 112707139 Change-Id: Ifae98ad3dc94562918c8fdd254c5bbeb7a444586 --- docs/source/tutorials/ads.rst | 3 +++ docs/source/tutorials/dash.rst | 4 +++- docs/source/tutorials/drm.rst | 9 ++++++--- docs/source/tutorials/hls.rst | 5 +++-- docs/source/tutorials/live.rst | 4 +++- docs/source/tutorials/playready.rst | 5 +++++ docs/source/tutorials/raw_key.rst | 5 ++++- docs/source/tutorials/tutorials.rst | 1 + docs/source/tutorials/widevine.rst | 3 +++ 9 files changed, 31 insertions(+), 8 deletions(-) diff --git a/docs/source/tutorials/ads.rst b/docs/source/tutorials/ads.rst index 08805dfe9e..82342823d6 100644 --- a/docs/source/tutorials/ads.rst +++ b/docs/source/tutorials/ads.rst @@ -77,4 +77,7 @@ Use the below option if your player does not like it. --ad_cues 600;1800;3000 \ --hls_master_playlist_output h264_master.m3u8 +Configuration options +--------------------- + .. include:: /options/ads_options.rst diff --git a/docs/source/tutorials/dash.rst b/docs/source/tutorials/dash.rst index 951bd8284e..f6773a6c0d 100644 --- a/docs/source/tutorials/dash.rst +++ b/docs/source/tutorials/dash.rst @@ -79,6 +79,8 @@ which describes the streams. .. include:: /tutorials/dash_hls_example.rst -.. include:: /options/dash_options.rst +Configuration options +--------------------- +.. include:: /options/dash_options.rst .. include:: /options/segment_template_formatting.rst diff --git a/docs/source/tutorials/drm.rst b/docs/source/tutorials/drm.rst index 479da117ed..91a4206a97 100644 --- a/docs/source/tutorials/drm.rst +++ b/docs/source/tutorials/drm.rst @@ -2,20 +2,23 @@ DRM === Shaka Packager supports fetching encryption keys from Widevine Key Server and -PlayReady Key Server. In addition, Shaka Packager also supports Raw Keys, for -which keys and key_ids are provided to Shaka Packager directly. +PlayReady Key Server. Shaka Packager also supports Raw Keys, for which keys are +provided to Shaka Packager directly. .. toctree:: :maxdepth: 2 - /tutorials/raw_key.rst /tutorials/widevine.rst /tutorials/playready.rst + /tutorials/raw_key.rst Regardless of which key server you are using, you can instruct Shaka Packager to generate other protection systems in additional to the native protection system from the key server. This allows generating multi-DRM contents easily. +Configuration options +--------------------- + .. include:: /options/drm_stream_descriptors.rst .. include:: /options/general_encryption_options.rst .. include:: /options/widevine_encryption_options.rst diff --git a/docs/source/tutorials/hls.rst b/docs/source/tutorials/hls.rst index ff9abedb51..d900d2e6e4 100644 --- a/docs/source/tutorials/hls.rst +++ b/docs/source/tutorials/hls.rst @@ -87,8 +87,9 @@ playlists, which describe the streams. .. include:: /tutorials/dash_hls_example.rst +Configuration options +--------------------- + .. include:: /options/hls_stream_descriptors.rst - .. include:: /options/hls_options.rst - .. include:: /options/segment_template_formatting.rst diff --git a/docs/source/tutorials/live.rst b/docs/source/tutorials/live.rst index 8cbb563f42..7643178dc2 100644 --- a/docs/source/tutorials/live.rst +++ b/docs/source/tutorials/live.rst @@ -60,6 +60,8 @@ Here are some examples. 2. Upload / Sync media segments 3. Rename uploaded manifest / playlists back to the original names -.. include:: /options/udp_file_options.rst +Configuration options +--------------------- +.. include:: /options/udp_file_options.rst .. include:: /options/segment_template_formatting.rst diff --git a/docs/source/tutorials/playready.rst b/docs/source/tutorials/playready.rst index 815071a31e..8f9d2a079b 100644 --- a/docs/source/tutorials/playready.rst +++ b/docs/source/tutorials/playready.rst @@ -11,6 +11,8 @@ contents. Synopsis -------- +:: + $ packager ... \ --enable_playready_encryption \ --playready_server_url \ @@ -24,6 +26,9 @@ Synopsis The --client_cert_xx and --ca_file parameters can be omitted if not required by the key server. +Configuration options +--------------------- + .. include:: /options/drm_stream_descriptors.rst .. include:: /options/general_encryption_options.rst .. include:: /options/playready_encryption_options.rst diff --git a/docs/source/tutorials/raw_key.rst b/docs/source/tutorials/raw_key.rst index f78ec42592..62548bb4ec 100644 --- a/docs/source/tutorials/raw_key.rst +++ b/docs/source/tutorials/raw_key.rst @@ -125,11 +125,14 @@ Test vectors used in this tutorial $ pssh-box.py --widevine-system-id \ --content-id 7465737420636f6e74656e74206964 --hex +Configuration options +--------------------- + .. include:: /options/drm_stream_descriptors.rst .. include:: /options/general_encryption_options.rst .. include:: /options/raw_key_encryption_options.rst pssh-box (Utility to generate PSSH boxes) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------------------------------- https://github.com/google/shaka-packager/tree/master/packager/tools/pssh diff --git a/docs/source/tutorials/tutorials.rst b/docs/source/tutorials/tutorials.rst index c5786155c0..7fb5188172 100644 --- a/docs/source/tutorials/tutorials.rst +++ b/docs/source/tutorials/tutorials.rst @@ -9,4 +9,5 @@ Tutorials hls.rst live.rst drm.rst + ads.rst ffmpeg_piping.rst diff --git a/docs/source/tutorials/widevine.rst b/docs/source/tutorials/widevine.rst index b8987720b6..e812796171 100644 --- a/docs/source/tutorials/widevine.rst +++ b/docs/source/tutorials/widevine.rst @@ -130,6 +130,9 @@ Here is the test crendential used in this tutorial. `Widevine `_ if you need something for production use. +Configuration options +--------------------- + .. include:: /options/drm_stream_descriptors.rst .. include:: /options/general_encryption_options.rst .. include:: /options/widevine_encryption_options.rst