CMMFAudioControllerCustomCommandParser Class Reference

class CMMFAudioControllerCustomCommandParser : public CMMFCustomCommandParserBase

Custom command parser class to be used by controller plugins wishing to support audio controller commands.

The controller plugin must be derived from MMMFAudioControllerCustomCommandImplementor to use this class.

The controller plugin should create an object of this type and add it to the list of custom command parsers in the controller framework. See the following example code for details.

void CMMFAudioController::ConstructL()
	{
	// Construct custom command parsers
	CMMFAudioPlayDeviceCustomCommandParser* audPlayDevParser = CMMFAudioPlayDeviceCustomCommandParser::NewL(*this);
	CleanupStack::PushL(audPlayDevParser);
	AddCustomCommandParserL(*audPlayDevParser); //parser now owned by controller framework
	CleanupStack::Pop();//audPlayDevParser

	CMMFAudioRecordDeviceCustomCommandParser* audRecDevParser = CMMFAudioRecordDeviceCustomCommandParser::NewL(*this);
	CleanupStack::PushL(audRecDevParser);
	AddCustomCommandParserL(*audRecDevParser); //parser now owned by controller framework
	CleanupStack::Pop();//audRecDevParser

etc.
	}
Since
7.0s

Inherits from

Public Member Functions
~CMMFAudioControllerCustomCommandParser()
voidHandleRequest(TMMFMessage &)
IMPORT_C CMMFAudioControllerCustomCommandParser *NewL(MMMFAudioControllerCustomCommandImplementor &)
Private Member Functions
CMMFAudioControllerCustomCommandParser(MMMFAudioControllerCustomCommandImplementor &)
TBool DoCopyArrayDataL(TMMFMessage &)
voidDoCreateBufFromFourCCArrayL(RArray< TFourCC > &)
voidDoCreateBufFromUintArrayL(RArray< TUint > &)
TBool DoGetSinkBitRateL(TMMFMessage &)
TBool DoGetSinkDataTypeL(TMMFMessage &)
TBool DoGetSinkFormatL(TMMFMessage &)
TBool DoGetSinkNumChannelsL(TMMFMessage &)
TBool DoGetSinkSampleRateL(TMMFMessage &)
TBool DoGetSourceBitRateL(TMMFMessage &)
TBool DoGetSourceDataTypeL(TMMFMessage &)
TBool DoGetSourceFormatL(TMMFMessage &)
TBool DoGetSourceNumChannelsL(TMMFMessage &)
TBool DoGetSourceSampleRateL(TMMFMessage &)
TBool DoGetSupportedSinkBitRatesL(TMMFMessage &)
TBool DoGetSupportedSinkDataTypesL(TMMFMessage &)
TBool DoGetSupportedSinkNumChannelsL(TMMFMessage &)
TBool DoGetSupportedSinkSampleRatesL(TMMFMessage &)
TBool DoGetSupportedSourceBitRatesL(TMMFMessage &)
TBool DoGetSupportedSourceDataTypesL(TMMFMessage &)
TBool DoGetSupportedSourceNumChannelsL(TMMFMessage &)
TBool DoGetSupportedSourceSampleRatesL(TMMFMessage &)
voidDoHandleRequestL(TMMFMessage &)
TBool DoSetCodecL(TMMFMessage &)
TBool DoSetSinkBitRateL(TMMFMessage &)
TBool DoSetSinkDataTypeL(TMMFMessage &)
TBool DoSetSinkFormatL(TMMFMessage &)
TBool DoSetSinkNumChannelsL(TMMFMessage &)
TBool DoSetSinkSampleRateL(TMMFMessage &)
TBool DoSetSourceBitRateL(TMMFMessage &)
TBool DoSetSourceDataTypeL(TMMFMessage &)
TBool DoSetSourceFormatL(TMMFMessage &)
TBool DoSetSourceNumChannelsL(TMMFMessage &)
TBool DoSetSourceSampleRateL(TMMFMessage &)
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()
CMMFCustomCommandParserBase::CMMFCustomCommandParserBase(TUid)
CMMFCustomCommandParserBase::InterfaceId()
CMMFCustomCommandParserBase::~CMMFCustomCommandParserBase()
Private Attributes
CBufFlat *iDataCopyBuffer
MMMFAudioControllerCustomCommandImplementor &iImplementor

Constructor & Destructor Documentation

CMMFAudioControllerCustomCommandParser(MMMFAudioControllerCustomCommandImplementor &)

CMMFAudioControllerCustomCommandParser(MMMFAudioControllerCustomCommandImplementor &aImplementor)[private]

Constructor.

Since
7.0s

Parameters

MMMFAudioControllerCustomCommandImplementor & aImplementorA reference to the controller plugin that owns this new object.

