MMdfOutputPort Class Reference

class MMdfOutputPort

Codec API Output Port interface.

Member Functions Documentation

MopBufferSize()

TUint32 MopBufferSize ( ) const [pure virtual]

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

MopConfigure(const TPuConfig &)

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

Synchronous function used to configure the Output Port.

Parameters

const TPuConfig & aConfiguration Holds the configuration parameters for the Output Port.

MopCreateBuffer(TInt)

CMMFBuffer * MopCreateBuffer ( TInt aBufferSize ) [pure virtual]

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

Parameters

TInt aBufferSize The size of the buffer to be created.

MopCreateCustomInterface(TUid)

TInt MopCreateCustomInterface ( TUid aUid ) [pure virtual]

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

Parameters

TUid aUid Used to indicate which interface is required.

MopCustomInterface(TUid)

TAny * MopCustomInterface ( TUid aUid ) [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. MopCreateCustomInterface()

Parameters

TUid aUid Used to indicate which interface is required.

MopDisconnectTunnel()

void MopDisconnectTunnel ( ) [pure virtual]

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

MopFreeBuffer(CMMFBuffer *)

TInt MopFreeBuffer ( CMMFBuffer * aBuffer ) [pure virtual]

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

Parameters

CMMFBuffer * aBuffer The buffer to be freed

MopGetConfig(TPuConfig &)

TInt MopGetConfig ( TPuConfig & aConfigurationSetup ) [pure virtual]

Synchronous method which gets a configuration structure for the Output Port

Parameters

TPuConfig & aConfigurationSetup The reference to the structure that is to contain the configuration information

MopIndex()

TInt MopIndex ( ) const [pure virtual]

Synchronous function used to get the Output Port index

MopInitialize()

void MopInitialize ( ) [pure virtual]

Synchronous function used to initialise the Output Port.

MopIsTunnelled()

TBool MopIsTunnelled ( ) const [pure virtual]

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

MopReadData(CMMFBuffer &)

void MopReadData ( CMMFBuffer & aBuffer ) [pure virtual]

Asynchronous function used to read data from the Output Port.

Parameters

CMMFBuffer & aBuffer Reference to the buffer containing data.

MopRestartTunnel()

void MopRestartTunnel ( ) [pure virtual]

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

MopSetObserver(const MMdfOutputPortObserver &)

void MopSetObserver ( const MMdfOutputPortObserver & aOutputPortObserver ) [pure virtual]

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

Parameters

const MMdfOutputPortObserver & aOutputPortObserver The observer of the Output Port.

MopTunnelRequest(const MMdfInputPort &, TTunnelFlags &, TSupplierType &)

TInt MopTunnelRequest ( const MMdfInputPort & aInputPortToBeConnectedTo,
TTunnelFlags & aTunnelFlags,
TSupplierType & aSupplierType
) [pure virtual]

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

Parameters

const MMdfInputPort & aInputPortToBeConnectedTo Reference to the Input Port to be connected to.
TTunnelFlags & aTunnelFlags Control flags for tunneling
TSupplierType & aSupplierType Specifies the supplier of the buffers for the tunnel.

MopUseBuffer(CMMFBuffer &)

TInt MopUseBuffer ( CMMFBuffer & aBuffer ) [pure virtual]

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

Parameters

CMMFBuffer & aBuffer The buffer to be used by the Output Port.