docs: Update docs for shaka-streamer-binaries and multiperiod (#92)

Closes #60
shaka-project · Sep 8, 2021 · d8a8d2d · d8a8d2d
1 parent 282db9d
commit d8a8d2d
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/docs/source/overview.rst b/docs/source/overview.rst
@@ -44,6 +44,7 @@ Features
   * Control output folders and file names
   * Add arbitrary FFmpeg filters for input or output
 
+* Supports generating multi-period VOD content for DASH and stitched playlists for HLS
 
 Caveat: text processing
 ~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/source/prerequisites.rst b/docs/source/prerequisites.rst
@@ -40,6 +40,30 @@ This can also be installed via ``pip3`` on any platform:
   # To install/upgrade per-user:
   pip3 install --user --upgrade pyyaml
 
+Shaka Streamer Binaries (optional)
+----------------------------------
+
+Shaka Streamer requires the installation of `Shaka Packager`
+and `FFmpeg`, as it uses them internally.
+
+These binaries can most likely be installed for your platform
+using ``pip3`` through the PyPi package ``shaka-streamer-binaries``.
+
+If you choose to install ``shaka-streamer-binaries``, you won't need to install
+the other two dependencies: `Shaka Packager` and `FFmpeg`.
+
+To install ``shaka-streamer-binaries``:
+
+.. code:: sh
+
+  pip3 install shaka-streamer-binaries
+
+The static `FFmpeg` builds are pulled from here:
+https://github.com/joeyparrish/static-ffmpeg-binaries
+
+The static `Shaka Packager` builds are pulled from here:
+https://github.com/google/shaka-packager
+
 Shaka Packager
 --------------
 

diff --git a/streamer/input_configuration.py b/streamer/input_configuration.py
@@ -314,7 +314,7 @@ def get_channel_layout(self) -> bitrate_configuration.AudioChannelLayout:
     return bitrate_configuration.AudioChannelLayout.get_value(self.channel_layout)
 
 class SinglePeriod(configuration.Base):
-  """An object repersenting one optional video stream and multiple audio and text streams"""
+  """An object representing a single period in a multiperiod inputs list."""
 
   inputs = configuration.Field(List[Input], required=True).cast()