Symbian^3 Product Developer Library >

RMMFAudioPlayDeviceCustomCommands Class Reference

class RMMFAudioPlayDeviceCustomCommands : public RMMFCustomCommandsBase

Client class to access Audio Play 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

Inherits from

Public Member Functions
RMMFAudioPlayDeviceCustomCommands(RMMFController &)
IMPORT_C TIntGetBalance(TInt &)
IMPORT_C TIntGetMaxVolume(TInt &)
IMPORT_C TIntGetVolume(TInt &)
IMPORT_C TIntSetBalance(TInt)
IMPORT_C TIntSetVolume(TInt)
IMPORT_C TIntSetVolumeRamp(const TTimeIntervalMicroSeconds &)
Inherited Functions
RMMFCustomCommandsBase::RMMFCustomCommandsBase(RMMFController &,TUid)
Inherited Attributes
RMMFCustomCommandsBase::iController
RMMFCustomCommandsBase::iDestinationPckg

Constructor & Destructor Documentation

RMMFAudioPlayDeviceCustomCommands(RMMFController &)

IMPORT_CRMMFAudioPlayDeviceCustomCommands(RMMFController &aController)

Constructor.

Since
7.0s

Parameters

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

Member Functions Documentation

GetBalance(TInt &)

IMPORT_C TIntGetBalance(TInt &aBalance)const

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

Since
7.0s

Parameters

TInt & aBalanceThe current balance, filled in by the controller.

GetMaxVolume(TInt &)

IMPORT_C TIntGetMaxVolume(TInt &aMaxVolume)const

Gets the maximum volume supported by the sound device.

Since
7.0s

Parameters

TInt & aMaxVolumeThe maximum volume, filled in by the controller.

GetVolume(TInt &)

IMPORT_C TIntGetVolume(TInt &aVolume)const

Gets the current playback volume.

Since
7.0s

Parameters

TInt & aVolumeOn return contains the current playback volume.

SetBalance(TInt)

IMPORT_C TIntSetBalance(TIntaBalance)const

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

Since
7.0s

Parameters

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

SetVolume(TInt)

IMPORT_C TIntSetVolume(TIntaVolume)const

Sets the volume of the sound device.

Since
7.0s

Parameters

TInt aVolumeThe new volume.

SetVolumeRamp(const TTimeIntervalMicroSeconds &)

IMPORT_C TIntSetVolumeRamp(const TTimeIntervalMicroSeconds &aRampDuration)const

Sets a volume ramp.

This will cause the sound device to start playing with zero volume, increasing the volume over aRampDuration microseconds.

The volume ramp can be removed by setting the ramp duration to zero.

Since
7.0s

Parameters

const TTimeIntervalMicroSeconds & aRampDurationThe duration over which the volume is to be increased, in microseconds.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.