shaka-packager/docs/d8/d8e/classshaka_1_1AdaptationSet...

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::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/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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</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="../../d8/d8e/classshaka_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="../../df/d33/classshaka_1_1AdaptationSet-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">shaka::AdaptationSet Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="../../d8/d72/adaptation__set_8h_source.html">adaptation_set.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::AdaptationSet:</div>
<div class="dyncontent">
 <div class="center">
  <img src="../../d8/d8e/classshaka_1_1AdaptationSet.png" usemap="#shaka::AdaptationSet_map" alt=""/>
  <map id="shaka::AdaptationSet_map" name="shaka::AdaptationSet_map">
<area href="../../db/d4b/classshaka_1_1MockAdaptationSet.html" alt="shaka::MockAdaptationSet" shape="rect" coords="0,56,160,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:a89f6573af412970297f4cf888d31edbd"><td class="memItemLeft" align="right" valign="top"><a id="a89f6573af412970297f4cf888d31edbd"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>Role</b> { <br />
&#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:a89f6573af412970297f4cf888d31edbd"><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:a124e3c1ba5e3209f3214a556ecae28c3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#a124e3c1ba5e3209f3214a556ecae28c3">AddRepresentation</a> (const MediaInfo &amp;media_info)</td></tr>
<tr class="separator:a124e3c1ba5e3209f3214a556ecae28c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48a144f36f6ba4736f683f102582fabc"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#a48a144f36f6ba4736f683f102582fabc">CopyRepresentation</a> (const <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> &amp;representation)</td></tr>
<tr class="separator:a48a144f36f6ba4736f683f102582fabc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28c52febc71a581ebec2c1308f6ea15c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#a28c52febc71a581ebec2c1308f6ea15c">AddContentProtectionElement</a> (const <a class="el" href="../../da/d43/structshaka_1_1ContentProtectionElement.html">ContentProtectionElement</a> &amp;element)</td></tr>
<tr class="separator:a28c52febc71a581ebec2c1308f6ea15c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8a28838bf1bbc1ad8f5b80961fe33c2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#ae8a28838bf1bbc1ad8f5b80961fe33c2">UpdateContentProtectionPssh</a> (const std::string &amp;drm_uuid, const std::string &amp;pssh)</td></tr>
<tr class="separator:ae8a28838bf1bbc1ad8f5b80961fe33c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae96ad89ec7cc7d5ef1db467a9cf13730"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#ae96ad89ec7cc7d5ef1db467a9cf13730">AddRole</a> (Role role)</td></tr>
<tr class="separator:ae96ad89ec7cc7d5ef1db467a9cf13730"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af988e3a6d8b0d3ede66e3f3aea992d5e"><td class="memItemLeft" align="right" valign="top">xml::scoped_xml_ptr&lt; xmlNode &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#af988e3a6d8b0d3ede66e3f3aea992d5e">GetXml</a> ()</td></tr>
<tr class="separator:af988e3a6d8b0d3ede66e3f3aea992d5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40532ecbed5f71de85bde0cb7eb1ef9d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#a40532ecbed5f71de85bde0cb7eb1ef9d">ForceSetSegmentAlignment</a> (bool segment_alignment)</td></tr>
<tr class="separator:a40532ecbed5f71de85bde0cb7eb1ef9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a979cef296d0e67c271641a0c3146e8f3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#a979cef296d0e67c271641a0c3146e8f3">AddAdaptationSetSwitching</a> (const <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> *adaptation_set)</td></tr>
<tr class="separator:a979cef296d0e67c271641a0c3146e8f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c4f483919b62a28c3a9061b3384f68b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#a4c4f483919b62a28c3a9061b3384f68b">has_id</a> () const</td></tr>
<tr class="separator:a4c4f483919b62a28c3a9061b3384f68b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a960b899f0badc0b1623220e1caaa76eb"><td class="memItemLeft" align="right" valign="top"><a id="a960b899f0badc0b1623220e1caaa76eb"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>id</b> () const</td></tr>
<tr class="separator:a960b899f0badc0b1623220e1caaa76eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4172e846f376783c39fe48230aefa8a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#af4172e846f376783c39fe48230aefa8a">set_id</a> (uint32_t id)</td></tr>
<tr class="separator:af4172e846f376783c39fe48230aefa8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcfb8f59204f6ec2f5dcd9cbd81dddf9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#afcfb8f59204f6ec2f5dcd9cbd81dddf9">OnNewSegmentForRepresentation</a> (uint32_t representation_id, uint64_t start_time, uint64_t duration)</td></tr>
<tr class="separator:afcfb8f59204f6ec2f5dcd9cbd81dddf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37904780833b552b7f95f124ffd10456"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#a37904780833b552b7f95f124ffd10456">OnSetFrameRateForRepresentation</a> (uint32_t representation_id, uint32_t frame_duration, uint32_t timescale)</td></tr>
<tr class="separator:a37904780833b552b7f95f124ffd10456"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a834d1c61e34db517169b802b8a11eeda"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#a834d1c61e34db517169b802b8a11eeda">AddTrickPlayReference</a> (const <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> *adaptation_set)</td></tr>
<tr class="separator:a834d1c61e34db517169b802b8a11eeda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4acfcdbaf3fbd87982398cfb14c5616c"><td class="memItemLeft" align="right" valign="top"><a id="a4acfcdbaf3fbd87982398cfb14c5616c"></a>
const std::list&lt; <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetRepresentations</b> () const</td></tr>
<tr class="separator:a4acfcdbaf3fbd87982398cfb14c5616c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9642eb0276b8f455d096c2e380ab9ac"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#ac9642eb0276b8f455d096c2e380ab9ac">IsVideo</a> () const</td></tr>
<tr class="separator:ac9642eb0276b8f455d096c2e380ab9ac"><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:ac4e96321642dc738e5c21511746fcb1f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#ac4e96321642dc738e5c21511746fcb1f">AdaptationSet</a> (const std::string &amp;language, const <a class="el" href="../../d1/df3/structshaka_1_1MpdOptions.html">MpdOptions</a> &amp;mpd_options, base::AtomicSequenceNumber *representation_counter)</td></tr>
<tr class="separator:ac4e96321642dc738e5c21511746fcb1f"><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:a1be92914085d069c8b44dd8c954a940b"><td class="memItemLeft" align="right" valign="top"><a id="a1be92914085d069c8b44dd8c954a940b"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>Period</b></td></tr>
<tr class="separator:a1be92914085d069c8b44dd8c954a940b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83023865f15fe283e94ce3925d69c916"><td class="memItemLeft" align="right" valign="top"><a id="a83023865f15fe283e94ce3925d69c916"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>AdaptationSetTest</b></td></tr>
<tr class="separator:a83023865f15fe283e94ce3925d69c916"><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="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> class provides methods to add Representations and &lt;ContentProtection&gt; elements to the <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> element. </p>

<p class="definition">Definition at line <a class="el" href="../../d8/d72/adaptation__set_8h_source.html#l00038">38</a> of file <a class="el" href="../../d8/d72/adaptation__set_8h_source.html">adaptation_set.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac4e96321642dc738e5c21511746fcb1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4e96321642dc738e5c21511746fcb1f">&#9670;&nbsp;</a></span>AdaptationSet()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">shaka::AdaptationSet::AdaptationSet </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>language</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> &amp;&#160;</td>
          <td class="paramname"><em>mpd_options</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">language</td><td>is the language of this <a class="el" href="../../d8/d8e/classshaka_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="../../de/d52/classshaka_1_1Representation.html">Representation</a>. It can not be NULL. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html#l00169">169</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a979cef296d0e67c271641a0c3146e8f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a979cef296d0e67c271641a0c3146e8f3">&#9670;&nbsp;</a></span>AddAdaptationSetSwitching()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void shaka::AdaptationSet::AddAdaptationSetSwitching </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> *&#160;</td>
          <td class="paramname"><em>adaptation_set</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>Adds the adaptation set this adaptation set can switch to. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">adaptation_set</td><td>points to the switchable adaptation set. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html#l00346">346</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a>.</p>

</div>
</div>
<a id="a28c52febc71a581ebec2c1308f6ea15c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28c52febc71a581ebec2c1308f6ea15c">&#9670;&nbsp;</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::AdaptationSet::AddContentProtectionElement </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../da/d43/structshaka_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="../../d8/d8e/classshaka_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="../../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="../../de/dc2/adaptation__set_8cc_source.html#l00216">216</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a>.</p>

</div>
</div>
<a id="a124e3c1ba5e3209f3214a556ecae28c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a124e3c1ba5e3209f3214a556ecae28c3">&#9670;&nbsp;</a></span>AddRepresentation()</h2>

<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="../../de/d52/classshaka_1_1Representation.html">Representation</a> * shaka::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="../../de/d52/classshaka_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="../../de/d52/classshaka_1_1Representation.html">Representation</a> instance. It may contain only one of VideoInfo, AudioInfo, or TextInfo, i.e. VideoInfo XOR AudioInfo XOR TextInfo. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success, returns a pointer to <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a>. Otherwise returns NULL. The returned pointer is owned by the <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> instance. </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html#l00182">182</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a>.</p>

</div>
</div>
<a id="ae96ad89ec7cc7d5ef1db467a9cf13730"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae96ad89ec7cc7d5ef1db467a9cf13730">&#9670;&nbsp;</a></span>AddRole()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void shaka::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="../../d8/d8e/classshaka_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="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a>. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html#l00228">228</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a>.</p>

</div>
</div>
<a id="a834d1c61e34db517169b802b8a11eeda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a834d1c61e34db517169b802b8a11eeda">&#9670;&nbsp;</a></span>AddTrickPlayReference()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void shaka::AdaptationSet::AddTrickPlayReference </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> *&#160;</td>
          <td class="paramname"><em>adaptation_set</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 the adaptation set this trick play adaptation set belongs to. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">adaptation_set</td><td>points to the reference (or main) adapation set. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html#l00375">375</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a>.</p>

</div>
</div>
<a id="a48a144f36f6ba4736f683f102582fabc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48a144f36f6ba4736f683f102582fabc">&#9670;&nbsp;</a></span>CopyRepresentation()</h2>

<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="../../de/d52/classshaka_1_1Representation.html">Representation</a> * shaka::AdaptationSet::CopyRepresentation </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> &amp;&#160;</td>
          <td class="paramname"><em>representation</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>Copy a <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> instance from <em>representation</em> in another <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a>. One use case is to duplicate <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> in different periods. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">representation</td><td>is an existing <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> to be cloned from. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success, returns a pointer to <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a>. Otherwise returns NULL. The returned pointer is owned by the <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> instance. </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html#l00201">201</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a>.</p>

</div>
</div>
<a id="a40532ecbed5f71de85bde0cb7eb1ef9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40532ecbed5f71de85bde0cb7eb1ef9d">&#9670;&nbsp;</a></span>ForceSetSegmentAlignment()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void shaka::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>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </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="../../d8/d8e/classshaka_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 class="definition">Definition at line <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html#l00340">340</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a>.</p>

</div>
</div>
<a id="af988e3a6d8b0d3ede66e3f3aea992d5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af988e3a6d8b0d3ede66e3f3aea992d5e">&#9670;&nbsp;</a></span>GetXml()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xml::scoped_xml_ptr&lt; xmlNode &gt; shaka::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="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> xml element with its child <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> and ContentProtection elements. </p><dl class="section return"><dt>Returns</dt><dd>On success returns a non-NULL scoped_xml_ptr. Otherwise returns a NULL scoped_xml_ptr. </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html#l00238">238</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a>.</p>

</div>
</div>
<a id="a4c4f483919b62a28c3a9061b3384f68b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c4f483919b62a28c3a9061b3384f68b">&#9670;&nbsp;</a></span>has_id()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool shaka::AdaptationSet::has_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>true if id is set, false otherwise. </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../d8/d72/adaptation__set_8h_source.html#l00122">122</a> of file <a class="el" href="../../d8/d72/adaptation__set_8h_source.html">adaptation_set.h</a>.</p>

</div>
</div>
<a id="ac9642eb0276b8f455d096c2e380ab9ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9642eb0276b8f455d096c2e380ab9ac">&#9670;&nbsp;</a></span>IsVideo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool shaka::AdaptationSet::IsVideo </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if it is a video <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a>. </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html#l00387">387</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a>.</p>

</div>
</div>
<a id="afcfb8f59204f6ec2f5dcd9cbd81dddf9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcfb8f59204f6ec2f5dcd9cbd81dddf9">&#9670;&nbsp;</a></span>OnNewSegmentForRepresentation()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void shaka::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="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> instance that a new (sub)segment was added to the <a class="el" href="../../de/d52/classshaka_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="../../de/d52/classshaka_1_1Representation.html">Representation</a> in this <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a>. If a <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> is constructed using <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#a124e3c1ba5e3209f3214a556ecae28c3">AddRepresentation()</a> this is called automatically whenever <a class="el" href="../../de/d52/classshaka_1_1Representation.html#a6ca8bbfd34ef8ca782d2ef18aeaad932">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="../../de/d52/classshaka_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 class="definition">Definition at line <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html#l00358">358</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a>.</p>

</div>
</div>
<a id="a37904780833b552b7f95f124ffd10456"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37904780833b552b7f95f124ffd10456">&#9670;&nbsp;</a></span>OnSetFrameRateForRepresentation()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void shaka::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="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> instance that the sample duration for the <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> was set. The frame duration for a video <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> might not be specified when a <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> is created (by calling <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html#a124e3c1ba5e3209f3214a556ecae28c3">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="../../d8/d8e/classshaka_1_1AdaptationSet.html#a124e3c1ba5e3209f3214a556ecae28c3">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="../../de/d52/classshaka_1_1Representation.html">Representation</a>.  is the duration of a frame in the <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a>. </td></tr>
    <tr><td class="paramname">timescale</td><td>is the timescale of the <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a>. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html#l00369">369</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a>.</p>

</div>
</div>
<a id="af4172e846f376783c39fe48230aefa8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4172e846f376783c39fe48230aefa8a">&#9670;&nbsp;</a></span>set_id()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void shaka::AdaptationSet::set_id </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>id</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Set <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a>. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">id</td><td>is the new ID to be set. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="../../d8/d72/adaptation__set_8h_source.html#l00129">129</a> of file <a class="el" href="../../d8/d72/adaptation__set_8h_source.html">adaptation_set.h</a>.</p>

</div>
</div>
<a id="ae8a28838bf1bbc1ad8f5b80961fe33c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8a28838bf1bbc1ad8f5b80961fe33c2">&#9670;&nbsp;</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::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 class="definition">Definition at line <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html#l00222">222</a> of file <a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.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="../../d8/d72/adaptation__set_8h_source.html">adaptation_set.h</a></li>
<li>packager/mpd/base/<a class="el" href="../../de/dc2/adaptation__set_8cc_source.html">adaptation_set.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 23 2018 16:10:49 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>