RMMFAudioControllerCustomCommands Class Reference

#include <mmf/common/mmfstandardcustomcommands.h>

Link against: mmfstandardcustomcommands.lib

class RMMFAudioControllerCustomCommands : public RMMFCustomCommandsBase, public RMMFCustomCommandsBase

Inherits from

Public Member Functions
RMMFAudioControllerCustomCommands(RMMFController &)
IMPORT_C TIntGetSinkBitRate(TUint &)
IMPORT_C TIntGetSinkDataType(TFourCC &)
IMPORT_C TIntGetSinkFormat(TUid &)
IMPORT_C TIntGetSinkNumChannels(TUint &)
IMPORT_C TIntGetSinkSampleRate(TUint &)
IMPORT_C TIntGetSourceBitRate(TUint &)
IMPORT_C TIntGetSourceDataType(TFourCC &)
IMPORT_C TIntGetSourceFormat(TUid &)
IMPORT_C TIntGetSourceNumChannels(TUint &)
IMPORT_C TIntGetSourceSampleRate(TUint &)
IMPORT_C voidGetSupportedSinkBitRatesL(RArray< TUint > &)
IMPORT_C voidGetSupportedSinkDataTypesL(RArray< TFourCC > &)
IMPORT_C voidGetSupportedSinkNumChannelsL(RArray< TUint > &)
IMPORT_C voidGetSupportedSinkSampleRatesL(RArray< TUint > &)
IMPORT_C voidGetSupportedSourceBitRatesL(RArray< TUint > &)
IMPORT_C voidGetSupportedSourceDataTypesL(RArray< TFourCC > &)
IMPORT_C voidGetSupportedSourceNumChannelsL(RArray< TUint > &)
IMPORT_C voidGetSupportedSourceSampleRatesL(RArray< TUint > &)
IMPORT_C TIntSetCodec(TFourCC, TFourCC)
IMPORT_C TIntSetSinkBitRate(TUint)
IMPORT_C TIntSetSinkDataType(TFourCC)
IMPORT_C TIntSetSinkFormat(TUid)
IMPORT_C TIntSetSinkNumChannels(TUint)
IMPORT_C TIntSetSinkSampleRate(TUint)
IMPORT_C TIntSetSourceBitRate(TUint)
IMPORT_C TIntSetSourceDataType(TFourCC)
IMPORT_C TIntSetSourceFormat(TUid)
IMPORT_C TIntSetSourceNumChannels(TUint)
IMPORT_C TIntSetSourceSampleRate(TUint)
Inherited Attributes
RMMFCustomCommandsBase::iController
RMMFCustomCommandsBase::iDestinationPckg
Inherited Functions
RMMFCustomCommandsBase::RMMFCustomCommandsBase(RMMFController &,TUid)

Detailed 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.

Since
7.0s

Constructor & Destructor Documentation

RMMFAudioControllerCustomCommands ( RMMFController & )

IMPORT_CRMMFAudioControllerCustomCommands(RMMFController &aController)

Constructor.

interface.

Since
7.0s
Parameters
aControllerThe client side controller object to be used by this custom command

Member Function Documentation

GetSinkBitRate ( TUint & )

IMPORT_C TIntGetSinkBitRate(TUint &aRate)const

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

Since
7.0s
Parameters
aRateThe bit rate, in bits per second.
Return Value
One of the system-wide error codes.

GetSinkDataType ( TFourCC & )

IMPORT_C TIntGetSinkDataType(TFourCC &aDataType)const

Gets the fourCC code of the sink.

Since
7.0s
Parameters
aDataTypeThe fourCC code.
Return Value
One of the system-wide error codes.

GetSinkFormat ( TUid & )

