shaka-packager/docs/d7/d6d/classshaka_1_1media_1_1Medi...

477 lines
29 KiB
HTML
Raw Permalink Normal View 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"/>
2021-06-22 00:16:40 +00:00
<meta name="generator" content="Doxygen 1.8.17"/>
2018-02-10 23:37:42 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::media::MediaSample 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 -->
2021-06-22 00:16:40 +00:00
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2021-06-22 00:16:40 +00:00
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2018-02-10 23:37:42 +00:00
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
2018-02-10 23:37:42 +00:00
<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="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</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="../../df/d1c/classshaka_1_1media_1_1MediaSample-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::MediaSample Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class to hold a media sample.
<a href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../dd/d80/media__sample_8h_source.html">media_sample.h</a>&gt;</code></p>
<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:a5cf07ebc02514de4c2e2adf8280acedf"><td class="memItemLeft" align="right" valign="top"><a id="a5cf07ebc02514de4c2e2adf8280acedf"></a>
std::shared_ptr&lt; <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html#a5cf07ebc02514de4c2e2adf8280acedf">Clone</a> () const</td></tr>
<tr class="memdesc:a5cf07ebc02514de4c2e2adf8280acedf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clone the object and return a new <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html" title="Class to hold a media sample.">MediaSample</a>. <br /></td></tr>
2018-02-10 23:37:42 +00:00
<tr class="separator:a5cf07ebc02514de4c2e2adf8280acedf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5402405ad4abb5102078d047972a56fa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html#a5402405ad4abb5102078d047972a56fa">TransferData</a> (std::shared_ptr&lt; uint8_t &gt; data, size_t data_size)</td></tr>
<tr class="separator:a5402405ad4abb5102078d047972a56fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9be744240871d88cd76d04adbd2d702"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html#ab9be744240871d88cd76d04adbd2d702">SetData</a> (const uint8_t *data, size_t data_size)</td></tr>
<tr class="separator:ab9be744240871d88cd76d04adbd2d702"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:ac73cd44d0804ccb8e686912caec9873e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html#ac73cd44d0804ccb8e686912caec9873e">ToString</a> () const</td></tr>
<tr class="separator:ac73cd44d0804ccb8e686912caec9873e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64c3c8767af7ee3582fbb794a342efc2"><td class="memItemLeft" align="right" valign="top"><a id="a64c3c8767af7ee3582fbb794a342efc2"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>dts</b> () const</td></tr>
<tr class="separator:a64c3c8767af7ee3582fbb794a342efc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a282f6c6f514e5500d7c601b456b02ff2"><td class="memItemLeft" align="right" valign="top"><a id="a282f6c6f514e5500d7c601b456b02ff2"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_dts</b> (int64_t dts)</td></tr>
<tr class="separator:a282f6c6f514e5500d7c601b456b02ff2"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:acc1c737ecec91878c3e06eaf54b963fb"><td class="memItemLeft" align="right" valign="top"><a id="acc1c737ecec91878c3e06eaf54b963fb"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>pts</b> () const</td></tr>
<tr class="separator:acc1c737ecec91878c3e06eaf54b963fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a766027345233f30a6ab105a0f812c9d4"><td class="memItemLeft" align="right" valign="top"><a id="a766027345233f30a6ab105a0f812c9d4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_pts</b> (int64_t pts)</td></tr>
<tr class="separator:a766027345233f30a6ab105a0f812c9d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a30a4c03eb4b6e2ed6628bcf214fb6d29"><td class="memItemLeft" align="right" valign="top"><a id="a30a4c03eb4b6e2ed6628bcf214fb6d29"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>duration</b> () const</td></tr>
<tr class="separator:a30a4c03eb4b6e2ed6628bcf214fb6d29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31af3b3d7e02720b8b2430fb35be617a"><td class="memItemLeft" align="right" valign="top"><a id="a31af3b3d7e02720b8b2430fb35be617a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_duration</b> (int64_t duration)</td></tr>
<tr class="separator:a31af3b3d7e02720b8b2430fb35be617a"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a6d9f33b174a72d44deb8e4614fcdc0d3"><td class="memItemLeft" align="right" valign="top"><a id="a6d9f33b174a72d44deb8e4614fcdc0d3"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_key_frame</b> () const</td></tr>
<tr class="separator:a6d9f33b174a72d44deb8e4614fcdc0d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f80233715e6de3465dacd56fdb447d0"><td class="memItemLeft" align="right" valign="top"><a id="a2f80233715e6de3465dacd56fdb447d0"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_encrypted</b> () const</td></tr>
<tr class="separator:a2f80233715e6de3465dacd56fdb447d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a1191845b289a9066b5cd16aa24da27"><td class="memItemLeft" align="right" valign="top"><a id="a9a1191845b289a9066b5cd16aa24da27"></a>
const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><b>data</b> () const</td></tr>
<tr class="separator:a9a1191845b289a9066b5cd16aa24da27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbcc8422f0bdbbf6b094d227b7339ed0"><td class="memItemLeft" align="right" valign="top"><a id="acbcc8422f0bdbbf6b094d227b7339ed0"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>data_size</b> () const</td></tr>
<tr class="separator:acbcc8422f0bdbbf6b094d227b7339ed0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a284951ef20e0c397ba6f4ffc83d88ec3"><td class="memItemLeft" align="right" valign="top"><a id="a284951ef20e0c397ba6f4ffc83d88ec3"></a>
const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><b>side_data</b> () const</td></tr>
<tr class="separator:a284951ef20e0c397ba6f4ffc83d88ec3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3604d9ea035b258b50fd1d2cf8e5102a"><td class="memItemLeft" align="right" valign="top"><a id="a3604d9ea035b258b50fd1d2cf8e5102a"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>side_data_size</b> () const</td></tr>
<tr class="separator:a3604d9ea035b258b50fd1d2cf8e5102a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5709c6855383d3565acb1cc6320056ff"><td class="memItemLeft" align="right" valign="top"><a id="a5709c6855383d3565acb1cc6320056ff"></a>
const <a class="el" href="../../de/d49/classshaka_1_1media_1_1DecryptConfig.html">DecryptConfig</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>decrypt_config</b> () const</td></tr>
<tr class="separator:a5709c6855383d3565acb1cc6320056ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99ffbe5854478e1acd3f324b91801091"><td class="memItemLeft" align="right" valign="top"><a id="a99ffbe5854478e1acd3f324b91801091"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_is_key_frame</b> (bool value)</td></tr>
<tr class="separator:a99ffbe5854478e1acd3f324b91801091"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a8c7cb12233fb08f48f08ac175468db54"><td class="memItemLeft" align="right" valign="top"><a id="a8c7cb12233fb08f48f08ac175468db54"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_is_encrypted</b> (bool value)</td></tr>
<tr class="separator:a8c7cb12233fb08f48f08ac175468db54"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a18a97b2d0901174672b6d7708cdcaf26"><td class="memItemLeft" align="right" valign="top"><a id="a18a97b2d0901174672b6d7708cdcaf26"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_decrypt_config</b> (std::unique_ptr&lt; <a class="el" href="../../de/d49/classshaka_1_1media_1_1DecryptConfig.html">DecryptConfig</a> &gt; decrypt_config)</td></tr>
<tr class="separator:a18a97b2d0901174672b6d7708cdcaf26"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a50581e04dd53ae306f54dfe5c9ff60a9"><td class="memItemLeft" align="right" valign="top"><a id="a50581e04dd53ae306f54dfe5c9ff60a9"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>end_of_stream</b> () const</td></tr>
<tr class="separator:a50581e04dd53ae306f54dfe5c9ff60a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab72b26d2824ab4c3122fe37507a878d"><td class="memItemLeft" align="right" valign="top"><a id="aab72b26d2824ab4c3122fe37507a878d"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>config_id</b> () const</td></tr>
<tr class="separator:aab72b26d2824ab4c3122fe37507a878d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6217d289829ab91c85be82d8f8bdfbab"><td class="memItemLeft" align="right" valign="top"><a id="a6217d289829ab91c85be82d8f8bdfbab"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_config_id</b> (const std::string &amp;config_id)</td></tr>
<tr class="separator:a6217d289829ab91c85be82d8f8bdfbab"><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>
2018-02-10 23:37:42 +00:00
<tr class="memitem:ad8975dbb21747ff32c8604f5489bf5c9"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html#ad8975dbb21747ff32c8604f5489bf5c9">CopyFrom</a> (const uint8_t *data, size_t size, bool is_key_frame)</td></tr>
<tr class="separator:ad8975dbb21747ff32c8604f5489bf5c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a910e68f46b9464e4ea36cf9cd5116b55"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html#a910e68f46b9464e4ea36cf9cd5116b55">CopyFrom</a> (const uint8_t *data, size_t size, const uint8_t *side_data, size_t side_data_size, bool is_key_frame)</td></tr>
<tr class="separator:a910e68f46b9464e4ea36cf9cd5116b55"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a8c70ae863851c7a1066923cf387fb178"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html#a8c70ae863851c7a1066923cf387fb178">FromMetadata</a> (const uint8_t *metadata, size_t metadata_size)</td></tr>
<tr class="separator:a8c70ae863851c7a1066923cf387fb178"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a4a7f8d79f9ec3cd3df9a395eef71f0c6"><td class="memItemLeft" align="right" valign="top"><a id="a4a7f8d79f9ec3cd3df9a395eef71f0c6"></a>
static std::shared_ptr&lt; <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html#a4a7f8d79f9ec3cd3df9a395eef71f0c6">CreateEmptyMediaSample</a> ()</td></tr>
<tr class="memdesc:a4a7f8d79f9ec3cd3df9a395eef71f0c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html" title="Class to hold a media sample.">MediaSample</a> object with default members. <br /></td></tr>
<tr class="separator:a4a7f8d79f9ec3cd3df9a395eef71f0c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a236e80a98d7f22ec585bbbf2e91397f5"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html#a236e80a98d7f22ec585bbbf2e91397f5">CreateEOSBuffer</a> ()</td></tr>
<tr class="separator:a236e80a98d7f22ec585bbbf2e91397f5"><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:a5fde40524f29d01ad947604b56e193b6"><td class="memItemLeft" align="right" valign="top"><a id="a5fde40524f29d01ad947604b56e193b6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>MediaSample</b> (const uint8_t *data, size_t data_size, const uint8_t *side_data, size_t side_data_size, bool is_key_frame)</td></tr>
<tr class="separator:a5fde40524f29d01ad947604b56e193b6"><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>Class to hold a media sample. </p>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../dd/d80/media__sample_8h_source.html#l00022">22</a> of file <a class="el" href="../../dd/d80/media__sample_8h_source.html">media_sample.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
2018-02-10 23:37:42 +00:00
<a id="ad8975dbb21747ff32c8604f5489bf5c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8975dbb21747ff32c8604f5489bf5c9">&#9670;&nbsp;</a></span>CopyFrom() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> &gt; shaka::media::MediaSample::CopyFrom </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_key_frame</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html" title="Class to hold a media sample.">MediaSample</a> object from input. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>points to the buffer containing the sample data. Must not be NULL. </td></tr>
<tr><td class="paramname">size</td><td>indicates sample size in bytes. Must not be negative. </td></tr>
<tr><td class="paramname">is_key_frame</td><td>indicates whether the sample is a key frame. </td></tr>
</table>
</dd>
</dl>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../d8/d0d/media__sample_8cc_source.html#l00042">42</a> of file <a class="el" href="../../d8/d0d/media__sample_8cc_source.html">media_sample.cc</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a910e68f46b9464e4ea36cf9cd5116b55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a910e68f46b9464e4ea36cf9cd5116b55">&#9670;&nbsp;</a></span>CopyFrom() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> &gt; shaka::media::MediaSample::CopyFrom </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>side_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>side_data_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_key_frame</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html" title="Class to hold a media sample.">MediaSample</a> object from input. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>points to the buffer containing the sample data. Must not be NULL. </td></tr>
<tr><td class="paramname">side_data</td><td>points to the buffer containing the additional data. Some containers allow additional data to be specified. Must not be NULL. </td></tr>
<tr><td class="paramname">size</td><td>indicates sample size in bytes. Must not be negative. </td></tr>
<tr><td class="paramname">side_data_size</td><td>indicates additional sample data size in bytes. </td></tr>
<tr><td class="paramname">is_key_frame</td><td>indicates whether the sample is a key frame. </td></tr>
</table>
</dd>
</dl>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../d8/d0d/media__sample_8cc_source.html#l00052">52</a> of file <a class="el" href="../../d8/d0d/media__sample_8cc_source.html">media_sample.cc</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a236e80a98d7f22ec585bbbf2e91397f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a236e80a98d7f22ec585bbbf2e91397f5">&#9670;&nbsp;</a></span>CreateEOSBuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> &gt; shaka::media::MediaSample::CreateEOSBuffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html" title="Class to hold a media sample.">MediaSample</a> indicating we've reached end of stream. Calling any method other than end_of_stream() on the resulting buffer is disallowed. </p>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../d8/d0d/media__sample_8cc_source.html#l00076">76</a> of file <a class="el" href="../../d8/d0d/media__sample_8cc_source.html">media_sample.cc</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a8c70ae863851c7a1066923cf387fb178"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c70ae863851c7a1066923cf387fb178">&#9670;&nbsp;</a></span>FromMetadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> &gt; shaka::media::MediaSample::FromMetadata </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>metadata</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>metadata_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html" title="Class to hold a media sample.">MediaSample</a> object from metadata. Unlike other factory methods, this cannot be a key frame. It must be only for metadata. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">metadata</td><td>points to the buffer containing metadata. Must not be NULL. </td></tr>
<tr><td class="paramname">metadata_size</td><td>is the size of metadata in bytes. </td></tr>
</table>
</dd>
</dl>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../d8/d0d/media__sample_8cc_source.html#l00064">64</a> of file <a class="el" href="../../d8/d0d/media__sample_8cc_source.html">media_sample.cc</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="ab9be744240871d88cd76d04adbd2d702"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9be744240871d88cd76d04adbd2d702">&#9670;&nbsp;</a></span>SetData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shaka::media::MediaSample::SetData </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>data_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<p>Set the data in this media sample. Note that this method involves data copying. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>points to the data to be copied. </td></tr>
<tr><td class="paramname">data_size</td><td>is the size of the data to be copied. </td></tr>
</table>
</dd>
</dl>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../d8/d0d/media__sample_8cc_source.html#l00109">109</a> of file <a class="el" href="../../d8/d0d/media__sample_8cc_source.html">media_sample.cc</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="ac73cd44d0804ccb8e686912caec9873e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac73cd44d0804ccb8e686912caec9873e">&#9670;&nbsp;</a></span>ToString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::media::MediaSample::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>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../d8/d0d/media__sample_8cc_source.html#l00116">116</a> of file <a class="el" href="../../d8/d0d/media__sample_8cc_source.html">media_sample.cc</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a5402405ad4abb5102078d047972a56fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5402405ad4abb5102078d047972a56fa">&#9670;&nbsp;</a></span>TransferData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shaka::media::MediaSample::TransferData </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; uint8_t &gt;&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>data_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<p>Transfer data to this media sample. No data copying is involved. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>points to the data to be transferred. </td></tr>
<tr><td class="paramname">data_size</td><td>is the size of the data to be transferred. </td></tr>
</table>
</dd>
</dl>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../d8/d0d/media__sample_8cc_source.html#l00103">103</a> of file <a class="el" href="../../d8/d0d/media__sample_8cc_source.html">media_sample.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="../../dd/d80/media__sample_8h_source.html">media_sample.h</a></li>
<li>packager/media/base/<a class="el" href="../../d8/d0d/media__sample_8cc_source.html">media_sample.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
2021-06-22 00:16:40 +00:00
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>