#include <mmfstandardcustomcommands.h>
Link against: mmfstandardcustomcommands.lib

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(TUint &)constGets the bit rate of the data sink in bits per second.
GetSinkDataType(TFourCC &)constGets the fourCC code of the sink.
GetSinkFormat(TUid &)constGets the format of the data sink.
GetSinkNumChannels(TUint &)constGets the number of channels in the data sink. For example, one channel for mono,...
GetSinkSampleRate(TUint &)constGets the sample rate of the data sink in samples per second.
GetSourceBitRate(TUint &)constGets the bit rate of the data source in bits per second.
GetSourceDataType(TFourCC &)constGet the fourCC code of the source.
GetSourceFormat(TUid &)constGets the format of the data source.
GetSourceNumChannels(TUint &)constGets the number of channels in the data source. For example, one channel for mon...
GetSourceSampleRate(TUint &)constGets the sample rate of the data source in samples per second.
GetSupportedSinkBitRatesL(RArray< TUint > &)constGets the list of bit rates supported by the data sink.
GetSupportedSinkDataTypesL(RArray< TFourCC > &)constGets the list of fourCC codes supported by the data sink.
GetSupportedSinkNumChannelsL(RArray< TUint > &)constGets the list of channels supported by the data sink (ie mono, stereo etc).
GetSupportedSinkSampleRatesL(RArray< TUint > &)constGets the list of sample rates supported by the data sink.
GetSupportedSourceBitRatesL(RArray< TUint > &)constGets the list of bit rates supported by the data source.
GetSupportedSourceDataTypesL(RArray< TFourCC > &)constGets the list of fourCC codes supported by the data source.
GetSupportedSourceNumChannelsL(RArray< TUint > &)constGets the list of channels supported by the data source (ie mono, stereo etc).
GetSupportedSourceSampleRatesL(RArray< TUint > &)constGets the list of sample rates supported by the data source.
RMMFAudioControllerCustomCommands(RMMFController &)Constructor.
SetCodec(TFourCC,TFourCC)constSets the codec to be used. Useful when recording data.
SetSinkBitRate(TUint)constSet the bit rate of the data sink in bits per second.
SetSinkDataType(TFourCC)constSet the fourCC code of the sink.
SetSinkFormat(TUid)constSets the format of the data sink.
SetSinkNumChannels(TUint)constSets the number of channels in the data sink. For example, one channel for mono,...
SetSinkSampleRate(TUint)constSets the sample rate of the data sink in samples per second.
SetSourceBitRate(TUint)constSets the bit rate of the data source in bits per second.
SetSourceDataType(TFourCC)constSets the fourCC code of the source.
SetSourceFormat(TUid)constSets the format of the data source.
SetSourceNumChannels(TUint)constSets the number of channels in the data source. For example, one channel for mon...
SetSourceSampleRate(TUint)constSets the sample rate of the data source in samples per second.

Inherited from RMMFCustomCommandsBase:

RMMFCustomCommandsBase(RMMFController &,TUid)Constructor.
iControllerThe controller.
iDestinationPckgThe destination package.

Construction and destruction

`RMMFAudioControllerCustomCommands(RMMFController &)`

IMPORT_C RMMFAudioControllerCustomCommands(RMMFController &aController);

Description

Constructor.

Parameters


                                 						RMMFController &aController

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

Member functions

`SetSourceSampleRate(TUint)const`

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.

`SetSourceBitRate(TUint)const`

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.

`SetSourceNumChannels(TUint)const`

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.

`SetSourceFormat(TUid)const`

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.

`SetSourceDataType(TFourCC)const`

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.

`SetSinkSampleRate(TUint)const`

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.

`SetSinkBitRate(TUint)const`

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.

`SetSinkNumChannels(TUint)const`

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.

`SetSinkFormat(TUid)const`

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.

`SetSinkDataType(TFourCC)const`

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.

`SetCodec(TFourCC,TFourCC)const`

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.

`GetSourceSampleRate(TUint &)const`

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.

`GetSourceBitRate(TUint &)const`

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.

`GetSourceNumChannels(TUint &)const`

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.

`GetSourceFormat(TUid &)const`

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.

`GetSourceDataType(TFourCC &)const`

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.

