2018-02-10 23:37:42 +00:00
|
|
|
|
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<!DOCTYPE html>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<html>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
<head>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<meta charset="utf-8" />
|
2021-06-22 00:16:40 +00:00
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|
|
|
|
|
|
2017-09-20 02:35:05 +00:00
|
|
|
|
<title>HLS options — Shaka Packager documentation</title>
|
2021-06-22 00:16:40 +00:00
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/sphinxdoc_new.css" />
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/table_styling.css" />
|
2021-06-22 00:16:40 +00:00
|
|
|
|
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<script src="../_static/jquery.js"></script>
|
|
|
|
|
|
<script src="../_static/underscore.js"></script>
|
|
|
|
|
|
<script src="../_static/doctools.js"></script>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
|
|
|
|
<link rel="search" title="Search" href="../search.html" />
|
2020-01-22 00:59:16 +00:00
|
|
|
|
</head><body>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
|
|
|
|
<h3>Navigation</h3>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
|
|
|
<a href="../genindex.html" title="General Index"
|
|
|
|
|
|
accesskey="I">index</a></li>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Shaka Packager documentation</a> »</li>
|
|
|
|
|
|
<li class="nav-item nav-item-this"><a href="">HLS options</a></li>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
</ul>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
</div>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
|
|
|
|
|
|
<div class="document">
|
|
|
|
|
|
<div class="documentwrapper">
|
|
|
|
|
|
<div class="bodywrapper">
|
|
|
|
|
|
<div class="body" role="main">
|
|
|
|
|
|
|
2021-06-22 00:16:40 +00:00
|
|
|
|
<section id="hls-options">
|
2017-09-20 02:35:05 +00:00
|
|
|
|
<h1>HLS options<a class="headerlink" href="#hls-options" title="Permalink to this headline">¶</a></h1>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<dl class="option-list">
|
|
|
|
|
|
<dt><kbd><span class="option">--hls_master_playlist_output <var><file_path></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>Output path for the master playlist for HLS. This flag must be used to
|
|
|
|
|
|
output HLS.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--hls_base_url <var><url></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>The base URL for the Media Playlists and media files listed in the
|
|
|
|
|
|
playlists. This is the prefix for the files.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--hls_key_uri <var><uri></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>The key uri for ‘identity’ and ‘com.apple.streamingkeydelivery’ (FairPlay)
|
2018-08-16 00:35:22 +00:00
|
|
|
|
key formats. Ignored if the playlist is not encrypted or not using the above
|
2020-01-22 00:59:16 +00:00
|
|
|
|
key formats.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--hls_playlist_type <var><type></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>VOD, EVENT, or LIVE. This defines the EXT-X-PLAYLIST-TYPE in the HLS
|
2017-09-20 02:35:05 +00:00
|
|
|
|
specification. For hls_playlist_type of LIVE, EXT-X-PLAYLIST-TYPE tag is
|
2020-01-22 00:59:16 +00:00
|
|
|
|
omitted.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--time_shift_buffer_depth <var><seconds></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>Guaranteed duration of the time shifting buffer for LIVE playlists, in
|
|
|
|
|
|
seconds.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--preserved_segments_outside_live_window <var><num_segments></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>Segments outside the live window (defined by <cite>time_shift_buffer_depth</cite>
|
2018-05-23 23:12:00 +00:00
|
|
|
|
above) are automatically removed except for the most recent X segments
|
|
|
|
|
|
defined by this parameter. This is needed to accommodate latencies in
|
|
|
|
|
|
various stages of content serving pipeline, so that the segments stay
|
|
|
|
|
|
accessible as they may still be accessed by the player.</p>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<p>The segments are not removed if the value is zero.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--default_language <var><language></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>The first audio/text rendition in a group tagged with this language will
|
2018-02-10 23:37:42 +00:00
|
|
|
|
have ‘DEFAULT’ attribute set to ‘YES’. This allows the player to choose the
|
2018-12-20 22:38:40 +00:00
|
|
|
|
correct default language for the content.</p>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<p>This applies to both audio and text tracks. The default language for text
|
2018-12-20 22:38:40 +00:00
|
|
|
|
tracks can be overriden by ‘default_text_language’.</p>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--default_text_language <var><text_language></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>Same as above, but this applies to text tracks only, and overrides the
|
|
|
|
|
|
default language for text tracks.</p>
|
|
|
|
|
|
</dd>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<dt><kbd><span class="option">--hls_media_sequence_number <var><unsigned_number></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>HLS uses the EXT-X-MEDIA-SEQUENCE tag at the start of a live playlist in
|
|
|
|
|
|
order to specify the first segment sequence number. This is because any
|
|
|
|
|
|
live playlist have a limited number of segments, and they also keep
|
|
|
|
|
|
updating with new segments while removing old ones. When a player refreshes
|
|
|
|
|
|
the playlist, this information is important for keeping track of segments
|
|
|
|
|
|
positions.</p>
|
|
|
|
|
|
<p>When the packager starts, it naturally starts this count from zero. However,
|
|
|
|
|
|
there are many situations where the packager may be restarted, without this
|
|
|
|
|
|
meaning starting this value from zero (but continuing a previous sequence).
|
|
|
|
|
|
The most common situations are problems in the encoder feeding the packager.</p>
|
|
|
|
|
|
<p>With those cases in mind, this parameter allows to set the initial
|
|
|
|
|
|
EXT-X-MEDIA-SEQUENCE value. This way, it’s possible to continue the sequence
|
|
|
|
|
|
number from previous packager run.</p>
|
|
|
|
|
|
<p>For more information about the reasoning of this, please see issue
|
|
|
|
|
|
<a class="reference external" href="https://github.com/google/shaka-packager/issues/691">#691</a>.</p>
|
|
|
|
|
|
<p>The EXT-X-MEDIA-SEQUENCE documentation can be read here:
|
|
|
|
|
|
<a class="reference external" href="https://tools.ietf.org/html/rfc8216#section-4.3.3.2">https://tools.ietf.org/html/rfc8216#section-4.3.3.2</a>.</p>
|
|
|
|
|
|
</dd>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
</dl>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<p>–hls_only=0|1</p>
|
|
|
|
|
|
<blockquote>
|
|
|
|
|
|
<div><p>Optional. Defaults to 0 if not specified. If it is set to 1, indicates the
|
|
|
|
|
|
stream is HLS only.</p>
|
|
|
|
|
|
</div></blockquote>
|
2021-06-22 00:16:40 +00:00
|
|
|
|
</section>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
|
|
|
|
|
|
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<div class="clearer"></div>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
<div class="sphinxsidebarwrapper">
|
|
|
|
|
|
<div role="note" aria-label="source link">
|
|
|
|
|
|
<h3>This Page</h3>
|
|
|
|
|
|
<ul class="this-page-menu">
|
|
|
|
|
|
<li><a href="../_sources/options/hls_options.rst.txt"
|
|
|
|
|
|
rel="nofollow">Show Source</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="searchbox" style="display: none" role="search">
|
|
|
|
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
|
|
|
|
<div class="searchformwrapper">
|
|
|
|
|
|
<form class="search" action="../search.html" method="get">
|
|
|
|
|
|
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
|
|
|
|
<input type="submit" value="Go" />
|
|
|
|
|
|
</form>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<script>$('#searchbox').show(0);</script>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
<div class="clearer"></div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
|
|
|
|
<h3>Navigation</h3>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
|
|
|
<a href="../genindex.html" title="General Index"
|
|
|
|
|
|
>index</a></li>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Shaka Packager documentation</a> »</li>
|
|
|
|
|
|
<li class="nav-item nav-item-this"><a href="">HLS options</a></li>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
|
|
|
|
|
© Copyright 2017, Google.
|
2021-06-22 00:16:40 +00:00
|
|
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.0.2.
|
2017-09-20 02:35:05 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
