Package: android.hardware.media.omx@1.0

IOmxNode

interface IOmxNode

IOmxNode is an interface for communicating with an OMX component(called "node" here)that has been previously obtained by calling IOmx::allocateNode().

Methods

freeNode

freeNode ()
generates (Status status)

Free the node.

Details
Generates
status
Status of the call.

sendCommand

sendCommand (uint32_t cmd, int32_t param)
generates (Status status)

Invoke a command on the node.

Details
Parameters
cmd
Type of the command.
param
Parameter for the command.
Generates
status
Status of the call.

getParameter

getParameter (uint32_t index, Bytes inParams)
generates (Status status, Bytes outParams)

Retrieve a parameter setting from the node.

Details
Parameters
index
Type of the parameter to retrieve.
inParams
Information about the retrieval.
Generates
status
Status of the call.
outParams
Current parameter setting.

setParameter

setParameter (uint32_t index, Bytes params)
generates (Status status)

Change a parameter setting of the node.

Details
Parameters
index
Type of the parameter to change.
params
New parameter setting.
Generates
status
Status of the call.

getConfig

getConfig (uint32_t index, Bytes inConfig)
generates (Status status, Bytes outConfig)

Retrieve a configuration from the node.

Details
Parameters
index
Type of the configuration to retrieve.
inConfig
Information about the retrieval.
Generates
status
Status of the call.
outConfig
Current configuration.

setConfig

setConfig (uint32_t index, Bytes config)
generates (Status status)

Change a configuration of the node.

Details
Parameters
index
Type of the configuration to change.
config
New configuration.
Generates
status
Status of the call.

setPortMode

setPortMode (uint32_t portIndex, PortMode mode)
generates (Status status)

Set the mode of a port on the node.

Details
Parameters
portIndex
Index of the port.
mode
Target mode on the specified port.
Generates
status
Status of the call.

prepareForAdaptivePlayback

prepareForAdaptivePlayback (uint32_t portIndex, bool enable, uint32_t maxFrameWidth, uint32_t maxFrameHeight)
generates (Status status)

Prepare a port for adaptive playback.This is based on the extension "OMX.google.android.index.prepareForAdaptivePlayback".

Details
Parameters
portIndex
Index of the port.
enable
Whether the adaptive playback is enabled or not.
maxFrameWidth
Maximum frame width.
maxFrameHeight
Maximum frame height.
Generates
status
Status of the call.

configureVideoTunnelMode

configureVideoTunnelMode (uint32_t portIndex, bool tunneled, uint32_t audioHwSync)
generates (Status status, handle sidebandHandle)

Configure a port for a tunneled playback mode.This is based on the extension "OMX.google.android.index.configureVideoTunnelMode".

Details
Parameters
portIndex
Index of the port.
tunneled
Whether the tunneled mode is used or not.
audioHwSync
HW SYNC ID of the audio HAL output stream to sync the video with.
Generates
status
Status of the call.
sidebandHandle
Codec-allocated sideband window handle.

getGraphicBufferUsage

getGraphicBufferUsage (uint32_t portIndex)
generates (Status status, uint32_t usage)

Retrieve the buffer usage on a port.This is based on the extension "OMX.google.android.index.getAndroidNativeBufferUsage".

Details
Parameters
portIndex
Index of the port.
Generates
status
Status of the call.
usage
Current graphic buffer usage.

setInputSurface

setInputSurface (IOmxBufferSource bufferSource)
generates (Status status)

Set up a listener to events related to the input surface.

Details
Parameters
bufferSource
Listener object that implements IOmxBufferSource.
Generates
status
Status of the call.

allocateSecureBuffer

allocateSecureBuffer (uint32_t portIndex, uint64_t size)
generates (Status status, BufferId buffer, handle nativeHandle)

Allocate an opaque buffer on a port as a native handle.

Details
Parameters
portIndex
Index of the port.
size
Desired size of the buffer.
Generates
status
Status of the call.
buffer
Id of the allocated buffer, which will be needed in other buffer-related functions.
nativeHandle
Native handle of the allocated buffer.

useBuffer

useBuffer (uint32_t portIndex, CodecBuffer omxBuffer)
generates (Status status, BufferId buffer)

Assign a buffer to a port.

Details
Parameters
portIndex
Index of the port.
omxBuffer
Buffer to be assigned to the port.
Generates
status
Status of the call.
buffer
Id of the assigned buffer, which will be needed in other buffer-related functions.

freeBuffer

freeBuffer (uint32_t portIndex, BufferId buffer)
generates (Status status)

Free a buffer previously assigned to a port by allocateSecureBuffer() or useBuffer().

Details
Parameters
portIndex
Index of the port.
buffer
Id of the buffer to be freed.
Generates
status
Status of the call.

fillBuffer

fillBuffer (BufferId buffer, CodecBuffer omxBuffer, Fence fence)
generates (Status status)

Pass p fence to the node if it supports fences.Otherwise, it waits on p fence before calling OMX_FillThisBuffer().The node will take ownership of the fence even if this call fails.

If the port is in metadata mode, the buffer will be updated to point to the new buffer passed in via p omxBuffer before OMX_FillThisBuffer() is called.Otherwise, p omxBuffer is not used.

Details
Parameters
buffer
Id of the buffer to fill.
omxBuffer
New buffer information(in metadata mode).
fence
Fence to wait for(if not null).
Generates
status
Status of the call.

emptyBuffer

emptyBuffer (BufferId buffer, CodecBuffer omxBuffer, uint32_t flags, uint64_t timestampUs, Fence fence)
generates (Status status)

Pass p fence to the node if it supports fences.Otherwise, wait on p fence before calling OMX_EmptyThisBuffer().The node will take ownership of the fence even if this call fails.

If the port is in metadata mode, the buffer will be updated to point to the new buffer passed in via p omxBuffer before OMX_EmptyThisBuffer() is called.Otherwise, p omxBuffer is not used.

Details
Parameters
buffer
Id of the buffer to fill.
omxBuffer
New buffer information(in metadata mode).
flags
Flags to be passed to OMX_EmptyBuffer().
timestampUs
Timestamp OMX_EmptyBuffer().
fence
Fence to wait for(if not null).
Generates
status
Status of the call.

getExtensionIndex

getExtensionIndex (string parameterName)
generates (Status status, uint32_t index)

Request the node to translate an extension string to an index.

Details
Parameters
parameterName
Requested extension string.
Generates
status
Status of the call.
index
Translated index.

dispatchMessage

dispatchMessage (Message msg)
generates (Status status)

Add an OMX message on the node's message queue.The instance of IOmxObserver that was obtained during the creation of the node will receive the message in batches by the callback IOmxObserver::onMessages().

Details
Parameters
msg
Message to send.
Generates
status
Status of the call.