shaka-packager/docs/d1/d1e/hls__notifier_8h_source.html

161 lines
19 KiB
HTML
Raw 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: packager/hls/base/hls_notifier.h Source File</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="../../dir_3f8eec2fc361645de4b1ec14c19fffc7.html">packager</a></li><li class="navelem"><a class="el" href="../../dir_b7f276137d53b05d7f6b34219adc0a31.html">hls</a></li><li class="navelem"><a class="el" href="../../dir_65bafb41b3669ba481c8da543a696a08.html">base</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">hls_notifier.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2016 Google Inc. All rights reserved.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Use of this source code is governed by a BSD-style</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// license that can be found in the LICENSE file or at</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// https://developers.google.com/open-source/licenses/bsd</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#ifndef PACKAGER_HLS_BASE_HLS_NOTIFIER_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_HLS_BASE_HLS_NOTIFIER_H_</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;packager/hls/public/hls_params.h&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;packager/mpd/base/media_info.pb.h&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">namespace </span>hls {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">// TODO(rkuroiwa): Consider merging this with MpdNotifier.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html"> 20</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html">HlsNotifier</a> {</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">explicit</span> <a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html">HlsNotifier</a>(<span class="keyword">const</span> <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html">HlsParams</a>&amp; <a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a56af7fda2e9c5e1d376ba8a73ecb188c">hls_params</a>) : hls_params_(<a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a56af7fda2e9c5e1d376ba8a73ecb188c">hls_params</a>) {}</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html">HlsNotifier</a>() {}</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
2021-06-22 00:16:40 +00:00
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a8bd9273a1893899036e640c1e35fbaff">Init</a>() = 0;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
2021-06-22 00:16:40 +00:00
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a2b85f6e4c2798f2634cd535011c230a2">NotifyNewStream</a>(<span class="keyword">const</span> MediaInfo&amp; media_info,</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">const</span> std::string&amp; playlist_name,</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">const</span> std::string&amp; stream_name,</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">const</span> std::string&amp; group_id,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; uint32_t* stream_id) = 0;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
2021-06-22 00:16:40 +00:00
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a63a11df343b1f75a5d89327a23d5249c">NotifySampleDuration</a>(uint32_t stream_id,</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; uint32_t sample_duration) = 0;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
2021-06-22 00:16:40 +00:00
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#af5a0d6670313d81eff20bb959732a2cd">NotifyNewSegment</a>(uint32_t stream_id,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">const</span> std::string&amp; segment_name,</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; uint64_t start_time,</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; uint64_t duration,</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; uint64_t start_byte_offset,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; uint64_t size) = 0;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
2021-06-22 00:16:40 +00:00
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#ad97b17a04765577090ef9b6124928af2">NotifyKeyFrame</a>(uint32_t stream_id,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; uint64_t timestamp,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; uint64_t start_byte_offset,</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; uint64_t size) = 0;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
2021-06-22 00:16:40 +00:00
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a064753b88baf3e2db4cbb316b07fd236">NotifyCueEvent</a>(uint32_t stream_id, uint64_t timestamp) = 0;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
2021-06-22 00:16:40 +00:00
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a310fadabce7f3ac4a3313631340b880f">NotifyEncryptionUpdate</a>(</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; uint32_t stream_id,</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keyword">const</span> std::vector&lt;uint8_t&gt;&amp; key_id,</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keyword">const</span> std::vector&lt;uint8_t&gt;&amp; system_id,</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">const</span> std::vector&lt;uint8_t&gt;&amp; iv,</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">const</span> std::vector&lt;uint8_t&gt;&amp; protection_system_specific_data) = 0;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
2021-06-22 00:16:40 +00:00
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a5d788d47d01aee4f75c7b55251d69edf">Flush</a>() = 0;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a56af7fda2e9c5e1d376ba8a73ecb188c"> 104</a></span>&#160; <span class="keyword">const</span> <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html">HlsParams</a>&amp; <a class="code" href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a56af7fda2e9c5e1d376ba8a73ecb188c">hls_params</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> hls_params_; }</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">const</span> <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html">HlsParams</a> hls_params_;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;};</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;} <span class="comment">// namespace hls</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
2021-06-22 00:16:40 +00:00
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="preprocessor">#endif // PACKAGER_HLS_BASE_HLS_NOTIFIER_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassshaka_1_1hls_1_1HlsNotifier_html_a5d788d47d01aee4f75c7b55251d69edf"><div class="ttname"><a href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a5d788d47d01aee4f75c7b55251d69edf">shaka::hls::HlsNotifier::Flush</a></div><div class="ttdeci">virtual bool Flush()=0</div></div>
<div class="ttc" id="aclassshaka_1_1hls_1_1HlsNotifier_html_a56af7fda2e9c5e1d376ba8a73ecb188c"><div class="ttname"><a href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a56af7fda2e9c5e1d376ba8a73ecb188c">shaka::hls::HlsNotifier::hls_params</a></div><div class="ttdeci">const HlsParams &amp; hls_params() const</div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d1e/hls__notifier_8h_source.html#l00104">hls_notifier.h:104</a></div></div>
<div class="ttc" id="astructshaka_1_1HlsParams_html"><div class="ttname"><a href="../../d0/da8/structshaka_1_1HlsParams.html">shaka::HlsParams</a></div><div class="ttdoc">HLS related parameters.</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d47/hls__params_8h_source.html#l00023">hls_params.h:23</a></div></div>
<div class="ttc" id="anamespaceshaka_html"><div class="ttname"><a href="../../d8/daf/namespaceshaka.html">shaka</a></div><div class="ttdoc">All the methods that are virtual are virtual for mocking.</div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d15/gflags__hex__bytes_8cc_source.html#l00011">gflags_hex_bytes.cc:11</a></div></div>
<div class="ttc" id="aclassshaka_1_1hls_1_1HlsNotifier_html_ad97b17a04765577090ef9b6124928af2"><div class="ttname"><a href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#ad97b17a04765577090ef9b6124928af2">shaka::hls::HlsNotifier::NotifyKeyFrame</a></div><div class="ttdeci">virtual bool NotifyKeyFrame(uint32_t stream_id, uint64_t timestamp, uint64_t start_byte_offset, uint64_t size)=0</div></div>
<div class="ttc" id="aclassshaka_1_1hls_1_1HlsNotifier_html_af5a0d6670313d81eff20bb959732a2cd"><div class="ttname"><a href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#af5a0d6670313d81eff20bb959732a2cd">shaka::hls::HlsNotifier::NotifyNewSegment</a></div><div class="ttdeci">virtual bool NotifyNewSegment(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</div></div>
<div class="ttc" id="aclassshaka_1_1hls_1_1HlsNotifier_html"><div class="ttname"><a href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html">shaka::hls::HlsNotifier</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d1e/hls__notifier_8h_source.html#l00020">hls_notifier.h:20</a></div></div>
2021-06-22 00:16:40 +00:00
<div class="ttc" id="aclassshaka_1_1hls_1_1HlsNotifier_html_a8bd9273a1893899036e640c1e35fbaff"><div class="ttname"><a href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a8bd9273a1893899036e640c1e35fbaff">shaka::hls::HlsNotifier::Init</a></div><div class="ttdeci">virtual bool Init()=0</div></div>
<div class="ttc" id="aclassshaka_1_1hls_1_1HlsNotifier_html_a064753b88baf3e2db4cbb316b07fd236"><div class="ttname"><a href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a064753b88baf3e2db4cbb316b07fd236">shaka::hls::HlsNotifier::NotifyCueEvent</a></div><div class="ttdeci">virtual bool NotifyCueEvent(uint32_t stream_id, uint64_t timestamp)=0</div></div>
<div class="ttc" id="aclassshaka_1_1hls_1_1HlsNotifier_html_a310fadabce7f3ac4a3313631340b880f"><div class="ttname"><a href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a310fadabce7f3ac4a3313631340b880f">shaka::hls::HlsNotifier::NotifyEncryptionUpdate</a></div><div class="ttdeci">virtual bool NotifyEncryptionUpdate(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</div></div>
2021-06-22 00:16:40 +00:00
<div class="ttc" id="aclassshaka_1_1hls_1_1HlsNotifier_html_a2b85f6e4c2798f2634cd535011c230a2"><div class="ttname"><a href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a2b85f6e4c2798f2634cd535011c230a2">shaka::hls::HlsNotifier::NotifyNewStream</a></div><div class="ttdeci">virtual bool NotifyNewStream(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</div></div>
<div class="ttc" id="aclassshaka_1_1hls_1_1HlsNotifier_html_a63a11df343b1f75a5d89327a23d5249c"><div class="ttname"><a href="../../d9/deb/classshaka_1_1hls_1_1HlsNotifier.html#a63a11df343b1f75a5d89327a23d5249c">shaka::hls::HlsNotifier::NotifySampleDuration</a></div><div class="ttdeci">virtual bool NotifySampleDuration(uint32_t stream_id, uint32_t sample_duration)=0</div></div>
<!-- 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:03 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>