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/d9/deb/classshaka_1_1hls_1_1HlsNot...

566 lines
27 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::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/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"><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:aeff7cc5e10b69f1338df5135cd446ee9"><td class="memItemLeft" align="right" valign="top"><a id="aeff7cc5e10b69f1338df5135cd446ee9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>HlsNotifier</b> (const <a class="el" href="../../d0/da8/structshaka_1_1HlsParams.html">HlsParams</a> &amp;<a class="el" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a56af7fda2e9c5e1d376ba8a73ecb188c">hls_params</a>)</td></tr>
<tr class="separator:aeff7cc5e10b69f1338df5135cd446ee9"><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:a63a11df343b1f75a5d89327a23d5249c"><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#a63a11df343b1f75a5d89327a23d5249c">NotifySampleDuration</a> (uint32_t stream_id, uint32_t sample_duration)=0</td></tr>
<tr class="separator:a63a11df343b1f75a5d89327a23d5249c"><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:ad97b17a04765577090ef9b6124928af2"><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#ad97b17a04765577090ef9b6124928af2">NotifyKeyFrame</a> (uint32_t stream_id, uint64_t timestamp, uint64_t start_byte_offset, uint64_t size)=0</td></tr>
<tr class="separator:ad97b17a04765577090ef9b6124928af2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a064753b88baf3e2db4cbb316b07fd236"><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#a064753b88baf3e2db4cbb316b07fd236">NotifyCueEvent</a> (uint32_t stream_id, uint64_t timestamp)=0</td></tr>
<tr class="separator:a064753b88baf3e2db4cbb316b07fd236"><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:a56af7fda2e9c5e1d376ba8a73ecb188c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../d0/da8/structshaka_1_1HlsParams.html">HlsParams</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a56af7fda2e9c5e1d376ba8a73ecb188c">hls_params</a> () const</td></tr>
<tr class="separator:a56af7fda2e9c5e1d376ba8a73ecb188c"><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 class="definition">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 id="a5d788d47d01aee4f75c7b55251d69edf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d788d47d01aee4f75c7b55251d69edf">&#9670;&nbsp;</a></span>Flush()</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::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 id="a56af7fda2e9c5e1d376ba8a73ecb188c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56af7fda2e9c5e1d376ba8a73ecb188c">&#9670;&nbsp;</a></span>hls_params()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="../../d0/da8/structshaka_1_1HlsParams.html">HlsParams</a>&amp; shaka::hls::HlsNotifier::hls_params </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 HLS parameters. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d1/d1e/hls__notifier_8h_source.html#l00104">104</a> of file <a class="el" href="../../d1/d1e/hls__notifier_8h_source.html">hls_notifier.h</a>.</p>
</div>
</div>
<a id="a8bd9273a1893899036e640c1e35fbaff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bd9273a1893899036e640c1e35fbaff">&#9670;&nbsp;</a></span>Init()</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::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 id="a064753b88baf3e2db4cbb316b07fd236"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a064753b88baf3e2db4cbb316b07fd236">&#9670;&nbsp;</a></span>NotifyCueEvent()</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::hls::HlsNotifier::NotifyCueEvent </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">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">
<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">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>
<p>Implemented in <a class="el" href="../../d7/d5c/classshaka_1_1hls_1_1SimpleHlsNotifier.html#a1e7faa024bed78aa7bc8e3a2a36b3ad7">shaka::hls::SimpleHlsNotifier</a>.</p>
</div>
</div>
<a id="a310fadabce7f3ac4a3313631340b880f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a310fadabce7f3ac4a3313631340b880f">&#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::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 id="ad97b17a04765577090ef9b6124928af2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad97b17a04765577090ef9b6124928af2">&#9670;&nbsp;</a></span>NotifyKeyFrame()</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::hls::HlsNotifier::NotifyKeyFrame </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">uint64_t&#160;</td>
<td class="paramname"><em>timestamp</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">
<p>Called on every key frame. For Video only. </p><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">timestamp</td><td>is the timesamp of the key frame in timescale units passed in <em>media_info</em>. </td></tr>
<tr><td class="paramname">start_byte_offset</td><td>is the offset of where the keyframe starts. </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#a3eed6f6e65b079b3ece7d3c503b33fbf">shaka::hls::SimpleHlsNotifier</a>.</p>
</div>
</div>
<a id="af5a0d6670313d81eff20bb959732a2cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5a0d6670313d81eff20bb959732a2cd">&#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::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 id="a2b85f6e4c2798f2634cd535011c230a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b85f6e4c2798f2634cd535011c230a2">&#9670;&nbsp;</a></span>NotifyNewStream()</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::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 id="a63a11df343b1f75a5d89327a23d5249c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63a11df343b1f75a5d89327a23d5249c">&#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::hls::HlsNotifier::NotifySampleDuration </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">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">
<p>Change the sample duration of stream with <em>stream_id</em>. </p><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">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 stream specified by <em>stream_id</em> does not exist. </dd></dl>
<p>Implemented in <a class="el" href="../../d7/d5c/classshaka_1_1hls_1_1SimpleHlsNotifier.html#aa7af83ad4387d28f5aa391a8a558d104">shaka::hls::SimpleHlsNotifier</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 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