MMdfInputPort Class Reference

class MMdfInputPort

Codec API Input Port interface.

Member Functions Documentation

MipBufferSize()

TUint32 MipBufferSize()const [pure virtual]

Synchronous function used to get the size of the buffer(s) used by the Input Port.

MipConfigure(const TPuConfig &)

TInt MipConfigure(const TPuConfig &aConfiguration)[pure virtual]

Synchronous function used to configure the Input Port.

Parameters

const TPuConfig & aConfigurationHolds the configuration parameters for the Input Port.

MipCreateBuffer(TInt)

CMMFBuffer *MipCreateBuffer(TIntaBufferSize)[pure virtual]

Synchronous function used to instruct the Input Port to create a buffer.

Parameters

TInt aBufferSizeThe size of the buffer to be created.

MipCreateCustomInterface(TUid)

TInt MipCreateCustomInterface(TUidaUid)[pure virtual]

Request extension feature. This is intended to provide additional features.

Parameters

TUid aUidUsed to indicate which interface is required.

MipCustomInterface(TUid)

TAny *MipCustomInterface(TUidaUid)[pure virtual]

Return previously created extension. This returns a custom interface whose ownership is not transferred to the caller. This should only be used if CreateCustomInterface() has already been called for the same UID value. This means that any construction for that interface has already been called, and thus this call cannot fail. MipCreateCustomInterface()

Parameters

TUid aUidUsed to indicate which interface is required.

MipDisconnectTunnel()

voidMipDisconnectTunnel()[pure virtual]

Asynchronous function used to disconnect a tunnelled port, and thus stop the data processing.

MipFreeBuffer(CMMFBuffer *)

TInt MipFreeBuffer(CMMFBuffer *aBuffer)[pure virtual]

Synchronous function used to instruct the Input Port to free the buffer given passed in the function's argument.

Parameters

CMMFBuffer * aBufferThe buffer to be freed

MipGetConfig(TPuConfig &)

TInt MipGetConfig(TPuConfig &aConfigurationSetup)[pure virtual]

Synchronous method which gets a configuration structure for the Input Port

Parameters

TPuConfig & aConfigurationSetupThe reference to the structure that is to contain the configuration information

MipIndex()

TInt MipIndex()const [pure virtual]

Synchronous function used to get the Input Port index

MipInitialize()

voidMipInitialize()[pure virtual]

Synchronous function used to initialise the Input Port.

MipIsTunnelled()

TBool MipIsTunnelled()const [pure virtual]

Synchronous function used to find out if an Input Port is tunnelled or not.

MipRestartTunnel()

voidMipRestartTunnel()[pure virtual]

Asynchronous function used to restart the data processing of a tunnelled port.

MipSetObserver(const MMdfInputPortObserver &)

voidMipSetObserver(const MMdfInputPortObserver &aInputPortObserver)[pure virtual]

Synchronous function used to set the observer for the Input Port.

Parameters

const MMdfInputPortObserver & aInputPortObserverThe observer of the Input Port.

MipTunnelRequest(const MMdfOutputPort &, TTunnelFlags &, TSupplierType &)

TInt MipTunnelRequest(const MMdfOutputPort &aOutputPortToBeConnectedTo,
TTunnelFlags &aTunnelFlags,
TSupplierType &aSupplierType
)[pure virtual]

Synchronous function used to request the set up of a tunnel between this Input Port and an Output Port.

Parameters

const MMdfOutputPort & aOutputPortToBeConnectedToReference to the Output Port to be connected to.
TTunnelFlags & aTunnelFlagsControl flags for tunneling
TSupplierType & aSupplierTypeSpecifies the supplier of the buffers for the tunnel.

MipUseBuffer(CMMFBuffer &)

TInt MipUseBuffer(CMMFBuffer &aBuffer)[pure virtual]

Synchronous function used to instruct the Input Port to use the buffer passed in the function's argument.

Parameters

CMMFBuffer & aBufferThe buffer to be used by the Input Port.

MipWriteData(CMMFBuffer &)

voidMipWriteData(CMMFBuffer &aBuffer)[pure virtual]

Asynchronous function used to write data to the Input Port.

Parameters

CMMFBuffer & aBufferReference to the buffer containing data.