Mirror-Tools
/
shaka-packager
mirror of https://github.com/shaka-project/shaka-packager.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
shaka-packager/docs/db/de4/classedash__packager_1_1Ada...

579 lines
34 KiB
HTML
Raw Normal View History

Add SDK documents Change-Id: Ie3e4cbb93b44bbcf97e050f112f58578e17ca04f
2015-10-16 00:33:37 +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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>DASH Media Packaging SDK: edash_packager::AdaptationSet 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">DASH Media Packaging SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="../../index.html"><span>Main&#160;Page</span></a></li>
<li><a href="../../namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="../../annotated.html"><span>Classes</span></a></li>
<li><a href="../../files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="../../search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="../../annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="../../classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="../../hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="../../functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
Generate SDK documents for commit afbab863992317378e01df369f02d420f4dce576
2015-10-19 19:22:31 +00:00
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
Add SDK documents Change-Id: Ie3e4cbb93b44bbcf97e050f112f58578e17ca04f
2015-10-16 00:33:37 +00:00
<!-- 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="../../db/d09/namespaceedash__packager.html">edash_packager</a></li><li class="navelem"><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="../../d4/d9b/classedash__packager_1_1AdaptationSet-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">edash_packager::AdaptationSet Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d6/da3/mpd__builder_8h_source.html">mpd_builder.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for edash_packager::AdaptationSet:</div>
<div class="dyncontent">
<div class="center">
<img src="../../db/de4/classedash__packager_1_1AdaptationSet.png" usemap="#edash_packager::AdaptationSet_map" alt=""/>
<map id="edash_packager::AdaptationSet_map" name="edash_packager::AdaptationSet_map">
<area href="../../d8/d78/classedash__packager_1_1MockAdaptationSet.html" alt="edash_packager::MockAdaptationSet" shape="rect" coords="0,56,221,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>
Generate SDK documents for commit 845766f69a745f176fe4854449c2b67b9ab00997
2015-10-19 17:27:30 +00:00
<tr class="memitem:a451df65b68f1114a1e43cf6475fa324a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>Role</b> { <br/>
Add SDK documents Change-Id: Ie3e4cbb93b44bbcf97e050f112f58578e17ca04f
2015-10-16 00:33:37 +00:00
&#160;&#160;<b>kRoleCaption</b>,
<b>kRoleSubtitle</b>,
<b>kRoleMain</b>,
<b>kRoleAlternate</b>,
<br/>
&#160;&#160;<b>kRoleSupplementary</b>,
<b>kRoleCommentary</b>,
<b>kRoleDub</b>
<br/>
}</td></tr>
<tr class="separator:a451df65b68f1114a1e43cf6475fa324a"><td class="memSeparator" colspan="2">&#160;</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:a9a15647b565f9898a5a0e1d3176ff935"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#a9a15647b565f9898a5a0e1d3176ff935">AddRepresentation</a> (const MediaInfo &amp;media_info)</td></tr>
<tr class="separator:a9a15647b565f9898a5a0e1d3176ff935"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a419e5b2dc27fef47fb0fcaa17ea09314"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#a419e5b2dc27fef47fb0fcaa17ea09314">AddContentProtectionElement</a> (const <a class="el" href="../../d0/d96/structedash__packager_1_1ContentProtectionElement.html">ContentProtectionElement</a> &amp;element)</td></tr>
<tr class="separator:a419e5b2dc27fef47fb0fcaa17ea09314"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6630f9954b604bee7f90c11778336fdc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#a6630f9954b604bee7f90c11778336fdc">UpdateContentProtectionPssh</a> (const std::string &amp;drm_uuid, const std::string &amp;pssh)</td></tr>
<tr class="separator:a6630f9954b604bee7f90c11778336fdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bfc3e2de3eaafc61a4dc2e23c698956"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#a3bfc3e2de3eaafc61a4dc2e23c698956">AddRole</a> (Role role)</td></tr>
<tr class="separator:a3bfc3e2de3eaafc61a4dc2e23c698956"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44984cfaed799fd6683c6c9d41394dd6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/df3/structedash__packager_1_1xml_1_1ScopedXmlPtr.html">xml::ScopedXmlPtr</a>&lt; xmlNode &gt;::type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#a44984cfaed799fd6683c6c9d41394dd6">GetXml</a> ()</td></tr>
<tr class="separator:a44984cfaed799fd6683c6c9d41394dd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a949526c833122b9a1ca40b9990224990"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#a949526c833122b9a1ca40b9990224990">ForceSetSegmentAlignment</a> (bool segment_alignment)</td></tr>
<tr class="separator:a949526c833122b9a1ca40b9990224990"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bea0954dfe1781afc1c7a624965bc84"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#a3bea0954dfe1781afc1c7a624965bc84">SetGroup</a> (int group_number)</td></tr>
<tr class="separator:a3bea0954dfe1781afc1c7a624965bc84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5efd9add7037cf939c6a48733e38f8f"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#ad5efd9add7037cf939c6a48733e38f8f">Group</a> () const </td></tr>
<tr class="separator:ad5efd9add7037cf939c6a48733e38f8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af44375c55737ee2a04532da9a0a22d82"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af44375c55737ee2a04532da9a0a22d82"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>id</b> () const </td></tr>
<tr class="separator:af44375c55737ee2a04532da9a0a22d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed9c81cd32d8bbb8ed71d5ab3f16efac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#aed9c81cd32d8bbb8ed71d5ab3f16efac">OnNewSegmentForRepresentation</a> (uint32_t representation_id, uint64_t start_time, uint64_t duration)</td></tr>
<tr class="separator:aed9c81cd32d8bbb8ed71d5ab3f16efac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9adf17a02fabfd4aa8d91a2d65d52ad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#ad9adf17a02fabfd4aa8d91a2d65d52ad">OnSetFrameRateForRepresentation</a> (uint32_t representation_id, uint32_t frame_duration, uint32_t timescale)</td></tr>
<tr class="separator:ad9adf17a02fabfd4aa8d91a2d65d52ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a21ce7ce804532a95f9aea7e2a9c3570e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#a21ce7ce804532a95f9aea7e2a9c3570e">AdaptationSet</a> (uint32_t adaptation_set_id, const std::string &amp;lang, const <a class="el" href="../../d1/d5d/structedash__packager_1_1MpdOptions.html">MpdOptions</a> &amp;mpd_options, MpdBuilder::MpdType mpd_type, base::AtomicSequenceNumber *representation_counter)</td></tr>
<tr class="separator:a21ce7ce804532a95f9aea7e2a9c3570e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:aa8a6d1affa97b417155f40cc2ae03a99"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8a6d1affa97b417155f40cc2ae03a99"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>MpdBuilder</b></td></tr>
<tr class="separator:aa8a6d1affa97b417155f40cc2ae03a99"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a> class provides methods to add Representations and &lt;ContentProtection&gt; elements to the <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a> element. </p>
<p>Definition at line <a class="el" href="../../d6/da3/mpd__builder_8h_source.html#l00156">156</a> of file <a class="el" href="../../d6/da3/mpd__builder_8h_source.html">mpd_builder.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a21ce7ce804532a95f9aea7e2a9c3570e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">edash_packager::AdaptationSet::AdaptationSet </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>adaptation_set_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>lang</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="../../d1/d5d/structedash__packager_1_1MpdOptions.html">MpdOptions</a> &amp;&#160;</td>
<td class="paramname"><em>mpd_options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MpdBuilder::MpdType&#160;</td>
<td class="paramname"><em>mpd_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">base::AtomicSequenceNumber *&#160;</td>
<td class="paramname"><em>representation_counter</em>&#160;</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">adaptation_set_id</td><td>is an ID number for this <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a>. </td></tr>
<tr><td class="paramname">lang</td><td>is the language of this <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a>. Mainly relevant for audio. </td></tr>
<tr><td class="paramname">mpd_options</td><td>is the options for this MPD. </td></tr>
<tr><td class="paramname">mpd_type</td><td>is the type of this MPD. </td></tr>
<tr><td class="paramname">representation_counter</td><td>is a Counter for assigning ID numbers to <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a>. It can not be NULL. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html#l00636">636</a> of file <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html">mpd_builder.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a419e5b2dc27fef47fb0fcaa17ea09314"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void edash_packager::AdaptationSet::AddContentProtectionElement </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d0/d96/structedash__packager_1_1ContentProtectionElement.html">ContentProtectionElement</a> &amp;&#160;</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 adaptation set. <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a> does not add &lt;ContentProtection&gt; elements automatically to itself even if <em>media_info.protected_content</em> is populated. This is because some MPDs should have the elements at <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a> level and some at <a class="el" href="../../d7/d15/classedash__packager_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>Definition at line <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html#l00693">693</a> of file <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html">mpd_builder.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a9a15647b565f9898a5a0e1d3176ff935"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a> * edash_packager::AdaptationSet::AddRepresentation </td>
<td>(</td>
<td class="paramtype">const MediaInfo &amp;&#160;</td>
<td class="paramname"><em>media_info</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>Create a <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a> instance using <em>media_info</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">media_info</td><td>is a MediaInfo object used to initialize the returned <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a> instance. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success, returns a pointer to <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a>. Otherwise returns NULL. The returned pointer is owned by the <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a> instance. </dd></dl>
<p>Definition at line <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html#l00655">655</a> of file <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html">mpd_builder.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a3bfc3e2de3eaafc61a4dc2e23c698956"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void edash_packager::AdaptationSet::AddRole </td>
<td>(</td>
<td class="paramtype">Role&#160;</td>
<td class="paramname"><em>role</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 Role element for this <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a>. The Role element's is schemeIdUri='urn:mpeg:dash:role:2011'. See ISO/IEC 23009-1:2012 section 5.8.5.5. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">role</td><td>of this <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a>. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html#l00707">707</a> of file <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html">mpd_builder.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a949526c833122b9a1ca40b9990224990"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void edash_packager::AdaptationSet::ForceSetSegmentAlignment </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>segment_alignment</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Forces the (sub)segmentAlignment field to be set to <em>segment_alignment</em>. Use this if you are certain that the (sub)segments are alinged/unaligned for the <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">segment_alignment</td><td>is the value used for (sub)segmentAlignment attribute. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html#l00783">783</a> of file <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html">mpd_builder.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a44984cfaed799fd6683c6c9d41394dd6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d8/df3/structedash__packager_1_1xml_1_1ScopedXmlPtr.html">xml::ScopedXmlPtr</a>&lt; xmlNode &gt;::type edash_packager::AdaptationSet::GetXml </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes a copy of <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a> xml element with its child <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a> and ContentProtection elements. </p>
<dl class="section return"><dt>Returns</dt><dd>On success returns a non-NULL ScopedXmlPtr. Otherwise returns a NULL ScopedXmlPtr. </dd></dl>
<p>Definition at line <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html#l00713">713</a> of file <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html">mpd_builder.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ad5efd9add7037cf939c6a48733e38f8f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int edash_packager::AdaptationSet::Group </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>Returns the value for group. If not set, returns a negative value. </dd></dl>
<p>Definition at line <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html#l00793">793</a> of file <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html">mpd_builder.cc</a>.</p>
</div>
</div>
<a class="anchor" id="aed9c81cd32d8bbb8ed71d5ab3f16efac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void edash_packager::AdaptationSet::OnNewSegmentForRepresentation </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>representation_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>start_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>duration</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies the <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a> instance that a new (sub)segment was added to the <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a> with <em>representation_id</em>. This must be called every time a (sub)segment is added to a <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a> in this <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a>. If a <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a> is constructed using <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#a9a15647b565f9898a5a0e1d3176ff935">AddRepresentation()</a> this is called automatically whenever <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html#ad40b7da1667aeb77c84958ec4ec0d9eb">Representation::AddNewSegment()</a> is is called. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">representation_id</td><td>is the id of the <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a> with a new segment. </td></tr>
<tr><td class="paramname">start_time</td><td>is the start time of the new segment. </td></tr>
<tr><td class="paramname">duration</td><td>is the duration of the new segment. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html#l00804">804</a> of file <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html">mpd_builder.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ad9adf17a02fabfd4aa8d91a2d65d52ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void edash_packager::AdaptationSet::OnSetFrameRateForRepresentation </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>representation_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>frame_duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>timescale</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies the <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a> instance that the sample duration for the <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a> was set. The frame duration for a video <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a> might not be specified when a <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a> is created (by calling <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#a9a15647b565f9898a5a0e1d3176ff935">AddRepresentation()</a>). This should be used to notify this instance that the frame rate for a Represenatation has been set. This method is called automatically when Represenatation::SetSampleDuration() is called if the Represenatation instance was created using <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html#a9a15647b565f9898a5a0e1d3176ff935">AddRepresentation()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">representation_id</td><td>is the id of the <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a>. is the duration of a frame in the <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a>. </td></tr>
<tr><td class="paramname">timescale</td><td>is the timescale of the <a class="el" href="../../d7/d15/classedash__packager_1_1Representation.html">Representation</a>. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html#l00817">817</a> of file <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html">mpd_builder.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a3bea0954dfe1781afc1c7a624965bc84"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void edash_packager::AdaptationSet::SetGroup </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>group_number</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>Sets the <a class="el" href="../../db/de4/classedash__packager_1_1AdaptationSet.html">AdaptationSet</a> attribute. Passing a negative value to this method will unset the attribute. Note that group=0 is a special group, as mentioned in the DASH MPD specification. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">group_number</td><td>is the value of AdaptatoinSet. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html#l00789">789</a> of file <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html">mpd_builder.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a6630f9954b604bee7f90c11778336fdc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void edash_packager::AdaptationSet::UpdateContentProtectionPssh </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>drm_uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>pssh</em>&#160;</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 &lt;cenc:pssh&gt; 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>Definition at line <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html#l00700">700</a> of file <a class="el" href="../../dd/d11/mpd__builder_8cc_source.html">mpd_builder.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>mpd/base/<a class="el" href="../../d6/da3/mpd__builder_8h_source.html">mpd_builder.h</a></li>
<li>mpd/base/<a class="el" href="../../dd/d11/mpd__builder_8cc_source.html">mpd_builder.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generate SDK documents for commit 8fc7f51d81d62054f035240048f786886c9993e1
2015-10-28 00:32:32 +00:00
Generated on Wed Oct 28 2015 00:32:28 for DASH Media Packaging SDK by &#160;<a href="http://www.doxygen.org/index.html">
Add SDK documents Change-Id: Ie3e4cbb93b44bbcf97e050f112f58578e17ca04f
2015-10-16 00:33:37 +00:00
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>