Symbian^3 Application Developer Library >

RMMFAudioControllerCustomCommands Class Reference

class RMMFAudioControllerCustomCommands : public RMMFCustomCommandsBase

Client class to access functionality specific to an audio controller.

The class uses the custom command function of the controller plugin, and removes the necessity for the client to formulate the custom commands.

Since
7.0s

Inherits from

Public Member Functions
RMMFAudioControllerCustomCommands ( RMMFController &)
IMPORT_C TInt GetSinkBitRate ( TUint &)
IMPORT_C TInt GetSinkDataType ( TFourCC &)
IMPORT_C TInt GetSinkFormat ( TUid &)
IMPORT_C TInt GetSinkNumChannels ( TUint &)
IMPORT_C TInt GetSinkSampleRate ( TUint &)
IMPORT_C TInt GetSourceBitRate ( TUint &)
IMPORT_C TInt GetSourceDataType ( TFourCC &)
IMPORT_C TInt GetSourceFormat ( TUid &)
IMPORT_C TInt GetSourceNumChannels ( TUint &)
IMPORT_C TInt GetSourceSampleRate ( TUint &)
IMPORT_C void GetSupportedSinkBitRatesL ( RArray < TUint > &)
IMPORT_C void GetSupportedSinkDataTypesL ( RArray < TFourCC > &)
IMPORT_C void GetSupportedSinkNumChannelsL ( RArray < TUint > &)
IMPORT_C void GetSupportedSinkSampleRatesL ( RArray < TUint > &)
IMPORT_C void GetSupportedSourceBitRatesL ( RArray < TUint > &)
IMPORT_C void GetSupportedSourceDataTypesL ( RArray < TFourCC > &)
IMPORT_C void GetSupportedSourceNumChannelsL ( RArray < TUint > &)
IMPORT_C void GetSupportedSourceSampleRatesL ( RArray < TUint > &)
IMPORT_C TInt SetCodec ( TFourCC , TFourCC )
IMPORT_C TInt SetSinkBitRate ( TUint )
IMPORT_C TInt SetSinkDataType ( TFourCC )
IMPORT_C TInt SetSinkFormat ( TUid )
IMPORT_C TInt SetSinkNumChannels ( TUint )
IMPORT_C TInt SetSinkSampleRate ( TUint )
IMPORT_C TInt SetSourceBitRate ( TUint )
IMPORT_C TInt SetSourceDataType ( TFourCC )
IMPORT_C TInt SetSourceFormat ( TUid )
IMPORT_C TInt SetSourceNumChannels ( TUint )
IMPORT_C TInt SetSourceSampleRate ( TUint )
Private Member Functions
void DoGetFourCCArrayL ( RArray < TFourCC > &, TMMFAudioControllerMessages )
void DoGetUintArrayL ( RArray < TUint > &, TMMFAudioControllerMessages )
Inherited Functions
RMMFCustomCommandsBase::RMMFCustomCommandsBase(RMMFController &,TUid)
Inherited Attributes
RMMFCustomCommandsBase::iController
RMMFCustomCommandsBase::iDestinationPckg

Constructor & Destructor Documentation

RMMFAudioControllerCustomCommands(RMMFController &)

IMPORT_C RMMFAudioControllerCustomCommands ( RMMFController & aController )

Constructor.

Since
7.0s

Parameters

RMMFController & aController The client side controller object to be used by this custom command interface.

Member Functions Documentation

DoGetFourCCArrayL(RArray< TFourCC > &, TMMFAudioControllerMessages)

void DoGetFourCCArrayL ( RArray < TFourCC > & aArray,
TMMFAudioControllerMessages aIpc
) const [private]

Parameters

RArray < TFourCC > & aArray
TMMFAudioControllerMessages aIpc

DoGetUintArrayL(RArray< TUint > &, TMMFAudioControllerMessages)

void DoGetUintArrayL ( RArray < TUint > & aArray,
TMMFAudioControllerMessages aIpc
) const [private]

Parameters

RArray < TUint > & aArray
TMMFAudioControllerMessages aIpc

GetSinkBitRate(TUint &)

IMPORT_C TInt GetSinkBitRate ( TUint & aRate ) const

Gets the bit rate of the data sink in bits per second.

Since
7.0s

Parameters

TUint & aRate The bit rate, in bits per second.

