shaka-packager/docs/db/dab/classshaka_1_1media_1_1Text...

291 lines
21 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::TextStreamInfo 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&#160;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&#160;List</span></a></li>
<li><a href="../../classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="../../hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="../../functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</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="../../db/dab/classshaka_1_1media_1_1TextStreamInfo.html">TextStreamInfo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../d2/de7/classshaka_1_1media_1_1TextStreamInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::TextStreamInfo Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for shaka::media::TextStreamInfo:</div>
<div class="dyncontent">
<div class="center">
<img src="../../db/dab/classshaka_1_1media_1_1TextStreamInfo.png" usemap="#shaka::media::TextStreamInfo_map" alt=""/>
<map id="shaka::media::TextStreamInfo_map" name="shaka::media::TextStreamInfo_map">
<area href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html" title="Abstract class holds stream information. " alt="shaka::media::StreamInfo" shape="rect" coords="0,56,261,80"/>
</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:a3cc97869179c6e1f845ee84ba630048f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dab/classshaka_1_1media_1_1TextStreamInfo.html#a3cc97869179c6e1f845ee84ba630048f">TextStreamInfo</a> (int track_id, uint32_t time_scale, uint64_t duration, const std::string &amp;codec_string, const std::string &amp;codec_config, uint16_t width, uint16_t height, const std::string &amp;language)</td></tr>
<tr class="separator:a3cc97869179c6e1f845ee84ba630048f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab40aed17c046e639efde04a2075e25a8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dab/classshaka_1_1media_1_1TextStreamInfo.html#ab40aed17c046e639efde04a2075e25a8">IsValidConfig</a> () const override</td></tr>
<tr class="separator:ab40aed17c046e639efde04a2075e25a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a218aa26b26f8a6784acff7817d825606"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a218aa26b26f8a6784acff7817d825606"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>width</b> () const </td></tr>
<tr class="separator:a218aa26b26f8a6784acff7817d825606"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b34578679e74d60d515d324d7af110d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b34578679e74d60d515d324d7af110d"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>height</b> () const </td></tr>
<tr class="separator:a2b34578679e74d60d515d324d7af110d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshaka_1_1media_1_1StreamInfo"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshaka_1_1media_1_1StreamInfo')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">shaka::media::StreamInfo</a></td></tr>
<tr class="memitem:a4dd520edf7452a27afccd578a53c246f inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4dd520edf7452a27afccd578a53c246f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>StreamInfo</b> (StreamType stream_type, int track_id, uint32_t time_scale, uint64_t duration, Codec codec, const std::string &amp;codec_string, const uint8_t *codec_config, size_t codec_config_size, const std::string &amp;language, bool is_encrypted)</td></tr>
<tr class="separator:a4dd520edf7452a27afccd578a53c246f inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa11d2fe5509ebfdc038aa3f2cdbbe00d inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html#aa11d2fe5509ebfdc038aa3f2cdbbe00d">ToString</a> () const </td></tr>
<tr class="separator:aa11d2fe5509ebfdc038aa3f2cdbbe00d inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28665578e17162b3d3cd9ef44ed05ef3 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28665578e17162b3d3cd9ef44ed05ef3"></a>
StreamType&#160;</td><td class="memItemRight" valign="bottom"><b>stream_type</b> () const </td></tr>
<tr class="separator:a28665578e17162b3d3cd9ef44ed05ef3 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63546b6cfc21d363662d6f18fb8b5b0c inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63546b6cfc21d363662d6f18fb8b5b0c"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>track_id</b> () const </td></tr>
<tr class="separator:a63546b6cfc21d363662d6f18fb8b5b0c inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62b43e5c92f00a4a77fea10b8e1cf56d inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62b43e5c92f00a4a77fea10b8e1cf56d"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>time_scale</b> () const </td></tr>
<tr class="separator:a62b43e5c92f00a4a77fea10b8e1cf56d inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba86f24d96ed36a78d1d08deb61b5e2a inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba86f24d96ed36a78d1d08deb61b5e2a"></a>
uint64_t&#160;</td><td class="memItemRight" valign="bottom"><b>duration</b> () const </td></tr>
<tr class="separator:aba86f24d96ed36a78d1d08deb61b5e2a inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95fc96e6353049269a8a8871cdcd4e8b inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95fc96e6353049269a8a8871cdcd4e8b"></a>
Codec&#160;</td><td class="memItemRight" valign="bottom"><b>codec</b> () const </td></tr>
<tr class="separator:a95fc96e6353049269a8a8871cdcd4e8b inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f27c7e372ece6d4014153fcb51f59c7 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f27c7e372ece6d4014153fcb51f59c7"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>codec_string</b> () const </td></tr>
<tr class="separator:a2f27c7e372ece6d4014153fcb51f59c7 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50772fb5c00a449a084b29b70dcf5135 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50772fb5c00a449a084b29b70dcf5135"></a>
const std::vector&lt; uint8_t &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>codec_config</b> () const </td></tr>
<tr class="separator:a50772fb5c00a449a084b29b70dcf5135 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ae0ea39ecc8d911b2f5d38a8ae2261f inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ae0ea39ecc8d911b2f5d38a8ae2261f"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>language</b> () const </td></tr>
<tr class="separator:a0ae0ea39ecc8d911b2f5d38a8ae2261f inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95aa5740795c72c1e41afc54a4e3dcc8 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95aa5740795c72c1e41afc54a4e3dcc8"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_encrypted</b> () const </td></tr>
<tr class="separator:a95aa5740795c72c1e41afc54a4e3dcc8 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3b5158ebe44f59b8e43b02ce71df46a inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3b5158ebe44f59b8e43b02ce71df46a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_duration</b> (int duration)</td></tr>
<tr class="separator:ad3b5158ebe44f59b8e43b02ce71df46a inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0744a0e813c8ad8c5df649a130794fb6 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0744a0e813c8ad8c5df649a130794fb6"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_codec</b> (Codec codec)</td></tr>
<tr class="separator:a0744a0e813c8ad8c5df649a130794fb6 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa54bb3e89db461517aec46d994bf972f inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa54bb3e89db461517aec46d994bf972f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_codec_config</b> (const std::vector&lt; uint8_t &gt; &amp;data)</td></tr>
<tr class="separator:aa54bb3e89db461517aec46d994bf972f inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a253c9f1d0cd2d58cd041a2b5fcd2eb93 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a253c9f1d0cd2d58cd041a2b5fcd2eb93"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_codec_string</b> (const std::string &amp;codec_string)</td></tr>
<tr class="separator:a253c9f1d0cd2d58cd041a2b5fcd2eb93 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa939a8328421d629d778f8b149146911 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa939a8328421d629d778f8b149146911"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_language</b> (const std::string &amp;language)</td></tr>
<tr class="separator:aa939a8328421d629d778f8b149146911 inherit pub_methods_classshaka_1_1media_1_1StreamInfo"><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>Definition at line <a class="el" href="../../da/d2a/text__stream__info_8h_source.html#l00017">17</a> of file <a class="el" href="../../da/d2a/text__stream__info_8h_source.html">text_stream_info.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3cc97869179c6e1f845ee84ba630048f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">shaka::media::TextStreamInfo::TextStreamInfo </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>track_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>time_scale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>codec_string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>codec_config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>language</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>No encryption supported. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">track_id</td><td>is the track ID of this stream. </td></tr>
<tr><td class="paramname">time_scale</td><td>is the time scale of this stream. </td></tr>
<tr><td class="paramname">duration</td><td>is the duration of this stream. </td></tr>
<tr><td class="paramname">codec_string</td><td>is the codec. </td></tr>
<tr><td class="paramname">codec_config</td><td>is configuration for this text stream. This could be the metadata that applies to all the samples of this stream. This may be empty. </td></tr>
<tr><td class="paramname">width</td><td>of the text. This may be 0. </td></tr>
<tr><td class="paramname">height</td><td>of the text. This may be 0. </td></tr>
<tr><td class="paramname">language</td><td>is the language of this stream. This may be empty. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="../../d6/d16/text__stream__info_8cc_source.html#l00012">12</a> of file <a class="el" href="../../d6/d16/text__stream__info_8cc_source.html">text_stream_info.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab40aed17c046e639efde04a2075e25a8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::TextStreamInfo::IsValidConfig </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if this object has appropriate configuration values, false otherwise. </dd></dl>
<p>Implements <a class="el" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html#a6e5c5ade77b7bcf0b7822de568695dc8">shaka::media::StreamInfo</a>.</p>
<p>Definition at line <a class="el" href="../../d6/d16/text__stream__info_8cc_source.html#l00026">26</a> of file <a class="el" href="../../d6/d16/text__stream__info_8cc_source.html">text_stream_info.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="../../da/d2a/text__stream__info_8h_source.html">text_stream_info.h</a></li>
<li>media/base/<a class="el" href="../../d6/d16/text__stream__info_8cc_source.html">text_stream_info.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 9 2016 18:38:41 for DASH Media Packaging SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>