OMX_COMPONENTTYPE Struct Reference
[OpenMAX IL component]

#include <OMX_Component.h>

Data Fields
OMX_U32	nSize
OMX_VERSIONTYPE	nVersion
OMX_PTR	pComponentPrivate
OMX_PTR	pApplicationPrivate
OMX_ERRORTYPE(*	GetComponentVersion )(OMX_IN OMX_HANDLETYPE hComponent, OMX_OUT OMX_STRING pComponentName, OMX_OUT OMX_VERSIONTYPE *pComponentVersion, OMX_OUT OMX_VERSIONTYPE *pSpecVersion, OMX_OUT OMX_UUIDTYPE *pComponentUUID)
OMX_ERRORTYPE(*	SendCommand )(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_COMMANDTYPE Cmd, OMX_IN OMX_U32 nParam1, OMX_IN OMX_PTR pCmdData)
OMX_ERRORTYPE(*	GetParameter )(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_INDEXTYPE nParamIndex, OMX_INOUT OMX_PTR pComponentParameterStructure)
OMX_ERRORTYPE(*	SetParameter )(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_INDEXTYPE nIndex, OMX_IN OMX_PTR pComponentParameterStructure)
OMX_ERRORTYPE(*	GetConfig )(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_INDEXTYPE nIndex, OMX_INOUT OMX_PTR pComponentConfigStructure)
OMX_ERRORTYPE(*	SetConfig )(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_INDEXTYPE nIndex, OMX_IN OMX_PTR pComponentConfigStructure)
OMX_ERRORTYPE(*	GetExtensionIndex )(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_STRING cParameterName, OMX_OUT OMX_INDEXTYPE *pIndexType)
OMX_ERRORTYPE(*	GetState )(OMX_IN OMX_HANDLETYPE hComponent, OMX_OUT OMX_STATETYPE *pState)
OMX_ERRORTYPE(*	ComponentTunnelRequest )(OMX_IN OMX_HANDLETYPE hComp, OMX_IN OMX_U32 nPort, OMX_IN OMX_HANDLETYPE hTunneledComp, OMX_IN OMX_U32 nTunneledPort, OMX_INOUT OMX_TUNNELSETUPTYPE *pTunnelSetup)
OMX_ERRORTYPE(*	UseBuffer )(OMX_IN OMX_HANDLETYPE hComponent, OMX_INOUT OMX_BUFFERHEADERTYPE **ppBufferHdr, OMX_IN OMX_U32 nPortIndex, OMX_IN OMX_PTR pAppPrivate, OMX_IN OMX_U32 nSizeBytes, OMX_IN OMX_U8 *pBuffer)
OMX_ERRORTYPE(*	AllocateBuffer )(OMX_IN OMX_HANDLETYPE hComponent, OMX_INOUT OMX_BUFFERHEADERTYPE **ppBuffer, OMX_IN OMX_U32 nPortIndex, OMX_IN OMX_PTR pAppPrivate, OMX_IN OMX_U32 nSizeBytes)
OMX_ERRORTYPE(*	FreeBuffer )(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_U32 nPortIndex, OMX_IN OMX_BUFFERHEADERTYPE *pBuffer)
OMX_ERRORTYPE(*	EmptyThisBuffer )(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_BUFFERHEADERTYPE *pBuffer)
OMX_ERRORTYPE(*	FillThisBuffer )(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_BUFFERHEADERTYPE *pBuffer)
OMX_ERRORTYPE(*	SetCallbacks )(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_CALLBACKTYPE *pCallbacks, OMX_IN OMX_PTR pAppData)
OMX_ERRORTYPE(*	ComponentDeInit )(OMX_IN OMX_HANDLETYPE hComponent)
OMX_ERRORTYPE(*	UseEGLImage )(OMX_IN OMX_HANDLETYPE hComponent, OMX_INOUT OMX_BUFFERHEADERTYPE **ppBufferHdr, OMX_IN OMX_U32 nPortIndex, OMX_IN OMX_PTR pAppPrivate, OMX_IN void *eglImage)
OMX_ERRORTYPE(*	ComponentRoleEnum )(OMX_IN OMX_HANDLETYPE hComponent, OMX_OUT OMX_U8 *cRole, OMX_IN OMX_U32 nIndex)