GetSinkDataType(TFourCC &)

IMPORT_C TInt GetSinkDataType ( TFourCC & aDataType ) const

Gets the fourCC code of the sink.

Since
7.0s

Parameters

TFourCC & aDataType The fourCC code.

GetSinkFormat(TUid &)

IMPORT_C TInt GetSinkFormat ( TUid & aFormat ) const

Gets the format of the data sink.

The UID corresponds to the UID of the CMMFFormat-derived ECOM plugin being used.

Since
7.0s

Parameters

TUid & aFormat The format plugin being used.

GetSinkNumChannels(TUint &)

IMPORT_C TInt GetSinkNumChannels ( TUint & aNumChannels ) const

Gets the number of channels in the data sink. For example, one channel for mono, two channels for stereo etc.

Since
7.0s

Parameters

TUint & aNumChannels The number of channels.

GetSinkSampleRate(TUint &)

IMPORT_C TInt GetSinkSampleRate ( TUint & aRate ) const

Gets the sample rate of the data sink in samples per second.

Since
7.0s

Parameters

TUint & aRate The sample rate, in samples per second.

GetSourceBitRate(TUint &)

IMPORT_C TInt GetSourceBitRate ( TUint & aRate ) const

Gets the bit rate of the data source in bits per second.

Since
7.0s

Parameters

TUint & aRate The bit rate, in bits per second.

GetSourceDataType(TFourCC &)

IMPORT_C TInt GetSourceDataType ( TFourCC & aDataType ) const

Get the fourCC code of the source.

Since
7.0s

Parameters

TFourCC & aDataType The fourCC code.

GetSourceFormat(TUid &)

IMPORT_C TInt GetSourceFormat ( TUid & aFormat ) const

Gets the format of the data source.

The UID corresponds to the UID of the CMMFFormat-derived ECOM plugin being used.

Since
7.0s

Parameters

TUid & aFormat The format plugin being used.

GetSourceNumChannels(TUint &)

IMPORT_C TInt GetSourceNumChannels ( TUint & aNumChannels ) const

Gets the number of channels in the data source. For example, one channel for mono, two channels for stereo etc.

Since
7.0s

Parameters

TUint & aNumChannels The number of channels.

GetSourceSampleRate(TUint &)

IMPORT_C TInt GetSourceSampleRate ( TUint & aRate ) const

Gets the sample rate of the data source in samples per second.

Since
7.0s

Parameters

TUint & aRate The sample rate, in samples per second.

GetSupportedSinkBitRatesL(RArray< TUint > &)

IMPORT_C void GetSupportedSinkBitRatesL ( RArray < TUint > & aSupportedRates ) const

Gets the list of bit rates supported by the data sink.

Warning: Existing objects in this array will be removed by this method.

Since
7.0s

Parameters

RArray < TUint > & aSupportedRates The supported rates.

GetSupportedSinkDataTypesL(RArray< TFourCC > &)

IMPORT_C void GetSupportedSinkDataTypesL ( RArray < TFourCC > & aSupportedDataTypes ) const

Gets the list of fourCC codes supported by the data sink.

Warning: Existing objects in this array will be removed by this method.

Since
7.0s

Parameters

RArray < TFourCC > & aSupportedDataTypes The supported data types.

GetSupportedSinkNumChannelsL(RArray< TUint > &)

IMPORT_C void GetSupportedSinkNumChannelsL ( RArray < TUint > & aSupportedChannels ) const

Gets the list of channels supported by the data sink (ie mono, stereo etc).

Warning: Existing objects in this array will be removed by this method.

Since
7.0s

Parameters

RArray < TUint > & aSupportedChannels The supported channels.

GetSupportedSinkSampleRatesL(RArray< TUint > &)

IMPORT_C void GetSupportedSinkSampleRatesL ( RArray < TUint > & aSupportedRates ) const

Gets the list of sample rates supported by the data sink.

Warning: Existing objects in this array will be removed by this method.

Since
7.0s

Parameters

RArray < TUint > & aSupportedRates The supported rates.

GetSupportedSourceBitRatesL(RArray< TUint > &)

IMPORT_C void GetSupportedSourceBitRatesL ( RArray < TUint > & aSupportedRates ) const

Gets the list of bit rates supported by the data source.

Warning: Existing objects in this array will be removed by this function.

Since
7.0s

Parameters

