2018-02-10 23:37:42 +00:00
2017-09-20 02:35:05 +00:00
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
< title > Stream descriptors — Shaka Packager documentation< / title >
< link rel = "stylesheet" href = "../_static/sphinxdoc_new.css" type = "text/css" / >
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" / >
< link rel = "stylesheet" href = "../_static/table_styling.css" type = "text/css" / >
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
< / script >
< script type = "text/javascript" src = "../_static/jquery.js" > < / script >
< script type = "text/javascript" src = "../_static/underscore.js" > < / script >
< script type = "text/javascript" src = "../_static/doctools.js" > < / script >
2018-02-10 23:37:42 +00:00
< script type = "text/javascript" src = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML" > < / 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" / >
< / head >
2018-02-10 23:37:42 +00:00
< 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 >
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Shaka Packager documentation< / a > » < / li >
< / ul >
< / div >
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" >
< h3 > < a href = "../index.html" > Table Of Contents< / a > < / h3 >
< ul >
< li > < a class = "reference internal" href = "#" > Stream descriptors< / a > < / li >
2017-10-24 22:51:02 +00:00
< li > < a class = "reference internal" href = "#drm-related-stream-descriptor-fields" > DRM related Stream descriptor fields< / a > < / li >
2017-09-20 02:35:05 +00:00
< li > < a class = "reference internal" href = "#hls-specific-stream-descriptor-fields" > HLS specific stream descriptor fields< / a > < / li >
< / ul >
< div role = "note" aria-label = "source link" >
< h3 > This Page< / h3 >
< ul class = "this-page-menu" >
< li > < a href = "../_sources/options/stream_descriptors.rst.txt"
rel="nofollow">Show Source< / a > < / li >
< / ul >
< / div >
< div id = "searchbox" style = "display: none" role = "search" >
< h3 > Quick search< / h3 >
< form class = "search" action = "../search.html" method = "get" >
< div > < input type = "text" name = "q" / > < / div >
< div > < input type = "submit" value = "Go" / > < / div >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< script type = "text/javascript" > $ ( '#searchbox' ) . show ( 0 ) ; < / script >
< / div >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< div class = "section" id = "stream-descriptors" >
< h1 > Stream descriptors< a class = "headerlink" href = "#stream-descriptors" title = "Permalink to this headline" > ¶< / a > < / h1 >
2018-02-10 23:37:42 +00:00
< p > There can be multiple < em > stream_descriptor< / em > with input from the same “file” or
multiple different “files”.< / p >
2017-10-24 22:51:02 +00:00
< p > Stream descriptor is of the form:< / p >
2017-09-20 02:35:05 +00:00
< div class = "highlight-default" > < div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span > < span class = "n" > field< / span > < span class = "p" > }< / span > < span class = "o" > =< / span > < span class = "p" > {< / span > < span class = "n" > value< / span > < span class = "p" > }[,{< / span > < span class = "n" > field< / span > < span class = "p" > }< / span > < span class = "o" > =< / span > < span class = "p" > {< / span > < span class = "n" > value< / span > < span class = "p" > }]< / span > < span class = "o" > ...< / span >
< / pre > < / div >
< / div >
< p > These are the available fields:< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2018-02-10 23:37:42 +00:00
< tr class = "field-odd field" > < th class = "field-name" > input (in):< / th > < td class = "field-body" > input/source media “file” path, which can be regular files, pipes, udp
2017-09-20 02:35:05 +00:00
streams. See < a class = "reference internal" href = "udp_file_options.html" > < span class = "doc" > UDP file options< / span > < / a > on additional options for UDP
files.< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" colspan = "2" > stream_selector (stream):< / th > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "field-even field" > < td >   < / td > < td class = "field-body" > Required field with value ‘ ’ ‘ ’ ‘ ’
2017-09-20 02:35:05 +00:00
based).< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > output (out):< / th > < td class = "field-body" > Required output file path (single file).< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > init_segment:< / th > < td class = "field-body" > initialization segment path (multiple file).< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" colspan = "2" > segment_template (segment):< / th > < / tr >
< tr class = "field-odd field" > < td >   < / td > < td class = "field-body" > Optional value which specifies the naming pattern for the segment files,
and that the stream should be split into multiple files. Its presence should
be consistent across streams. See
< a class = "reference internal" href = "segment_template_formatting.html" > < span class = "doc" > Segment template formatting< / span > < / a > .< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > bandwidth (bw):< / th > < td class = "field-body" > Optional value which contains a user-specified content bit rate for the
stream, in bits/sec. If specified, this value is propagated to (HLS)
EXT-X-STREAM-INF:BANDWIDTH or (DASH) Representation@ bandwidth and the
$Bandwidth$ template parameter for segment names. If not specified, the
bandwidth value is estimated from content bitrate. Note that it only affects
the generated manifests/playlists; it has no effect on the media content
itself.< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" colspan = "2" > language (lang):< / th > < / tr >
< tr class = "field-odd field" > < td >   < / td > < td class = "field-body" > Optional value which contains a user-specified language tag. If specified,
this value overrides any language metadata in the input stream.< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" colspan = "2" > output_format (format):< / th > < / tr >
< tr class = "field-even field" > < td >   < / td > < td class = "field-body" > Optional value which specifies the format of the output files (MP4 or WebM).
If not specified, it will be derived from the file extension of the output
file.< / td >
< / tr >
2017-10-24 22:51:02 +00:00
< tr class = "field-odd field" > < th class = "field-name" colspan = "2" > trick_play_factor (tpf):< / th > < / tr >
< tr class = "field-odd field" > < td >   < / td > < td class = "field-body" > Optional value which specifies the trick play, a.k.a. trick mode, stream
sampling rate among key frames. If specified, the output is a trick play
stream.< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div class = "section" id = "drm-related-stream-descriptor-fields" >
< h1 > DRM related Stream descriptor fields< a class = "headerlink" href = "#drm-related-stream-descriptor-fields" title = "Permalink to this headline" > ¶< / a > < / h1 >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2017-09-20 02:35:05 +00:00
< tr class = "field-odd field" > < th class = "field-name" colspan = "2" > skip_encryption=0|1:< / th > < / tr >
< tr class = "field-odd field" > < td >   < / td > < td class = "field-body" > Optional. Defaults to 0 if not specified. If it is set to 1, no encryption
of the stream will be made.< / td >
< / tr >
2017-10-24 22:51:02 +00:00
< tr class = "field-even field" > < th class = "field-name" > drm_label:< / th > < td class = "field-body" > Optional value for custom DRM label, which defines the encryption key
applied to the stream. Typically values include AUDIO, SD, HD, UHD1, UHD2.
2018-02-10 23:37:42 +00:00
For raw key, it should be a label defined in –
2017-10-24 22:51:02 +00:00
DRM label is derived from stream type (video, audio), resolutions, etc.
Note that it is case sensitive.< / td >
2017-09-20 02:35:05 +00:00
< / tr >
< / tbody >
< / table >
< / div >
< div class = "section" id = "hls-specific-stream-descriptor-fields" >
< h1 > HLS specific stream descriptor fields< a class = "headerlink" href = "#hls-specific-stream-descriptor-fields" title = "Permalink to this headline" > ¶< / a > < / h1 >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2017-10-24 22:51:02 +00:00
< tr class = "field-odd field" > < th class = "field-name" > hls_name:< / th > < td class = "field-body" > Used for HLS audio to set the NAME attribute for EXT-X-MEDIA.
Defaults to the base of the playlist name.< / td >
2017-09-20 02:35:05 +00:00
< / tr >
2017-10-24 22:51:02 +00:00
< tr class = "field-even field" > < th class = "field-name" > hls_group_id:< / th > < td class = "field-body" > Used for HLS audio to set the GROUP-ID attribute for EXT-X-MEDIA.
2018-02-10 23:37:42 +00:00
Defaults to ‘ ’ < / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > playlist_name:< / th > < td class = "field-body" > The HLS playlist file to create. Usually ends with ‘ ’
relative to hls_master_playlist_output (see below). If unspecified,
defaults to something of the form ‘ ’ ‘ ’
‘ ’ < / td >
2017-09-20 02:35:05 +00:00
< / tr >
2018-02-10 23:37:42 +00:00
< tr class = "field-even field" > < th class = "field-name" colspan = "2" > iframe_playlist_name:< / th > < / tr >
< tr class = "field-even field" > < td >   < / td > < td class = "field-body" > The optional HLS I-Frames only playlist file to create. Usually ends with
‘ ’
only be set for video streams. If unspecified, no I-Frames only playlist is
created.< / td >
2017-09-20 02:35:05 +00:00
< / tr >
< / tbody >
< / table >
< / div >
< / div >
< / div >
< / div >
< 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 >
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Shaka Packager documentation< / a > » < / li >
< / ul >
< / div >
< div class = "footer" role = "contentinfo" >
© Copyright 2017, Google.
2018-02-10 23:37:42 +00:00
Created using < a href = "http://sphinx-doc.org/" > Sphinx< / a > 1.6.7.
2017-09-20 02:35:05 +00:00
< / div >
< / body >
< / html >
