Class RMMFAudioRecordDeviceCustomCommands

class RMMFAudioRecordDeviceCustomCommands : public RMMFCustomCommandsBase;

Description

Client class to access Audio Record Device functionality.

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.

• RMMFAudioRecordDeviceCustomCommands - Client class to access Audio Record Device functionality.

Members

Defined in RMMFAudioRecordDeviceCustomCommands:

• GetBalance(TInt &)constGets the balance between the left and right stereo microphone channels.
• GetGain(TInt &)constGets the current recording gain.
• GetMaxGain(TInt &)constGets the maximum gain supported by the sound device.
• RMMFAudioRecordDeviceCustomCommands(RMMFController &)Constructor.
• SetBalance(TInt)constSets the balance between the left and right stereo microphone channels.
• SetGain(TInt)constSets the gain of the sound device.

Inherited from RMMFCustomCommandsBase:

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

IMPORT_C RMMFAudioRecordDeviceCustomCommands(RMMFController &aController);

Description

Constructor.

Parameters

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

IMPORT_C TInt SetGain(TInt aGain) const;

Description

Sets the gain of the sound device.

Parameters

TInt aGain The new gain.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetMaxGain(TInt &aMaxGain) const;

Description

Gets the maximum gain supported by the sound device.

Parameters

TInt &aMaxGain The maximum gain, filled in by the controller.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetGain(TInt &aGain) const;

Description

Gets the current recording gain.

Parameters

TInt &aGain The gain, filled in by the controller.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetBalance(TInt aBalance) const;

Description

Sets the balance between the left and right stereo microphone channels.

Parameters

TInt aBalance Use a value between KMMFBalanceMaxLeft and KMMFBalanceMaxRight. Centre balance can be restored by using KMMFBalanceCenter.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt GetBalance(TInt &aBalance) const;

Description

Gets the balance between the left and right stereo microphone channels.

Parameters

TInt &aBalance The current balance, filled in by the controller.

Return value

TInt One of the system-wide error codes.