RArray < TUint > & aSupportedRates The supported rates.

GetSupportedSourceDataTypesL(RArray< TFourCC > &)

IMPORT_C void GetSupportedSourceDataTypesL ( RArray < TFourCC > & aSupportedDataTypes ) const

Gets the list of fourCC codes supported by the data source.

Warning: Existing objects in this array will be removed by this method.

Since
7.0s

Parameters

RArray < TFourCC > & aSupportedDataTypes The supported data types.

GetSupportedSourceNumChannelsL(RArray< TUint > &)

IMPORT_C void GetSupportedSourceNumChannelsL ( RArray < TUint > & aSupportedChannels ) const

Gets the list of channels supported by the data source (ie mono, stereo etc).

Warning: Existing objects in this array will be removed by this method.

Since
7.0s

Parameters

RArray < TUint > & aSupportedChannels The supported channels.

GetSupportedSourceSampleRatesL(RArray< TUint > &)

IMPORT_C void GetSupportedSourceSampleRatesL ( RArray < TUint > & aSupportedRates ) const

Gets the list of sample rates supported by the data source.

Warning: Existing objects in this array will be removed by this function.

Since
7.0s

Parameters

RArray < TUint > & aSupportedRates The supported rates.

SetCodec(TFourCC, TFourCC)

IMPORT_C TInt SetCodec ( TFourCC aSourceDataType,
TFourCC aSinkDataType
) const

Sets the codec to be used. Useful when recording data.

Since
7.0s

Parameters

TFourCC aSourceDataType The data type of the source of the codec.
TFourCC aSinkDataType The data type of the sink of the codec.

SetSinkBitRate(TUint)

IMPORT_C TInt SetSinkBitRate ( TUint aRate ) const

Set the bit rate of the data sink in bits per second.

Since
7.0s

Parameters

TUint aRate The bit rate, in bits per second.

SetSinkDataType(TFourCC)

IMPORT_C TInt SetSinkDataType ( TFourCC aDataType ) const

Set the fourCC code of the sink.

Since
7.0s

Parameters

TFourCC aDataType The fourCC code.

SetSinkFormat(TUid)

IMPORT_C TInt SetSinkFormat ( TUid aFormatUid ) const

Sets the format of the data sink.

The UID corresponds to the UID of the CMMFFormat-derived ECOM plugin to be used.

Since
7.0s

Parameters

TUid aFormatUid The format plugin to be used.

SetSinkNumChannels(TUint)

IMPORT_C TInt SetSinkNumChannels ( TUint aNumChannels ) const

Sets the number of channels in the data sink. For example, one channel for mono, two channels for stereo etc.

Since
7.0s

Parameters

TUint aNumChannels The number of channels.

SetSinkSampleRate(TUint)

IMPORT_C TInt SetSinkSampleRate ( TUint aSampleRate ) const

Sets the sample rate of the data sink in samples per second.

Since
7.0s

Parameters

TUint aSampleRate The sample rate, in samples per second.

SetSourceBitRate(TUint)

IMPORT_C TInt SetSourceBitRate ( TUint aRate ) const

Sets the bit rate of the data source in bits per second.

Since
7.0s

Parameters

TUint aRate The bit rate, in bits per second.

SetSourceDataType(TFourCC)

IMPORT_C TInt SetSourceDataType ( TFourCC aDataType ) const

Sets the fourCC code of the source.

Since
7.0s

Parameters

TFourCC aDataType The fourCC code.

SetSourceFormat(TUid)

IMPORT_C TInt SetSourceFormat ( TUid aFormatUid ) const

Sets the format of the data source.

The UID corresponds to the UID of the CMMFFormat-derived ECOM plugin to be used.

Since
7.0s

Parameters

TUid aFormatUid The format plugin to be used.

SetSourceNumChannels(TUint)

IMPORT_C TInt SetSourceNumChannels ( TUint aNumChannels ) const

Sets the number of channels in the data source. For example, one channel for mono, two channels for stereo etc.

Since
7.0s

Parameters

TUint aNumChannels The number of channels.

SetSourceSampleRate(TUint)

IMPORT_C TInt SetSourceSampleRate ( TUint aSampleRate ) const

Sets the sample rate of the data source in samples per second.

Since
7.0s

Parameters

TUint aSampleRate The sample rate, in samples per second.

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.