shaka-packager/docs/d3/d93/media__handler_8h_source.html

93 lines
45 KiB
HTML
Raw Normal View History

<!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"/>
2018-02-10 23:37:42 +00:00
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/media/base/media_handler.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 -->
2018-02-10 23:37:42 +00:00
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</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">
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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)">
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_f99dae54fe7170f791f339b952d5067a.html">media</a></li><li class="navelem"><a class="el" href="../../dir_e3bda0bde998a4d5063328245b9909be.html">base</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">media_handler.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 2017 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_MEDIA_BASE_MEDIA_HANDLER_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_MEDIA_BASE_MEDIA_HANDLER_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;map&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;packager/media/base/media_sample.h&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;packager/media/base/stream_info.h&quot;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;packager/media/base/text_sample.h&quot;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;packager/status.h&quot;</span></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="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">namespace </span>media {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">enum class</span> StreamDataType {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; kUnknown,</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; kStreamInfo,</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; kMediaSample,</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; kTextSample,</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; kSegmentInfo,</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; kScte35Event,</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; kCueEvent,</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;};</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;std::string StreamDataTypeToString(StreamDataType type);</div>
<div class="ttc" id="structshaka_1_1media_1_1SegmentInfo_html"><div class="ttname"><a href="../../d0/dc0/structshaka_1_1media_1_1SegmentInfo.html">shaka::media::SegmentInfo</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00055">media_handler.h:55</a></div></div>
<div class="ttc" id="structshaka_1_1media_1_1StreamData_html"><div class="ttname"><a href="../../d0/d4c/structshaka_1_1media_1_1StreamData.html">shaka::media::StreamData</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00067">media_handler.h:67</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MediaHandler_html"><div class="ttname"><a href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">shaka::media::MediaHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00150">media_handler.h:150</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MediaHandler_html_a0e169e81344ce4ccfed3194ec5f4a3a1"><div class="ttname"><a href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a0e169e81344ce4ccfed3194ec5f4a3a1">shaka::media::MediaHandler::IsConnected</a></div><div class="ttdeci">bool IsConnected()</div><div class="ttdoc">Validate if the handler is connected to its upstream handler. </div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00169">media_handler.h:169</a></div></div>
2018-02-10 23:37:42 +00:00
<div class="ttc" id="namespaceshaka_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="structshaka_1_1media_1_1CueEvent_html"><div class="ttname"><a href="../../da/d93/structshaka_1_1media_1_1CueEvent.html">shaka::media::CueEvent</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00049">media_handler.h:49</a></div></div>
<div class="ttc" id="classshaka_1_1Status_html"><div class="ttname"><a href="../../d2/d20/classshaka_1_1Status.html">shaka::Status</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d13/status_8h_source.html#l00110">status.h:110</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MediaHandler_html_a9c44df529fead65c007ee27b84ebd32a"><div class="ttname"><a href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a9c44df529fead65c007ee27b84ebd32a">shaka::media::MediaHandler::DispatchTextSample</a></div><div class="ttdeci">Status DispatchTextSample(size_t stream_index, std::shared_ptr&lt; const TextSample &gt; text_sample) const</div><div class="ttdoc">Dispatch the text sample to downstream handlers. </div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00210">media_handler.h:210</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MediaHandler_html_afc48a2450ce50162de18071aef516b6c"><div class="ttname"><a href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#afc48a2450ce50162de18071aef516b6c">shaka::media::MediaHandler::AddHandler</a></div><div class="ttdeci">Status AddHandler(std::shared_ptr&lt; MediaHandler &gt; handler)</div><div class="ttdoc">Connect downstream handler to the next available output stream index. </div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00160">media_handler.h:160</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MediaHandler_html_a2acc1c84a61aee93229d493aa93308d5"><div class="ttname"><a href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a2acc1c84a61aee93229d493aa93308d5">shaka::media::MediaHandler::DispatchSegmentInfo</a></div><div class="ttdeci">Status DispatchSegmentInfo(size_t stream_index, std::shared_ptr&lt; const SegmentInfo &gt; segment_info) const</div><div class="ttdoc">Dispatch the segment info to downstream handlers. </div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00218">media_handler.h:218</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MediaHandler_html_a0dcba8fa849d5f031ab3e2b4803a7804"><div class="ttname"><a href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a0dcba8fa849d5f031ab3e2b4803a7804">shaka::media::MediaHandler::DispatchCueEvent</a></div><div class="ttdeci">Status DispatchCueEvent(size_t stream_index, std::shared_ptr&lt; const CueEvent &gt; cue_event) const</div><div class="ttdoc">Dispatch the cue event to downstream handlers. </div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00234">media_handler.h:234</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MediaHandler_html_aaea265e5d6e765b75ad622c5588e09f8"><div class="ttname"><a href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#aaea265e5d6e765b75ad622c5588e09f8">shaka::media::MediaHandler::DispatchScte35Event</a></div><div class="ttdeci">Status DispatchScte35Event(size_t stream_index, std::shared_ptr&lt; const Scte35Event &gt; scte35_event) const</div><div class="ttdoc">Dispatch the scte35 event to downstream handlers. </div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00226">media_handler.h:226</a></div></div>
<div class="ttc" id="structshaka_1_1media_1_1Scte35Event_html"><div class="ttname"><a href="../../d1/d41/structshaka_1_1media_1_1Scte35Event.html">shaka::media::Scte35Event</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00036">media_handler.h:36</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MediaHandler_html_a9a74fead95bc16255e73908bbebbced9"><div class="ttname"><a href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a9a74fead95bc16255e73908bbebbced9">shaka::media::MediaHandler::DispatchMediaSample</a></div><div class="ttdeci">Status DispatchMediaSample(size_t stream_index, std::shared_ptr&lt; const MediaSample &gt; media_sample) const</div><div class="ttdoc">Dispatch the media sample to downstream handlers. </div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00201">media_handler.h:201</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jun 7 2018 16:03:49 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
2018-02-10 23:37:42 +00:00
</a> 1.8.13
</small></address>
</body>
</html>