IMPORT_C TIntGetSinkFormat(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
aFormatThe format plugin being used.
Return Value
One of the system-wide error codes.

GetSinkNumChannels ( TUint & )

IMPORT_C TIntGetSinkNumChannels(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
aNumChannelsThe number of channels.
Return Value
One of the system-wide error codes.

GetSinkSampleRate ( TUint & )

IMPORT_C TIntGetSinkSampleRate(TUint &aRate)const

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

Since
7.0s
Parameters
aRateThe sample rate, in samples per second.
Return Value
One of the system-wide error codes.

GetSourceBitRate ( TUint & )

IMPORT_C TIntGetSourceBitRate(TUint &aRate)const

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

Since
7.0s
Parameters
aRateThe bit rate, in bits per second.
Return Value
One of the system-wide error codes.

GetSourceDataType ( TFourCC & )

IMPORT_C TIntGetSourceDataType(TFourCC &aDataType)const

Get the fourCC code of the source.

Since
7.0s
Parameters
aDataTypeThe fourCC code.
Return Value
One of the system-wide error codes.

GetSourceFormat ( TUid & )

IMPORT_C TIntGetSourceFormat(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
aFormatThe format plugin being used.
Return Value
One of the system-wide error codes.

GetSourceNumChannels ( TUint & )

IMPORT_C TIntGetSourceNumChannels(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
aNumChannelsThe number of channels.
Return Value
One of the system-wide error codes.

GetSourceSampleRate ( TUint & )

IMPORT_C TIntGetSourceSampleRate(TUint &aRate)const

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

Since
7.0s
Parameters
aRateThe sample rate, in samples per second.
Return Value
One of the system-wide error codes.

GetSupportedSinkBitRatesL ( RArray< TUint > & )

IMPORT_C voidGetSupportedSinkBitRatesL(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
aSupportedRatesThe supported rates.
Return Value
One of the system-wide error codes.

GetSupportedSinkDataTypesL ( RArray< TFourCC > & )

IMPORT_C voidGetSupportedSinkDataTypesL(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
aSupportedDataTypesThe supported data types.
Return Value
One of the system-wide error codes.

GetSupportedSinkNumChannelsL ( RArray< TUint > & )

IMPORT_C voidGetSupportedSinkNumChannelsL(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
aSupportedChannelsThe supported channels.
Return Value
One of the system-wide error codes.

GetSupportedSinkSampleRatesL ( RArray< TUint > & )

IMPORT_C voidGetSupportedSinkSampleRatesL(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
aSupportedRatesThe supported rates.
Return Value
One of the system-wide error codes.

GetSupportedSourceBitRatesL ( RArray< TUint > & )

IMPORT_C voidGetSupportedSourceBitRatesL(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
aSupportedRatesThe supported rates.
Return Value
One of the system-wide error codes.

GetSupportedSourceDataTypesL ( RArray< TFourCC > & )

IMPORT_C voidGetSupportedSourceDataTypesL(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
aSupportedDataTypesThe supported data types.
Return Value
One of the system-wide error codes.

GetSupportedSourceNumChannelsL ( RArray< TUint > & )

IMPORT_C voidGetSupportedSourceNumChannelsL(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
aSupportedChannelsThe supported channels.
Return Value
One of the system-wide error codes.

GetSupportedSourceSampleRatesL ( RArray< TUint > & )

IMPORT_C voidGetSupportedSourceSampleRatesL(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
aSupportedRatesThe supported rates.
Return Value
One of the system-wide error codes.

SetCodec ( TFourCC, TFourCC )

IMPORT_C TIntSetCodec(TFourCCaSourceDataType,
TFourCCaSinkDataType
)const

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

Since
7.0s
Parameters
aSourceDataTypeThe data type of the source of the codec.
aSinkDataTypeThe data type of the sink of the codec.
Return Value
One of the system-wide error codes.

SetSinkBitRate ( TUint )

IMPORT_C TIntSetSinkBitRate(TUintaRate)const

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

Since
7.0s
Parameters
aRateThe bit rate, in bits per second.
Return Value
One of the system-wide error codes.

SetSinkDataType ( TFourCC )

IMPORT_C TIntSetSinkDataType(TFourCCaDataType)const

Set the fourCC code of the sink.

Since
7.0s
Parameters
aDataTypeThe fourCC code.
Return Value
One of the system-wide error codes.

SetSinkFormat ( TUid )

IMPORT_C TIntSetSinkFormat(TUidaFormatUid)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
aFormatUidThe format plugin to be used.
Return Value
One of the system-wide error codes.

SetSinkNumChannels ( TUint )

IMPORT_C TIntSetSinkNumChannels(TUintaNumChannels)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
aNumChannelsThe number of channels.
Return Value
One of the system-wide error codes.

SetSinkSampleRate ( TUint )

IMPORT_C TIntSetSinkSampleRate(TUintaSampleRate)const

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

Since
7.0s
Parameters
aSampleRateThe sample rate, in samples per second.
Return Value
One of the system-wide error codes.

SetSourceBitRate ( TUint )

IMPORT_C TIntSetSourceBitRate(TUintaRate)const

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

Since
7.0s
Parameters
aRateThe bit rate, in bits per second.
Return Value
One of the system-wide error codes.

SetSourceDataType ( TFourCC )

IMPORT_C TIntSetSourceDataType(TFourCCaDataType)const

Sets the fourCC code of the source.

Since
7.0s
Parameters
aDataTypeThe fourCC code.
Return Value
One of the system-wide error codes.

SetSourceFormat ( TUid )

IMPORT_C TIntSetSourceFormat(TUidaFormatUid)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
aFormatUidThe format plugin to be used.
Return Value
One of the system-wide error codes.

SetSourceNumChannels ( TUint )

IMPORT_C TIntSetSourceNumChannels(TUintaNumChannels)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
aNumChannelsThe number of channels.
Return Value
One of the system-wide error codes.

SetSourceSampleRate ( TUint )

IMPORT_C TIntSetSourceSampleRate(TUintaSampleRate)const

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

Since
7.0s
Parameters
aSampleRateThe sample rate, in samples per second.
Return Value
One of the system-wide error codes.
© Nokia 2005.