---

Detailed Description

The OMX_HANDLETYPE structure defines the component handle. The component handle is used to access all of the component's public methods and also contains pointers to the component's private data area. The component handle is initialized by the OMX core (with help from the component) during the process of loading the component. After the component is successfully loaded, the application can safely access any of the component's public functions (although some may return an error because the state is inappropriate for the access).

Definition at line 295 of file OMX_Component.h.

---

Field Documentation

OMX_U32 OMX_COMPONENTTYPE::nSize

The size of this structure, in bytes. It is the responsibility of the allocator of this structure to fill in this value. Since this structure is allocated by the GetHandle function, this function will fill in this value.

Definition at line 301 of file OMX_Component.h.

Referenced by omx_base_component_Constructor().

OMX_VERSIONTYPE OMX_COMPONENTTYPE::nVersion

nVersion is the version of the OMX specification that the structure is built against. It is the responsibility of the creator of this structure to initialize this value and every user of this structure should verify that it knows how to use the exact version of this structure found herein.

Definition at line 308 of file OMX_Component.h.

Referenced by omx_base_component_Constructor(), and omx_base_component_GetComponentVersion().

OMX_PTR OMX_COMPONENTTYPE::pComponentPrivate

pComponentPrivate is a pointer to the component private data area. This member is allocated and initialized by the component when the component is first loaded. The application should not access this data area.

Definition at line 314 of file OMX_Component.h.

