shaka-packager/docs/d9/deb/classshaka_1_1hls_1_1HlsNot...

420 lines
21 KiB
HTML

<!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>Shaka Packager SDK: shaka::hls::HlsNotifier 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">Shaka Packager 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)">
<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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></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"><b>hls</b></li><li class="navelem"><a class="el" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html">HlsNotifier</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../dc/d40/classshaka_1_1hls_1_1HlsNotifier-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::hls::HlsNotifier Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for shaka::hls::HlsNotifier:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.png" usemap="#shaka::hls::HlsNotifier_map" alt=""/>
<map id="shaka::hls::HlsNotifier_map" name="shaka::hls::HlsNotifier_map">
<area href="../../d7/d5c/classshaka_1_1hls_1_1SimpleHlsNotifier.html" title="This is thread safe. " alt="shaka::hls::SimpleHlsNotifier" shape="rect" coords="0,56,169,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:ae0ae240f27a464667e4627dad48e1bf6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0ae240f27a464667e4627dad48e1bf6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>HlsNotifier</b> (<a class="el" href="../../d8/daf/namespaceshaka.html#ab63a3c00cdbf61cfb6dd7a2497b26f8d">HlsPlaylistType</a> <a class="el" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#ab758817024e2d9ba012e93d02d115d94">playlist_type</a>)</td></tr>
<tr class="separator:ae0ae240f27a464667e4627dad48e1bf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bd9273a1893899036e640c1e35fbaff"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a8bd9273a1893899036e640c1e35fbaff">Init</a> ()=0</td></tr>
<tr class="separator:a8bd9273a1893899036e640c1e35fbaff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b85f6e4c2798f2634cd535011c230a2"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a2b85f6e4c2798f2634cd535011c230a2">NotifyNewStream</a> (const MediaInfo &amp;media_info, const std::string &amp;playlist_name, const std::string &amp;stream_name, const std::string &amp;group_id, uint32_t *stream_id)=0</td></tr>
<tr class="separator:a2b85f6e4c2798f2634cd535011c230a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5a0d6670313d81eff20bb959732a2cd"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#af5a0d6670313d81eff20bb959732a2cd">NotifyNewSegment</a> (uint32_t stream_id, const std::string &amp;segment_name, uint64_t start_time, uint64_t duration, uint64_t start_byte_offset, uint64_t size)=0</td></tr>
<tr class="separator:af5a0d6670313d81eff20bb959732a2cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a310fadabce7f3ac4a3313631340b880f"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a310fadabce7f3ac4a3313631340b880f">NotifyEncryptionUpdate</a> (uint32_t stream_id, const std::vector&lt; uint8_t &gt; &amp;key_id, const std::vector&lt; uint8_t &gt; &amp;system_id, const std::vector&lt; uint8_t &gt; &amp;iv, const std::vector&lt; uint8_t &gt; &amp;protection_system_specific_data)=0</td></tr>
<tr class="separator:a310fadabce7f3ac4a3313631340b880f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d788d47d01aee4f75c7b55251d69edf"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a5d788d47d01aee4f75c7b55251d69edf">Flush</a> ()=0</td></tr>
<tr class="separator:a5d788d47d01aee4f75c7b55251d69edf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab758817024e2d9ba012e93d02d115d94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/daf/namespaceshaka.html#ab63a3c00cdbf61cfb6dd7a2497b26f8d">HlsPlaylistType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#ab758817024e2d9ba012e93d02d115d94">playlist_type</a> () const </td></tr>
<tr class="separator:ab758817024e2d9ba012e93d02d115d94"><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>Definition at line <a class="el" href="../../d1/d1e/hls__notifier_8h_source.html#l00020">20</a> of file <a class="el" href="../../d1/d1e/hls__notifier_8h_source.html">hls_notifier.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5d788d47d01aee4f75c7b55251d69edf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool shaka::hls::HlsNotifier::Flush </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">
<p>Process any current buffered states/resources. </p>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
<p>Implemented in <a class="el" href="../../d7/d5c/classshaka_1_1hls_1_1SimpleHlsNotifier.html#a153fe931c8e6fe3e585ebd925d75d229">shaka::hls::SimpleHlsNotifier</a>.</p>
</div>
</div>
<a class="anchor" id="a8bd9273a1893899036e640c1e35fbaff"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool shaka::hls::HlsNotifier::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">
<p>Intialize the notifier. </p>
<dl class="section return"><dt>Returns</dt><dd>true on sucess, false otherwise. </dd></dl>
<p>Implemented in <a class="el" href="../../d7/d5c/classshaka_1_1hls_1_1SimpleHlsNotifier.html#a40850c462766a0ce4e9c92014ed77a91">shaka::hls::SimpleHlsNotifier</a>.</p>
</div>
</div>
<a class="anchor" id="a310fadabce7f3ac4a3313631340b880f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool shaka::hls::HlsNotifier::NotifyEncryptionUpdate </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>stream_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>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>system_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>iv</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>protection_system_specific_data</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">stream_id</td><td>is the value set by <a class="el" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a2b85f6e4c2798f2634cd535011c230a2">NotifyNewStream()</a>. </td></tr>
<tr><td class="paramname">key_id</td><td>is the key ID for the stream. </td></tr>
<tr><td class="paramname">system_id</td><td>is the DRM system ID in e.g. PSSH boxes. For example this can be used to determine the KEYFORMAT attribute for EXT-X-KEY. </td></tr>
<tr><td class="paramname">iv</td><td>is the new initialization vector. </td></tr>
<tr><td class="paramname">protection_system_specific_data</td><td>is the DRM specific data. The interpretation of this data is up to the implementation, possibly using <em>system_id</em> to determine how to interpret the data. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="../../d7/d5c/classshaka_1_1hls_1_1SimpleHlsNotifier.html#ac2df072e5fbfcbf172319222a180e73d">shaka::hls::SimpleHlsNotifier</a>.</p>
</div>
</div>
<a class="anchor" id="af5a0d6670313d81eff20bb959732a2cd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool shaka::hls::HlsNotifier::NotifyNewSegment </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>stream_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>segment_name</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>start_byte_offset</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">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream_id</td><td>is the value set by <a class="el" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a2b85f6e4c2798f2634cd535011c230a2">NotifyNewStream()</a>. </td></tr>
<tr><td class="paramname">segment_name</td><td>is the name of the new segment. </td></tr>
<tr><td class="paramname">start_time</td><td>is the start time of the segment in timescale units passed in <em>media_info</em>. </td></tr>
<tr><td class="paramname">duration</td><td>is also in terms of timescale. </td></tr>
<tr><td class="paramname">start_byte_offset</td><td>is the offset of where the subsegment starts. This should be 0 if the whole segment is a subsegment. </td></tr>
<tr><td class="paramname">size</td><td>is the size in bytes. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="../../d7/d5c/classshaka_1_1hls_1_1SimpleHlsNotifier.html#afab88a610a6d2ac8b21dd86a456c2c06">shaka::hls::SimpleHlsNotifier</a>.</p>
</div>
</div>
<a class="anchor" id="a2b85f6e4c2798f2634cd535011c230a2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool shaka::hls::HlsNotifier::NotifyNewStream </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">const std::string &amp;&#160;</td>
<td class="paramname"><em>playlist_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>stream_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>group_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>stream_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">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">media_info</td><td>specifies the stream. </td></tr>
<tr><td class="paramname">playlist_name</td><td>is the name of the playlist that this stream should go. </td></tr>
<tr><td class="paramname">stream_name</td><td>is the name of this stream. </td></tr>
<tr><td class="paramname">group_id</td><td>is the group ID for this stream. </td></tr>
<tr><td class="paramname">stream_id</td><td>is set to a value so that it can be used to call the other methods. If this returns false, the stream_id may be set to an invalid value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on sucess, false otherwise. </dd></dl>
<p>Implemented in <a class="el" href="../../d7/d5c/classshaka_1_1hls_1_1SimpleHlsNotifier.html#a44409a32566bb416e572946fc2f511c9">shaka::hls::SimpleHlsNotifier</a>.</p>
</div>
</div>
<a class="anchor" id="ab758817024e2d9ba012e93d02d115d94"></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="../../d8/daf/namespaceshaka.html#ab63a3c00cdbf61cfb6dd7a2497b26f8d">HlsPlaylistType</a> shaka::hls::HlsNotifier::playlist_type </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 playlist type. </dd></dl>
<p>Definition at line <a class="el" href="../../d1/d1e/hls__notifier_8h_source.html#l00080">80</a> of file <a class="el" href="../../d1/d1e/hls__notifier_8h_source.html">hls_notifier.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>packager/hls/base/<a class="el" href="../../d1/d1e/hls__notifier_8h_source.html">hls_notifier.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2017 20:22:07 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.6
</small></address>
</body>
</html>