mix_video/docs/reference/MixVideo/html/MixVideoFrame.html - platform/hardware/intel/common/libmix - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>MixVideoFrame</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
 <link rel="home" href="index.html" title="Mi-X Video Reference Manual">
 <link rel="up" href="ch01.html" title="MI-X Video API">
 <link rel="prev" href="MixBuffer.html" title="MixBuffer">
 <link rel="next" href="MixVideoConfigParams.html" title="MixVideoConfigParams">
 <meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 <link rel="chapter" href="ch01.html" title="MI-X Video API">
 <link rel="chapter" href="object-tree.html" title="Object Hierarchy">
 <link rel="index" href="api-index-full.html" title="API Index">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 <tr valign="middle">
 <td><a accesskey="p" href="MixBuffer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 <th width="100%" align="center">Mi-X Video Reference Manual</th>
 <td><a accesskey="n" href="MixVideoConfigParams.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 </tr>
 <tr><td colspan="5" class="shortcuts">
 <a href="#MixVideoFrame.synopsis" class="shortcut">Top</a>
                  |
                 <a href="#MixVideoFrame.description" class="shortcut">Description</a>
                  |
                 <a href="#MixVideoFrame.object-hierarchy" class="shortcut">Object Hierarchy</a>
 </td></tr>
 </table>
 <div class="refentry" title="MixVideoFrame">
 <a name="MixVideoFrame"></a><div class="titlepage"></div>
 <div class="refnamediv"><table width="100%"><tr>
 <td valign="top">
 <h2><span class="refentrytitle"><a name="MixVideoFrame.top_of_page"></a>MixVideoFrame</span></h2>
 <p>MixVideoFrame — MI-X Video Frame Object</p>
 </td>
 <td valign="top" align="right"></td>
 </tr></table></div>
 <div class="refsynopsisdiv" title="Synopsis">
 <a name="MixVideoFrame.synopsis"></a><h2>Synopsis</h2>
 <pre class="synopsis">
                     <a class="link" href="MixVideoFrame.html#MixVideoFrame-struct" title="MixVideoFrame">MixVideoFrame</a>;
 <a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *     <a class="link" href="MixVideoFrame.html#mix-videoframe-new" title="mix_videoframe_new ()">mix_videoframe_new</a>                  (void);
 <a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *     <a class="link" href="MixVideoFrame.html#mix-videoframe-ref" title="mix_videoframe_ref ()">mix_videoframe_ref</a>                  (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj);
 void                <a class="link" href="MixVideoFrame.html#mix-videoframe-unref" title="mix_videoframe_unref ()">mix_videoframe_unref</a>                (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj);
 MIX_RESULT          <a class="link" href="MixVideoFrame.html#mix-videoframe-set-frame-id" title="mix_videoframe_set_frame_id ()">mix_videoframe_set_frame_id</a>         (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          ulong frame_id);
 MIX_RESULT          <a class="link" href="MixVideoFrame.html#mix-videoframe-get-frame-id" title="mix_videoframe_get_frame_id ()">mix_videoframe_get_frame_id</a>         (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          ulong *frame_id);
 MIX_RESULT          <a class="link" href="MixVideoFrame.html#mix-videoframe-set-ci-frame-idx" title="mix_videoframe_set_ci_frame_idx ()">mix_videoframe_set_ci_frame_idx</a>     (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          uint ci_frame_idx);
 MIX_RESULT          <a class="link" href="MixVideoFrame.html#mix-videoframe-get-ci-frame-idx" title="mix_videoframe_get_ci_frame_idx ()">mix_videoframe_get_ci_frame_idx</a>     (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          uint *ci_frame_idx);
 MIX_RESULT          <a class="link" href="MixVideoFrame.html#mix-videoframe-set-timestamp" title="mix_videoframe_set_timestamp ()">mix_videoframe_set_timestamp</a>        (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          uint64 timestamp);
 MIX_RESULT          <a class="link" href="MixVideoFrame.html#mix-videoframe-get-timestamp" title="mix_videoframe_get_timestamp ()">mix_videoframe_get_timestamp</a>        (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          uint64 *timestamp);
 MIX_RESULT          <a class="link" href="MixVideoFrame.html#mix-videoframe-set-discontinuity" title="mix_videoframe_set_discontinuity ()">mix_videoframe_set_discontinuity</a>    (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          bool discontinuity);
 MIX_RESULT          <a class="link" href="MixVideoFrame.html#mix-videoframe-get-discontinuity" title="mix_videoframe_get_discontinuity ()">mix_videoframe_get_discontinuity</a>    (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          bool *discontinuity);
 </pre>
 </div>
 <div class="refsect1" title="Object Hierarchy">
 <a name="MixVideoFrame.object-hierarchy"></a><h2>Object Hierarchy</h2>
 <pre class="synopsis">
   MixParams
    +----MixVideoFrame
 </pre>
 </div>
 <div class="refsect1" title="Description">
 <a name="MixVideoFrame.description"></a><h2>Description</h2>
 <p>
 </p>
 <p>
 The MixVideoFrame object will be created by
 MixVideo and provided to the MMF/App in the
 MixVideo <a class="link" href="MixVideo.html#mix-video-get-frame" title="mix_video_get_frame ()"><code class="function">mix_video_get_frame()</code></a> function.
 </p>
 <p>
 </p>
 <p>
 <a class="link" href="MixVideo.html#mix-video-release-frame" title="mix_video_release_frame ()"><code class="function">mix_video_release_frame()</code></a> must be used
 to release frame object returned from
 <a class="link" href="MixVideo.html#mix-video-get-frame" title="mix_video_get_frame ()"><code class="function">mix_video_get_frame()</code></a>. Caller must not
 use <a class="link" href="MixVideoFrame.html#mix-videoframe-ref" title="mix_videoframe_ref ()"><code class="function">mix_videoframe_ref()</code></a> or <a class="link" href="MixVideoFrame.html#mix-videoframe-unref" title="mix_videoframe_unref ()"><code class="function">mix_videoframe_unref()</code></a>
 or adjust the reference count directly in any way.
 This object can be supplied in the <a class="link" href="MixVideo.html#mix-video-render" title="mix_video_render ()"><code class="function">mix_video_render()</code></a>
 function to render the associated video frame.
 The MMF/App can release this object when it no longer
 needs to display/re-display this frame.
 </p>
 </div>
 <div class="refsect1" title="Details">
 <a name="MixVideoFrame.details"></a><h2>Details</h2>
 <div class="refsect2" title="MixVideoFrame">
 <a name="MixVideoFrame-struct"></a><h3>MixVideoFrame</h3>
 <pre class="programlisting">typedef struct {
 	MixParams parent;


 	/* ID associated with the decoded frame */
 	ulong frame_id;

 	/* ID associated with the CI frame
 	 * (used for encode only) */
 	uint ci_frame_idx;

 	/* 64 bit timestamp. For decode,
 	 * this is preserved from the corresponding
 	 * MixVideoDecodeParams field. For encode,
 	 * this is created during encoding. */
 	uint64 timestamp;

 	/* Flag indicating whether there
 	 * is a discontinuity. For decode,
 	 * this is preserved from the corresponding
 	 * MixVideoDecodeParams field. */
 	bool discontinuity;

 	/* Reserved for future use */
 	void *reserved1;

 	/* Reserved for future use */
 	void *reserved2;

 	/* Reserved for future use */
 	void *reserved3;

 	/* Reserved for future use */
 	void *reserved4;
 } MixVideoFrame;
 </pre>
 <p>
 MI-X VideoConfig Parameter object</p>
 </div>
 <hr>
 <div class="refsect2" title="mix_videoframe_new ()">
 <a name="mix-videoframe-new"></a><h3>mix_videoframe_new ()</h3>
 <pre class="programlisting"><a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *     mix_videoframe_new                  (void);</pre>
 <p>
 Use this method to create new instance of <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a></p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
 <tbody><tr>
 <td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
 <td> A newly allocated instance of <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a>
 </td>
 </tr></tbody>
 </table></div>
 </div>
 <hr>
 <div class="refsect2" title="mix_videoframe_ref ()">
 <a name="mix-videoframe-ref"></a><h3>mix_videoframe_ref ()</h3>
 <pre class="programlisting"><a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *     mix_videoframe_ref                  (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj);</pre>
 <p>
 Add reference count.</p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
 <tbody>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>mix</code></em> :</span></p></td>
 <td> object to add reference
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
 <td> the <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> instance where reference count has been increased.
 </td>
 </tr>
 </tbody>
 </table></div>
 </div>
 <hr>
 <div class="refsect2" title="mix_videoframe_unref ()">
 <a name="mix-videoframe-unref"></a><h3>mix_videoframe_unref ()</h3>
 <pre class="programlisting">void                mix_videoframe_unref                (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj);</pre>
 <p>
 Decrement reference count of the object.</p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
 <tbody><tr>
 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 <td> object to unref.
 </td>
 </tr></tbody>
 </table></div>
 </div>
 <hr>
 <div class="refsect2" title="mix_videoframe_set_frame_id ()">
 <a name="mix-videoframe-set-frame-id"></a><h3>mix_videoframe_set_frame_id ()</h3>
 <pre class="programlisting">MIX_RESULT          mix_videoframe_set_frame_id         (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          ulong frame_id);</pre>
 <p>
 Set Frame ID</p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
 <tbody>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>frame_id</code></em> :</span></p></td>
 <td> ID associated with the decoded frame
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
 </td>
 </tr>
 </tbody>
 </table></div>
 </div>
 <hr>
 <div class="refsect2" title="mix_videoframe_get_frame_id ()">
 <a name="mix-videoframe-get-frame-id"></a><h3>mix_videoframe_get_frame_id ()</h3>
 <pre class="programlisting">MIX_RESULT          mix_videoframe_get_frame_id         (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          ulong *frame_id);</pre>
 <p>
 Get Frame ID</p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
 <tbody>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>frame_id</code></em> :</span></p></td>
 <td> frame ID to be returned
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
 </td>
 </tr>
 </tbody>
 </table></div>
 </div>
 <hr>
 <div class="refsect2" title="mix_videoframe_set_ci_frame_idx ()">
 <a name="mix-videoframe-set-ci-frame-idx"></a><h3>mix_videoframe_set_ci_frame_idx ()</h3>
 <pre class="programlisting">MIX_RESULT          mix_videoframe_set_ci_frame_idx     (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          uint ci_frame_idx);</pre>
 <p>
 Set CI Frame ID</p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
 <tbody>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>ci_frame_idx</code></em> :</span></p></td>
 <td> ID associated with the CI frame (used for encode only)
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
 </td>
 </tr>
 </tbody>
 </table></div>
 </div>
 <hr>
 <div class="refsect2" title="mix_videoframe_get_ci_frame_idx ()">
 <a name="mix-videoframe-get-ci-frame-idx"></a><h3>mix_videoframe_get_ci_frame_idx ()</h3>
 <pre class="programlisting">MIX_RESULT          mix_videoframe_get_ci_frame_idx     (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          uint *ci_frame_idx);</pre>
 <p>
 Get CI Frame ID</p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
 <tbody>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>ci_frame_idx</code></em> :</span></p></td>
 <td> CI Frame ID to be returned
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
 </td>
 </tr>
 </tbody>
 </table></div>
 </div>
 <hr>
 <div class="refsect2" title="mix_videoframe_set_timestamp ()">
 <a name="mix-videoframe-set-timestamp"></a><h3>mix_videoframe_set_timestamp ()</h3>
 <pre class="programlisting">MIX_RESULT          mix_videoframe_set_timestamp        (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          uint64 timestamp);</pre>
 <p>
 Set Frame timestamp</p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
 <tbody>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
 <td> Frame timestamp
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
 </td>
 </tr>
 </tbody>
 </table></div>
 </div>
 <hr>
 <div class="refsect2" title="mix_videoframe_get_timestamp ()">
 <a name="mix-videoframe-get-timestamp"></a><h3>mix_videoframe_get_timestamp ()</h3>
 <pre class="programlisting">MIX_RESULT          mix_videoframe_get_timestamp        (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          uint64 *timestamp);</pre>
 <p>
 Get Frame timestamp</p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
 <tbody>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
 <td> Frame timestamp to be returned
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
 </td>
 </tr>
 </tbody>
 </table></div>
 </div>
 <hr>
 <div class="refsect2" title="mix_videoframe_set_discontinuity ()">
 <a name="mix-videoframe-set-discontinuity"></a><h3>mix_videoframe_set_discontinuity ()</h3>
 <pre class="programlisting">MIX_RESULT          mix_videoframe_set_discontinuity    (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          bool discontinuity);</pre>
 <p>
 Get discontinuity flag</p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
 <tbody>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>discontinuity</code></em> :</span></p></td>
 <td> Discontinuity flag
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
 </td>
 </tr>
 </tbody>
 </table></div>
 </div>
 <hr>
 <div class="refsect2" title="mix_videoframe_get_discontinuity ()">
 <a name="mix-videoframe-get-discontinuity"></a><h3>mix_videoframe_get_discontinuity ()</h3>
 <pre class="programlisting">MIX_RESULT          mix_videoframe_get_discontinuity    (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
                                                          bool *discontinuity);</pre>
 <p>
 Get discontinuity flag</p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
 <tbody>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>discontinuity</code></em> :</span></p></td>
 <td> Discontinuity flag to be returned
 </td>
 </tr>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
 <td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
 </td>
 </tr>
 </tbody>
 </table></div>
 </div>
 </div>
 </div>
 <div class="footer">
 <hr>
           Generated by GTK-Doc V1.11</div>
 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
	<html>
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<title>MixVideoFrame</title>
	<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
	<link rel="home" href="index.html" title="Mi-X Video Reference Manual">
	<link rel="up" href="ch01.html" title="MI-X Video API">
	<link rel="prev" href="MixBuffer.html" title="MixBuffer">
	<link rel="next" href="MixVideoConfigParams.html" title="MixVideoConfigParams">
	<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
	<link rel="stylesheet" href="style.css" type="text/css">
	<link rel="chapter" href="ch01.html" title="MI-X Video API">
	<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
	<link rel="index" href="api-index-full.html" title="API Index">
	</head>
	<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
	<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
	<tr valign="middle">
	<td><a accesskey="p" href="MixBuffer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
	<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
	<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
	<th width="100%" align="center">Mi-X Video Reference Manual</th>
	<td><a accesskey="n" href="MixVideoConfigParams.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
	</tr>
	<tr><td colspan="5" class="shortcuts">
	<a href="#MixVideoFrame.synopsis" class="shortcut">Top</a>
	\|
	<a href="#MixVideoFrame.description" class="shortcut">Description</a>
	\|
	<a href="#MixVideoFrame.object-hierarchy" class="shortcut">Object Hierarchy</a>
	</td></tr>
	</table>
	<div class="refentry" title="MixVideoFrame">
	<a name="MixVideoFrame"></a><div class="titlepage"></div>
	<div class="refnamediv"><table width="100%"><tr>
	<td valign="top">
	<h2><span class="refentrytitle"><a name="MixVideoFrame.top_of_page"></a>MixVideoFrame</span></h2>
	<p>MixVideoFrame — MI-X Video Frame Object</p>
	</td>
	<td valign="top" align="right"></td>
	</tr></table></div>
	<div class="refsynopsisdiv" title="Synopsis">
	<a name="MixVideoFrame.synopsis"></a><h2>Synopsis</h2>
	<pre class="synopsis">
	<a class="link" href="MixVideoFrame.html#MixVideoFrame-struct" title="MixVideoFrame">MixVideoFrame</a>;
	<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> * <a class="link" href="MixVideoFrame.html#mix-videoframe-new" title="mix_videoframe_new ()">mix_videoframe_new</a> (void);
	<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> * <a class="link" href="MixVideoFrame.html#mix-videoframe-ref" title="mix_videoframe_ref ()">mix_videoframe_ref</a> (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj);
	void <a class="link" href="MixVideoFrame.html#mix-videoframe-unref" title="mix_videoframe_unref ()">mix_videoframe_unref</a> (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj);
	MIX_RESULT <a class="link" href="MixVideoFrame.html#mix-videoframe-set-frame-id" title="mix_videoframe_set_frame_id ()">mix_videoframe_set_frame_id</a> (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	ulong frame_id);
	MIX_RESULT <a class="link" href="MixVideoFrame.html#mix-videoframe-get-frame-id" title="mix_videoframe_get_frame_id ()">mix_videoframe_get_frame_id</a> (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	ulong *frame_id);
	MIX_RESULT <a class="link" href="MixVideoFrame.html#mix-videoframe-set-ci-frame-idx" title="mix_videoframe_set_ci_frame_idx ()">mix_videoframe_set_ci_frame_idx</a> (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	uint ci_frame_idx);
	MIX_RESULT <a class="link" href="MixVideoFrame.html#mix-videoframe-get-ci-frame-idx" title="mix_videoframe_get_ci_frame_idx ()">mix_videoframe_get_ci_frame_idx</a> (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	uint *ci_frame_idx);
	MIX_RESULT <a class="link" href="MixVideoFrame.html#mix-videoframe-set-timestamp" title="mix_videoframe_set_timestamp ()">mix_videoframe_set_timestamp</a> (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	uint64 timestamp);
	MIX_RESULT <a class="link" href="MixVideoFrame.html#mix-videoframe-get-timestamp" title="mix_videoframe_get_timestamp ()">mix_videoframe_get_timestamp</a> (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	uint64 *timestamp);
	MIX_RESULT <a class="link" href="MixVideoFrame.html#mix-videoframe-set-discontinuity" title="mix_videoframe_set_discontinuity ()">mix_videoframe_set_discontinuity</a> (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	bool discontinuity);
	MIX_RESULT <a class="link" href="MixVideoFrame.html#mix-videoframe-get-discontinuity" title="mix_videoframe_get_discontinuity ()">mix_videoframe_get_discontinuity</a> (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	bool *discontinuity);
	</pre>
	</div>
	<div class="refsect1" title="Object Hierarchy">
	<a name="MixVideoFrame.object-hierarchy"></a><h2>Object Hierarchy</h2>
	<pre class="synopsis">
	MixParams
	+----MixVideoFrame
	</pre>
	</div>
	<div class="refsect1" title="Description">
	<a name="MixVideoFrame.description"></a><h2>Description</h2>
	<p>
	</p>
	<p>
	The MixVideoFrame object will be created by
	MixVideo and provided to the MMF/App in the
	MixVideo <a class="link" href="MixVideo.html#mix-video-get-frame" title="mix_video_get_frame ()"><code class="function">mix_video_get_frame()</code></a> function.
	</p>
	<p>
	</p>
	<p>
	<a class="link" href="MixVideo.html#mix-video-release-frame" title="mix_video_release_frame ()"><code class="function">mix_video_release_frame()</code></a> must be used
	to release frame object returned from
	<a class="link" href="MixVideo.html#mix-video-get-frame" title="mix_video_get_frame ()"><code class="function">mix_video_get_frame()</code></a>. Caller must not
	use <a class="link" href="MixVideoFrame.html#mix-videoframe-ref" title="mix_videoframe_ref ()"><code class="function">mix_videoframe_ref()</code></a> or <a class="link" href="MixVideoFrame.html#mix-videoframe-unref" title="mix_videoframe_unref ()"><code class="function">mix_videoframe_unref()</code></a>
	or adjust the reference count directly in any way.
	This object can be supplied in the <a class="link" href="MixVideo.html#mix-video-render" title="mix_video_render ()"><code class="function">mix_video_render()</code></a>
	function to render the associated video frame.
	The MMF/App can release this object when it no longer
	needs to display/re-display this frame.
	</p>
	</div>
	<div class="refsect1" title="Details">
	<a name="MixVideoFrame.details"></a><h2>Details</h2>
	<div class="refsect2" title="MixVideoFrame">
	<a name="MixVideoFrame-struct"></a><h3>MixVideoFrame</h3>
	<pre class="programlisting">typedef struct {
	MixParams parent;


	/* ID associated with the decoded frame */
	ulong frame_id;

	/* ID associated with the CI frame
	* (used for encode only) */
	uint ci_frame_idx;

	/* 64 bit timestamp. For decode,
	* this is preserved from the corresponding
	* MixVideoDecodeParams field. For encode,
	* this is created during encoding. */
	uint64 timestamp;

	/* Flag indicating whether there
	* is a discontinuity. For decode,
	* this is preserved from the corresponding
	* MixVideoDecodeParams field. */
	bool discontinuity;

	/* Reserved for future use */
	void *reserved1;

	/* Reserved for future use */
	void *reserved2;

	/* Reserved for future use */
	void *reserved3;

	/* Reserved for future use */
	void *reserved4;
	} MixVideoFrame;
	</pre>
	<p>
	MI-X VideoConfig Parameter object</p>
	</div>
	<hr>
	<div class="refsect2" title="mix_videoframe_new ()">
	<a name="mix-videoframe-new"></a><h3>mix_videoframe_new ()</h3>
	<pre class="programlisting"><a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> * mix_videoframe_new (void);</pre>
	<p>
	Use this method to create new instance of <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a></p>
	<div class="variablelist"><table border="0">
	<col align="left" valign="top">
	<tbody><tr>
	<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
	<td> A newly allocated instance of <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a>
	</td>
	</tr></tbody>
	</table></div>
	</div>
	<hr>
	<div class="refsect2" title="mix_videoframe_ref ()">
	<a name="mix-videoframe-ref"></a><h3>mix_videoframe_ref ()</h3>
	<pre class="programlisting"><a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> * mix_videoframe_ref (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj);</pre>
	<p>
	Add reference count.</p>
	<div class="variablelist"><table border="0">
	<col align="left" valign="top">
	<tbody>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>mix</code></em> :</span></p></td>
	<td> object to add reference
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
	<td> the <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> instance where reference count has been increased.
	</td>
	</tr>
	</tbody>
	</table></div>
	</div>
	<hr>
	<div class="refsect2" title="mix_videoframe_unref ()">
	<a name="mix-videoframe-unref"></a><h3>mix_videoframe_unref ()</h3>
	<pre class="programlisting">void mix_videoframe_unref (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj);</pre>
	<p>
	Decrement reference count of the object.</p>
	<div class="variablelist"><table border="0">
	<col align="left" valign="top">
	<tbody><tr>
	<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
	<td> object to unref.
	</td>
	</tr></tbody>
	</table></div>
	</div>
	<hr>
	<div class="refsect2" title="mix_videoframe_set_frame_id ()">
	<a name="mix-videoframe-set-frame-id"></a><h3>mix_videoframe_set_frame_id ()</h3>
	<pre class="programlisting">MIX_RESULT mix_videoframe_set_frame_id (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	ulong frame_id);</pre>
	<p>
	Set Frame ID</p>
	<div class="variablelist"><table border="0">
	<col align="left" valign="top">
	<tbody>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>frame_id</code></em> :</span></p></td>
	<td> ID associated with the decoded frame
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
	</td>
	</tr>
	</tbody>
	</table></div>
	</div>
	<hr>
	<div class="refsect2" title="mix_videoframe_get_frame_id ()">
	<a name="mix-videoframe-get-frame-id"></a><h3>mix_videoframe_get_frame_id ()</h3>
	<pre class="programlisting">MIX_RESULT mix_videoframe_get_frame_id (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	ulong *frame_id);</pre>
	<p>
	Get Frame ID</p>
	<div class="variablelist"><table border="0">
	<col align="left" valign="top">
	<tbody>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>frame_id</code></em> :</span></p></td>
	<td> frame ID to be returned
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
	</td>
	</tr>
	</tbody>
	</table></div>
	</div>
	<hr>
	<div class="refsect2" title="mix_videoframe_set_ci_frame_idx ()">
	<a name="mix-videoframe-set-ci-frame-idx"></a><h3>mix_videoframe_set_ci_frame_idx ()</h3>
	<pre class="programlisting">MIX_RESULT mix_videoframe_set_ci_frame_idx (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	uint ci_frame_idx);</pre>
	<p>
	Set CI Frame ID</p>
	<div class="variablelist"><table border="0">
	<col align="left" valign="top">
	<tbody>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>ci_frame_idx</code></em> :</span></p></td>
	<td> ID associated with the CI frame (used for encode only)
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
	</td>
	</tr>
	</tbody>
	</table></div>
	</div>
	<hr>
	<div class="refsect2" title="mix_videoframe_get_ci_frame_idx ()">
	<a name="mix-videoframe-get-ci-frame-idx"></a><h3>mix_videoframe_get_ci_frame_idx ()</h3>
	<pre class="programlisting">MIX_RESULT mix_videoframe_get_ci_frame_idx (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	uint *ci_frame_idx);</pre>
	<p>
	Get CI Frame ID</p>
	<div class="variablelist"><table border="0">
	<col align="left" valign="top">
	<tbody>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>ci_frame_idx</code></em> :</span></p></td>
	<td> CI Frame ID to be returned
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
	</td>
	</tr>
	</tbody>
	</table></div>
	</div>
	<hr>
	<div class="refsect2" title="mix_videoframe_set_timestamp ()">
	<a name="mix-videoframe-set-timestamp"></a><h3>mix_videoframe_set_timestamp ()</h3>
	<pre class="programlisting">MIX_RESULT mix_videoframe_set_timestamp (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	uint64 timestamp);</pre>
	<p>
	Set Frame timestamp</p>
	<div class="variablelist"><table border="0">
	<col align="left" valign="top">
	<tbody>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
	<td> Frame timestamp
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
	</td>
	</tr>
	</tbody>
	</table></div>
	</div>
	<hr>
	<div class="refsect2" title="mix_videoframe_get_timestamp ()">
	<a name="mix-videoframe-get-timestamp"></a><h3>mix_videoframe_get_timestamp ()</h3>
	<pre class="programlisting">MIX_RESULT mix_videoframe_get_timestamp (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	uint64 *timestamp);</pre>
	<p>
	Get Frame timestamp</p>
	<div class="variablelist"><table border="0">
	<col align="left" valign="top">
	<tbody>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
	<td> Frame timestamp to be returned
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
	</td>
	</tr>
	</tbody>
	</table></div>
	</div>
	<hr>
	<div class="refsect2" title="mix_videoframe_set_discontinuity ()">
	<a name="mix-videoframe-set-discontinuity"></a><h3>mix_videoframe_set_discontinuity ()</h3>
	<pre class="programlisting">MIX_RESULT mix_videoframe_set_discontinuity (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	bool discontinuity);</pre>
	<p>
	Get discontinuity flag</p>
	<div class="variablelist"><table border="0">
	<col align="left" valign="top">
	<tbody>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>discontinuity</code></em> :</span></p></td>
	<td> Discontinuity flag
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
	</td>
	</tr>
	</tbody>
	</table></div>
	</div>
	<hr>
	<div class="refsect2" title="mix_videoframe_get_discontinuity ()">
	<a name="mix-videoframe-get-discontinuity"></a><h3>mix_videoframe_get_discontinuity ()</h3>
	<pre class="programlisting">MIX_RESULT mix_videoframe_get_discontinuity (<a class="link" href="MixVideoFrame.html" title="MixVideoFrame">MixVideoFrame</a> *obj,
	bool *discontinuity);</pre>
	<p>
	Get discontinuity flag</p>
	<div class="variablelist"><table border="0">
	<col align="left" valign="top">
	<tbody>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideoFrame.html" title="MixVideoFrame"><span class="type">MixVideoFrame</span></a> object
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>discontinuity</code></em> :</span></p></td>
	<td> Discontinuity flag to be returned
	</td>
	</tr>
	<tr>
	<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
	<td> <a class="link" href="MixVideo-mixvideodef.html" title="MI-X Video Data Definitons And Common Error Code">Common Video Error Return Codes</a>
	</td>
	</tr>
	</tbody>
	</table></div>
	</div>
	</div>
	</div>
	<div class="footer">
	<hr>
	Generated by GTK-Doc V1.11</div>
	</body>
	</html>