Upstream version 5.34.104.0
[platform/framework/web/crosswalk.git] / src / native_client_sdk / doc_generated / pepper_dev / c / struct_p_p_b___media_stream_audio_track__0__1.html
index 5dce1be..6299252 100644 (file)
@@ -1,6 +1,8 @@
 {{+bindTo:partials.standard_nacl_article}}
 <h1>PPB_MediaStreamAudioTrack Struct Reference</h1>
-<div>
+<div id="doxygen-ref">
+{{- dummy div to appease doxygen -}}
+  <div>
 <!-- Generated by Doxygen 1.7.6.1 -->
 
 
@@ -11,7 +13,8 @@
 Data Fields</h2><table class="memberdecls">
 
 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#a578685c385942e0f9e9e3b041dea4f17">IsMediaStreamAudioTrack</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#a601dfa7dc958d6e0e33a667fe98cf087">Configure</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> audio_track, uint32_t samples_per_frame, uint32_t max_buffered_frames)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#a73f0f222f60ceed5f662ef3db7dee21b">Configure</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> audio_track, const int32_t attrib_list[], struct <a class="el" href="struct_p_p___completion_callback.html">PP_CompletionCallback</a> callback)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#a3ad96bc4cd30dd580871a789a749819c">GetAttrib</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> audio_track, <a class="el" href="group___enums.html#ga2f729c238ba74adc778c0d0bc17c453f">PP_MediaStreamAudioTrack_Attrib</a> attrib, int32_t *value)</td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#a54bbc279f3440f49fbb9ad357ba4d224">GetId</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> audio_track)</td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#a21037392fc0a6fb893881fddb204002f">HasEnded</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> audio_track)</td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#af63b07a557e11a5bbee56a90b9071535">GetFrame</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> audio_track, <a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> *frame, struct <a class="el" href="struct_p_p___completion_callback.html">PP_CompletionCallback</a> callback)</td></tr>
@@ -39,23 +42,50 @@ Data Fields</h2><table class="memberdecls">
 </dl>
 </div>
 </div>
-<a class="anchor" id="a601dfa7dc958d6e0e33a667fe98cf087"></a><!-- doxytag: member="PPB_MediaStreamAudioTrack::Configure" ref="a601dfa7dc958d6e0e33a667fe98cf087" args=")(PP_Resource audio_track, uint32_t samples_per_frame, uint32_t max_buffered_frames)" -->
+<a class="anchor" id="a73f0f222f60ceed5f662ef3db7dee21b"></a><!-- doxytag: member="PPB_MediaStreamAudioTrack::Configure" ref="a73f0f222f60ceed5f662ef3db7dee21b" args=")(PP_Resource audio_track, const int32_t attrib_list[], struct PP_CompletionCallback callback)" -->
 <div class="memitem">
 <div class="memproto">
 <table class="memname">
 <tr>
