<!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.8"/>
<title>OpenMAXBellagio: OpenMAX IL core</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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">OpenMAXBellagio
 <span id="projectnumber">0.9.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__core.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">OpenMAX IL core</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__tun"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tun.html">Tunneling</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__cp"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cp.html">Content Pipes</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_m_x___c_o_m_p_o_n_e_n_t_r_e_g_i_s_t_e_r_t_y_p_e.html">OMX_COMPONENTREGISTERTYPE</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga51a1f485743fe5bf8df04de53bb27bdc"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__core.html#ga866121e7689263734cbaef7f2946efca">OMX_COMMANDTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__core.html#ga51a1f485743fe5bf8df04de53bb27bdc">OMX_COMMANDTYPE</a></td></tr>
<tr class="separator:ga51a1f485743fe5bf8df04de53bb27bdc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaece6c79f30a90c67bd48b3df7fad3cdf"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__core.html#gaece6c79f30a90c67bd48b3df7fad3cdf">OMX_COMPONENTINITTYPE</a> )(<a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a7b426d7bc825bf8a56ee39dc3c217af7">OMX_HANDLETYPE</a> hComponent)</td></tr>
<tr class="separator:gaece6c79f30a90c67bd48b3df7fad3cdf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga39c9f1b6bd8918b139d17c477cb1c0bf"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak" />
<a class="el" href="struct_o_m_x___c_o_m_p_o_n_e_n_t_r_e_g_i_s_t_e_r_t_y_p_e.html">OMX_COMPONENTREGISTERTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__core.html#ga39c9f1b6bd8918b139d17c477cb1c0bf">OMX_COMPONENTREGISTERTYPE</a></td></tr>
<tr class="separator:ga39c9f1b6bd8918b139d17c477cb1c0bf"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga866121e7689263734cbaef7f2946efca"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__core.html#ga866121e7689263734cbaef7f2946efca">OMX_COMMANDTYPE</a> { <br />
  <a class="el" href="group__core.html#gga866121e7689263734cbaef7f2946efcaa85c11df69b1c21d18a3e3b16f1179e9b">OMX_CommandStateSet</a>,
<a class="el" href="group__core.html#gga866121e7689263734cbaef7f2946efcaa8268f8530a473ee6f5b85c61993a1d4e">OMX_CommandFlush</a>,
<a class="el" href="group__core.html#gga866121e7689263734cbaef7f2946efcaa51f537c6205e087487c0d66d71c6761c">OMX_CommandPortDisable</a>,
<a class="el" href="group__core.html#gga866121e7689263734cbaef7f2946efcaa5c6246d6d245048e2fae5e31c210e55e">OMX_CommandPortEnable</a>,
<br />
  <a class="el" href="group__core.html#gga866121e7689263734cbaef7f2946efcaa219404995a94edc7704e9e14783dee4c">OMX_CommandMarkBuffer</a>,
<a class="el" href="group__core.html#gga866121e7689263734cbaef7f2946efcaa22b50871ddc023725f9a386e5ec4a45a">OMX_CommandKhronosExtensions</a> = 0x6F000000,
<a class="el" href="group__core.html#gga866121e7689263734cbaef7f2946efcaac0567610d2d7aebeeb37ccb205191f0b">OMX_CommandVendorStartUnused</a> = 0x7F000000,
<a class="el" href="group__core.html#gga866121e7689263734cbaef7f2946efcaa4e1499e008038e4921eb8623279fb649">OMX_CommandMax</a> = 0X7FFFFFFF
<br />
}</td></tr>
<tr class="separator:ga866121e7689263734cbaef7f2946efca"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac81e21bb18ce9bd985a933509a61884c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> <a class="el" href="_o_m_x___types_8h.html#a9b7491ee0c559eaba7416fe922882f65">OMX_APIENTRY</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__core.html#gac81e21bb18ce9bd985a933509a61884c">OMX_Init</a> (void)</td></tr>
<tr class="memdesc:gac81e21bb18ce9bd985a933509a61884c"><td class="mdescLeft"> </td><td class="mdescRight">The OMX_Init standard function. <a href="#gac81e21bb18ce9bd985a933509a61884c">More...</a><br /></td></tr>
<tr class="separator:gac81e21bb18ce9bd985a933509a61884c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga863300506af715fdf8b91f32bdcf553a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> <a class="el" href="_o_m_x___types_8h.html#a9b7491ee0c559eaba7416fe922882f65">OMX_APIENTRY</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__core.html#ga863300506af715fdf8b91f32bdcf553a">OMX_Deinit</a> (void)</td></tr>
<tr class="memdesc:ga863300506af715fdf8b91f32bdcf553a"><td class="mdescLeft"> </td><td class="mdescRight">The OMX_Deinit standard function. <a href="#ga863300506af715fdf8b91f32bdcf553a">More...</a><br /></td></tr>
<tr class="separator:ga863300506af715fdf8b91f32bdcf553a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4ef83dde46e3602f74c9a630c7d0a449"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> <a class="el" href="_o_m_x___types_8h.html#a9b7491ee0c559eaba7416fe922882f65">OMX_APIENTRY</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__core.html#ga4ef83dde46e3602f74c9a630c7d0a449">OMX_ComponentNameEnum</a> (<a class="el" href="_o_m_x___types_8h.html#ad6f8c05c2b49042f9051e1f3fce7b28c">OMX_OUT</a> <a class="el" href="_o_m_x___types_8h.html#a35830b439b00948006e5ef824fef715f">OMX_STRING</a> cComponentName, <a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a04983f4ca9c7876035dffc578597eae3">OMX_U32</a> nNameLength, <a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a04983f4ca9c7876035dffc578597eae3">OMX_U32</a> nIndex)</td></tr>
<tr class="separator:ga4ef83dde46e3602f74c9a630c7d0a449"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga911625211abe7e5726afceee0fd98d74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> <a class="el" href="_o_m_x___types_8h.html#a9b7491ee0c559eaba7416fe922882f65">OMX_APIENTRY</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__core.html#ga911625211abe7e5726afceee0fd98d74">OMX_GetHandle</a> (<a class="el" href="_o_m_x___types_8h.html#ad6f8c05c2b49042f9051e1f3fce7b28c">OMX_OUT</a> <a class="el" href="_o_m_x___types_8h.html#a7b426d7bc825bf8a56ee39dc3c217af7">OMX_HANDLETYPE</a> *pHandle, <a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a35830b439b00948006e5ef824fef715f">OMX_STRING</a> cComponentName, <a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a52f5626b11279ed9a6ce8731abc365be">OMX_PTR</a> pAppData, <a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="struct_o_m_x___c_a_l_l_b_a_c_k_t_y_p_e.html">OMX_CALLBACKTYPE</a> *pCallBacks)</td></tr>
<tr class="separator:ga911625211abe7e5726afceee0fd98d74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabdd0de6420415a359337e73381a7ddac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> <a class="el" href="_o_m_x___types_8h.html#a9b7491ee0c559eaba7416fe922882f65">OMX_APIENTRY</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__core.html#gabdd0de6420415a359337e73381a7ddac">OMX_FreeHandle</a> (<a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a7b426d7bc825bf8a56ee39dc3c217af7">OMX_HANDLETYPE</a> hComponent)</td></tr>
<tr class="separator:gabdd0de6420415a359337e73381a7ddac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga431fdec2b35dc0faee19225a786610bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__core.html#ga431fdec2b35dc0faee19225a786610bd">OMX_GetComponentsOfRole</a> (<a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a35830b439b00948006e5ef824fef715f">OMX_STRING</a> role, <a class="el" href="_o_m_x___types_8h.html#ae2413e67d24fdfc2c077685e84c53741">OMX_INOUT</a> <a class="el" href="_o_m_x___types_8h.html#a04983f4ca9c7876035dffc578597eae3">OMX_U32</a> *pNumComps, <a class="el" href="_o_m_x___types_8h.html#ae2413e67d24fdfc2c077685e84c53741">OMX_INOUT</a> <a class="el" href="_o_m_x___types_8h.html#a3ad7d812ff8ffb968c08e4b7bb04becd">OMX_U8</a> **compNames)</td></tr>
<tr class="separator:ga431fdec2b35dc0faee19225a786610bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga789b35e88446bbccbc8109b659cfd98d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__core.html#ga789b35e88446bbccbc8109b659cfd98d">OMX_GetRolesOfComponent</a> (<a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a35830b439b00948006e5ef824fef715f">OMX_STRING</a> compName, <a class="el" href="_o_m_x___types_8h.html#ae2413e67d24fdfc2c077685e84c53741">OMX_INOUT</a> <a class="el" href="_o_m_x___types_8h.html#a04983f4ca9c7876035dffc578597eae3">OMX_U32</a> *pNumRoles, <a class="el" href="_o_m_x___types_8h.html#ad6f8c05c2b49042f9051e1f3fce7b28c">OMX_OUT</a> <a class="el" href="_o_m_x___types_8h.html#a3ad7d812ff8ffb968c08e4b7bb04becd">OMX_U8</a> **roles)</td></tr>
<tr class="separator:ga789b35e88446bbccbc8109b659cfd98d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:gaf07808cc3e8c3950a0ac4b76d17cff9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_o_m_x___c_o_m_p_o_n_e_n_t_r_e_g_i_s_t_e_r_t_y_p_e.html">OMX_COMPONENTREGISTERTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__core.html#gaf07808cc3e8c3950a0ac4b76d17cff9e">OMX_ComponentRegistered</a> []</td></tr>
<tr class="separator:gaf07808cc3e8c3950a0ac4b76d17cff9e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>In the following we define groups that help building doxygen documentation Functions and structure related to the OMX IL core </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga51a1f485743fe5bf8df04de53bb27bdc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__core.html#ga866121e7689263734cbaef7f2946efca">OMX_COMMANDTYPE</a> <a class="el" href="group__core.html#ga866121e7689263734cbaef7f2946efca">OMX_COMMANDTYPE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="_o_m_x___core_8h.html">OMX_Core.h</a> - OpenMax IL version 1.1.2 The OMX_Core header file contains the definitions used by both the application and the component to access common items.The OMX_COMMANDTYPE enumeration is used to specify the action in the OMX_SendCommand macro. </p>
</div>
</div>
<a class="anchor" id="gaece6c79f30a90c67bd48b3df7fad3cdf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a>(* OMX_COMPONENTINITTYPE)(<a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a7b426d7bc825bf8a56ee39dc3c217af7">OMX_HANDLETYPE</a> hComponent)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_o_m_x___core_8h_source.html#l00260">260</a> of file <a class="el" href="_o_m_x___core_8h_source.html">OMX_Core.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga39c9f1b6bd8918b139d17c477cb1c0bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct_o_m_x___c_o_m_p_o_n_e_n_t_r_e_g_i_s_t_e_r_t_y_p_e.html">OMX_COMPONENTREGISTERTYPE</a> <a class="el" href="struct_o_m_x___c_o_m_p_o_n_e_n_t_r_e_g_i_s_t_e_r_t_y_p_e.html">OMX_COMPONENTREGISTERTYPE</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga866121e7689263734cbaef7f2946efca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__core.html#ga866121e7689263734cbaef7f2946efca">OMX_COMMANDTYPE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="_o_m_x___core_8h.html">OMX_Core.h</a> - OpenMax IL version 1.1.2 The OMX_Core header file contains the definitions used by both the application and the component to access common items.The OMX_COMMANDTYPE enumeration is used to specify the action in the OMX_SendCommand macro. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga866121e7689263734cbaef7f2946efcaa85c11df69b1c21d18a3e3b16f1179e9b"></a>OMX_CommandStateSet </td><td class="fielddoc">
<p>Change the component state </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga866121e7689263734cbaef7f2946efcaa8268f8530a473ee6f5b85c61993a1d4e"></a>OMX_CommandFlush </td><td class="fielddoc">
<p>Flush the data queue(s) of a component </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga866121e7689263734cbaef7f2946efcaa51f537c6205e087487c0d66d71c6761c"></a>OMX_CommandPortDisable </td><td class="fielddoc">
<p>Disable a port on a component. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga866121e7689263734cbaef7f2946efcaa5c6246d6d245048e2fae5e31c210e55e"></a>OMX_CommandPortEnable </td><td class="fielddoc">
<p>Enable a port on a component. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga866121e7689263734cbaef7f2946efcaa219404995a94edc7704e9e14783dee4c"></a>OMX_CommandMarkBuffer </td><td class="fielddoc">
<p>Mark a component/buffer for observation </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga866121e7689263734cbaef7f2946efcaa22b50871ddc023725f9a386e5ec4a45a"></a>OMX_CommandKhronosExtensions </td><td class="fielddoc">
<p>Reserved region for introducing Khronos Standard Extensions </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga866121e7689263734cbaef7f2946efcaac0567610d2d7aebeeb37ccb205191f0b"></a>OMX_CommandVendorStartUnused </td><td class="fielddoc">
<p>Reserved region for introducing Vendor Extensions </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga866121e7689263734cbaef7f2946efcaa4e1499e008038e4921eb8623279fb649"></a>OMX_CommandMax </td><td class="fielddoc">
</td></tr>
</table>
<p>Definition at line <a class="el" href="_o_m_x___core_8h_source.html#l00049">49</a> of file <a class="el" href="_o_m_x___core_8h_source.html">OMX_Core.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga4ef83dde46e3602f74c9a630c7d0a449"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> <a class="el" href="_o_m_x___types_8h.html#a9b7491ee0c559eaba7416fe922882f65">OMX_APIENTRY</a> OMX_ComponentNameEnum </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#ad6f8c05c2b49042f9051e1f3fce7b28c">OMX_OUT</a> <a class="el" href="_o_m_x___types_8h.html#a35830b439b00948006e5ef824fef715f">OMX_STRING</a> </td>
<td class="paramname"><em>cComponentName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a04983f4ca9c7876035dffc578597eae3">OMX_U32</a> </td>
<td class="paramname"><em>nNameLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a04983f4ca9c7876035dffc578597eae3">OMX_U32</a> </td>
<td class="paramname"><em>nIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The OMX_ComponentNameEnum method will enumerate through all the names of recognised valid components in the system. This function is provided as a means to detect all the components in the system run-time. There is no strict ordering to the enumeration order of component names, although each name will only be enumerated once. If the OMX core supports run-time installation of new components, it is only requried to detect newly installed components when the first call to enumerate component names is made (i.e. when nIndex is 0x0).</p>
<p>The core should return from this call in 20 msec.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">cComponentName</td><td>pointer to a null terminated string with the component name. The names of the components are strings less than 127 bytes in length plus the trailing null for a maximum size of 128 bytes. An example of a valid component name is "OMX.TI.AUDIO.DSP.MIXER\0". Names are assigned by the vendor, but shall start with "OMX." and then have the Vendor designation next. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nNameLength</td><td>number of characters in the cComponentName string. With all component name strings restricted to less than 128 characters (including the trailing null) it is recomended that the caller provide a input string for the cComponentName of 128 characters. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nIndex</td><td>number containing the enumeration index for the component. Multiple calls to OMX_ComponentNameEnum with increasing values of nIndex will enumerate through the component names in the system until OMX_ErrorNoMore is returned. The value of nIndex is 0 to (N-1), where N is the number of valid installed components in the system. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>OMX_ERRORTYPE If the command successfully executes, the return code will be OMX_ErrorNone. When the value of nIndex exceeds the number of components in the system minus 1, OMX_ErrorNoMore will be returned. Otherwise the appropriate OMX error will be returned. </dd></dl>
</div>
</div>
<a class="anchor" id="ga863300506af715fdf8b91f32bdcf553a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> <a class="el" href="_o_m_x___types_8h.html#a9b7491ee0c559eaba7416fe922882f65">OMX_APIENTRY</a> OMX_Deinit </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The OMX_Deinit standard function. </p>
<p>The OMX_Deinit method is used to deinitialize the OMX core. It shall be the last call made into OMX. In the event that the core determines that thare are components loaded when this call is made, the core may return with an error rather than try to unload the components.</p>
<p>The core should return from this call within 20 msec.</p>
<dl class="section return"><dt>Returns</dt><dd>OMX_ERRORTYPE If the command successfully executes, the return code will be OMX_ErrorNone. Otherwise the appropriate OMX error will be returned.</dd></dl>
<p>In this function the Deinit function for each component loader is performed </p>
<p>Definition at line <a class="el" href="omxcore_8c_source.html#l00123">123</a> of file <a class="el" href="omxcore_8c_source.html">omxcore.c</a>.</p>
<p>References <a class="el" href="component__loader_8h_source.html#l00062">BOSA_COMPONENTLOADER::BOSA_DeInitComponentLoader</a>, <a class="el" href="omx__comp__debug__levels_8h_source.html#l00059">DEB_LEV_FUNCTION_NAME</a>, <a class="el" href="omx__comp__debug__levels_8h_source.html#l00077">DEBUG</a>, and <a class="el" href="_o_m_x___core_8h_source.html#l00128">OMX_ErrorNone</a>.</p>
<p>Referenced by <a class="el" href="omxprioritytest_8c_source.html#l00075">main()</a>.</p>
</div>
</div>
<a class="anchor" id="gabdd0de6420415a359337e73381a7ddac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> <a class="el" href="_o_m_x___types_8h.html#a9b7491ee0c559eaba7416fe922882f65">OMX_APIENTRY</a> OMX_FreeHandle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a7b426d7bc825bf8a56ee39dc3c217af7">OMX_HANDLETYPE</a> </td>
<td class="paramname"><em>hComponent</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The OMX_FreeHandle method will free a handle allocated by the OMX_GetHandle method. If the component reference count goes to zero, the component will be unloaded from memory.</p>
<p>The core should return from this call within 20 msec when the component is in the OMX_StateLoaded state.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">hComponent</td><td>Handle of the component to be accessed. This is the component handle returned by the call to the GetHandle function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>OMX_ERRORTYPE If the command successfully executes, the return code will be OMX_ErrorNone. Otherwise the appropriate OMX error will be returned. </dd></dl>
<p>Referenced by <a class="el" href="omxaudiomixertest_8c_source.html#l00080">main()</a>.</p>
</div>
</div>
<a class="anchor" id="ga431fdec2b35dc0faee19225a786610bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> OMX_GetComponentsOfRole </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a35830b439b00948006e5ef824fef715f">OMX_STRING</a> </td>
<td class="paramname"><em>role</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#ae2413e67d24fdfc2c077685e84c53741">OMX_INOUT</a> <a class="el" href="_o_m_x___types_8h.html#a04983f4ca9c7876035dffc578597eae3">OMX_U32</a> * </td>
<td class="paramname"><em>pNumComps</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#ae2413e67d24fdfc2c077685e84c53741">OMX_INOUT</a> <a class="el" href="_o_m_x___types_8h.html#a3ad7d812ff8ffb968c08e4b7bb04becd">OMX_U8</a> ** </td>
<td class="paramname"><em>compNames</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The OMX_GetComponentsOfRole method will return the number of components that support the given role and (if the compNames field is non-NULL) the names of those components. The call will fail if an insufficiently sized array of names is supplied. To ensure the array is sufficiently sized the client should: first call this function with the compNames field NULL to determine the number of component names second call this function with the compNames field pointing to an array of names allocated according to the number returned by the first call.</p>
<p>The core should return from this call within 5 msec.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">role</td><td>This is generic standard component name consisting only of component class name and the type within that class (e.g. 'audio_decoder.aac'). </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">pNumComps</td><td>This is used both as input and output.</td></tr>
</table>
</dd>
</dl>
<p>If compNames is NULL, the input is ignored and the output specifies how many components support the given role.</p>
<p>If compNames is not NULL, on input it bounds the size of the input structure and on output, it specifies the number of components string names listed within the compNames parameter. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">compNames</td><td>If NULL this field is ignored. If non-NULL this points to an array of 128-byte strings which accepts a list of the names of all physical components that implement the specified standard component name. Each name is NULL terminated. numComps indicates the number of names. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga911625211abe7e5726afceee0fd98d74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> <a class="el" href="_o_m_x___types_8h.html#a9b7491ee0c559eaba7416fe922882f65">OMX_APIENTRY</a> OMX_GetHandle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#ad6f8c05c2b49042f9051e1f3fce7b28c">OMX_OUT</a> <a class="el" href="_o_m_x___types_8h.html#a7b426d7bc825bf8a56ee39dc3c217af7">OMX_HANDLETYPE</a> * </td>
<td class="paramname"><em>pHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a35830b439b00948006e5ef824fef715f">OMX_STRING</a> </td>
<td class="paramname"><em>cComponentName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a52f5626b11279ed9a6ce8731abc365be">OMX_PTR</a> </td>
<td class="paramname"><em>pAppData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="struct_o_m_x___c_a_l_l_b_a_c_k_t_y_p_e.html">OMX_CALLBACKTYPE</a> * </td>
<td class="paramname"><em>pCallBacks</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The OMX_GetHandle method will locate the component specified by the component name given, load that component into memory and then invoke the component's methods to create an instance of the component.</p>
<p>The core should return from this call within 20 msec.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">pHandle</td><td>pointer to an OMX_HANDLETYPE pointer to be filled in by this method. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cComponentName</td><td>pointer to a null terminated string with the component name. The names of the components are strings less than 127 bytes in length plus the trailing null for a maximum size of 128 bytes. An example of a valid component name is "OMX.TI.AUDIO.DSP.MIXER\0". Names are assigned by the vendor, but shall start with "OMX." and then have the Vendor designation next. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pAppData</td><td>pointer to an application defined value that will be returned during callbacks so that the application can identify the source of the callback. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pCallBacks</td><td>pointer to a <a class="el" href="struct_o_m_x___c_a_l_l_b_a_c_k_t_y_p_e.html">OMX_CALLBACKTYPE</a> structure that will be passed to the component to initialize it with. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>OMX_ERRORTYPE If the command successfully executes, the return code will be OMX_ErrorNone. Otherwise the appropriate OMX error will be returned. </dd></dl>
<p>Referenced by <a class="el" href="omxaudiomixertest_8c_source.html#l00080">main()</a>.</p>
</div>
</div>
<a class="anchor" id="ga789b35e88446bbccbc8109b659cfd98d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> OMX_GetRolesOfComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#a9f94ed9e467960d51f3b1da3a4ebf55c">OMX_IN</a> <a class="el" href="_o_m_x___types_8h.html#a35830b439b00948006e5ef824fef715f">OMX_STRING</a> </td>
<td class="paramname"><em>compName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#ae2413e67d24fdfc2c077685e84c53741">OMX_INOUT</a> <a class="el" href="_o_m_x___types_8h.html#a04983f4ca9c7876035dffc578597eae3">OMX_U32</a> * </td>
<td class="paramname"><em>pNumRoles</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_o_m_x___types_8h.html#ad6f8c05c2b49042f9051e1f3fce7b28c">OMX_OUT</a> <a class="el" href="_o_m_x___types_8h.html#a3ad7d812ff8ffb968c08e4b7bb04becd">OMX_U8</a> ** </td>
<td class="paramname"><em>roles</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The OMX_GetRolesOfComponent method will return the number of roles supported by the given component and (if the roles field is non-NULL) the names of those roles. The call will fail if an insufficiently sized array of names is supplied. To ensure the array is sufficiently sized the client should: first call this function with the roles field NULL to determine the number of role names second call this function with the roles field pointing to an array of names allocated according to the number returned by the first call.</p>
<p>The core should return from this call within 5 msec.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">compName</td><td>This is the name of the component being queried about. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">pNumRoles</td><td>This is used both as input and output.</td></tr>
</table>
</dd>
</dl>
<p>If roles is NULL, the input is ignored and the output specifies how many roles the component supports.</p>
<p>If compNames is not NULL, on input it bounds the size of the input structure and on output, it specifies the number of roles string names listed within the roles parameter. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">roles</td><td>If NULL this field is ignored. If non-NULL this points to an array of 128-byte strings which accepts a list of the names of all standard components roles implemented on the specified component name. numComps indicates the number of names. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gac81e21bb18ce9bd985a933509a61884c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_o_m_x___types_8h.html#aa904bc42411fc5979c164cef96e90400">OMX_API</a> <a class="el" href="_o_m_x___core_8h.html#a4e2923ea92fd56f5bd9783a6dac7629a">OMX_ERRORTYPE</a> <a class="el" href="_o_m_x___types_8h.html#a9b7491ee0c559eaba7416fe922882f65">OMX_APIENTRY</a> OMX_Init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The OMX_Init standard function. </p>
<p>The OMX_Init method is used to initialize the OMX core. It shall be the first call made into OMX and it should only be executed one time without an interviening OMX_Deinit call.</p>
<p>The core should return from this call within 20 msec.</p>
<dl class="section return"><dt>Returns</dt><dd>OMX_ERRORTYPE If the command successfully executes, the return code will be OMX_ErrorNone. Otherwise the appropriate OMX error will be returned.</dd></dl>
<p>This function calls the init function of each component loader added. If there is no component loaders present, the ST default component loader (static libraries) is loaded as default component loader.</p>
<dl class="section return"><dt>Returns</dt><dd>OMX_ErrorNone </dd></dl>
<p>Definition at line <a class="el" href="omxcore_8c_source.html#l00094">94</a> of file <a class="el" href="omxcore_8c_source.html">omxcore.c</a>.</p>
<p>References <a class="el" href="component__loader_8h_source.html#l00050">BOSA_COMPONENTLOADER::BOSA_InitComponentLoader</a>, <a class="el" href="omx__create__loaders__linux_8c_source.html#l00058">createComponentLoaders()</a>, <a class="el" href="omx__comp__debug__levels_8h_source.html#l00039">DEB_LEV_ERR</a>, <a class="el" href="omx__comp__debug__levels_8h_source.html#l00059">DEB_LEV_FUNCTION_NAME</a>, <a class="el" href="omx__comp__debug__levels_8h_source.html#l00077">DEBUG</a>, <a class="el" href="omxvolcontroltest_8c_source.html#l00034">err</a>, <a class="el" href="_o_m_x___core_8h_source.html#l00131">OMX_ErrorInsufficientResources</a>, and <a class="el" href="_o_m_x___core_8h_source.html#l00128">OMX_ErrorNone</a>.</p>
<p>Referenced by <a class="el" href="omxaudiomixertest_8c_source.html#l00080">main()</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="gaf07808cc3e8c3950a0ac4b76d17cff9e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_o_m_x___c_o_m_p_o_n_e_n_t_r_e_g_i_s_t_e_r_t_y_p_e.html">OMX_COMPONENTREGISTERTYPE</a> OMX_ComponentRegistered[]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<html>
<body>
<hr size="1"><small>Generated for OpenMAX Bellagio rel. 0.9.3 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small>
<br>
<a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=160680&type=4" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
87aded5420321e37af1000cab6d33378
>
files
>
253