Referenced by base_port_AllocateBuffer(), base_port_AllocateTunnelBuffer(), base_port_DisablePort(), base_port_EnablePort(), base_port_FlushProcessingBuffers(), base_port_FreeBuffer(), base_port_FreeTunnelBuffer(), base_port_ReturnBufferFunction(), base_port_SendBufferFunction(), base_port_UseBuffer(), BOSA_ST_CreateComponent(), compMessageHandlerFunction(), omx_alsasink_component_BufferMgmtCallback(), omx_alsasink_component_Constructor(), omx_alsasink_component_Destructor(), omx_alsasink_component_GetParameter(), omx_alsasink_component_SetParameter(), omx_alsasrc_component_BufferMgmtCallback(), omx_alsasrc_component_Constructor(), omx_alsasrc_component_Destructor(), omx_alsasrc_component_GetParameter(), omx_alsasrc_component_SetParameter(), omx_audio_mixer_BufferMgmtFunction(), omx_audio_mixer_component_BufferMgmtCallback(), omx_audio_mixer_component_Constructor(), omx_audio_mixer_component_Destructor(), omx_audio_mixer_component_GetConfig(), omx_audio_mixer_component_GetParameter(), omx_audio_mixer_component_SetConfig(), omx_audio_mixer_component_SetParameter(), omx_audiodec_component_BufferMgmtCallback(), omx_audiodec_component_Constructor(), omx_audiodec_component_Deinit(), omx_audiodec_component_Destructor(), omx_audiodec_component_GetParameter(), omx_audiodec_component_Init(), omx_audiodec_component_MessageHandler(), omx_audiodec_component_SetConfig(), omx_audiodec_component_SetInternalParameters(), omx_audiodec_component_SetParameter(), omx_base_component_ComponentDeInit(), omx_base_component_Constructor(), omx_base_component_Destructor(), omx_base_component_DoStateSet(), omx_base_component_GetComponentVersion(), omx_base_component_GetParameter(), omx_base_component_GetState(), omx_base_component_MessageHandler(), omx_base_component_SendCommand(), omx_base_component_SetCallbacks(), omx_base_component_SetParameter(), omx_base_filter_BufferMgmtFunction(), omx_base_filter_Constructor(), omx_base_sink_BufferMgmtFunction(), omx_base_sink_Constructor(), omx_base_source_BufferMgmtFunction(), omx_base_source_Constructor(), omx_base_source_twoport_BufferMgmtFunction(), omx_camera_source_component_Constructor(), omx_camera_source_component_Destructor(), omx_fbdev_sink_component_BufferMgmtCallback(), omx_fbdev_sink_component_Constructor(), omx_fbdev_sink_component_Deinit(), omx_fbdev_sink_component_Destructor(), omx_fbdev_sink_component_GetConfig(), omx_fbdev_sink_component_GetParameter(), omx_fbdev_sink_component_Init(), omx_fbdev_sink_component_MessageHandler(), omx_fbdev_sink_component_SetConfig(), omx_fbdev_sink_component_SetParameter(), omx_ffmpeg_colorconv_component_BufferMgmtCallback(), omx_ffmpeg_colorconv_component_Constructor(), omx_ffmpeg_colorconv_component_Deinit(), omx_ffmpeg_colorconv_component_Destructor(), omx_ffmpeg_colorconv_component_GetConfig(), omx_ffmpeg_colorconv_component_GetParameter(), omx_ffmpeg_colorconv_component_Init(), omx_ffmpeg_colorconv_component_SetConfig(), omx_ffmpeg_colorconv_component_SetParameter(), omx_filereader_component_BufferMgmtCallback(), omx_filereader_component_Constructor(), omx_filereader_component_Deinit(), omx_filereader_component_Destructor(), omx_filereader_component_GetConfig(), omx_filereader_component_GetParameter(), omx_filereader_component_Init(), omx_filereader_component_MessageHandler(), omx_filereader_component_SetConfig(), omx_filereader_component_SetParameter(), omx_mad_decoder_MessageHandler(), omx_maddec_component_BufferMgmtCallback(), omx_maddec_component_Constructor(), omx_maddec_component_Deinit(), omx_maddec_component_Destructor(), omx_maddec_component_GetParameter(), omx_maddec_component_Init(), omx_maddec_component_SetInternalParameters(), omx_maddec_component_SetParameter(), omx_parser3gp_component_BufferMgmtCallback(), omx_parser3gp_component_Constructor(), omx_parser3gp_component_Deinit(), omx_parser3gp_component_Destructor(), omx_parser3gp_component_GetConfig(), omx_parser3gp_component_GetParameter(), omx_parser3gp_component_Init(), omx_parser3gp_component_MessageHandler(), omx_parser3gp_component_SetConfig(), omx_parser3gp_component_SetParameter(), omx_symbianoutputstreamsink_component_BufferMgmtCallback(), omx_symbianoutputstreamsink_component_Constructor(), omx_symbianoutputstreamsink_component_Destructor(), omx_symbianoutputstreamsink_component_GetParameter(), omx_symbianoutputstreamsink_component_SetParameter(), omx_video_colorconv_MessageHandler(), omx_videodec_component_BufferMgmtCallback(), omx_videodec_component_Constructor(), omx_videodec_component_Deinit(), omx_videodec_component_Destructor(), omx_videodec_component_GetParameter(), omx_videodec_component_Init(), omx_videodec_component_MessageHandler(), omx_videodec_component_SetConfig(), omx_videodec_component_SetParameter(), omx_videoenc_component_BufferMgmtCallback(), omx_videoenc_component_Constructor(), omx_videoenc_component_Deinit(), omx_videoenc_component_Destructor(), omx_videoenc_component_GetParameter(), omx_videoenc_component_Init(), omx_videoenc_component_MessageHandler(), omx_videoenc_component_SetParameter(), omx_videosrc_component_BufferMgmtCallback(), omx_videosrc_component_Constructor(), omx_videosrc_component_Deinit(), omx_videosrc_component_Destructor(), omx_videosrc_component_GetParameter(), omx_videosrc_component_Init(), omx_videosrc_component_MessageHandler(), omx_videosrc_component_SetParameter(), omx_volume_component_BufferMgmtCallback(), omx_volume_component_Constructor(), omx_volume_component_Destructor(), omx_volume_component_GetConfig(), omx_volume_component_GetParameter(), omx_volume_component_SetConfig(), omx_volume_component_SetParameter(), omx_vorbis_decoder_MessageHandler(), omx_vorbisdec_component_BufferMgmtCallbackVorbis(), omx_vorbisdec_component_Constructor(), omx_vorbisdec_component_Deinit(), omx_vorbisdec_component_Destructor(), omx_vorbisdec_component_GetParameter(), omx_vorbisdec_component_Init(), omx_vorbisdec_component_SetInternalParameters(), omx_vorbisdec_component_SetParameter(), SetInternalVideoEncParameters(), SetInternalVideoParameters(), videosrc_port_AllocateBuffer(), videosrc_port_AllocateTunnelBuffer(), videosrc_port_FreeBuffer(), and videosrc_port_FreeTunnelBuffer().

