Skip to content

Commit

Permalink
Clean up in documentation
Browse files Browse the repository at this point in the history
Bug: 112707139

Change-Id: Ifae98ad3dc94562918c8fdd254c5bbeb7a444586
  • Loading branch information
kqyang committed Aug 16, 2018
1 parent 451406a commit 59cc6ad
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 8 deletions.
3 changes: 3 additions & 0 deletions docs/source/tutorials/ads.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 3 additions & 1 deletion docs/source/tutorials/dash.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
9 changes: 6 additions & 3 deletions docs/source/tutorials/drm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions docs/source/tutorials/hls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,9 @@ playlists, which describe the streams.

.. include:: /tutorials/dash_hls_example.rst

.. include:: /options/hls_stream_descriptors.rst
Configuration options
---------------------

.. include:: /options/hls_stream_descriptors.rst
.. include:: /options/hls_options.rst

.. include:: /options/segment_template_formatting.rst
4 changes: 3 additions & 1 deletion docs/source/tutorials/live.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
5 changes: 5 additions & 0 deletions docs/source/tutorials/playready.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ contents.
Synopsis
--------

::

$ packager <stream_descriptor> ... \
--enable_playready_encryption \
--playready_server_url <playready_server_url> \
Expand All @@ -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
5 changes: 4 additions & 1 deletion docs/source/tutorials/raw_key.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions docs/source/tutorials/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ Tutorials
hls.rst
live.rst
drm.rst
ads.rst
ffmpeg_piping.rst
3 changes: 3 additions & 0 deletions docs/source/tutorials/widevine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,9 @@ Here is the test crendential used in this tutorial.
`Widevine <https://support.google.com/widevine/troubleshooter/6027072>`_ 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

0 comments on commit 59cc6ad

Please sign in to comment.