~CMMFAudioControllerCustomCommandParser()

IMPORT_C~CMMFAudioControllerCustomCommandParser()

Destructor.

Since
7.0s

Member Functions Documentation

DoCopyArrayDataL(TMMFMessage &)

TBool DoCopyArrayDataL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoCreateBufFromFourCCArrayL(RArray< TFourCC > &)

voidDoCreateBufFromFourCCArrayL(RArray< TFourCC > &aArray)[private]

Parameters

RArray< TFourCC > & aArray

DoCreateBufFromUintArrayL(RArray< TUint > &)

voidDoCreateBufFromUintArrayL(RArray< TUint > &aArray)[private]

Parameters

RArray< TUint > & aArray

DoGetSinkBitRateL(TMMFMessage &)

TBool DoGetSinkBitRateL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSinkDataTypeL(TMMFMessage &)

TBool DoGetSinkDataTypeL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSinkFormatL(TMMFMessage &)

TBool DoGetSinkFormatL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSinkNumChannelsL(TMMFMessage &)

TBool DoGetSinkNumChannelsL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSinkSampleRateL(TMMFMessage &)

TBool DoGetSinkSampleRateL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSourceBitRateL(TMMFMessage &)

TBool DoGetSourceBitRateL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSourceDataTypeL(TMMFMessage &)

TBool DoGetSourceDataTypeL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSourceFormatL(TMMFMessage &)

TBool DoGetSourceFormatL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSourceNumChannelsL(TMMFMessage &)

TBool DoGetSourceNumChannelsL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSourceSampleRateL(TMMFMessage &)

TBool DoGetSourceSampleRateL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSupportedSinkBitRatesL(TMMFMessage &)

TBool DoGetSupportedSinkBitRatesL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSupportedSinkDataTypesL(TMMFMessage &)

TBool DoGetSupportedSinkDataTypesL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSupportedSinkNumChannelsL(TMMFMessage &)

TBool DoGetSupportedSinkNumChannelsL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSupportedSinkSampleRatesL(TMMFMessage &)

TBool DoGetSupportedSinkSampleRatesL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSupportedSourceBitRatesL(TMMFMessage &)

TBool DoGetSupportedSourceBitRatesL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSupportedSourceDataTypesL(TMMFMessage &)

TBool DoGetSupportedSourceDataTypesL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSupportedSourceNumChannelsL(TMMFMessage &)

TBool DoGetSupportedSourceNumChannelsL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoGetSupportedSourceSampleRatesL(TMMFMessage &)

TBool DoGetSupportedSourceSampleRatesL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoHandleRequestL(TMMFMessage &)

voidDoHandleRequestL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoSetCodecL(TMMFMessage &)

TBool DoSetCodecL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoSetSinkBitRateL(TMMFMessage &)

TBool DoSetSinkBitRateL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoSetSinkDataTypeL(TMMFMessage &)

TBool DoSetSinkDataTypeL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoSetSinkFormatL(TMMFMessage &)

TBool DoSetSinkFormatL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoSetSinkNumChannelsL(TMMFMessage &)

TBool DoSetSinkNumChannelsL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoSetSinkSampleRateL(TMMFMessage &)

TBool DoSetSinkSampleRateL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoSetSourceBitRateL(TMMFMessage &)

TBool DoSetSourceBitRateL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoSetSourceDataTypeL(TMMFMessage &)

TBool DoSetSourceDataTypeL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoSetSourceFormatL(TMMFMessage &)

TBool DoSetSourceFormatL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoSetSourceNumChannelsL(TMMFMessage &)

TBool DoSetSourceNumChannelsL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

DoSetSourceSampleRateL(TMMFMessage &)

TBool DoSetSourceSampleRateL(TMMFMessage &aMessage)[private]

Parameters

TMMFMessage & aMessage

HandleRequest(TMMFMessage &)

voidHandleRequest(TMMFMessage &aMessage)[virtual]

Handles a request from the client. Called by the controller framework.

Since
7.0s

Parameters

TMMFMessage & aMessageThe message to be handled.

NewL(MMMFAudioControllerCustomCommandImplementor &)

IMPORT_C CMMFAudioControllerCustomCommandParser *NewL(MMMFAudioControllerCustomCommandImplementor &aImplementor)[static]

Creates a new custom command parser capable of handling audio controller commands.

Since
7.0s

Parameters

MMMFAudioControllerCustomCommandImplementor & aImplementorA reference to the controller plugin that owns this new object.

Member Data Documentation

CBufFlat * iDataCopyBuffer

CBufFlat *iDataCopyBuffer[private]

MMMFAudioControllerCustomCommandImplementor & iImplementor

MMMFAudioControllerCustomCommandImplementor &iImplementor[private]

The object that implements the audio record controller interface