OMX_PTR OMX_COMPONENTTYPE::pApplicationPrivate

pApplicationPrivate is a pointer that is a parameter to the OMX_GetHandle method, and contains an application private value provided by the IL client. This application private data is returned to the IL Client by OMX in all callbacks

Definition at line 320 of file OMX_Component.h.

Referenced by omx_base_component_Constructor().

OMX_ERRORTYPE(* OMX_COMPONENTTYPE::GetComponentVersion)(OMX_IN OMX_HANDLETYPE hComponent, OMX_OUT OMX_STRING pComponentName, OMX_OUT OMX_VERSIONTYPE *pComponentVersion, OMX_OUT OMX_VERSIONTYPE *pSpecVersion, OMX_OUT OMX_UUIDTYPE *pComponentUUID)

refer to OMX_GetComponentVersion in OMX_core.h or the OMX IL specification for details on the GetComponentVersion method.

Referenced by omx_base_component_Constructor().

OMX_ERRORTYPE(* OMX_COMPONENTTYPE::SendCommand)(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_COMMANDTYPE Cmd, OMX_IN OMX_U32 nParam1, OMX_IN OMX_PTR pCmdData)

refer to OMX_SendCommand in OMX_core.h or the OMX IL specification for details on the SendCommand method.

Referenced by omx_base_component_Constructor().

OMX_ERRORTYPE(* OMX_COMPONENTTYPE::GetParameter)(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_INDEXTYPE nParamIndex, OMX_INOUT OMX_PTR pComponentParameterStructure)

refer to OMX_GetParameter in OMX_core.h or the OMX IL specification for details on the GetParameter method.

Referenced by omx_alsasink_component_Constructor(), omx_alsasrc_component_Constructor(), omx_audio_mixer_component_Constructor(), omx_audiodec_component_Constructor(), omx_base_component_Constructor(), omx_camera_source_component_Constructor(), omx_fbdev_sink_component_Constructor(), omx_ffmpeg_colorconv_component_Constructor(), omx_filereader_component_Constructor(), omx_maddec_component_Constructor(), omx_parser3gp_component_Constructor(), omx_symbianoutputstreamsink_component_Constructor(), omx_videodec_component_Constructor(), omx_videoenc_component_Constructor(), omx_videosrc_component_Constructor(), omx_volume_component_Constructor(), and omx_vorbisdec_component_Constructor().

OMX_ERRORTYPE(* OMX_COMPONENTTYPE::SetParameter)(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_INDEXTYPE nIndex, OMX_IN OMX_PTR pComponentParameterStructure)

refer to OMX_SetParameter in OMX_core.h or the OMX IL specification for details on the SetParameter method.

Referenced by omx_alsasink_component_Constructor(), omx_alsasrc_component_Constructor(), omx_audio_mixer_component_Constructor(), omx_audiodec_component_Constructor(), omx_base_component_Constructor(), omx_camera_source_component_Constructor(), omx_fbdev_sink_component_Constructor(), omx_ffmpeg_colorconv_component_Constructor(), omx_filereader_component_Constructor(), omx_maddec_component_Constructor(), omx_parser3gp_component_Constructor(), omx_symbianoutputstreamsink_component_Constructor(), omx_videodec_component_Constructor(), omx_videoenc_component_Constructor(), omx_videosrc_component_Constructor(), omx_volume_component_Constructor(), and omx_vorbisdec_component_Constructor().

OMX_ERRORTYPE(* OMX_COMPONENTTYPE::GetConfig)(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_INDEXTYPE nIndex, OMX_INOUT OMX_PTR pComponentConfigStructure)

refer to OMX_GetConfig in OMX_core.h or the OMX IL specification for details on the GetConfig method.

