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/da/dfd/classshaka_1_1media_1_1Medi...

311 lines
29 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::media::MediaHandler 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>media</b></li><li class="navelem"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">MediaHandler</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="../../dd/de9/classshaka_1_1media_1_1MediaHandler-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::MediaHandler 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="../../d3/d93/media__handler_8h_source.html">media_handler.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::media::MediaHandler:</div>
<div class="dyncontent">
<div class="center">
<img src="../../da/dfd/classshaka_1_1media_1_1MediaHandler.png" usemap="#shaka::media::MediaHandler_map" alt=""/>
<map id="shaka::media::MediaHandler_map" name="shaka::media::MediaHandler_map">
<area href="../../d7/d94/classshaka_1_1media_1_1CachingMediaHandler.html" alt="shaka::media::CachingMediaHandler" shape="rect" coords="248,56,486,80"/>
<area href="../../db/d5a/classshaka_1_1media_1_1CcStreamFilter.html" alt="shaka::media::CcStreamFilter" shape="rect" coords="248,112,486,136"/>
<area href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html" alt="shaka::media::ChunkingHandler" shape="rect" coords="248,168,486,192"/>
<area href="../../da/dab/classshaka_1_1media_1_1CueAlignmentHandler.html" alt="shaka::media::CueAlignmentHandler" shape="rect" coords="248,224,486,248"/>
<area href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html" alt="shaka::media::EncryptionHandler" shape="rect" coords="248,280,486,304"/>
<area href="../../d3/d1e/classshaka_1_1media_1_1FakeInputMediaHandler.html" alt="shaka::media::FakeInputMediaHandler" shape="rect" coords="248,336,486,360"/>
<area href="../../de/db2/classshaka_1_1media_1_1MockOutputMediaHandler.html" alt="shaka::media::MockOutputMediaHandler" shape="rect" coords="248,392,486,416"/>
<area href="../../df/d46/classshaka_1_1media_1_1Muxer.html" alt="shaka::media::Muxer" shape="rect" coords="248,448,486,472"/>
<area href="../../de/d85/classshaka_1_1media_1_1OriginHandler.html" alt="shaka::media::OriginHandler" shape="rect" coords="248,504,486,528"/>
<area href="../../d3/d1a/classshaka_1_1media_1_1Replicator.html" alt="shaka::media::Replicator" shape="rect" coords="248,560,486,584"/>
<area href="../../d5/d3e/classshaka_1_1media_1_1TextChunker.html" alt="shaka::media::TextChunker" shape="rect" coords="248,616,486,640"/>
<area href="../../d8/df8/classshaka_1_1media_1_1TextPadder.html" alt="shaka::media::TextPadder" shape="rect" coords="248,672,486,696"/>
<area href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html" alt="shaka::media::TrickPlayHandler" shape="rect" coords="248,728,486,752"/>
<area href="../../d0/df2/classshaka_1_1media_1_1ttml_1_1TtmlToMp4Handler.html" alt="shaka::media::ttml::TtmlToMp4Handler" shape="rect" coords="248,784,486,808"/>
<area href="../../d7/d53/classshaka_1_1media_1_1WebVttToMp4Handler.html" alt="shaka::media::WebVttToMp4Handler" shape="rect" coords="248,840,486,864"/>
</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:a0fac1fe2d593e78d47244acdfa21759d"><td class="memItemLeft" align="right" valign="top"><a id="a0fac1fe2d593e78d47244acdfa21759d"></a>
<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a0fac1fe2d593e78d47244acdfa21759d">SetHandler</a> (size_t output_stream_index, std::shared_ptr&lt; <a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">MediaHandler</a> &gt; handler)</td></tr>
<tr class="memdesc:a0fac1fe2d593e78d47244acdfa21759d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect downstream handler at the specified output stream index. <br /></td></tr>
<tr class="separator:a0fac1fe2d593e78d47244acdfa21759d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc48a2450ce50162de18071aef516b6c"><td class="memItemLeft" align="right" valign="top"><a id="afc48a2450ce50162de18071aef516b6c"></a>
<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#afc48a2450ce50162de18071aef516b6c">AddHandler</a> (std::shared_ptr&lt; <a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">MediaHandler</a> &gt; handler)</td></tr>
<tr class="memdesc:afc48a2450ce50162de18071aef516b6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect downstream handler to the next available output stream index. <br /></td></tr>
<tr class="separator:afc48a2450ce50162de18071aef516b6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed0da512bbd998ec9d0a5c019ad17acb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#aed0da512bbd998ec9d0a5c019ad17acb">Initialize</a> ()</td></tr>
<tr class="separator:aed0da512bbd998ec9d0a5c019ad17acb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e169e81344ce4ccfed3194ec5f4a3a1"><td class="memItemLeft" align="right" valign="top"><a id="a0e169e81344ce4ccfed3194ec5f4a3a1"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a0e169e81344ce4ccfed3194ec5f4a3a1">IsConnected</a> ()</td></tr>
<tr class="memdesc:a0e169e81344ce4ccfed3194ec5f4a3a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Validate if the handler is connected to its upstream handler. <br /></td></tr>
<tr class="separator:a0e169e81344ce4ccfed3194ec5f4a3a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a393473d421c1cb5f37a4fdd5702681ed"><td class="memItemLeft" align="right" valign="top"><a id="a393473d421c1cb5f37a4fdd5702681ed"></a>
static <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Chain</b> (const std::vector&lt; std::shared_ptr&lt; <a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">MediaHandler</a> &gt;&gt; &amp;list)</td></tr>
<tr class="separator:a393473d421c1cb5f37a4fdd5702681ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a0e05325d62bfb66318301c1ed790a46e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a0e05325d62bfb66318301c1ed790a46e">InitializeInternal</a> ()=0</td></tr>
<tr class="separator:a0e05325d62bfb66318301c1ed790a46e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb614e9f43e1eb6f837801b15b78c0b4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#acb614e9f43e1eb6f837801b15b78c0b4">Process</a> (std::unique_ptr&lt; <a class="el" href="../../d0/d4c/structshaka_1_1media_1_1StreamData.html">StreamData</a> &gt; stream_data)=0</td></tr>
<tr class="separator:acb614e9f43e1eb6f837801b15b78c0b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69a31b8ec1b85fd4790c7c2013c69a73"><td class="memItemLeft" align="right" valign="top"><a id="a69a31b8ec1b85fd4790c7c2013c69a73"></a>
virtual <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a69a31b8ec1b85fd4790c7c2013c69a73">OnFlushRequest</a> (size_t input_stream_index)</td></tr>
<tr class="memdesc:a69a31b8ec1b85fd4790c7c2013c69a73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event handler for flush request at the specific input stream index. <br /></td></tr>
<tr class="separator:a69a31b8ec1b85fd4790c7c2013c69a73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe33a7328099b7917b2b3ba1038997b0"><td class="memItemLeft" align="right" valign="top"><a id="abe33a7328099b7917b2b3ba1038997b0"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#abe33a7328099b7917b2b3ba1038997b0">ValidateOutputStreamIndex</a> (size_t stream_index) const</td></tr>
<tr class="memdesc:abe33a7328099b7917b2b3ba1038997b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Validate if the stream at the specified index actually exists. <br /></td></tr>
<tr class="separator:abe33a7328099b7917b2b3ba1038997b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe98a4fd19eabe0fc78afc91959c34a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#afe98a4fd19eabe0fc78afc91959c34a6">Dispatch</a> (std::unique_ptr&lt; <a class="el" href="../../d0/d4c/structshaka_1_1media_1_1StreamData.html">StreamData</a> &gt; stream_data) const</td></tr>
<tr class="separator:afe98a4fd19eabe0fc78afc91959c34a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad165375cd0a2074c5a740b42f847c499"><td class="memItemLeft" align="right" valign="top"><a id="ad165375cd0a2074c5a740b42f847c499"></a>
<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#ad165375cd0a2074c5a740b42f847c499">DispatchStreamInfo</a> (size_t stream_index, std::shared_ptr&lt; const <a class="el" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">StreamInfo</a> &gt; stream_info) const</td></tr>
<tr class="memdesc:ad165375cd0a2074c5a740b42f847c499"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch the stream info to downstream handlers. <br /></td></tr>
<tr class="separator:ad165375cd0a2074c5a740b42f847c499"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a74fead95bc16255e73908bbebbced9"><td class="memItemLeft" align="right" valign="top"><a id="a9a74fead95bc16255e73908bbebbced9"></a>
<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a9a74fead95bc16255e73908bbebbced9">DispatchMediaSample</a> (size_t stream_index, std::shared_ptr&lt; const <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> &gt; media_sample) const</td></tr>
<tr class="memdesc:a9a74fead95bc16255e73908bbebbced9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch the media sample to downstream handlers. <br /></td></tr>
<tr class="separator:a9a74fead95bc16255e73908bbebbced9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c44df529fead65c007ee27b84ebd32a"><td class="memItemLeft" align="right" valign="top"><a id="a9c44df529fead65c007ee27b84ebd32a"></a>
<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a9c44df529fead65c007ee27b84ebd32a">DispatchTextSample</a> (size_t stream_index, std::shared_ptr&lt; const <a class="el" href="../../db/d1f/classshaka_1_1media_1_1TextSample.html">TextSample</a> &gt; text_sample) const</td></tr>
<tr class="memdesc:a9c44df529fead65c007ee27b84ebd32a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch the text sample to downstream handlers. <br /></td></tr>
<tr class="separator:a9c44df529fead65c007ee27b84ebd32a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2acc1c84a61aee93229d493aa93308d5"><td class="memItemLeft" align="right" valign="top"><a id="a2acc1c84a61aee93229d493aa93308d5"></a>
<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a2acc1c84a61aee93229d493aa93308d5">DispatchSegmentInfo</a> (size_t stream_index, std::shared_ptr&lt; const <a class="el" href="../../d0/dc0/structshaka_1_1media_1_1SegmentInfo.html">SegmentInfo</a> &gt; segment_info) const</td></tr>
<tr class="memdesc:a2acc1c84a61aee93229d493aa93308d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch the segment info to downstream handlers. <br /></td></tr>
<tr class="separator:a2acc1c84a61aee93229d493aa93308d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaea265e5d6e765b75ad622c5588e09f8"><td class="memItemLeft" align="right" valign="top"><a id="aaea265e5d6e765b75ad622c5588e09f8"></a>
<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#aaea265e5d6e765b75ad622c5588e09f8">DispatchScte35Event</a> (size_t stream_index, std::shared_ptr&lt; const <a class="el" href="../../d1/d41/structshaka_1_1media_1_1Scte35Event.html">Scte35Event</a> &gt; scte35_event) const</td></tr>
<tr class="memdesc:aaea265e5d6e765b75ad622c5588e09f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch the scte35 event to downstream handlers. <br /></td></tr>
<tr class="separator:aaea265e5d6e765b75ad622c5588e09f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dcba8fa849d5f031ab3e2b4803a7804"><td class="memItemLeft" align="right" valign="top"><a id="a0dcba8fa849d5f031ab3e2b4803a7804"></a>
<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a0dcba8fa849d5f031ab3e2b4803a7804">DispatchCueEvent</a> (size_t stream_index, std::shared_ptr&lt; const <a class="el" href="../../da/d93/structshaka_1_1media_1_1CueEvent.html">CueEvent</a> &gt; cue_event) const</td></tr>
<tr class="memdesc:a0dcba8fa849d5f031ab3e2b4803a7804"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch the cue event to downstream handlers. <br /></td></tr>
<tr class="separator:a0dcba8fa849d5f031ab3e2b4803a7804"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5001bf12073101a949b062943769f5b"><td class="memItemLeft" align="right" valign="top"><a id="ad5001bf12073101a949b062943769f5b"></a>
<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#ad5001bf12073101a949b062943769f5b">FlushDownstream</a> (size_t output_stream_index)</td></tr>
<tr class="memdesc:ad5001bf12073101a949b062943769f5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush the downstream connected at the specified output stream index. <br /></td></tr>
<tr class="separator:ad5001bf12073101a949b062943769f5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab644ca7b0a0dbcbc42936f2dfb979ca5"><td class="memItemLeft" align="right" valign="top"><a id="ab644ca7b0a0dbcbc42936f2dfb979ca5"></a>
<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#ab644ca7b0a0dbcbc42936f2dfb979ca5">FlushAllDownstreams</a> ()</td></tr>
<tr class="memdesc:ab644ca7b0a0dbcbc42936f2dfb979ca5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush all connected downstream handlers. <br /></td></tr>
<tr class="separator:ab644ca7b0a0dbcbc42936f2dfb979ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb64985e305009df53bd60a5b4ff3122"><td class="memItemLeft" align="right" valign="top"><a id="aeb64985e305009df53bd60a5b4ff3122"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>initialized</b> ()</td></tr>
<tr class="separator:aeb64985e305009df53bd60a5b4ff3122"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9090654f2a7355517f4a80bc6ce868d"><td class="memItemLeft" align="right" valign="top"><a id="ad9090654f2a7355517f4a80bc6ce868d"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>num_input_streams</b> () const</td></tr>
<tr class="separator:ad9090654f2a7355517f4a80bc6ce868d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d80c96b3c6824532733c73672185ba9"><td class="memItemLeft" align="right" valign="top"><a id="a8d80c96b3c6824532733c73672185ba9"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>next_output_stream_index</b> () const</td></tr>
<tr class="separator:a8d80c96b3c6824532733c73672185ba9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a665eb29cf9704481a490c5a912083104"><td class="memItemLeft" align="right" valign="top"><a id="a665eb29cf9704481a490c5a912083104"></a>
const std::map&lt; size_t, std::pair&lt; std::shared_ptr&lt; <a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">MediaHandler</a> &gt;, size_t &gt; &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>output_handlers</b> ()</td></tr>
<tr class="separator:a665eb29cf9704481a490c5a912083104"><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><a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">MediaHandler</a> is the base media processing unit. Media handlers transform the input streams and propagate the outputs to downstream media handlers. There are three different types of media handlers: 1) Single input single output This is the most basic handler. It only supports one input and one output with both index as 0. 2) Multiple inputs multiple outputs The number of outputs must be equal to the number of inputs. The output stream at a specific index comes from the input stream at the same index. Different streams usually share a common resource, although they may be independent. One example of this is encryption handler. 3) Single input multiple outputs The input stream is split into multiple output streams. One example of this is the replicator media handler. Other types of media handlers are disallowed and not supported. </p>
<p class="definition">Definition at line <a class="el" href="../../d3/d93/media__handler_8h_source.html#l00154">154</a> of file <a class="el" href="../../d3/d93/media__handler_8h_source.html">media_handler.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="afe98a4fd19eabe0fc78afc91959c34a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe98a4fd19eabe0fc78afc91959c34a6">&#9670;&nbsp;</a></span>Dispatch()</h2>
<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="../../d2/d20/classshaka_1_1Status.html">Status</a> shaka::media::MediaHandler::Dispatch </td>
<td>(</td>
<td class="paramtype">std::unique_ptr&lt; <a class="el" href="../../d0/d4c/structshaka_1_1media_1_1StreamData.html">StreamData</a> &gt;&#160;</td>
<td class="paramname"><em>stream_data</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Dispatch the stream data to downstream handlers. Note that stream_data.stream_index should be the output stream index. </p>
<p class="definition">Definition at line <a class="el" href="../../d2/de9/media__handler_8cc_source.html#l00094">94</a> of file <a class="el" href="../../d2/de9/media__handler_8cc_source.html">media_handler.cc</a>.</p>
</div>
</div>
<a id="aed0da512bbd998ec9d0a5c019ad17acb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed0da512bbd998ec9d0a5c019ad17acb">&#9670;&nbsp;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> shaka::media::MediaHandler::Initialize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the handler and downstream handlers. Note that it should be called after setting up the graph before running the graph. </p>
<p class="definition">Definition at line <a class="el" href="../../d2/de9/media__handler_8cc_source.html#l00046">46</a> of file <a class="el" href="../../d2/de9/media__handler_8cc_source.html">media_handler.cc</a>.</p>
</div>
</div>
<a id="a0e05325d62bfb66318301c1ed790a46e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e05325d62bfb66318301c1ed790a46e">&#9670;&nbsp;</a></span>InitializeInternal()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> shaka::media::MediaHandler::InitializeInternal </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Internal implementation of initialize. Note that it should only initialize the <a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">MediaHandler</a> itself. Downstream handlers are handled in <a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#aed0da512bbd998ec9d0a5c019ad17acb">Initialize()</a>. </p>
<p>Implemented in <a class="el" href="../../dd/d17/classshaka_1_1media_1_1Demuxer.html#a7488d8ea312be5822c67f5b69a8dbd9f">shaka::media::Demuxer</a>, <a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html#a36882e12df5c5bfd48a7b94d1dfad857">shaka::media::Muxer</a>, <a class="el" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html#a76a5f4b74da3876cc72f44301c389ebd">shaka::media::ChunkingHandler</a>, <a class="el" href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html#a3f1808a4386081e5e1c9a798a1a69dd0">shaka::media::EncryptionHandler</a>, and <a class="el" href="../../db/d5a/classshaka_1_1media_1_1CcStreamFilter.html#aea60c40b6d500f62d012140396ecc34a">shaka::media::CcStreamFilter</a>.</p>
</div>
</div>
<a id="acb614e9f43e1eb6f837801b15b78c0b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb614e9f43e1eb6f837801b15b78c0b4">&#9670;&nbsp;</a></span>Process()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> shaka::media::MediaHandler::Process </td>
<td>(</td>
<td class="paramtype">std::unique_ptr&lt; <a class="el" href="../../d0/d4c/structshaka_1_1media_1_1StreamData.html">StreamData</a> &gt;&#160;</td>
<td class="paramname"><em>stream_data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Process the incoming stream data. Note that (1) stream_data.stream_index should be the input stream index; (2) The implementation needs to call DispatchXxx to dispatch the processed stream data to the downstream handlers after finishing processing if needed. </p>
<p>Implemented in <a class="el" href="../../dd/d17/classshaka_1_1media_1_1Demuxer.html#a869b21d13f02d4d5c0519f9eb35117cd">shaka::media::Demuxer</a>, <a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html#aec730b070245231a0887787005c06eee">shaka::media::Muxer</a>, <a class="el" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html#a44c30ffd7c283be2ba4347bda7848633">shaka::media::ChunkingHandler</a>, <a class="el" href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html#a7887e6060eb572036674ecb9a7e045c4">shaka::media::EncryptionHandler</a>, and <a class="el" href="../../db/d5a/classshaka_1_1media_1_1CcStreamFilter.html#a10dcba65d3832002231d1ec368eab002">shaka::media::CcStreamFilter</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>packager/media/base/<a class="el" href="../../d3/d93/media__handler_8h_source.html">media_handler.h</a></li>
<li>packager/media/base/<a class="el" href="../../d2/de9/media__handler_8cc_source.html">media_handler.cc</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