Class RMMFAudioControllerCustomCommands

class RMMFAudioControllerCustomCommands : public RMMFCustomCommandsBase;

Description

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.

Derivation

• RMMFCustomCommandsBase - Base class for client-side custom command classes

• RMMFAudioControllerCustomCommands - Client class to access functionality specific to an audio controller

Members

Defined in RMMFAudioControllerCustomCommands:
GetSinkBitRate(), GetSinkDataType(), GetSinkFormat(), GetSinkNumChannels(), GetSinkSampleRate(), GetSourceBitRate(), GetSourceDataType(), GetSourceFormat(), GetSourceNumChannels(), GetSourceSampleRate(), GetSupportedSinkBitRatesL(), GetSupportedSinkDataTypesL(), GetSupportedSinkNumChannelsL(), GetSupportedSinkSampleRatesL(), GetSupportedSourceBitRatesL(), GetSupportedSourceDataTypesL(), GetSupportedSourceNumChannelsL(), GetSupportedSourceSampleRatesL(), RMMFAudioControllerCustomCommands(), SetCodec(), SetSinkBitRate(), SetSinkDataType(), SetSinkFormat(), SetSinkNumChannels(), SetSinkSampleRate(), SetSourceBitRate(), SetSourceDataType(), SetSourceFormat(), SetSourceNumChannels(), SetSourceSampleRate()

Inherited from RMMFCustomCommandsBase:
iController, iDestinationPckg

IMPORT_C RMMFAudioControllerCustomCommands(RMMFController &aController);

Description

Constructor.

Parameters

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

IMPORT_C TInt SetSourceSampleRate(TUint aSampleRate) const;

Description

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

Parameters

TUint aSampleRate The sample rate, in samples per second.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetSourceBitRate(TUint aRate) const;

Description

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

Parameters

TUint aRate The bit rate, in bits per second.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetSourceNumChannels(TUint aNumChannels) const;

Description

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

Parameters

TUint aNumChannels The number of channels.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetSourceFormat(TUid aFormatUid) const;

Description

Sets the format of the data source.

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

Parameters

TUid aFormatUid The format plugin to be used.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetSourceDataType(TFourCC aDataType) const;

Description

Sets the fourCC code of the source.

Parameters

TFourCC aDataType The fourCC code.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetSinkSampleRate(TUint aSampleRate) const;

Description

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

Parameters

TUint aSampleRate The sample rate, in samples per second.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetSinkBitRate(TUint aRate) const;

Description

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

Parameters

TUint aRate The bit rate, in bits per second.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetSinkNumChannels(TUint aNumChannels) const;

Description

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

Parameters

TUint aNumChannels The number of channels.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetSinkFormat(TUid aFormatUid) const;

Description

Sets the format of the data sink.

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

Parameters

TUid aFormatUid The format plugin to be used.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetSinkDataType(TFourCC aDataType) const;

Description

Set the fourCC code of the sink.

Parameters

TFourCC aDataType The fourCC code.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetCodec(TFourCC aSourceDataType, TFourCC aSinkDataType) const;

Description

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

Parameters

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

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetSourceSampleRate(TUint &aRate) const;

Description

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

Parameters

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

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetSourceBitRate(TUint &aRate) const;

Description

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

Parameters

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

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetSourceNumChannels(TUint &aNumChannels) const;

Description

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

Parameters

TUint &aNumChannels The number of channels.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetSourceFormat(TUid &aFormat) const;

Description

Gets the format of the data source.

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

Parameters

TUid &aFormat The format plugin being used.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetSourceDataType(TFourCC &aDataType) const;

Description

Get the fourCC code of the source.

Parameters

TFourCC &aDataType The fourCC code.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetSinkSampleRate(TUint &aRate) const;

Description

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

Parameters

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

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetSinkBitRate(TUint &aRate) const;

Description

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

Parameters

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

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetSinkNumChannels(TUint &aNumChannels) const;

Description

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

Parameters

TUint &aNumChannels The number of channels.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetSinkFormat(TUid &aFormat) const;

Description

Gets the format of the data sink.

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

Parameters

TUid &aFormat The format plugin being used.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetSinkDataType(TFourCC &aDataType) const;

Description

Gets the fourCC code of the sink.

Parameters

TFourCC &aDataType The fourCC code.

Return value

TInt One of the system-wide error codes.

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

Description

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

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

Parameters

RArray< TUint > &aSupportedRates The supported rates.

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

Description

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

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

Parameters

RArray< TUint > &aSupportedRates The supported rates.

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

Description

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.

Parameters

RArray< TUint > &aSupportedChannels The supported channels.

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

Description

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

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

Parameters

RArray< TFourCC > &aSupportedDataTypes The supported data types.

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

Description

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

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

Parameters

RArray< TUint > &aSupportedRates The supported rates.

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

Description

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

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

Parameters

RArray< TUint > &aSupportedRates The supported rates.

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

Description

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.

Parameters

RArray< TUint > &aSupportedChannels The supported channels.

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

Description

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

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

Parameters

RArray< TFourCC > &aSupportedDataTypes The supported data types.