Referenced by omx_audio_mixer_component_Constructor(), omx_base_component_Constructor(), omx_camera_source_component_Constructor(), omx_ffmpeg_colorconv_component_Constructor(), omx_filereader_component_Constructor(), omx_parser3gp_component_Constructor(), omx_symbianoutputstreamsink_component_Constructor(), and omx_volume_component_Constructor().

OMX_ERRORTYPE(* OMX_COMPONENTTYPE::SetConfig)(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_INDEXTYPE nIndex, OMX_IN OMX_PTR pComponentConfigStructure)

refer to OMX_SetConfig in OMX_core.h or the OMX IL specification for details on the SetConfig method.

Referenced by omx_audio_mixer_component_Constructor(), omx_audiodec_component_Constructor(), omx_base_component_Constructor(), omx_camera_source_component_Constructor(), omx_ffmpeg_colorconv_component_Constructor(), omx_filereader_component_Constructor(), omx_parser3gp_component_Constructor(), omx_symbianoutputstreamsink_component_Constructor(), omx_videodec_component_Constructor(), and omx_volume_component_Constructor().

OMX_ERRORTYPE(* OMX_COMPONENTTYPE::GetExtensionIndex)(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_STRING cParameterName, OMX_OUT OMX_INDEXTYPE *pIndexType)

refer to OMX_GetExtensionIndex in OMX_core.h or the OMX IL specification for details on the GetExtensionIndex method.

Referenced by omx_audiodec_component_Constructor(), omx_base_component_Constructor(), omx_filereader_component_Constructor(), omx_parser3gp_component_Constructor(), and omx_videodec_component_Constructor().

OMX_ERRORTYPE(* OMX_COMPONENTTYPE::GetState)(OMX_IN OMX_HANDLETYPE hComponent, OMX_OUT OMX_STATETYPE *pState)

refer to OMX_GetState in OMX_core.h or the OMX IL specification for details on the GetState method.

Referenced by omx_base_component_Constructor().

OMX_ERRORTYPE(* OMX_COMPONENTTYPE::SetCallbacks)(OMX_IN OMX_HANDLETYPE hComponent, OMX_IN OMX_CALLBACKTYPE *pCallbacks, OMX_IN OMX_PTR pAppData)

The SetCallbacks method is used by the core to specify the callback structure from the application to the component. This is a blocking call. The component will return from this call within 5 msec.

Parameters:

[in]	hComponent	Handle of the component to be accessed. This is the component handle returned by the call to the GetHandle function.
[in]	pCallbacks	pointer to an OMX_CALLBACKTYPE structure used to provide the callback information to the component
[in]	pAppData	pointer to an application defined value. It is anticipated that the application will pass a pointer to a data structure or a "this pointer" in this area to allow the callback (in the application) to determine the context of the call

Returns:

OMX_ERRORTYPE If the command successfully executes, the return code will be OMX_NoError. Otherwise the appropriate OMX error will be returned.

Referenced by omx_base_component_Constructor().

OMX_ERRORTYPE(* OMX_COMPONENTTYPE::ComponentDeInit)(OMX_IN OMX_HANDLETYPE hComponent)

ComponentDeInit method is used to deinitialize the component providing a means to free any resources allocated at component initialization. NOTE: After this call the component handle is not valid for further use.

Parameters:

[in]

hComponent

Handle of the component to be accessed. This is the component handle returned by the call to the GetHandle function.

Returns:

OMX_ERRORTYPE If the command successfully executes, the return code will be OMX_NoError. Otherwise the appropriate OMX error will be returned.

Referenced by BOSA_ST_CreateComponent(), and omx_base_component_Constructor().

OMX_ERRORTYPE(* OMX_COMPONENTTYPE::ComponentRoleEnum)(OMX_IN OMX_HANDLETYPE hComponent, OMX_OUT OMX_U8 *cRole, OMX_IN OMX_U32 nIndex)

Referenced by omx_audiodec_component_Constructor(), omx_base_component_Constructor(), omx_videodec_component_Constructor(), and omx_videoenc_component_Constructor().

---

The documentation for this struct was generated from the following file:

• OMX_Component.h