580 lines
33 KiB
HTML
580 lines
33 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Shaka Packager SDK: shaka::Representation Class Reference</title>
|
|
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="../../jquery.js"></script>
|
|
<script type="text/javascript" src="../../dynsections.js"></script>
|
|
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="../../search/searchdata.js"></script>
|
|
<script type="text/javascript" src="../../search/search.js"></script>
|
|
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Shaka Packager SDK
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('../../',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="../../d8/daf/namespaceshaka.html">shaka</a></li><li class="navelem"><a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="../../da/db2/classshaka_1_1Representation-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">shaka::Representation Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="../../d0/d2b/representation_8h_source.html">representation.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for shaka::Representation:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="../../de/d52/classshaka_1_1Representation.png" usemap="#shaka::Representation_map" alt=""/>
|
|
<map id="shaka::Representation_map" name="shaka::Representation_map">
|
|
<area href="../../d0/d33/classshaka_1_1MockRepresentation.html" alt="shaka::MockRepresentation" shape="rect" coords="0,56,166,80"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:ad0c3f0dfed3c9b1cf4993530ea652661"><td class="memItemLeft" align="right" valign="top"><a id="ad0c3f0dfed3c9b1cf4993530ea652661"></a>enum  </td><td class="memItemRight" valign="bottom"><b>SuppressFlag</b> { <b>kSuppressWidth</b> = 1,
|
|
<b>kSuppressHeight</b> = 2,
|
|
<b>kSuppressFrameRate</b> = 4
|
|
}</td></tr>
|
|
<tr class="separator:ad0c3f0dfed3c9b1cf4993530ea652661"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ae998409ae94f3ba12909a96e8f3f4f7e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#ae998409ae94f3ba12909a96e8f3f4f7e">Init</a> ()</td></tr>
|
|
<tr class="separator:ae998409ae94f3ba12909a96e8f3f4f7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a265d014093c9073b08505013886aaa8d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#a265d014093c9073b08505013886aaa8d">AddContentProtectionElement</a> (const <a class="el" href="../../da/d43/structshaka_1_1ContentProtectionElement.html">ContentProtectionElement</a> &element)</td></tr>
|
|
<tr class="separator:a265d014093c9073b08505013886aaa8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d17325903aa01f0c8ff7753d94ff330"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#a3d17325903aa01f0c8ff7753d94ff330">UpdateContentProtectionPssh</a> (const std::string &drm_uuid, const std::string &pssh)</td></tr>
|
|
<tr class="separator:a3d17325903aa01f0c8ff7753d94ff330"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad95da6fec382d9b88ac45ba397529f0"><td class="memItemLeft" align="right" valign="top"><a id="aad95da6fec382d9b88ac45ba397529f0"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>AdaptationSet</b></td></tr>
|
|
<tr class="separator:aad95da6fec382d9b88ac45ba397529f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e27c18b522c08ee8300a92881d1db5d"><td class="memItemLeft" align="right" valign="top"><a id="a8e27c18b522c08ee8300a92881d1db5d"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>RepresentationTest</b></td></tr>
|
|
<tr class="separator:a8e27c18b522c08ee8300a92881d1db5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9b6536925d1107e3f22ad3130cb9fe9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#ae9b6536925d1107e3f22ad3130cb9fe9">AddNewSegment</a> (int64_t start_time, int64_t duration, uint64_t size)</td></tr>
|
|
<tr class="separator:ae9b6536925d1107e3f22ad3130cb9fe9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11b32833166b9c4bea78cca2c6069d98"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#a11b32833166b9c4bea78cca2c6069d98">SetSampleDuration</a> (uint32_t sample_duration)</td></tr>
|
|
<tr class="separator:a11b32833166b9c4bea78cca2c6069d98"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a524291f7a968cb040fdce0ac1db5fbd3"><td class="memItemLeft" align="right" valign="top">virtual const MediaInfo & </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#a524291f7a968cb040fdce0ac1db5fbd3">GetMediaInfo</a> () const</td></tr>
|
|
<tr class="separator:a524291f7a968cb040fdce0ac1db5fbd3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4008b130a91b83198e769d15b3dfac3"><td class="memItemLeft" align="right" valign="top">base::Optional< <a class="el" href="../../d1/d31/classshaka_1_1xml_1_1XmlNode.html">xml::XmlNode</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#ab4008b130a91b83198e769d15b3dfac3">GetXml</a> ()</td></tr>
|
|
<tr class="separator:ab4008b130a91b83198e769d15b3dfac3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a473e45dbbf64e6ab6ed670ccedac84ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#a473e45dbbf64e6ab6ed670ccedac84ed">SuppressOnce</a> (SuppressFlag flag)</td></tr>
|
|
<tr class="separator:a473e45dbbf64e6ab6ed670ccedac84ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa93fd6cd965d3091a280debc93656d57"><td class="memItemLeft" align="right" valign="top"><a id="aa93fd6cd965d3091a280debc93656d57"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#aa93fd6cd965d3091a280debc93656d57">SetPresentationTimeOffset</a> (double presentation_time_offset)</td></tr>
|
|
<tr class="memdesc:aa93fd6cd965d3091a280debc93656d57"><td class="mdescLeft"> </td><td class="mdescRight">Set @presentationTimeOffset in SegmentBase / SegmentTemplate. <br /></td></tr>
|
|
<tr class="separator:aa93fd6cd965d3091a280debc93656d57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94fcb546e555637d33286515c1a44545"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#a94fcb546e555637d33286515c1a44545">GetStartAndEndTimestamps</a> (double *start_timestamp_seconds, double *end_timestamp_seconds) const</td></tr>
|
|
<tr class="separator:a94fcb546e555637d33286515c1a44545"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9cb9a38de5e57bff1feb81d2575ae1b2"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#a9cb9a38de5e57bff1feb81d2575ae1b2">id</a> () const</td></tr>
|
|
<tr class="separator:a9cb9a38de5e57bff1feb81d2575ae1b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a149769f6d702726b3fda5b99af622673"><td class="memItemLeft" align="right" valign="top"><a id="a149769f6d702726b3fda5b99af622673"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>set_media_info</b> (const MediaInfo &media_info)</td></tr>
|
|
<tr class="separator:a149769f6d702726b3fda5b99af622673"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a997138fcaa5deef5151a64a2d7ce6aeb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#a997138fcaa5deef5151a64a2d7ce6aeb">Representation</a> (const MediaInfo &media_info, const <a class="el" href="../../d1/df3/structshaka_1_1MpdOptions.html">MpdOptions</a> &mpd_options, uint32_t representation_id, std::unique_ptr< <a class="el" href="../../df/d94/classshaka_1_1RepresentationStateChangeListener.html">RepresentationStateChangeListener</a> > state_change_listener)</td></tr>
|
|
<tr class="separator:a997138fcaa5deef5151a64a2d7ce6aeb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1854062c6c5a3a1e622fca4d47eb4903"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d52/classshaka_1_1Representation.html#a1854062c6c5a3a1e622fca4d47eb4903">Representation</a> (const <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> &representation, std::unique_ptr< <a class="el" href="../../df/d94/classshaka_1_1RepresentationStateChangeListener.html">RepresentationStateChangeListener</a> > state_change_listener)</td></tr>
|
|
<tr class="separator:a1854062c6c5a3a1e622fca4d47eb4903"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> class contains references to a single media stream, as well as optional ContentProtection elements for that stream. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d0/d2b/representation_8h_source.html#l00050">50</a> of file <a class="el" href="../../d0/d2b/representation_8h_source.html">representation.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a997138fcaa5deef5151a64a2d7ce6aeb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a997138fcaa5deef5151a64a2d7ce6aeb">◆ </a></span>Representation() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">shaka::Representation::Representation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const MediaInfo & </td>
|
|
<td class="paramname"><em>media_info</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="../../d1/df3/structshaka_1_1MpdOptions.html">MpdOptions</a> & </td>
|
|
<td class="paramname"><em>mpd_options</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>representation_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::unique_ptr< <a class="el" href="../../df/d94/classshaka_1_1RepresentationStateChangeListener.html">RepresentationStateChangeListener</a> > </td>
|
|
<td class="paramname"><em>state_change_listener</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">media_info</td><td>is a MediaInfo containing information on the media. <em>media_info.bandwidth</em> is required for 'static' profile. If <em>media_info.bandwidth</em> is not present in 'dynamic' profile, this tries to estimate it using the info passed to <a class="el" href="../../de/d52/classshaka_1_1Representation.html#ae9b6536925d1107e3f22ad3130cb9fe9">AddNewSegment()</a>. </td></tr>
|
|
<tr><td class="paramname">mpd_options</td><td>is options for the entire MPD. </td></tr>
|
|
<tr><td class="paramname">representation_id</td><td>is the numeric ID for the <Representation>. </td></tr>
|
|
<tr><td class="paramname">state_change_listener</td><td>is an event handler for state changes to the representation. If null, no event handler registered. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d7/d94/representation_8cc_source.html#l00085">85</a> of file <a class="el" href="../../d7/d94/representation_8cc_source.html">representation.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1854062c6c5a3a1e622fca4d47eb4903"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1854062c6c5a3a1e622fca4d47eb4903">◆ </a></span>Representation() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">shaka::Representation::Representation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> & </td>
|
|
<td class="paramname"><em>representation</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::unique_ptr< <a class="el" href="../../df/d94/classshaka_1_1RepresentationStateChangeListener.html">RepresentationStateChangeListener</a> > </td>
|
|
<td class="paramname"><em>state_change_listener</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">representation</td><td>points to the original <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> to be cloned. </td></tr>
|
|
<tr><td class="paramname">state_change_listener</td><td>is an event handler for state changes to the representation. If null, no event handler registered. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d7/d94/representation_8cc_source.html#l00100">100</a> of file <a class="el" href="../../d7/d94/representation_8cc_source.html">representation.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a265d014093c9073b08505013886aaa8d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a265d014093c9073b08505013886aaa8d">◆ </a></span>AddContentProtectionElement()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void shaka::Representation::AddContentProtectionElement </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../da/d43/structshaka_1_1ContentProtectionElement.html">ContentProtectionElement</a> & </td>
|
|
<td class="paramname"><em>element</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Add a ContenProtection element to the representation. <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> does not add <ContentProtection> elements automatically to itself even if <em>media_info</em> passed to <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#a124e3c1ba5e3209f3214a556ecae28c3">AdaptationSet::AddRepresentation()</a> has <em>media_info.protected_content</em> populated. This is because some MPDs should have the elements at <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> level and some at <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> level. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">element</td><td>contains the ContentProtection element contents. If <em>element</em> has {value, schemeIdUri} set and has {“value”, “schemeIdUri”} as key for <em>additional_attributes</em>, then the former is used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d7/d94/representation_8cc_source.html#l00159">159</a> of file <a class="el" href="../../d7/d94/representation_8cc_source.html">representation.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae9b6536925d1107e3f22ad3130cb9fe9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae9b6536925d1107e3f22ad3130cb9fe9">◆ </a></span>AddNewSegment()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void shaka::Representation::AddNewSegment </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int64_t </td>
|
|
<td class="paramname"><em>start_time</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int64_t </td>
|
|
<td class="paramname"><em>duration</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Add a media (sub)segment to the representation. AdaptationSetsubsegmentAlignment,segmentAlignment} cannot be set if this is not called for all Representations. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">start_time</td><td>is the start time for the (sub)segment, in units of the stream's time scale. </td></tr>
|
|
<tr><td class="paramname">duration</td><td>is the duration of the segment, in units of the stream's time scale. </td></tr>
|
|
<tr><td class="paramname">size</td><td>of the segment in bytes. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d7/d94/representation_8cc_source.html#l00171">171</a> of file <a class="el" href="../../d7/d94/representation_8cc_source.html">representation.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a524291f7a968cb040fdce0ac1db5fbd3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a524291f7a968cb040fdce0ac1db5fbd3">◆ </a></span>GetMediaInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const MediaInfo & shaka::Representation::GetMediaInfo </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>MediaInfo for the <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a>. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d7/d94/representation_8cc_source.html#l00211">211</a> of file <a class="el" href="../../d7/d94/representation_8cc_source.html">representation.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a94fcb546e555637d33286515c1a44545"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a94fcb546e555637d33286515c1a44545">◆ </a></span>GetStartAndEndTimestamps()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool shaka::Representation::GetStartAndEndTimestamps </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double * </td>
|
|
<td class="paramname"><em>start_timestamp_seconds</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double * </td>
|
|
<td class="paramname"><em>end_timestamp_seconds</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Gets the start and end timestamps in seconds. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">start_timestamp_seconds</td><td>contains the returned start timestamp in seconds on success. It can be nullptr, which means that start timestamp does not need to be returned. </td></tr>
|
|
<tr><td class="paramname">end_timestamp_seconds</td><td>contains the returned end timestamp in seconds on success. It can be nullptr, which means that end timestamp does not need to be returned. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if successful, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d7/d94/representation_8cc_source.html#l00300">300</a> of file <a class="el" href="../../d7/d94/representation_8cc_source.html">representation.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab4008b130a91b83198e769d15b3dfac3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4008b130a91b83198e769d15b3dfac3">◆ </a></span>GetXml()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">base::Optional< <a class="el" href="../../d1/d31/classshaka_1_1xml_1_1XmlNode.html">xml::XmlNode</a> > shaka::Representation::GetXml </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>Copy of <Representation>. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d7/d94/representation_8cc_source.html#l00221">221</a> of file <a class="el" href="../../d7/d94/representation_8cc_source.html">representation.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9cb9a38de5e57bff1feb81d2575ae1b2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9cb9a38de5e57bff1feb81d2575ae1b2">◆ </a></span>id()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t shaka::Representation::id </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>ID number for <Representation>. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d0/d2b/representation_8h_source.html#l00142">142</a> of file <a class="el" href="../../d0/d2b/representation_8h_source.html">representation.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae998409ae94f3ba12909a96e8f3f4f7e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae998409ae94f3ba12909a96e8f3f4f7e">◆ </a></span>Init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool shaka::Representation::Init </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Tries to initialize the instance. If this does not succeed, the instance should not be used. </p><dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d7/d94/representation_8cc_source.html#l00117">117</a> of file <a class="el" href="../../d7/d94/representation_8cc_source.html">representation.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a11b32833166b9c4bea78cca2c6069d98"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a11b32833166b9c4bea78cca2c6069d98">◆ </a></span>SetSampleDuration()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void shaka::Representation::SetSampleDuration </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>sample_duration</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the sample duration of this <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a>. Sample duration is not available right away especially for live. This allows setting the sample duration after the <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> has been initialized. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sample_duration</td><td>is the duration of a sample. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d7/d94/representation_8cc_source.html#l00196">196</a> of file <a class="el" href="../../d7/d94/representation_8cc_source.html">representation.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a473e45dbbf64e6ab6ed670ccedac84ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a473e45dbbf64e6ab6ed670ccedac84ed">◆ </a></span>SuppressOnce()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void shaka::Representation::SuppressOnce </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SuppressFlag </td>
|
|
<td class="paramname"><em>flag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>By calling this methods, the next time <a class="el" href="../../de/d52/classshaka_1_1Representation.html#ab4008b130a91b83198e769d15b3dfac3">GetXml()</a> is called, the corresponding attributes will not be set. For example, if SuppressOnce(kSuppressWidth) is called, then <a class="el" href="../../de/d52/classshaka_1_1Representation.html#ab4008b130a91b83198e769d15b3dfac3">GetXml()</a> will return a <Representation> element without a @width attribute. Note that it only applies to the next call to <a class="el" href="../../de/d52/classshaka_1_1Representation.html#ab4008b130a91b83198e769d15b3dfac3">GetXml()</a>, calling <a class="el" href="../../de/d52/classshaka_1_1Representation.html#ab4008b130a91b83198e769d15b3dfac3">GetXml()</a> again without calling this methods will return a <Representation> element with the attribute. This may be called multiple times to set different (or the same) flags. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d7/d94/representation_8cc_source.html#l00288">288</a> of file <a class="el" href="../../d7/d94/representation_8cc_source.html">representation.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3d17325903aa01f0c8ff7753d94ff330"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d17325903aa01f0c8ff7753d94ff330">◆ </a></span>UpdateContentProtectionPssh()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void shaka::Representation::UpdateContentProtectionPssh </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>drm_uuid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>pssh</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Update the 'cenc:pssh' element for <em>drm_uuid</em> ContentProtection element. If the element does not exist, this will add one. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">drm_uuid</td><td>is the UUID of the DRM for encryption. </td></tr>
|
|
<tr><td class="paramname">pssh</td><td>is the content of <cenc:pssh> element. Note that DASH IF IOP mentions that this should be base64 encoded string of the whole pssh box. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section attention"><dt>Attention</dt><dd>This might get removed once DASH IF IOP specification makes a a clear guideline on how to handle key rotation. Also to get this working with shaka-player, this method <em>DOES NOT</em> update the PSSH element. Instead, it removes the element regardless of the content of <em>pssh</em>. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d7/d94/representation_8cc_source.html#l00165">165</a> of file <a class="el" href="../../d7/d94/representation_8cc_source.html">representation.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>packager/mpd/base/<a class="el" href="../../d0/d2b/representation_8h_source.html">representation.h</a></li>
|
|
<li>packager/mpd/base/<a class="el" href="../../d7/d94/representation_8cc_source.html">representation.cc</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Jun 22 2021 00:16:05 for Shaka Packager SDK by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|