TMMFAudioConfig Class Reference

class TMMFAudioConfig

A class used when sending custom commands from the client API to the audio controller to get or set the audio configuration

Constructor & Destructor Documentation

TMMFAudioConfig()

TMMFAudioConfig ( ) [inline]

Initialises the object with arbitrary values.

Member Functions Documentation

SetReturnSize(TInt)

void SetReturnSize ( TInt aReturnSize ) [inline]

Not implemented.

Parameters

TInt aReturnSize

Member Enumerations Documentation

Enum anonymous

Enumerators

KNotificationDataBufferSize = 256

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

Member Data Documentation

TInt iBalance

TInt iBalance

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

TUint iChannels

TUint iChannels

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

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

TTimeIntervalMicroSeconds iEndPosition

TTimeIntervalMicroSeconds iEndPosition

The end position for audio playback in micro seconds.

TUid iEventType

TUid iEventType

The notification event to register for the client.

TUid iFormatUid

TUid iFormatUid

The format UID to be used.

TInt iGain

TInt iGain

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

TInt iLoadingCompletePercentage

TInt iLoadingCompletePercentage

The current completion status of loading/rebuffering.

TTimeIntervalMicroSeconds iMaxDuration

TTimeIntervalMicroSeconds iMaxDuration

The maximum duration of the recorded clip, in microseconds

TInt iMaxFileSize

TInt iMaxFileSize

The maximum size of the recorded clip, in bytes.

TInt iMaxGain

TInt iMaxGain

The maximum gain of the audio device.

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

TBuf8< KNotificationDataBufferSize > iNotificationData

TBuf8 < KNotificationDataBufferSize > iNotificationData

The notification data for the client.

TBufC8< KNotificationDataBufferSize > iNotificationRegistrationData

TBufC8 < KNotificationDataBufferSize > iNotificationRegistrationData

The notification data from the client.

TTimeIntervalMicroSeconds iRampDuration

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

TTimeIntervalMicroSeconds iRecordTimeAvailable

TTimeIntervalMicroSeconds iRecordTimeAvailable

The recordable time available to the audio device.

This value may be the estimated time available.

TInt iReserved1

TInt iReserved1 [private]

This member is internal and not intended for use.

TInt iReserved2

TInt iReserved2 [private]

TInt iReserved3

TInt iReserved3 [private]

TUint iSampleRate

TUint iSampleRate

The sample rate of the audio device.

TFourCC iSinkDataTypeCode

TFourCC iSinkDataTypeCode

The sink data codec type.

TFourCC iSourceDataTypeCode

TFourCC iSourceDataTypeCode

The source data codec type.

TTimeIntervalMicroSeconds iStartPosition

TTimeIntervalMicroSeconds iStartPosition

The start position for audio playback in micro seconds.

TInt iState

TInt iState

The current state of the audio device.

TInt iVolume

TInt iVolume

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