Symbian^3 Application Developer Library >

COmxInputPort Class Reference

class COmxInputPort : public CBase

Base class for OpenMAX Input Ports.

Inherits from

Nested Classes and Structures

Public Member Functions
IMPORT_C TUint32 MipBufferSize ()
IMPORT_C TInt MipConfigure (const TPuConfig &)
IMPORT_C CMMFBuffer * MipCreateBuffer ( TInt )
IMPORT_C TInt MipCreateCustomInterface ( TUid )
IMPORT_C TAny * MipCustomInterface ( TUid )
IMPORT_C void MipDisconnectTunnel ()
IMPORT_C TInt MipFreeBuffer ( CMMFBuffer *)
IMPORT_C TInt MipGetConfig ( TPuConfig &)
IMPORT_C TInt MipIndex ()
IMPORT_C void MipInitialize ()
IMPORT_C TBool MipIsTunnelled ()
IMPORT_C void MipRestartTunnel ()
IMPORT_C void MipSetObserver (const MMdfInputPortObserver &)
IMPORT_C TInt MipTunnelRequest (const MMdfOutputPort &, TTunnelFlags &, TSupplierType &)
IMPORT_C TInt MipUseBuffer ( CMMFBuffer &)
IMPORT_C void MipWriteData ( CMMFBuffer &)
Protected Member Functions
COmxInputPort ()
~COmxInputPort ()
IMPORT_C COmxProcessingUnit * Component ()
IMPORT_C void ConstructL ( TInt , COmxProcessingUnit *)
IMPORT_C MMdfInputPortObserver * 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

COmxInputPort()

IMPORT_C COmxInputPort ( ) [protected]

Constructor.

~COmxInputPort()

IMPORT_C ~COmxInputPort ( ) [protected]

Destructor.

Member Functions Documentation

Component()

IMPORT_C COmxProcessingUnit * Component ( ) const [protected]

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

ConstructL(TInt, COmxProcessingUnit *)

IMPORT_C void ConstructL ( TInt aIndex,
COmxProcessingUnit * aComponent
) [protected]

Class constructor.

Parameters

TInt aIndex
COmxProcessingUnit * aComponent

MipBufferSize()

IMPORT_C TUint32 MipBufferSize ( ) const

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

MipConfigure(const TPuConfig &)

IMPORT_C TInt MipConfigure ( const TPuConfig & aConfiguration )

Synchronous function used to configure the OpenMAX Input Port.

Parameters

const TPuConfig & aConfiguration Holds the configuration parameters for the OpenMAX Input Port.

MipCreateBuffer(TInt)

IMPORT_C CMMFBuffer * MipCreateBuffer ( TInt aBufferSize )

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

Parameters

TInt aBufferSize The size of the buffer to be created.

MipCreateCustomInterface(TUid)

IMPORT_C TInt MipCreateCustomInterface ( TUid aUid )

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

Parameters

TUid aUid Used to indicate which interface is required.

MipCustomInterface(TUid)

IMPORT_C TAny * MipCustomInterface ( TUid aUid )

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 aUid Used to indicate which interface is required.

MipDisconnectTunnel()

IMPORT_C void MipDisconnectTunnel ( )

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

MipFreeBuffer(CMMFBuffer *)

IMPORT_C TInt MipFreeBuffer ( CMMFBuffer * aBuffer )

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

Parameters

CMMFBuffer * aBuffer The buffer to be freed

MipGetConfig(TPuConfig &)

IMPORT_C TInt MipGetConfig ( TPuConfig & aConfigurationSetup )

Synchronous method which gets a configuration structure for the OpenMAX Input Port

Parameters

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

MipIndex()

IMPORT_C TInt MipIndex ( ) const

Synchronous function used to get the OpenMAX Input Port index

MipInitialize()

IMPORT_C void MipInitialize ( )

Synchronous function used to initialise the OpenMAX Input Port.

MipIsTunnelled()

IMPORT_C TBool MipIsTunnelled ( ) const

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

MipRestartTunnel()

IMPORT_C void MipRestartTunnel ( )

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

MipSetObserver(const MMdfInputPortObserver &)

IMPORT_C void MipSetObserver ( const MMdfInputPortObserver & aInputPortObserver )

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

Parameters

const MMdfInputPortObserver & aInputPortObserver The observer of the OpenMAX Input Port.

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

IMPORT_C TInt MipTunnelRequest ( const MMdfOutputPort & aOutputPortToBeConnectedTo,
TTunnelFlags & aTunnelFlags,
TSupplierType & aSupplierType
)

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

Parameters

const MMdfOutputPort & aOutputPortToBeConnectedTo Reference to the Output Port to be connected to.
TTunnelFlags & aTunnelFlags Control flags for tunneling
TSupplierType & aSupplierType Specifies the supplier of the buffers for the tunnel.

MipUseBuffer(CMMFBuffer &)

IMPORT_C TInt MipUseBuffer ( CMMFBuffer & aBuffer )

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

Parameters

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

MipWriteData(CMMFBuffer &)

IMPORT_C void MipWriteData ( CMMFBuffer & aBuffer )

Asynchronous function used to write data to the OpenMAX Input Port.

Parameters

CMMFBuffer & aBuffer Reference to the buffer containing data.

Observer()

IMPORT_C MMdfInputPortObserver * Observer ( ) const [protected]

Synchronous function used to return the observer for the OpenMAx Input 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.