-<td class="memname">int32_t(* <a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#a601dfa7dc958d6e0e33a667fe98cf087">PPB_MediaStreamAudioTrack::Configure</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> audio_track, uint32_t samples_per_frame, uint32_t max_buffered_frames)</td>
+<td class="memname">int32_t(* <a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#a73f0f222f60ceed5f662ef3db7dee21b">PPB_MediaStreamAudioTrack::Configure</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> audio_track, const int32_t attrib_list[], struct <a class="el" href="struct_p_p___completion_callback.html">PP_CompletionCallback</a> callback)</td>
 </tr>
 </table>
 </div>
 <div class="memdoc">
 <p>Configures underlying frame buffers for incoming frames. </p>
-<p>If the application doesn't want to drop frames, then the <code>max_buffered_frames</code> should be chosen such that inter-frame processing time variability won't overrun the input buffer. If the buffer is overfilled, then frames will be dropped. The application can detect this by examining the timestamp on returned frames. If <code><a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#a601dfa7dc958d6e0e33a667fe98cf087" title="Configures underlying frame buffers for incoming frames.">Configure()</a></code> is not used, default settings will be used.</p>
+<p>If the application doesn't want to drop frames, then the <code>PP_MEDIASTREAMAUDIOTRACK_ATTRIB_BUFFERED_FRAMES</code> should be chosen such that inter-frame processing time variability won't overrun the input buffer. If the buffer is overfilled, then frames will be dropped. The application can detect this by examining the timestamp on returned frames. If <code><a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#a73f0f222f60ceed5f662ef3db7dee21b" title="Configures underlying frame buffers for incoming frames.">Configure()</a></code> is not called, default settings will be used. Example usage from plugin code: </p>
+<div class="fragment"><pre class="fragment"> int32_t attribs[] = {
+     <a class="code" href="group___enums.html#gga2f729c238ba74adc778c0d0bc17c453fafd82a0ca09456944d9966cd25987ce38" title="The maximum number of frames to hold in the input buffer.">PP_MEDIASTREAMAUDIOTRACK_ATTRIB_BUFFERED_FRAMES</a>, 4,
+     <a class="code" href="group___enums.html#gga2f729c238ba74adc778c0d0bc17c453fa13c3fa0a2740301acda8b218bac8b972" title="The duration of audio frames in milliseconds.">PP_MEDIASTREAMAUDIOTRACK_ATTRIB_DURATION</a>, 10,
+     <a class="code" href="group___enums.html#gga2f729c238ba74adc778c0d0bc17c453fa5f1f0d353fe407fe10ac3c0e908aba4f" title="Attribute list terminator.">PP_MEDIASTREAMAUDIOTRACK_ATTRIB_NONE</a>};
+ track_if-&gt;Configure(track, attribs, callback);
+</pre></div><dl class="params"><dt><b>Parameters:</b></dt><dd>
+<table class="params">
+<tr><td class="paramdir">[in]</td><td class="paramname">audio_track</td><td>A <code>PP_Resource</code> corresponding to an audio resource. </td></tr>
+<tr><td class="paramdir">[in]</td><td class="paramname">attrib_list</td><td>A list of attribute name-value pairs in which each attribute is immediately followed by the corresponding desired value. The list is terminated by <code>PP_MEDIASTREAMAUDIOTRACK_ATTRIB_NONE</code>. </td></tr>
+<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>A <code><a class="el" href="struct_p_p___completion_callback.html" title="PP_CompletionCallback is a common mechanism for supporting potentially asynchronous calls in browser ...">PP_CompletionCallback</a></code> to be called upon completion of <code><a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#a73f0f222f60ceed5f662ef3db7dee21b" title="Configures underlying frame buffers for incoming frames.">Configure()</a></code>.</td></tr>
+</table>
+</dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>An int32_t containing a result code from <code><a class="el" href="pp__errors_8h.html" title="This file defines an enumeration of all PPAPI error codes.">pp_errors.h</a></code>. </dd></dl>
+</div>
+</div>
+<a class="anchor" id="a3ad96bc4cd30dd580871a789a749819c"></a><!-- doxytag: member="PPB_MediaStreamAudioTrack::GetAttrib" ref="a3ad96bc4cd30dd580871a789a749819c" args=")(PP_Resource audio_track, PP_MediaStreamAudioTrack_Attrib attrib, int32_t *value)" -->
+<div class="memitem">
+<div class="memproto">
+<table class="memname">
+<tr>
+<td class="memname">int32_t(* <a class="el" href="struct_p_p_b___media_stream_audio_track__0__1.html#a3ad96bc4cd30dd580871a789a749819c">PPB_MediaStreamAudioTrack::GetAttrib</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> audio_track, <a class="el" href="group___enums.html#ga2f729c238ba74adc778c0d0bc17c453f">PP_MediaStreamAudioTrack_Attrib</a> attrib, int32_t *value)</td>
+</tr>
+</table>
+</div>
+<div class="memdoc">
+<p>Gets attribute value for a given attribute name. </p>
 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 <table class="params">
 <tr><td class="paramdir">[in]</td><td class="paramname">audio_track</td><td>A <code>PP_Resource</code> corresponding to an audio resource. </td></tr>
-<tr><td class="paramdir">[in]</td><td class="paramname">samples_per_frame</td><td>The number of audio samples in an audio frame. </td></tr>
-<tr><td class="paramdir">[in]</td><td class="paramname">max_buffered_frames</td><td>The maximum number of audio frames to hold in the input buffer.</td></tr>
+<tr><td class="paramdir">[in]</td><td class="paramname">attrib</td><td>A <code>PP_MediaStreamAudioTrack_Attrib</code> for querying. </td></tr>
+<tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>A int32_t for storing the attribute value on success. Otherwise, the value will not be changed.</td></tr>
 </table>
 </dd>
 </dl>
@@ -172,4 +202,5 @@ Data Fields</h2><table class="memberdecls">
 <li><a class="el" href="ppb__media__stream__audio__track_8h.html">ppb_media_stream_audio_track.h</a></li>
 </ul>
 </div><!-- contents -->
+</div>
 {{/partials.standard_nacl_article}}