shaka-packager/docs/df/d46/classshaka_1_1media_1_1Muxe...

381 lines
35 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: shaka::media::Muxer 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"/>
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="../../d8/daf/namespaceshaka.html">shaka</a></li><li class="navelem"><b>media</b></li><li class="navelem"><a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="../../de/ddd/classshaka_1_1media_1_1Muxer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::Muxer 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="../../db/df6/muxer_8h_source.html">muxer.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::media::Muxer:</div>
<div class="dyncontent">
<div class="center">
<img src="../../df/d46/classshaka_1_1media_1_1Muxer.png" usemap="#shaka::media::Muxer_map" alt=""/>
<map id="shaka::media::Muxer_map" name="shaka::media::Muxer_map">
2018-05-23 23:12:00 +00:00
<area href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html" alt="shaka::media::MediaHandler" shape="rect" coords="315,0,515,24"/>
<area href="../../d3/d71/classshaka_1_1media_1_1mp2t_1_1TsMuxer.html" alt="shaka::media::mp2t::TsMuxer" shape="rect" coords="0,112,200,136"/>
<area href="../../db/d30/classshaka_1_1media_1_1mp4_1_1MP4Muxer.html" alt="shaka::media::mp4::MP4Muxer" shape="rect" coords="210,112,410,136"/>
2018-05-23 23:12:00 +00:00
<area href="../../d6/d48/classshaka_1_1media_1_1PackedAudioWriter.html" alt="shaka::media::PackedAudioWriter" shape="rect" coords="420,112,620,136"/>
<area href="../../d3/d73/classshaka_1_1media_1_1webm_1_1WebMMuxer.html" title="Implements WebM Muxer. " alt="shaka::media::webm::WebMMuxer" shape="rect" coords="630,112,830,136"/>
</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>
2018-02-10 23:37:42 +00:00
<tr class="memitem:ac2f53c94d6ecb25d28bd2865dfe03649"><td class="memItemLeft" align="right" valign="top"><a id="ac2f53c94d6ecb25d28bd2865dfe03649"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Muxer</b> (const <a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html">MuxerOptions</a> &amp;options)</td></tr>
<tr class="separator:ac2f53c94d6ecb25d28bd2865dfe03649"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9204fe352d13cea8a367ae9c14e9639e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html#a9204fe352d13cea8a367ae9c14e9639e">Cancel</a> ()</td></tr>
<tr class="separator:a9204fe352d13cea8a367ae9c14e9639e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e76dd0a5c07dd538221459365ae824a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html#a0e76dd0a5c07dd538221459365ae824a">SetMuxerListener</a> (std::unique_ptr&lt; <a class="el" href="../../dd/d7a/classshaka_1_1media_1_1MuxerListener.html">MuxerListener</a> &gt; muxer_listener)</td></tr>
<tr class="separator:a0e76dd0a5c07dd538221459365ae824a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25a146d553c385aad70dbff6b3e87eec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html#a25a146d553c385aad70dbff6b3e87eec">SetProgressListener</a> (std::unique_ptr&lt; <a class="el" href="../../d4/de6/classshaka_1_1media_1_1ProgressListener.html">ProgressListener</a> &gt; progress_listener)</td></tr>
<tr class="separator:a25a146d553c385aad70dbff6b3e87eec"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a72306914df3fe74ce307cb7db556b4a4"><td class="memItemLeft" align="right" valign="top"><a id="a72306914df3fe74ce307cb7db556b4a4"></a>
const std::vector&lt; std::shared_ptr&lt; const <a class="el" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">StreamInfo</a> &gt; &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>streams</b> () const</td></tr>
<tr class="separator:a72306914df3fe74ce307cb7db556b4a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cc7feaee9a2c3a7d0569cb9c67c8c68"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html#a3cc7feaee9a2c3a7d0569cb9c67c8c68">set_clock</a> (base::Clock *clock)</td></tr>
<tr class="separator:a3cc7feaee9a2c3a7d0569cb9c67c8c68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshaka_1_1media_1_1MediaHandler"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshaka_1_1media_1_1MediaHandler')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">shaka::media::MediaHandler</a></td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a0fac1fe2d593e78d47244acdfa21759d inherit pub_methods_classshaka_1_1media_1_1MediaHandler"><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>
2018-02-10 23:37:42 +00:00
<tr class="memdesc:a0fac1fe2d593e78d47244acdfa21759d inherit pub_methods_classshaka_1_1media_1_1MediaHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect downstream handler at the specified output stream index. <br /></td></tr>
<tr class="separator:a0fac1fe2d593e78d47244acdfa21759d inherit pub_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:afc48a2450ce50162de18071aef516b6c inherit pub_methods_classshaka_1_1media_1_1MediaHandler"><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>
2018-05-23 23:12:00 +00:00
<tr class="memdesc:afc48a2450ce50162de18071aef516b6c inherit pub_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pub_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed0da512bbd998ec9d0a5c019ad17acb inherit pub_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pub_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a0e169e81344ce4ccfed3194ec5f4a3a1 inherit pub_methods_classshaka_1_1media_1_1MediaHandler"><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>
2018-02-10 23:37:42 +00:00
<tr class="memdesc:a0e169e81344ce4ccfed3194ec5f4a3a1 inherit pub_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pub_methods_classshaka_1_1media_1_1MediaHandler"><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>
2018-02-10 23:37:42 +00:00
<tr class="memitem:ad74a3968d89a1f0ccd3774d1b75822ef"><td class="memItemLeft" align="right" valign="top"><a id="ad74a3968d89a1f0ccd3774d1b75822ef"></a>
const <a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html">MuxerOptions</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>options</b> () const</td></tr>
<tr class="separator:ad74a3968d89a1f0ccd3774d1b75822ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe95933100307abf0268591f9bf172a0"><td class="memItemLeft" align="right" valign="top"><a id="abe95933100307abf0268591f9bf172a0"></a>
<a class="el" href="../../dd/d7a/classshaka_1_1media_1_1MuxerListener.html">MuxerListener</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>muxer_listener</b> ()</td></tr>
<tr class="separator:abe95933100307abf0268591f9bf172a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a777f35b67b8a755e69dbf399bd3f2289"><td class="memItemLeft" align="right" valign="top"><a id="a777f35b67b8a755e69dbf399bd3f2289"></a>
<a class="el" href="../../d4/de6/classshaka_1_1media_1_1ProgressListener.html">ProgressListener</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>progress_listener</b> ()</td></tr>
<tr class="separator:a777f35b67b8a755e69dbf399bd3f2289"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:ae593c2f20635794e87ad7658c4858821"><td class="memItemLeft" align="right" valign="top"><a id="ae593c2f20635794e87ad7658c4858821"></a>
base::Clock *&#160;</td><td class="memItemRight" valign="bottom"><b>clock</b> ()</td></tr>
<tr class="separator:ae593c2f20635794e87ad7658c4858821"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">MediaHandler implementation overrides.</div></td></tr>
<tr class="memitem:a36882e12df5c5bfd48a7b94d1dfad857"><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="../../df/d46/classshaka_1_1media_1_1Muxer.html#a36882e12df5c5bfd48a7b94d1dfad857">InitializeInternal</a> () override</td></tr>
<tr class="separator:a36882e12df5c5bfd48a7b94d1dfad857"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec730b070245231a0887787005c06eee"><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="../../df/d46/classshaka_1_1media_1_1Muxer.html#aec730b070245231a0887787005c06eee">Process</a> (std::unique_ptr&lt; <a class="el" href="../../d0/d4c/structshaka_1_1media_1_1StreamData.html">StreamData</a> &gt; stream_data) override</td></tr>
<tr class="separator:aec730b070245231a0887787005c06eee"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a9f08c1385506636b800769480869e04f"><td class="memItemLeft" align="right" valign="top"><a id="a9f08c1385506636b800769480869e04f"></a>
<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html#a9f08c1385506636b800769480869e04f">OnFlushRequest</a> (size_t input_stream_index) override</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memdesc:a9f08c1385506636b800769480869e04f"><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:a9f08c1385506636b800769480869e04f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classshaka_1_1media_1_1MediaHandler"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classshaka_1_1media_1_1MediaHandler')"><img src="../../closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">shaka::media::MediaHandler</a></td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:abe33a7328099b7917b2b3ba1038997b0 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-05-23 23:12:00 +00:00
<tr class="memitem:afe98a4fd19eabe0fc78afc91959c34a6 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad165375cd0a2074c5a740b42f847c499 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch the stream info to downstream handlers. <br /></td></tr>
<tr class="separator:ad165375cd0a2074c5a740b42f847c499 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a74fead95bc16255e73908bbebbced9 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch the media sample to downstream handlers. <br /></td></tr>
<tr class="separator:a9a74fead95bc16255e73908bbebbced9 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c44df529fead65c007ee27b84ebd32a inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch the text sample to downstream handlers. <br /></td></tr>
<tr class="separator:a9c44df529fead65c007ee27b84ebd32a inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2acc1c84a61aee93229d493aa93308d5 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch the segment info to downstream handlers. <br /></td></tr>
<tr class="separator:a2acc1c84a61aee93229d493aa93308d5 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaea265e5d6e765b75ad622c5588e09f8 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch the scte35 event to downstream handlers. <br /></td></tr>
<tr class="separator:aaea265e5d6e765b75ad622c5588e09f8 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dcba8fa849d5f031ab3e2b4803a7804 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch the cue event to downstream handlers. <br /></td></tr>
<tr class="separator:a0dcba8fa849d5f031ab3e2b4803a7804 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:ad5001bf12073101a949b062943769f5b inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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>
2018-02-10 23:37:42 +00:00
<tr class="memdesc:ad5001bf12073101a949b062943769f5b inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:ab644ca7b0a0dbcbc42936f2dfb979ca5 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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>
2018-05-23 23:12:00 +00:00
<tr class="memdesc:ab644ca7b0a0dbcbc42936f2dfb979ca5 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush all connected downstream handlers. <br /></td></tr>
<tr class="separator:ab644ca7b0a0dbcbc42936f2dfb979ca5 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:aeb64985e305009df53bd60a5b4ff3122 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:ad9090654f2a7355517f4a80bc6ce868d inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d80c96b3c6824532733c73672185ba9 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a665eb29cf9704481a490c5a912083104 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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 inherit pro_methods_classshaka_1_1media_1_1MediaHandler"><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="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a> is responsible for taking elementary stream samples and producing media containers. An optional <a class="el" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html" title="KeySource is responsible for encryption key acquisition. ">KeySource</a> can be provided to <a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a> to generate encrypted outputs. </p>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../db/df6/muxer_8h_source.html#l00030">30</a> of file <a class="el" href="../../db/df6/muxer_8h_source.html">muxer.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
2018-02-10 23:37:42 +00:00
<a id="a9204fe352d13cea8a367ae9c14e9639e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9204fe352d13cea8a367ae9c14e9639e">&#9670;&nbsp;</a></span>Cancel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shaka::media::Muxer::Cancel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cancel a muxing job in progress. Will cause <em>Run</em> to exit with an error status of type CANCELLED. </p>
<p class="definition">Definition at line <a class="el" href="../../d9/db9/muxer_8cc_source.html#l00031">31</a> of file <a class="el" href="../../d9/db9/muxer_8cc_source.html">muxer.cc</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a36882e12df5c5bfd48a7b94d1dfad857"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36882e12df5c5bfd48a7b94d1dfad857">&#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"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> shaka::media::Muxer::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">inline</span><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">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>Implements <a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#a0e05325d62bfb66318301c1ed790a46e">shaka::media::MediaHandler</a>.</p>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../db/df6/muxer_8h_source.html#l00064">64</a> of file <a class="el" href="../../db/df6/muxer_8h_source.html">muxer.h</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="aec730b070245231a0887787005c06eee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec730b070245231a0887787005c06eee">&#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"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> shaka::media::Muxer::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">override</span><span class="mlabel">protected</span><span class="mlabel">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>Implements <a class="el" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html#acb614e9f43e1eb6f837801b15b78c0b4">shaka::media::MediaHandler</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../d9/db9/muxer_8cc_source.html#l00044">44</a> of file <a class="el" href="../../d9/db9/muxer_8cc_source.html">muxer.cc</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a3cc7feaee9a2c3a7d0569cb9c67c8c68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cc7feaee9a2c3a7d0569cb9c67c8c68">&#9670;&nbsp;</a></span>set_clock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void shaka::media::Muxer::set_clock </td>
<td>(</td>
<td class="paramtype">base::Clock *&#160;</td>
<td class="paramname"><em>clock</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<p>Inject clock, mainly used for testing. The injected clock will be used to generate the creation time-stamp and modification time-stamp of the muxer output. If no clock is injected, the code uses base::Time::Now() to generate the time-stamps. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">clock</td><td>is the Clock to be injected. </td></tr>
</table>
</dd>
</dl>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../db/df6/muxer_8h_source.html#l00057">57</a> of file <a class="el" href="../../db/df6/muxer_8h_source.html">muxer.h</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a0e76dd0a5c07dd538221459365ae824a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e76dd0a5c07dd538221459365ae824a">&#9670;&nbsp;</a></span>SetMuxerListener()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shaka::media::Muxer::SetMuxerListener </td>
<td>(</td>
<td class="paramtype">std::unique_ptr&lt; <a class="el" href="../../dd/d7a/classshaka_1_1media_1_1MuxerListener.html">MuxerListener</a> &gt;&#160;</td>
<td class="paramname"><em>muxer_listener</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<p>Set a <a class="el" href="../../dd/d7a/classshaka_1_1media_1_1MuxerListener.html">MuxerListener</a> event handler for this object. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">muxer_listener</td><td>should not be NULL. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d9/db9/muxer_8cc_source.html#l00035">35</a> of file <a class="el" href="../../d9/db9/muxer_8cc_source.html">muxer.cc</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a25a146d553c385aad70dbff6b3e87eec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25a146d553c385aad70dbff6b3e87eec">&#9670;&nbsp;</a></span>SetProgressListener()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shaka::media::Muxer::SetProgressListener </td>
<td>(</td>
<td class="paramtype">std::unique_ptr&lt; <a class="el" href="../../d4/de6/classshaka_1_1media_1_1ProgressListener.html">ProgressListener</a> &gt;&#160;</td>
<td class="paramname"><em>progress_listener</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<p>Set a <a class="el" href="../../d4/de6/classshaka_1_1media_1_1ProgressListener.html" title="This class listens to progress updates events. ">ProgressListener</a> event handler for this object. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">progress_listener</td><td>should not be NULL. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d9/db9/muxer_8cc_source.html#l00039">39</a> of file <a class="el" href="../../d9/db9/muxer_8cc_source.html">muxer.cc</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="../../db/df6/muxer_8h_source.html">muxer.h</a></li>
<li>packager/media/base/<a class="el" href="../../d9/db9/muxer_8cc_source.html">muxer.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jun 7 2018 16:04:01 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>