234 lines
16 KiB
HTML
234 lines
16 KiB
HTML
<!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"/>
|
|
<meta name="generator" content="Doxygen 1.8.6"/>
|
|
<title>DASH Media Packaging SDK: shaka::media::MediaStream 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/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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 style="padding-left: 0.5em;">
|
|
<div id="projectname">DASH Media Packaging SDK
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="../../index.html"><span>Main Page</span></a></li>
|
|
<li><a href="../../namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="../../annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="../../files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="../../search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="../../annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="../../classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="../../hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="../../functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></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="../../d8/d5c/classshaka_1_1media_1_1MediaStream.html">MediaStream</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="../../d6/db1/classshaka_1_1media_1_1MediaStream-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">shaka::media::MediaStream Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="../../d9/d93/media__stream_8h_source.html">media_stream.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:aa2dd0166bf3d62d0227a40f552127977"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>MediaStreamOperation</b> { <b>kPush</b>,
|
|
<b>kPull</b>
|
|
}</td></tr>
|
|
<tr class="separator:aa2dd0166bf3d62d0227a40f552127977"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a12b0f703395d756a584d78b686b2b99b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d5c/classshaka_1_1media_1_1MediaStream.html#a12b0f703395d756a584d78b686b2b99b">MediaStream</a> (std::shared_ptr< <a class="el" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">StreamInfo</a> > info, <a class="el" href="../../dd/d17/classshaka_1_1media_1_1Demuxer.html">Demuxer</a> *demuxer)</td></tr>
|
|
<tr class="separator:a12b0f703395d756a584d78b686b2b99b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a98e53e299c7258419623b3d709553562"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d5c/classshaka_1_1media_1_1MediaStream.html#a98e53e299c7258419623b3d709553562">Connect</a> (<a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a> *muxer)</td></tr>
|
|
<tr class="separator:a98e53e299c7258419623b3d709553562"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5eca8f2e63e762d52fcc30c5f8c38b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5eca8f2e63e762d52fcc30c5f8c38b0"></a>
|
|
<a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d5c/classshaka_1_1media_1_1MediaStream.html#af5eca8f2e63e762d52fcc30c5f8c38b0">Start</a> (MediaStreamOperation operation)</td></tr>
|
|
<tr class="memdesc:af5eca8f2e63e762d52fcc30c5f8c38b0"><td class="mdescLeft"> </td><td class="mdescRight">Start the stream for pushing or pulling. <br/></td></tr>
|
|
<tr class="separator:af5eca8f2e63e762d52fcc30c5f8c38b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac65da3105afb21a9013f59a217a26b29"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac65da3105afb21a9013f59a217a26b29"></a>
|
|
<a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d5c/classshaka_1_1media_1_1MediaStream.html#ac65da3105afb21a9013f59a217a26b29">PushSample</a> (const std::shared_ptr< <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> > &sample)</td></tr>
|
|
<tr class="memdesc:ac65da3105afb21a9013f59a217a26b29"><td class="mdescLeft"> </td><td class="mdescRight">Push sample to <a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a> (triggered by <a class="el" href="../../dd/d17/classshaka_1_1media_1_1Demuxer.html">Demuxer</a>). <br/></td></tr>
|
|
<tr class="separator:ac65da3105afb21a9013f59a217a26b29"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee15b821f0682812a9d631d531ed8101"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee15b821f0682812a9d631d531ed8101"></a>
|
|
<a class="el" href="../../d0/d93/classshaka_1_1media_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d5c/classshaka_1_1media_1_1MediaStream.html#aee15b821f0682812a9d631d531ed8101">PullSample</a> (std::shared_ptr< <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> > *sample)</td></tr>
|
|
<tr class="memdesc:aee15b821f0682812a9d631d531ed8101"><td class="mdescLeft"> </td><td class="mdescRight">Pull sample from <a class="el" href="../../dd/d17/classshaka_1_1media_1_1Demuxer.html">Demuxer</a> (triggered by <a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a>). <br/></td></tr>
|
|
<tr class="separator:aee15b821f0682812a9d631d531ed8101"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade7ea8dcbbd1f987a58094c9072ba83a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade7ea8dcbbd1f987a58094c9072ba83a"></a>
|
|
<a class="el" href="../../dd/d17/classshaka_1_1media_1_1Demuxer.html">Demuxer</a> * </td><td class="memItemRight" valign="bottom"><b>demuxer</b> ()</td></tr>
|
|
<tr class="separator:ade7ea8dcbbd1f987a58094c9072ba83a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c2ba3a3b0689f85cdf44f68e535c724"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c2ba3a3b0689f85cdf44f68e535c724"></a>
|
|
<a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a> * </td><td class="memItemRight" valign="bottom"><b>muxer</b> ()</td></tr>
|
|
<tr class="separator:a6c2ba3a3b0689f85cdf44f68e535c724"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31b3d86c276bd31b8646b1e06fa0a2e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31b3d86c276bd31b8646b1e06fa0a2e1"></a>
|
|
const std::shared_ptr< <a class="el" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">StreamInfo</a> > </td><td class="memItemRight" valign="bottom"><b>info</b> () const </td></tr>
|
|
<tr class="separator:a31b3d86c276bd31b8646b1e06fa0a2e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a51d85facae4f9d8d89b97a42148769dd"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d5c/classshaka_1_1media_1_1MediaStream.html#a51d85facae4f9d8d89b97a42148769dd">ToString</a> () const </td></tr>
|
|
<tr class="separator:a51d85facae4f9d8d89b97a42148769dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="../../d8/d5c/classshaka_1_1media_1_1MediaStream.html">MediaStream</a> connects <a class="el" href="../../dd/d17/classshaka_1_1media_1_1Demuxer.html">Demuxer</a> to <a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a>. It is an abstraction for a media elementary stream. </p>
|
|
|
|
<p>Definition at line <a class="el" href="../../d9/d93/media__stream_8h_source.html#l00025">25</a> of file <a class="el" href="../../d9/d93/media__stream_8h_source.html">media_stream.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a12b0f703395d756a584d78b686b2b99b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">shaka::media::MediaStream::MediaStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::shared_ptr< <a class="el" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">StreamInfo</a> > </td>
|
|
<td class="paramname"><em>info</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="../../dd/d17/classshaka_1_1media_1_1Demuxer.html">Demuxer</a> * </td>
|
|
<td class="paramname"><em>demuxer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Create <a class="el" href="../../d8/d5c/classshaka_1_1media_1_1MediaStream.html">MediaStream</a> from <a class="el" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html" title="Abstract class holds stream information. ">StreamInfo</a> and <a class="el" href="../../dd/d17/classshaka_1_1media_1_1Demuxer.html">Demuxer</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">demuxer</td><td>cannot be NULL. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../de/d15/media__stream_8cc_source.html#l00019">19</a> of file <a class="el" href="../../de/d15/media__stream_8cc_source.html">media_stream.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a98e53e299c7258419623b3d709553562"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void shaka::media::MediaStream::Connect </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a> * </td>
|
|
<td class="paramname"><em>muxer</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Connect the stream to <a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">muxer</td><td>cannot be NULL. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../de/d15/media__stream_8cc_source.html#l00055">55</a> of file <a class="el" href="../../de/d15/media__stream_8cc_source.html">media_stream.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a51d85facae4f9d8d89b97a42148769dd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string shaka::media::MediaStream::ToString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>a human-readable string describing |*this|. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../de/d15/media__stream_8cc_source.html#l00105">105</a> of file <a class="el" href="../../de/d15/media__stream_8cc_source.html">media_stream.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>media/base/<a class="el" href="../../d9/d93/media__stream_8h_source.html">media_stream.h</a></li>
|
|
<li>media/base/<a class="el" href="../../de/d15/media__stream_8cc_source.html">media_stream.cc</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Jan 26 2017 19:23:52 for DASH Media Packaging SDK by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|