`GetSinkSampleRate(TUint &)const`

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.

`GetSinkBitRate(TUint &)const`

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.

`GetSinkNumChannels(TUint &)const`

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.

`GetSinkFormat(TUid &)const`

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.

`GetSinkDataType(TFourCC &)const`

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.

`GetSupportedSourceSampleRatesL(RArray< TUint > &)const`

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.

`GetSupportedSourceBitRatesL(RArray< TUint > &)const`

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.

`GetSupportedSourceNumChannelsL(RArray< TUint > &)const`

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.

`GetSupportedSourceDataTypesL(RArray< TFourCC > &)const`

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.

`GetSupportedSinkSampleRatesL(RArray< TUint > &)const`

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.

`GetSupportedSinkBitRatesL(RArray< TUint > &)const`

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.

`GetSupportedSinkNumChannelsL(RArray< TUint > &)const`

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.

`GetSupportedSinkDataTypesL(RArray< TFourCC > &)const`

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.

Class RMMFAudioControllerCustomCommands

Description

Derivation

Members

Construction and destruction

RMMFAudioControllerCustomCommands(RMMFController &)

Description

Parameters

Member functions

SetSourceSampleRate(TUint)const

Description

Parameters

Return value

SetSourceBitRate(TUint)const

Description

Parameters

Return value

SetSourceNumChannels(TUint)const

Description

Parameters

Return value

SetSourceFormat(TUid)const

Description

Parameters

Return value

SetSourceDataType(TFourCC)const

Description

Parameters

Return value

SetSinkSampleRate(TUint)const

Description

Parameters

Return value

SetSinkBitRate(TUint)const

Description

Parameters

Return value

SetSinkNumChannels(TUint)const

Description

Parameters

Return value

SetSinkFormat(TUid)const

Description

Parameters

Return value

SetSinkDataType(TFourCC)const

Description

Parameters

Return value

SetCodec(TFourCC,TFourCC)const

Description

Parameters

Return value

GetSourceSampleRate(TUint &)const

Description

Parameters

Return value

GetSourceBitRate(TUint &)const

Description

Parameters

Return value

GetSourceNumChannels(TUint &)const

Description

Parameters

Return value

GetSourceFormat(TUid &)const

Description

Parameters

Return value

GetSourceDataType(TFourCC &)const

Description

Parameters

Return value

GetSinkSampleRate(TUint &)const

Description

Parameters

Return value

GetSinkBitRate(TUint &)const

Description

Parameters

Class `RMMFAudioControllerCustomCommands`

`RMMFAudioControllerCustomCommands(RMMFController &)`

`SetSourceSampleRate(TUint)const`

`SetSourceBitRate(TUint)const`

`SetSourceNumChannels(TUint)const`

`SetSourceFormat(TUid)const`

`SetSourceDataType(TFourCC)const`

`SetSinkSampleRate(TUint)const`

`SetSinkBitRate(TUint)const`

`SetSinkNumChannels(TUint)const`

`SetSinkFormat(TUid)const`

`SetSinkDataType(TFourCC)const`

`SetCodec(TFourCC,TFourCC)const`

`GetSourceSampleRate(TUint &)const`

`GetSourceBitRate(TUint &)const`

`GetSourceNumChannels(TUint &)const`

`GetSourceFormat(TUid &)const`

`GetSourceDataType(TFourCC &)const`

`GetSinkSampleRate(TUint &)const`

`GetSinkBitRate(TUint &)const`

`GetSinkNumChannels(TUint &)const`

`GetSinkFormat(TUid &)const`

`GetSinkDataType(TFourCC &)const`

`GetSupportedSourceSampleRatesL(RArray< TUint > &)const`

`GetSupportedSourceBitRatesL(RArray< TUint > &)const`

`GetSupportedSourceNumChannelsL(RArray< TUint > &)const`

`GetSupportedSourceDataTypesL(RArray< TFourCC > &)const`

`GetSupportedSinkSampleRatesL(RArray< TUint > &)const`

`GetSupportedSinkBitRatesL(RArray< TUint > &)const`

`GetSupportedSinkNumChannelsL(RArray< TUint > &)const`

`GetSupportedSinkDataTypesL(RArray< TFourCC > &)const`