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/d8/de1/classshaka_1_1Period.html

372 lines
20 KiB
HTML
Raw Permalink Blame History

<!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::Period 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&amp;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&amp;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="../../d8/de1/classshaka_1_1Period.html">Period</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</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="../../dd/d4e/classshaka_1_1Period-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::Period Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d7/d20/period_8h_source.html">period.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::Period:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d8/de1/classshaka_1_1Period.png" usemap="#shaka::Period_map" alt=""/>
<map id="shaka::Period_map" name="shaka::Period_map">
<area href="../../d8/d02/classshaka_1_1MockPeriod.html" alt="shaka::MockPeriod" shape="rect" coords="0,56,119,80"/>
</map>
</div></div>
<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:a6481aa2a87b0154796f49cb6198d0deb"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/de1/classshaka_1_1Period.html#a6481aa2a87b0154796f49cb6198d0deb">GetOrCreateAdaptationSet</a> (const MediaInfo &amp;media_info, bool content_protection_in_adaptation_set)</td></tr>
<tr class="separator:a6481aa2a87b0154796f49cb6198d0deb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabd4c14420c37f958523b84505a5dea1"><td class="memItemLeft" align="right" valign="top">base::Optional&lt; <a class="el" href="../../d1/d31/classshaka_1_1xml_1_1XmlNode.html">xml::XmlNode</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/de1/classshaka_1_1Period.html#aabd4c14420c37f958523b84505a5dea1">GetXml</a> (bool output_period_duration)</td></tr>
<tr class="separator:aabd4c14420c37f958523b84505a5dea1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee153103e77326b21f7f7c92af608654"><td class="memItemLeft" align="right" valign="top">const std::list&lt; <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/de1/classshaka_1_1Period.html#aee153103e77326b21f7f7c92af608654">GetAdaptationSets</a> () const</td></tr>
<tr class="separator:aee153103e77326b21f7f7c92af608654"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93ec8606ac8aa96139d3b5459ccb303d"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/de1/classshaka_1_1Period.html#a93ec8606ac8aa96139d3b5459ccb303d">start_time_in_seconds</a> () const</td></tr>
<tr class="separator:a93ec8606ac8aa96139d3b5459ccb303d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53fff2b4d8ac731857ec5a33cfcfaf86"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/de1/classshaka_1_1Period.html#a53fff2b4d8ac731857ec5a33cfcfaf86">duration_seconds</a> () const</td></tr>
<tr class="separator:a53fff2b4d8ac731857ec5a33cfcfaf86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5519676b3185c9902e98f5f3762d6d71"><td class="memItemLeft" align="right" valign="top"><a id="a5519676b3185c9902e98f5f3762d6d71"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/de1/classshaka_1_1Period.html#a5519676b3185c9902e98f5f3762d6d71">set_duration_seconds</a> (double <a class="el" href="../../d8/de1/classshaka_1_1Period.html#a53fff2b4d8ac731857ec5a33cfcfaf86">duration_seconds</a>)</td></tr>
<tr class="memdesc:a5519676b3185c9902e98f5f3762d6d71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set period duration. <br /></td></tr>
<tr class="separator:a5519676b3185c9902e98f5f3762d6d71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99e11102f8b1cb3a6ad71552f3e28128"><td class="memItemLeft" align="right" valign="top">const std::map&lt; std::string, std::list&lt; <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> * &gt; &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/de1/classshaka_1_1Period.html#a99e11102f8b1cb3a6ad71552f3e28128">trickplay_cache</a> () const</td></tr>
<tr class="separator:a99e11102f8b1cb3a6ad71552f3e28128"><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:a92f0486f20c430533a65d37a450ea020"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/de1/classshaka_1_1Period.html#a92f0486f20c430533a65d37a450ea020">Period</a> (uint32_t period_id, double <a class="el" href="../../d8/de1/classshaka_1_1Period.html#a93ec8606ac8aa96139d3b5459ccb303d">start_time_in_seconds</a>, const <a class="el" href="../../d1/df3/structshaka_1_1MpdOptions.html">MpdOptions</a> &amp;mpd_options, uint32_t *representation_counter)</td></tr>
<tr class="separator:a92f0486f20c430533a65d37a450ea020"><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 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>
<tr class="memitem:a445da55047811a33791b264e9e46659c"><td class="memItemLeft" align="right" valign="top"><a id="a445da55047811a33791b264e9e46659c"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>PeriodTest</b></td></tr>
<tr class="separator:a445da55047811a33791b264e9e46659c"><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/de1/classshaka_1_1Period.html">Period</a> class maps to &lt;Period&gt; element and provides methods to add AdaptationSets. </p>
<p class="definition">Definition at line <a class="el" href="../../d7/d20/period_8h_source.html#l00026">26</a> of file <a class="el" href="../../d7/d20/period_8h_source.html">period.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a92f0486f20c430533a65d37a450ea020"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92f0486f20c430533a65d37a450ea020">&#9670;&nbsp;</a></span>Period()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">shaka::Period::Period </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>period_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>start_time_in_seconds</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">uint32_t *&#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">period_id</td><td>is an ID number for this <a class="el" href="../../d8/de1/classshaka_1_1Period.html">Period</a>. </td></tr>
<tr><td class="paramname">start_time_in_seconds</td><td>is the start time for this <a class="el" href="../../d8/de1/classshaka_1_1Period.html">Period</a>. </td></tr>
<tr><td class="paramname">mpd_options</td><td>is the options for 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="../../dd/de1/period_8cc_source.html#l00065">65</a> of file <a class="el" href="../../dd/de1/period_8cc_source.html">period.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a53fff2b4d8ac731857ec5a33cfcfaf86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53fff2b4d8ac731857ec5a33cfcfaf86">&#9670;&nbsp;</a></span>duration_seconds()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double shaka::Period::duration_seconds </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>period duration in seconds. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d7/d20/period_8h_source.html#l00058">58</a> of file <a class="el" href="../../d7/d20/period_8h_source.html">period.h</a>.</p>
</div>
</div>
<a id="aee153103e77326b21f7f7c92af608654"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee153103e77326b21f7f7c92af608654">&#9670;&nbsp;</a></span>GetAdaptationSets()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::list&lt; <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> * &gt; shaka::Period::GetAdaptationSets </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>The list of AdaptationSets in this <a class="el" href="../../d8/de1/classshaka_1_1Period.html">Period</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../dd/de1/period_8cc_source.html#l00160">160</a> of file <a class="el" href="../../dd/de1/period_8cc_source.html">period.cc</a>.</p>
</div>
</div>
<a id="a6481aa2a87b0154796f49cb6198d0deb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6481aa2a87b0154796f49cb6198d0deb">&#9670;&nbsp;</a></span>GetOrCreateAdaptationSet()</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="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> * shaka::Period::GetOrCreateAdaptationSet </td>
<td>(</td>
<td class="paramtype">const MediaInfo &amp;&#160;</td>
<td class="paramname"><em>media_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>content_protection_in_adaptation_set</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>Check the existing AdaptationSets, if there is one matching the provided <em>media_info</em>, return it; otherwise a new <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> is created and returned. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">media_info</td><td>contains media information, which is used to match AdaptationSets. </td></tr>
<tr><td class="paramname">content_protection_in_adaptation_set</td><td>determines if the ContentProtection is placed in <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> or <a class="el" href="../../de/d52/classshaka_1_1Representation.html">Representation</a> element. This affects how MediaInfo in AdaptationSets are matched. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> matching <em>media_info</em> if found; otherwise return a new <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../dd/de1/period_8cc_source.html#l00074">74</a> of file <a class="el" href="../../dd/de1/period_8cc_source.html">period.cc</a>.</p>
</div>
</div>
<a id="aabd4c14420c37f958523b84505a5dea1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabd4c14420c37f958523b84505a5dea1">&#9670;&nbsp;</a></span>GetXml()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">base::Optional&lt; <a class="el" href="../../d1/d31/classshaka_1_1xml_1_1XmlNode.html">xml::XmlNode</a> &gt; shaka::Period::GetXml </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>output_period_duration</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generates &lt;Period&gt; xml element with its child <a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a> 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="../../dd/de1/period_8cc_source.html#l00123">123</a> of file <a class="el" href="../../dd/de1/period_8cc_source.html">period.cc</a>.</p>
</div>
</div>
<a id="a93ec8606ac8aa96139d3b5459ccb303d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93ec8606ac8aa96139d3b5459ccb303d">&#9670;&nbsp;</a></span>start_time_in_seconds()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double shaka::Period::start_time_in_seconds </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>The start time of this <a class="el" href="../../d8/de1/classshaka_1_1Period.html">Period</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d7/d20/period_8h_source.html#l00055">55</a> of file <a class="el" href="../../d7/d20/period_8h_source.html">period.h</a>.</p>
</div>
</div>
<a id="a99e11102f8b1cb3a6ad71552f3e28128"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99e11102f8b1cb3a6ad71552f3e28128">&#9670;&nbsp;</a></span>trickplay_cache()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::map&lt;std::string, std::list&lt;<a class="el" href="../../d8/d8e/classshaka_1_1AdaptationSet.html">AdaptationSet</a>*&gt; &gt;&amp; shaka::Period::trickplay_cache </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>trickplay_cache. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d7/d20/period_8h_source.html#l00066">66</a> of file <a class="el" href="../../d7/d20/period_8h_source.html">period.h</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="../../d7/d20/period_8h_source.html">period.h</a></li>
<li>packager/mpd/base/<a class="el" href="../../dd/de1/period_8cc_source.html">period.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink