Symbian^3 Product Developer Library >

COmxOutputPort Class Reference

class COmxOutputPort : public CBase

Base class for OpenMAX Output Ports.

Inherits from

Nested Classes and Structures

Public Member Functions
IMPORT_C voidMipoDisconnectTunnelComplete(const MMdfInputPort *, TInt)
IMPORT_C voidMipoRestartTunnelComplete(const MMdfInputPort *, TInt)
IMPORT_C voidMipoWriteDataComplete(const MMdfInputPort *, CMMFBuffer *, TInt)
IMPORT_C TUint32MopBufferSize()
IMPORT_C TIntMopConfigure(const TPuConfig &)
IMPORT_C CMMFBuffer *MopCreateBuffer(TInt)
IMPORT_C TIntMopCreateCustomInterface(TUid)
IMPORT_C TAny *MopCustomInterface(TUid)
IMPORT_C voidMopDisconnectTunnel()
IMPORT_C TIntMopFreeBuffer(CMMFBuffer *)
IMPORT_C TIntMopGetConfig(TPuConfig &)
IMPORT_C TIntMopIndex()
IMPORT_C voidMopInitialize()
IMPORT_C TBoolMopIsTunnelled()
IMPORT_C voidMopReadData(CMMFBuffer &)
IMPORT_C voidMopRestartTunnel()
IMPORT_C voidMopSetObserver(const MMdfOutputPortObserver &)
IMPORT_C TIntMopTunnelRequest(const MMdfInputPort &, TTunnelFlags &, TSupplierType &)
IMPORT_C TIntMopUseBuffer(CMMFBuffer &)
Protected Member Functions
COmxOutputPort()
~COmxOutputPort()
IMPORT_C COmxProcessingUnit *Component()
IMPORT_C voidConstructL(TInt, COmxProcessingUnit *)
IMPORT_C MMdfOutputPortObserver *Observer()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
CBody *iBody

Constructor & Destructor Documentation

COmxOutputPort()

IMPORT_CCOmxOutputPort()[protected]

Constructor

~COmxOutputPort()

IMPORT_C~COmxOutputPort()[protected]

Destructor

Member Functions Documentation

Component()

IMPORT_C COmxProcessingUnit *Component()const [protected]

Synchronous function used to return the OpenMAX Processing Unit this Output Port belongs to.

ConstructL(TInt, COmxProcessingUnit *)

IMPORT_C voidConstructL(TIntaIndex,
COmxProcessingUnit *aComponent
)[protected]

ConstructL. Must be used by derived class to create the component

Parameters

TInt aIndex
COmxProcessingUnit * aComponent

MipoDisconnectTunnelComplete(const MMdfInputPort *, TInt)

IMPORT_C voidMipoDisconnectTunnelComplete(const MMdfInputPort *aInputPort,
TIntaErrorCode
)

Called by an Input Port when MipDisconnectTunnel() has completed.

Parameters

const MMdfInputPort * aInputPortThe Input Port which sent the callback.
TInt aErrorCodeAn error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

MipoRestartTunnelComplete(const MMdfInputPort *, TInt)

IMPORT_C voidMipoRestartTunnelComplete(const MMdfInputPort *aInputPort,
TIntaErrorCode
)

Called by an Input Port when MipRestartTunnel() has completed.

Parameters

const MMdfInputPort * aInputPortThe Input Port which sent the callback.
TInt aErrorCodeAn error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

MipoWriteDataComplete(const MMdfInputPort *, CMMFBuffer *, TInt)

IMPORT_C voidMipoWriteDataComplete(const MMdfInputPort *aInputPort,
CMMFBuffer *aBuffer,
TIntaErrorCode
)

Called by an Input Port when MipWriteData() has completed.

Parameters

const MMdfInputPort * aInputPortThe Input Port which sent the callback.
CMMFBuffer * aBufferThe data buffer which was written.
TInt aErrorCodeAn error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

MopBufferSize()

IMPORT_C TUint32MopBufferSize()const

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

MopConfigure(const TPuConfig &)

IMPORT_C TIntMopConfigure(const TPuConfig &aConfiguration)

Synchronous function used to configure the OpenMAX Output Port.

Parameters

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

MopCreateBuffer(TInt)

IMPORT_C CMMFBuffer *MopCreateBuffer(TIntaBufferSize)

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

Parameters

TInt aBufferSizeThe size of the buffer to be created.

MopCreateCustomInterface(TUid)

IMPORT_C TIntMopCreateCustomInterface(TUidaUid)

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

Parameters

TUid aUidUsed to indicate which interface is required.

MopCustomInterface(TUid)

IMPORT_C TAny *MopCustomInterface(TUidaUid)

Return previously created extension. This returns a custom interface. 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.

MopDisconnectTunnel()

IMPORT_C voidMopDisconnectTunnel()

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

MopFreeBuffer(CMMFBuffer *)

IMPORT_C TIntMopFreeBuffer(CMMFBuffer *aBuffer)

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

Parameters

CMMFBuffer * aBufferThe buffer to be freed

MopGetConfig(TPuConfig &)

IMPORT_C TIntMopGetConfig(TPuConfig &aConfigurationSetup)

Synchronous method which gets a configuration structure for the Output Port

Parameters

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

MopIndex()

IMPORT_C TIntMopIndex()const

Synchronous function used to get the Output Port index

MopInitialize()

IMPORT_C voidMopInitialize()

Synchronous function used to initialise the OpenMAX Output Port.

MopIsTunnelled()

IMPORT_C TBoolMopIsTunnelled()const

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

MopReadData(CMMFBuffer &)

IMPORT_C voidMopReadData(CMMFBuffer &aBuffer)

Asynchronous function used to read data from the Output Port.

Parameters

CMMFBuffer & aBufferReference to the buffer containing data.

MopRestartTunnel()

IMPORT_C voidMopRestartTunnel()

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

MopSetObserver(const MMdfOutputPortObserver &)

IMPORT_C voidMopSetObserver(const MMdfOutputPortObserver &aOutputPortObserver)

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

Parameters

const MMdfOutputPortObserver & aOutputPortObserverThe observer of the Output Port.

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

IMPORT_C TIntMopTunnelRequest(const MMdfInputPort &aInputPortToBeConnectedTo,
TTunnelFlags &aTunnelFlags,
TSupplierType &aSupplierType
)

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

Parameters

const MMdfInputPort & aInputPortToBeConnectedToReference to the Input Port to be connected to.
TTunnelFlags & aTunnelFlagsControl flags for tunneling
TSupplierType & aSupplierTypeSpecifies the supplier of the buffers for the tunnel.

MopUseBuffer(CMMFBuffer &)

IMPORT_C TIntMopUseBuffer(CMMFBuffer &aBuffer)

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

Parameters

CMMFBuffer & aBufferThe buffer to be used by the OpenMAX Output Port.

Observer()

IMPORT_C MMdfOutputPortObserver *Observer()const [protected]

Synchronous function used to return the observer for the OpenMAx Output Port.

Member Data Documentation

CBody * iBody

CBody *iBody[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.