Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: MmfAudio.h

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:
KNotificationDataBufferSize, SetReturnSize(), TMMFAudioConfig(), anonymous, iBalance, iChannels, iCropToEnd, iEndPosition, iEventType, iFormatUid, iGain, iLoadingCompletePercentage, iMaxDuration, iMaxFileSize, iMaxGain, iMaxVolume, iNotificationData, iNotificationRegistrationData, iRampDuration, iRecordTimeAvailable, iSampleRate, iSinkDataTypeCode, iSourceDataTypeCode, iStartPosition, iState, iVolume


Construction and destruction


TMMFAudioConfig()

inline TMMFAudioConfig();

Description

Initialises the object with arbitrary values.

[Top]


Member functions


SetReturnSize()

inline void SetReturnSize(TInt aReturnSize);

Description

Not implemented.

Parameters

TInt aReturnSize

[Top]


Member enumerations


Enum anonymous

n/a

Description

KNotificationDataBufferSize

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

[Top]


Member data


iVolume

TInt iVolume;

Description

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


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.


iBalance

TInt iBalance;

Description

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


iGain

TInt iGain;

Description

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


iMaxGain

TInt iMaxGain;

Description

The maximum gain of the audio device.


iCropToEnd

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.


iChannels

TUint iChannels;

Description

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


iSampleRate

TUint iSampleRate;

Description

The sample rate of the audio device.


iFormatUid

TUid iFormatUid;

Description

The format UID to be used.


iSourceDataTypeCode

TFourCC iSourceDataTypeCode;

Description

The source data codec type.


iSinkDataTypeCode

TFourCC iSinkDataTypeCode;

Description

The sink data codec type.


iStartPosition

TTimeIntervalMicroSeconds iStartPosition;

Description

The start position for audio playback in micro seconds.


iEndPosition

TTimeIntervalMicroSeconds iEndPosition;

Description

The end position for audio playback in micro seconds.


iRampDuration

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.


iRecordTimeAvailable

TTimeIntervalMicroSeconds iRecordTimeAvailable;

Description

The recordable time available to the audio device.

This value may be the estimated time available.


iMaxDuration

TTimeIntervalMicroSeconds iMaxDuration;

Description

The maximum duration of the recorded clip, in microseconds


iMaxFileSize

TInt iMaxFileSize;

Description

The maximum size of the recorded clip, in bytes.


iState

TInt iState;

Description

The current state of the audio device.


iLoadingCompletePercentage

TInt iLoadingCompletePercentage;

Description

The current completion status of loading/rebuffering.


iEventType

TUid iEventType;

Description

The notification event to register for the client.


iNotificationRegistrationData

TBufC8< KNotificationDataBufferSize > iNotificationRegistrationData;

Description

The notification data from the client.


iNotificationData

TBuf8< KNotificationDataBufferSize > iNotificationData;

Description

The notification data for the client.