Class TMMFAudioConfig

class TMMFAudioConfig;

Description

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

Members

Defined in TMMFAudioConfig:

• KNotificationDataBufferSizeSpecifies the maximum buffer length that can be passed with notification request
• SetReturnSize(TInt)Not implemented.
• TMMFAudioConfig()Initialises the object with arbitrary values.
• anonymous
• iBalanceThe balance between left and right stereo channels. Must be between -100 and 100
• iChannelsThe number of channels of the audio device (signifying mono/stereo).
• iCropToEndIf true, the audio clip is cropped from the current position to the end and the ...
• iEndPositionThe end position for audio playback in micro seconds.
• iEventTypeThe notification event to register for the client.
• iFormatUidThe format UID to be used.
• iGainThe gain of the audio device. This can be any value from zero to iMaxGain
• iLoadingCompletePercentageThe current completion status of loading/rebuffering.
• iMaxDurationThe maximum duration of the recorded clip, in microseconds
• iMaxFileSizeThe maximum size of the recorded clip, in bytes.
• iMaxGainThe maximum gain of the audio device.
• iMaxVolumeThe maximum volume setting of the audio device.
• iNotificationDataThe notification data for the client.
• iNotificationRegistrationDataThe notification data from the client.
• iRampDurationThe period over which the volume is to rise.
• iRecordTimeAvailableThe recordable time available to the audio device.
• iSampleRateThe sample rate of the audio device.
• iSinkDataTypeCodeThe sink data codec type.
• iSourceDataTypeCodeThe source data codec type.
• iStartPositionThe start position for audio playback in micro seconds.
• iStateThe current state of the audio device.
• iVolumeThe volume setting. This can be any value from zero to iMaxVolume

inline TMMFAudioConfig();

Description

Initialises the object with arbitrary values.

inline void SetReturnSize(TInt aReturnSize);

Description

Not implemented.

Parameters

n/a

Description

TInt iVolume;

Description

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

TInt iMaxVolume;

Description

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.

TInt iBalance;

Description

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

TInt iGain;

Description

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

TInt iMaxGain;

Description

The maximum gain of the audio device.

TBool iCropToEnd;

Description

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.

TUint iChannels;

Description

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

TUint iSampleRate;

Description

The sample rate of the audio device.

TUid iFormatUid;

Description

The format UID to be used.

TFourCC iSourceDataTypeCode;

Description

The source data codec type.

TFourCC iSinkDataTypeCode;

Description

The sink data codec type.

TTimeIntervalMicroSeconds iStartPosition;

Description

The start position for audio playback in micro seconds.

TTimeIntervalMicroSeconds iEndPosition;

Description

The end position for audio playback in micro seconds.

TTimeIntervalMicroSeconds iRampDuration;

Description

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;

Description

The recordable time available to the audio device.

This value may be the estimated time available.

TTimeIntervalMicroSeconds iMaxDuration;

Description

The maximum duration of the recorded clip, in microseconds

TInt iMaxFileSize;

Description

The maximum size of the recorded clip, in bytes.

TInt iState;

Description

The current state of the audio device.

TInt iLoadingCompletePercentage;

Description

The current completion status of loading/rebuffering.

TUid iEventType;

Description

The notification event to register for the client.

TBufC8< KNotificationDataBufferSize > iNotificationRegistrationData;

Description

The notification data from the client.

TBuf8< KNotificationDataBufferSize > iNotificationData;

Description

The notification data for the client.