MMMFAudioPlayDeviceCustomCommandImplementor Class Reference

class MMMFAudioPlayDeviceCustomCommandImplementor

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

Member Functions Documentation

MapdGetBalanceL(TInt &)

void MapdGetBalanceL ( TInt & aBalance ) [pure virtual]

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

This function can leave with one of the system-wide error codes. The request will be completed with the leave code.

Since
7.0s

Parameters

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

MapdGetMaxVolumeL(TInt &)

void MapdGetMaxVolumeL ( TInt & aMaxVolume ) [pure virtual]

Gets the maximum volume supported by the sound device.

This function can leave with one of the system-wide error codes. The request will be completed with the leave code.

Since
7.0s

Parameters

TInt & aMaxVolume The maximum volume, to be filled in by the controller plugin.

MapdGetVolumeL(TInt &)

void MapdGetVolumeL ( TInt & aVolume ) [pure virtual]

Gets the current playback volume.

This function can leave with one of the system-wide error codes. The request will be completed with the leave code.

Since
7.0s

Parameters

TInt & aVolume The volume, to be filled in by the controller.

MapdSetBalanceL(TInt)

void MapdSetBalanceL ( TInt aBalance ) [pure virtual]

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

This function can leave with one of the system-wide error codes. The request will be completed with the leave code.

Since
7.0s

Parameters

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

MapdSetVolumeL(TInt)

void MapdSetVolumeL ( TInt aVolume ) [pure virtual]

Sets the volume of the sound device.

This function can leave with one of the system-wide error codes. The request will be completed with the leave code.

Since
7.0s

Parameters

TInt aVolume The new volume.

MapdSetVolumeRampL(const TTimeIntervalMicroSeconds &)

void MapdSetVolumeRampL ( const TTimeIntervalMicroSeconds & aRampDuration ) [pure virtual]

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.

This function can leave with one of the system-wide error codes. The request will be completed with the leave code.

Since
7.0s

Parameters

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