RMMFAudioRecordDeviceCustomCommands Class Reference

#include "mmfstandardcustomcommands.h"

Link against: mmfstandardcustomcommands.lib

class RMMFAudioRecordDeviceCustomCommands : public RMMFCustomCommandsBase

Inherits from

Public Member Functions
RMMFAudioRecordDeviceCustomCommands(RMMFController &)
IMPORT_C TIntGetBalance(TInt &)
IMPORT_C TIntGetGain(TInt &)
IMPORT_C TIntGetMaxGain(TInt &)
IMPORT_C TIntSetBalance(TInt)
IMPORT_C TIntSetGain(TInt)
Inherited Attributes
RMMFCustomCommandsBase::iController
RMMFCustomCommandsBase::iDestinationPckg
Inherited Functions
RMMFCustomCommandsBase::RMMFCustomCommandsBase(RMMFController &,TUid)

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

Since
7.0s

Constructor & Destructor Documentation

RMMFAudioRecordDeviceCustomCommands ( RMMFController & )

IMPORT_CRMMFAudioRecordDeviceCustomCommands(RMMFController &aController)

Constructor.

Since
7.0s
ParameterDescription
aControllerThe client side controller object to be used by this custom command interface.

Member Function Documentation

GetBalance ( TInt & )

IMPORT_C TIntGetBalance(TInt &aBalance)const

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

Since
7.0s
ParameterDescription
aBalanceThe current balance, filled in by the controller.

Returns: One of the system-wide error codes.

GetGain ( TInt & )

IMPORT_C TIntGetGain(TInt &aGain)const

Gets the current recording gain.

Since
7.0s
ParameterDescription
aGainThe gain, filled in by the controller.

Returns: One of the system-wide error codes.

GetMaxGain ( TInt & )

IMPORT_C TIntGetMaxGain(TInt &aMaxGain)const

Gets the maximum gain supported by the sound device.

Since
7.0s
ParameterDescription
aMaxGainThe maximum gain, filled in by the controller.

Returns: One of the system-wide error codes.

SetBalance ( TInt )

IMPORT_C TIntSetBalance(TIntaBalance)const

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

Since
7.0s
ParameterDescription
aBalanceUse a value between KMMFBalanceMaxLeft and KMMFBalanceMaxRight. Centre balance can be restored by using KMMFBalanceCenter.

Returns: One of the system-wide error codes.

SetGain ( TInt )

IMPORT_C TIntSetGain(TIntaGain)const

Sets the gain of the sound device.

Since
7.0s
ParameterDescription
aGainThe new gain.

Returns: One of the system-wide error codes.

© Nokia 2011.