MMMFAudioControllerCustomCommandImplementor Class Reference

#include "mmfstandardcustomcommands.h"

class MMMFAudioControllerCustomCommandImplementor
Public Member Functions
pure virtual voidMacGetSinkBitRateL(TUint &)
pure virtual voidMacGetSinkDataTypeL(TFourCC &)
pure virtual voidMacGetSinkFormatL(TUid &)
pure virtual voidMacGetSinkNumChannelsL(TUint &)
pure virtual voidMacGetSinkSampleRateL(TUint &)
pure virtual voidMacGetSourceBitRateL(TUint &)
pure virtual voidMacGetSourceDataTypeL(TFourCC &)
pure virtual voidMacGetSourceFormatL(TUid &)
pure virtual voidMacGetSourceNumChannelsL(TUint &)
pure virtual voidMacGetSourceSampleRateL(TUint &)
pure virtual voidMacGetSupportedSinkBitRatesL(RArray< TUint > &)
pure virtual voidMacGetSupportedSinkDataTypesL(RArray< TFourCC > &)
pure virtual voidMacGetSupportedSinkNumChannelsL(RArray< TUint > &)
pure virtual voidMacGetSupportedSinkSampleRatesL(RArray< TUint > &)
pure virtual voidMacGetSupportedSourceBitRatesL(RArray< TUint > &)
pure virtual voidMacGetSupportedSourceDataTypesL(RArray< TFourCC > &)
pure virtual voidMacGetSupportedSourceNumChannelsL(RArray< TUint > &)
pure virtual voidMacGetSupportedSourceSampleRatesL(RArray< TUint > &)
pure virtual voidMacSetCodecL(TFourCC, TFourCC)
pure virtual voidMacSetSinkBitRateL(TUint)
pure virtual voidMacSetSinkDataTypeL(TFourCC)
pure virtual voidMacSetSinkFormatL(TUid)
pure virtual voidMacSetSinkNumChannelsL(TUint)
pure virtual voidMacSetSinkSampleRateL(TUint)
pure virtual voidMacSetSourceBitRateL(TUint)
pure virtual voidMacSetSourceDataTypeL(TFourCC)
pure virtual voidMacSetSourceFormatL(TUid)
pure virtual voidMacSetSourceNumChannelsL(TUint)
pure virtual voidMacSetSourceSampleRateL(TUint)

Detailed Description

Mixin class to be derived from controller plugins that could support the audio record controller custom commands.

Member Function Documentation

MacGetSinkBitRateL ( TUint & )

voidMacGetSinkBitRateL(TUint &aRate)[pure virtual]

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

Since
7.0s
ParameterDescription
aRateThe bit rate, in bits per second.

MacGetSinkDataTypeL ( TFourCC & )

voidMacGetSinkDataTypeL(TFourCC &aDataType)[pure virtual]

Gets the fourCC code of the sink.

Since
7.0s
ParameterDescription
aDataTypeThe fourCC code.

MacGetSinkFormatL ( TUid & )

voidMacGetSinkFormatL(TUid &aFormat)[pure virtual]

Gets the format of the data sink. The UID corresponds to the uid of the CMMFFormat-derived ECOM plugin being used.

Since
7.0s
ParameterDescription
aFormatThe format plugin being used.

MacGetSinkNumChannelsL ( TUint & )

voidMacGetSinkNumChannelsL(TUint &aNumChannels)[pure virtual]

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

Since
7.0s
ParameterDescription
aNumChannelsThe number of channels.

MacGetSinkSampleRateL ( TUint & )

voidMacGetSinkSampleRateL(TUint &aRate)[pure virtual]

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

Since
7.0s
ParameterDescription
aRateThe sample rate, in samples per second.

MacGetSourceBitRateL ( TUint & )

voidMacGetSourceBitRateL(TUint &aRate)[pure virtual]

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

Since
7.0s
ParameterDescription
aRateThe bit rate, in bits per second.

MacGetSourceDataTypeL ( TFourCC & )

voidMacGetSourceDataTypeL(TFourCC &aDataType)[pure virtual]

Gets the fourCC code of the source.

Since
7.0s
ParameterDescription
aDataTypeThe fourCC code.

MacGetSourceFormatL ( TUid & )

voidMacGetSourceFormatL(TUid &aFormat)[pure virtual]

Gets the format of the data source. The UID corresponds to the uid of the CMMFFormat-derived ECOM plugin being used.

Since
7.0s
ParameterDescription
aFormatThe format plugin being used.

MacGetSourceNumChannelsL ( TUint & )

voidMacGetSourceNumChannelsL(TUint &aNumChannels)[pure virtual]

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

Since
7.0s
ParameterDescription
aNumChannelsThe number of channels.

MacGetSourceSampleRateL ( TUint & )

voidMacGetSourceSampleRateL(TUint &aRate)[pure virtual]

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

