TMMFAudioConfig Class Reference

#include <mmf/common/mmfaudio.h>

class TMMFAudioConfig

Detailed Description

A class used when sending custom commands from the client API

to the audio controller to get or set the audio configuration

Member Attribute Documentation

iBalance

TInt iBalance

The balance between left and right stereo channels. Must be between -100 and 100

iChannels

TUint iChannels

The number of channels of the audio device (signifying mono/stereo).

iCropToEnd

TBool iCropToEnd

If true, the audio clip is cropped from the current position to the end and the remainder of the clip

is discarded. If false, the audio clip is cropped from the start of the file to the current position.

The audio data prior to the current position is discarded.

iEndPosition

The end position for audio playback in micro seconds.

iEventType

TUid iEventType

The notification event to register for the client.

iFormatUid

TUid iFormatUid

The format UID to be used.

iGain

TInt iGain

The gain of the audio device. This can be any value from zero to iMaxGain

iLoadingCompletePercentage

TInt iLoadingCompletePercentage

The current completion status of loading/rebuffering.

iMaxDuration

The maximum duration of the recorded clip, in microseconds

iMaxFileSize

TInt iMaxFileSize

The maximum size of the recorded clip, in bytes.

iMaxGain

TInt iMaxGain

The maximum gain of the audio device.

iMaxVolume

TInt iMaxVolume

The maximum volume setting of the audio device.

This value is platform dependent but is always greater than or equal to one. This is the

maximum value that should be passed to iVolume.

iNotificationData

TBuf8< KNotificationDataBufferSize >iNotificationData

The notification data for the client.

iNotificationRegistrationData

TBufC8< KNotificationDataBufferSize >iNotificationRegistrationData

The notification data from the client.

iRampDuration

The period over which the volume is to rise.

A zero value causes the tone sample to be played at the normal level for the full

duration of the playback. A value which is longer than the duration

of the audio sample means that the sample never reaches its normal volume level.

Supported only during tone playing.

iRecordTimeAvailable

TTimeIntervalMicroSeconds iRecordTimeAvailable

The recordable time available to the audio device.

This value may be the estimated time available.

iSampleRate

TUint iSampleRate

The sample rate of the audio device.

iSinkDataTypeCode

TFourCC iSinkDataTypeCode

The sink data codec type.

iSourceDataTypeCode

TFourCC iSourceDataTypeCode

The source data codec type.

iStartPosition

The start position for audio playback in micro seconds.

iState

TInt iState

The current state of the audio device.

iVolume

TInt iVolume

The volume setting. This can be any value from zero to iMaxVolume

Member Enumeration Documentation

Enum anonymous

EnumeratorValueDescription
KNotificationDataBufferSize256

Specifies the maximum buffer length that can be passed with notification request

Constructor & Destructor Documentation

TMMFAudioConfig ( )

TMMFAudioConfig()[inline]

Initialises the object with arbitrary values.

Member Function Documentation

SetReturnSize ( TInt )

voidSetReturnSize(TIntaReturnSize)[inline]

Not implemented.