OMX_COMPONENTTYPE Struct Reference

struct OMX_COMPONENTTYPE

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).

Member Data Documentation

OMX_ERRORTYPE(* AllocateBuffer

OMX_ERRORTYPE (* AllocateBuffer

refer to OMX_AllocateBuffer in OMX_core.h or the OMX IL specification for details on the AllocateBuffer method.

OMX_ERRORTYPE(* ComponentDeInit

OMX_ERRORTYPE (* ComponentDeInit

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.

OMX_ERRORTYPE(* ComponentRoleEnum

OMX_ERRORTYPE (* ComponentRoleEnum

OMX_ERRORTYPE(* ComponentTunnelRequest

OMX_ERRORTYPE (* ComponentTunnelRequest

The ComponentTunnelRequest method will interact with another OMX component to determine if tunneling is possible and to setup the tunneling. The return codes for this method can be used to determine if tunneling is not possible, or if tunneling is not supported.

Base profile components (i.e. non-interop) do not support this method and should return OMX_ErrorNotImplemented

The interop profile component MUST support tunneling to another interop profile component with a compatible port parameters. A component may also support proprietary communication.

If proprietary communication is supported the negotiation of proprietary communication is done outside of OMX in a vendor specific way. It is only required that the proper result be returned and the details of how the setup is done is left to the component implementation.

When this method is invoked when nPort in an output port, the component will: 1. Populate the pTunnelSetup structure with the output port's requirements and constraints for the tunnel.

When this method is invoked when nPort in an input port, the component will: 1. Query the necessary parameters from the output port to determine if the ports are compatible for tunneling 2. If the ports are compatible, the component should store the tunnel step provided by the output port 3. Determine which port (either input or output) is the buffer supplier, and call OMX_SetParameter on the output port to indicate this selection.

The component will return from this call within 5 msec.

OMX_ERRORTYPE(* EmptyThisBuffer

OMX_ERRORTYPE (* EmptyThisBuffer

refer to OMX_EmptyThisBuffer in OMX_core.h or the OMX IL specification for details on the EmptyThisBuffer method.

OMX_ERRORTYPE(* FillThisBuffer

OMX_ERRORTYPE (* FillThisBuffer

refer to OMX_FillThisBuffer in OMX_core.h or the OMX IL specification for details on the FillThisBuffer method.

OMX_ERRORTYPE(* FreeBuffer

OMX_ERRORTYPE (* FreeBuffer

refer to OMX_FreeBuffer in OMX_core.h or the OMX IL specification for details on the FreeBuffer method.

OMX_ERRORTYPE(* GetComponentVersion

OMX_ERRORTYPE (* GetComponentVersion

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

OMX_ERRORTYPE(* GetConfig

OMX_ERRORTYPE (* GetConfig

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

OMX_ERRORTYPE(* GetExtensionIndex

OMX_ERRORTYPE (* GetExtensionIndex

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

OMX_ERRORTYPE(* GetParameter

OMX_ERRORTYPE (* GetParameter

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

OMX_ERRORTYPE(* GetState

OMX_ERRORTYPE (* GetState

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

OMX_ERRORTYPE(* SendCommand

OMX_ERRORTYPE (* SendCommand

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

OMX_ERRORTYPE(* SetCallbacks

OMX_ERRORTYPE (* SetCallbacks

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.

OMX_ERRORTYPE(* SetConfig

OMX_ERRORTYPE (* SetConfig

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

OMX_ERRORTYPE(* SetParameter

OMX_ERRORTYPE (* SetParameter

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

OMX_ERRORTYPE(* UseBuffer

OMX_ERRORTYPE (* UseBuffer

refer to OMX_UseBuffer in OMX_core.h or the OMX IL specification for details on the UseBuffer method.

OMX_ERRORTYPE(* UseEGLImage

OMX_ERRORTYPE (* UseEGLImage

OMX_U32 nSize

OMX_U32 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.

OMX_VERSIONTYPE nVersion

OMX_VERSIONTYPE 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.

OMX_PTR pApplicationPrivate

OMX_PTR 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

OMX_PTR pComponentPrivate

OMX_PTR 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.