shaka-packager/docs/d3/dd0/classshaka_1_1MpdNotifier.html

606 lines
30 KiB
HTML
Raw Permalink Normal View 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"/>
2021-06-22 00:16:40 +00:00
<meta name="generator" content="Doxygen 1.8.17"/>
2018-02-10 23:37:42 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::MpdNotifier 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"/>
2018-02-10 23:37:42 +00:00
<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;">
2018-02-10 23:37:42 +00:00
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Shaka Packager SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2021-06-22 00:16:40 +00:00
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2021-06-22 00:16:40 +00:00
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
2018-02-10 23:37:42 +00:00
<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 */
2018-02-10 23:37:42 +00:00
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
2018-02-10 23:37:42 +00:00
<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)">
2018-02-10 23:37:42 +00:00
</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="../../d3/dd0/classshaka_1_1MpdNotifier.html">MpdNotifier</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../dd/d9d/classshaka_1_1MpdNotifier-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::MpdNotifier Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d7/d15/mpd__notifier_8h_source.html">mpd_notifier.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::MpdNotifier:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d3/dd0/classshaka_1_1MpdNotifier.png" usemap="#shaka::MpdNotifier_map" alt=""/>
<map id="shaka::MpdNotifier_map" name="shaka::MpdNotifier_map">
2018-02-10 23:37:42 +00:00
<area href="../../dc/d5c/classshaka_1_1MockMpdNotifier.html" alt="shaka::MockMpdNotifier" shape="rect" coords="0,56,154,80"/>
<area href="../../d8/de1/classshaka_1_1SimpleMpdNotifier.html" alt="shaka::SimpleMpdNotifier" shape="rect" coords="164,56,318,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>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a2d4c6967b3db8ba800b9dd97bb99fbe1"><td class="memItemLeft" align="right" valign="top"><a id="a2d4c6967b3db8ba800b9dd97bb99fbe1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>MpdNotifier</b> (const <a class="el" href="../../d1/df3/structshaka_1_1MpdOptions.html">MpdOptions</a> &amp;mpd_options)</td></tr>
<tr class="separator:a2d4c6967b3db8ba800b9dd97bb99fbe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6171481d6fb437767b1f5b9e0dac1a3"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#ad6171481d6fb437767b1f5b9e0dac1a3">Init</a> ()=0</td></tr>
<tr class="separator:ad6171481d6fb437767b1f5b9e0dac1a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae10c06fe6022a1020fc889de389be430"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#ae10c06fe6022a1020fc889de389be430">NotifyNewContainer</a> (const MediaInfo &amp;media_info, uint32_t *container_id)=0</td></tr>
<tr class="separator:ae10c06fe6022a1020fc889de389be430"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a721edf600dc9165e96e4b6c154a2d4f6"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#a721edf600dc9165e96e4b6c154a2d4f6">NotifySampleDuration</a> (uint32_t container_id, uint32_t sample_duration)=0</td></tr>
<tr class="separator:a721edf600dc9165e96e4b6c154a2d4f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a100236a249477afcda4f50e4914f0eee"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#a100236a249477afcda4f50e4914f0eee">NotifyNewSegment</a> (uint32_t container_id, uint64_t start_time, uint64_t duration, uint64_t size)=0</td></tr>
<tr class="separator:a100236a249477afcda4f50e4914f0eee"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a74fed9807b9584387e5da5f0fd28d54d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#a74fed9807b9584387e5da5f0fd28d54d">NotifyCueEvent</a> (uint32_t container_id, uint64_t timestamp)=0</td></tr>
<tr class="separator:a74fed9807b9584387e5da5f0fd28d54d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf6a0bde4fc907053cc9f1ff9a38b59a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#acf6a0bde4fc907053cc9f1ff9a38b59a">NotifyEncryptionUpdate</a> (uint32_t container_id, const std::string &amp;drm_uuid, const std::vector&lt; uint8_t &gt; &amp;new_key_id, const std::vector&lt; uint8_t &gt; &amp;new_pssh)=0</td></tr>
<tr class="separator:acf6a0bde4fc907053cc9f1ff9a38b59a"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-05-23 23:12:00 +00:00
<tr class="memitem:a4d55e7b557c624954b4e05edf6bd83d1"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#a4d55e7b557c624954b4e05edf6bd83d1">NotifyMediaInfoUpdate</a> (uint32_t container_id, const MediaInfo &amp;media_info)=0</td></tr>
<tr class="separator:a4d55e7b557c624954b4e05edf6bd83d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8149126f4793506bef385d067561dbf"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#af8149126f4793506bef385d067561dbf">Flush</a> ()=0</td></tr>
<tr class="separator:af8149126f4793506bef385d067561dbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae926a171d926eb142f0e8cffe64bb2a2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#ae926a171d926eb142f0e8cffe64bb2a2">include_mspr_pro</a> () const</td></tr>
<tr class="separator:ae926a171d926eb142f0e8cffe64bb2a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a28714ebd081aa9244aca2beb85c78d37"><td class="memItemLeft" align="right" valign="top">DashProfile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#a28714ebd081aa9244aca2beb85c78d37">dash_profile</a> () const</td></tr>
<tr class="separator:a28714ebd081aa9244aca2beb85c78d37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a050bde7afb601661a5db508152ffc508"><td class="memItemLeft" align="right" valign="top">MpdType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#a050bde7afb601661a5db508152ffc508">mpd_type</a> () const</td></tr>
<tr class="separator:a050bde7afb601661a5db508152ffc508"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c44f9156ecc3dcef724b891aae65b24"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#a0c44f9156ecc3dcef724b891aae65b24">use_segment_list</a> () const</td></tr>
<tr class="separator:a0c44f9156ecc3dcef724b891aae65b24"><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>Interface for publish/subscribe publisher class which notifies <a class="el" href="../../dc/da1/classshaka_1_1MpdBuilder.html" title="This class generates DASH MPDs (Media Presentation Descriptions).">MpdBuilder</a> of media-related events. </p>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../d7/d15/mpd__notifier_8h_source.html#l00027">27</a> of file <a class="el" href="../../d7/d15/mpd__notifier_8h_source.html">mpd_notifier.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
2018-02-10 23:37:42 +00:00
<a id="a28714ebd081aa9244aca2beb85c78d37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28714ebd081aa9244aca2beb85c78d37">&#9670;&nbsp;</a></span>dash_profile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2018-02-10 23:37:42 +00:00
<td class="memname">DashProfile shaka::MpdNotifier::dash_profile </td>
<td>(</td>
2018-02-10 23:37:42 +00:00
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
2018-02-10 23:37:42 +00:00
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<dl class="section return"><dt>Returns</dt><dd>The dash profile for this object. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d7/d15/mpd__notifier_8h_source.html#l00111">111</a> of file <a class="el" href="../../d7/d15/mpd__notifier_8h_source.html">mpd_notifier.h</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="af8149126f4793506bef385d067561dbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8149126f4793506bef385d067561dbf">&#9670;&nbsp;</a></span>Flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2018-02-10 23:37:42 +00:00
<td class="memname">virtual bool shaka::MpdNotifier::Flush </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
2018-02-10 23:37:42 +00:00
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
2018-02-10 23:37:42 +00:00
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<p>Call this method to force a flush. Implementations might not write out the MPD to a stream (file, stdout, etc.) when the MPD is updated, this forces a flush. </p>
2018-02-10 23:37:42 +00:00
<p>Implemented in <a class="el" href="../../d8/de1/classshaka_1_1SimpleMpdNotifier.html#a8ea622a21a5807775bb2d998fa04658f">shaka::SimpleMpdNotifier</a>.</p>
</div>
</div>
<a id="ae926a171d926eb142f0e8cffe64bb2a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae926a171d926eb142f0e8cffe64bb2a2">&#9670;&nbsp;</a></span>include_mspr_pro()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::MpdNotifier::include_mspr_pro </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>include_mspr_pro option flag </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d7/d15/mpd__notifier_8h_source.html#l00108">108</a> of file <a class="el" href="../../d7/d15/mpd__notifier_8h_source.html">mpd_notifier.h</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="ad6171481d6fb437767b1f5b9e0dac1a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6171481d6fb437767b1f5b9e0dac1a3">&#9670;&nbsp;</a></span>Init()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2018-02-10 23:37:42 +00:00
<td class="memname">virtual bool shaka::MpdNotifier::Init </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<p>Initializes the notifier. For example, if this notifier uses a network for notification, then this would set up the connection with the remote host. </p><dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
2018-02-10 23:37:42 +00:00
<p>Implemented in <a class="el" href="../../d8/de1/classshaka_1_1SimpleMpdNotifier.html#a59bcb401b5ca8d5b893ec7da9461569f">shaka::SimpleMpdNotifier</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a050bde7afb601661a5db508152ffc508"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a050bde7afb601661a5db508152ffc508">&#9670;&nbsp;</a></span>mpd_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2018-02-10 23:37:42 +00:00
<td class="memname">MpdType shaka::MpdNotifier::mpd_type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
2018-02-10 23:37:42 +00:00
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
2018-02-10 23:37:42 +00:00
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<dl class="section return"><dt>Returns</dt><dd>The mpd type for this object. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d7/d15/mpd__notifier_8h_source.html#l00114">114</a> of file <a class="el" href="../../d7/d15/mpd__notifier_8h_source.html">mpd_notifier.h</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a74fed9807b9584387e5da5f0fd28d54d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74fed9807b9584387e5da5f0fd28d54d">&#9670;&nbsp;</a></span>NotifyCueEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2018-02-10 23:37:42 +00:00
<td class="memname">virtual bool shaka::MpdNotifier::NotifyCueEvent </td>
<td>(</td>
2018-02-10 23:37:42 +00:00
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>container_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>timestamp</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
2018-02-10 23:37:42 +00:00
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies <a class="el" href="../../dc/da1/classshaka_1_1MpdBuilder.html" title="This class generates DASH MPDs (Media Presentation Descriptions).">MpdBuilder</a> that there is a new CueEvent. </p><dl class="params"><dt>Parameters</dt><dd>
2018-02-10 23:37:42 +00:00
<table class="params">
<tr><td class="paramname">container_id</td><td>Container ID obtained from calling <a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#ae10c06fe6022a1020fc889de389be430">NotifyNewContainer()</a>. </td></tr>
<tr><td class="paramname">timestamp</td><td>is the timestamp of the CueEvent. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
2018-02-10 23:37:42 +00:00
<p>Implemented in <a class="el" href="../../d8/de1/classshaka_1_1SimpleMpdNotifier.html#a165f1237a3c70abe524289837f3b135d">shaka::SimpleMpdNotifier</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="acf6a0bde4fc907053cc9f1ff9a38b59a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf6a0bde4fc907053cc9f1ff9a38b59a">&#9670;&nbsp;</a></span>NotifyEncryptionUpdate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool shaka::MpdNotifier::NotifyEncryptionUpdate </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>container_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></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::vector&lt; uint8_t &gt; &amp;&#160;</td>
<td class="paramname"><em>new_key_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; uint8_t &gt; &amp;&#160;</td>
<td class="paramname"><em>new_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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifiers <a class="el" href="../../dc/da1/classshaka_1_1MpdBuilder.html" title="This class generates DASH MPDs (Media Presentation Descriptions).">MpdBuilder</a> that there is a new PSSH for the container. This may be called whenever the key has to change, e.g. key rotation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">container_id</td><td>Container ID obtained from calling <a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#ae10c06fe6022a1020fc889de389be430">NotifyNewContainer()</a>. </td></tr>
<tr><td class="paramname">drm_uuid</td><td>is the UUID of the DRM for encryption. </td></tr>
<tr><td class="paramname">new_key_id</td><td>is the new key ID for the key. </td></tr>
<tr><td class="paramname">new_pssh</td><td>is the new pssh box (including the header). </td></tr>
</table>
</dd>
</dl>
<dl class="section attention"><dt>Attention</dt><dd>This might change or get removed once DASH IF IOP specification writes a clear guideline on how to handle key rotation. </dd></dl>
2018-02-10 23:37:42 +00:00
<p>Implemented in <a class="el" href="../../d8/de1/classshaka_1_1SimpleMpdNotifier.html#ae1a1231fb13e0bc97cdea5fc239184bf">shaka::SimpleMpdNotifier</a>.</p>
2018-05-23 23:12:00 +00:00
</div>
</div>
<a id="a4d55e7b557c624954b4e05edf6bd83d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d55e7b557c624954b4e05edf6bd83d1">&#9670;&nbsp;</a></span>NotifyMediaInfoUpdate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool shaka::MpdNotifier::NotifyMediaInfoUpdate </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>container_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const MediaInfo &amp;&#160;</td>
<td class="paramname"><em>media_info</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">container_id</td><td>Container ID obtained from calling <a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#ae10c06fe6022a1020fc889de389be430">NotifyNewContainer()</a>. </td></tr>
<tr><td class="paramname">media_info</td><td>is the new MediaInfo. Note that codec related information cannot be updated. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="../../d8/de1/classshaka_1_1SimpleMpdNotifier.html#a6a811c3721117dcc6aac9595a8311e70">shaka::SimpleMpdNotifier</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="ae10c06fe6022a1020fc889de389be430"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae10c06fe6022a1020fc889de389be430">&#9670;&nbsp;</a></span>NotifyNewContainer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool shaka::MpdNotifier::NotifyNewContainer </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">uint32_t *&#160;</td>
<td class="paramname"><em>container_id</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies the <a class="el" href="../../dc/da1/classshaka_1_1MpdBuilder.html" title="This class generates DASH MPDs (Media Presentation Descriptions).">MpdBuilder</a> that there is a new container along with <em>media_info</em>. Live may have multiple files (segments) but those should be notified via <a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#a100236a249477afcda4f50e4914f0eee">NotifyNewSegment()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">media_info</td><td>is the MediaInfo that will be passed to <a class="el" href="../../dc/da1/classshaka_1_1MpdBuilder.html" title="This class generates DASH MPDs (Media Presentation Descriptions).">MpdBuilder</a>. </td></tr>
2018-02-10 23:37:42 +00:00
<tr><td class="paramdir">[out]</td><td class="paramname">container_id</td><td>is the numeric ID of the container, possibly for <a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#a100236a249477afcda4f50e4914f0eee">NotifyNewSegment()</a> and AddContentProtectionElement(). Only populated on success. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
2018-02-10 23:37:42 +00:00
<p>Implemented in <a class="el" href="../../d8/de1/classshaka_1_1SimpleMpdNotifier.html#a3f4aabd86ec08e5ff427120ed39fda29">shaka::SimpleMpdNotifier</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a100236a249477afcda4f50e4914f0eee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a100236a249477afcda4f50e4914f0eee">&#9670;&nbsp;</a></span>NotifyNewSegment()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool shaka::MpdNotifier::NotifyNewSegment </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>container_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>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>size</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies <a class="el" href="../../dc/da1/classshaka_1_1MpdBuilder.html" title="This class generates DASH MPDs (Media Presentation Descriptions).">MpdBuilder</a> that there is a new segment ready. For live, this is usually a new segment, for VOD this is usually a subsegment. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">container_id</td><td>Container ID obtained from calling <a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#ae10c06fe6022a1020fc889de389be430">NotifyNewContainer()</a>. </td></tr>
<tr><td class="paramname">start_time</td><td>is the start time of the new segment, in units of the stream's time scale. </td></tr>
<tr><td class="paramname">duration</td><td>is the duration of the new segment, in units of the stream's time scale. </td></tr>
<tr><td class="paramname">size</td><td>is the new segment size in bytes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
2018-02-10 23:37:42 +00:00
<p>Implemented in <a class="el" href="../../d8/de1/classshaka_1_1SimpleMpdNotifier.html#a8e9cc7fbe2e13a2b65ce9314428e48b8">shaka::SimpleMpdNotifier</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a721edf600dc9165e96e4b6c154a2d4f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a721edf600dc9165e96e4b6c154a2d4f6">&#9670;&nbsp;</a></span>NotifySampleDuration()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool shaka::MpdNotifier::NotifySampleDuration </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>container_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>sample_duration</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<p>Change the sample duration of container with <em>container_id</em>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">container_id</td><td>Container ID obtained from calling <a class="el" href="../../d3/dd0/classshaka_1_1MpdNotifier.html#ae10c06fe6022a1020fc889de389be430">NotifyNewContainer()</a>. </td></tr>
<tr><td class="paramname">sample_duration</td><td>is the duration of a sample in timescale of the media. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. This may fail if the container specified by <em>container_id</em> does not exist. </dd></dl>
2018-02-10 23:37:42 +00:00
<p>Implemented in <a class="el" href="../../d8/de1/classshaka_1_1SimpleMpdNotifier.html#ad876de8c9909394b6fb47f387066fc83">shaka::SimpleMpdNotifier</a>.</p>
</div>
</div>
<a id="a0c44f9156ecc3dcef724b891aae65b24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c44f9156ecc3dcef724b891aae65b24">&#9670;&nbsp;</a></span>use_segment_list()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::MpdNotifier::use_segment_list </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 value of dash_force_segment_list flag </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d7/d15/mpd__notifier_8h_source.html#l00117">117</a> of file <a class="el" href="../../d7/d15/mpd__notifier_8h_source.html">mpd_notifier.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>packager/mpd/base/<a class="el" href="../../d7/d15/mpd__notifier_8h_source.html">mpd_notifier.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
2021-06-22 00:16:40 +00:00
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>