Since
7.0s
ParameterDescription
aRateThe sample rate, in samples per second.

MacGetSupportedSinkBitRatesL ( RArray< TUint > & )

voidMacGetSupportedSinkBitRatesL(RArray< TUint > &aSupportedRates)[pure virtual]

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
ParameterDescription
aSupportedRatesThe supported rates.

MacGetSupportedSinkDataTypesL ( RArray< TFourCC > & )

voidMacGetSupportedSinkDataTypesL(RArray< TFourCC > &aSupportedDataTypes)[pure virtual]

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
ParameterDescription
aSupportedDataTypesThe supported data types.

MacGetSupportedSinkNumChannelsL ( RArray< TUint > & )

voidMacGetSupportedSinkNumChannelsL(RArray< TUint > &aSupportedChannels)[pure virtual]

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
ParameterDescription
aSupportedChannelsThe supported channels.

MacGetSupportedSinkSampleRatesL ( RArray< TUint > & )

voidMacGetSupportedSinkSampleRatesL(RArray< TUint > &aSupportedRates)[pure virtual]

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
ParameterDescription
aSupportedRatesThe supported rates.

MacGetSupportedSourceBitRatesL ( RArray< TUint > & )

voidMacGetSupportedSourceBitRatesL(RArray< TUint > &aSupportedRates)[pure virtual]

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

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

Since
7.0s
ParameterDescription
aSupportedRatesThe supported rates.

MacGetSupportedSourceDataTypesL ( RArray< TFourCC > & )

voidMacGetSupportedSourceDataTypesL(RArray< TFourCC > &aSupportedDataTypes)[pure virtual]

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
ParameterDescription
aSupportedDataTypesThe supported data types.

MacGetSupportedSourceNumChannelsL ( RArray< TUint > & )

voidMacGetSupportedSourceNumChannelsL(RArray< TUint > &aSupportedChannels)[pure virtual]

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
ParameterDescription
aSupportedChannelsThe supported channels.

MacGetSupportedSourceSampleRatesL ( RArray< TUint > & )

voidMacGetSupportedSourceSampleRatesL(RArray< TUint > &aSupportedRates)[pure virtual]

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

Since
7.0s
ParameterDescription
aSupportedRatesThe supported rates. Warning: Existing objects in this array will be removed by this method.

MacSetCodecL ( TFourCC, TFourCC )

voidMacSetCodecL(TFourCCaSourceDataType,
TFourCCaSinkDataType
)[pure virtual]

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

Since
7.0s
ParameterDescription
aSourceDataTypeThe data type of the source of the codec.
aSinkDataTypeThe data type of the sink of the codec.

MacSetSinkBitRateL ( TUint )

voidMacSetSinkBitRateL(TUintaRate)[pure virtual]

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

Since
7.0s
ParameterDescription
aRateThe bit rate, in bits per second.

MacSetSinkDataTypeL ( TFourCC )

voidMacSetSinkDataTypeL(TFourCCaDataType)[pure virtual]

Sets the fourCC code of the sink.

Since
7.0s
ParameterDescription
aDataTypeThe fourCC code.

MacSetSinkFormatL ( TUid )

voidMacSetSinkFormatL(TUidaFormatUid)[pure virtual]

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
ParameterDescription
aFormatUidThe format plugin to be used.

MacSetSinkNumChannelsL ( TUint )

voidMacSetSinkNumChannelsL(TUintaNumChannels)[pure virtual]

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

Since
7.0s
ParameterDescription
aNumChannelsThe number of channels.

MacSetSinkSampleRateL ( TUint )

voidMacSetSinkSampleRateL(TUintaSampleRate)[pure virtual]

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

Since
7.0s
ParameterDescription
aSampleRateThe sample rate, in samples per second.

MacSetSourceBitRateL ( TUint )

voidMacSetSourceBitRateL(TUintaBitRate)[pure virtual]

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

Since
7.0s
ParameterDescription
aBitRateThe bit rate, in bits per second.

MacSetSourceDataTypeL ( TFourCC )

voidMacSetSourceDataTypeL(TFourCCaDataType)[pure virtual]

Sets the fourCC code of the source.

Since
7.0s
ParameterDescription
aDataTypeThe fourCC code.

MacSetSourceFormatL ( TUid )

voidMacSetSourceFormatL(TUidaFormatUid)[pure virtual]

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
ParameterDescription
aFormatUidThe format plugin to be used.

MacSetSourceNumChannelsL ( TUint )

voidMacSetSourceNumChannelsL(TUintaNumChannels)[pure virtual]

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

Since
7.0s
ParameterDescription
aNumChannelsThe number of channels.

MacSetSourceSampleRateL ( TUint )

voidMacSetSourceSampleRateL(TUintaSampleRate)[pure virtual]

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

Since
7.0s
ParameterDescription
aSampleRateThe sample rate, in samples per second.