Symbian
Symbian OS Library

SYMBIAN OS V9.3

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



Location: Audio.h

Class TMdaAudioDataSettings

class TMdaAudioDataSettings : public TMdaDatatypeSettings;

Description

The settings for audio data played through the media server.

These can be the settings for an audio clip, for streamed audio data, or can be the capabilities of the sound device. The sample rate and number of channels apply to the audio sample, the maximum volume applies to the output device and the volume setting can apply to either, depending on the device. An object of this class is a public data member of class CMdaAudioType and also can be passed to CMdaAudioOutputStream::Open().

Derivation

Members

Defined in TMdaAudioDataSettings:
EChannelsMono, EChannelsStereo, ENoLocalRouting, ENoNetworkRouting, ERealTime, ERoutingControl, ESampleRate11025Hz, ESampleRate12000Hz, ESampleRate16000Hz, ESampleRate22050Hz, ESampleRate24000Hz, ESampleRate32000Hz, ESampleRate44100Hz, ESampleRate48000Hz, ESampleRate64000Hz, ESampleRate8000Hz, ESampleRate96000Hz, ESampleRateAnyInRange, ESampleRateFixed, Query(), TAudioCaps, TAudioFlags, TMdaAudioDataSettings(), iCaps, iChannels, iFlags, iMaxVolume, iSampleRate, iVolume

Inherited from TMdaPackage:
SetUid(), Type(), Uid(), operator==()

Inherited from TMdaRawPackage:
Package(), SetSize(), iThis

See also:


Construction and destruction


TMdaAudioDataSettings()

inline TMdaAudioDataSettings();

Description

Default constructor. The member data is not initialised.

[Top]


Member functions


Query()

inline void Query();

Description

Sets the number of channels, the sample rate and the volume to KMdaUnknown (–1). Call this function when you only want to have the iCaps and iMaxVolume members filled.

[Top]


Member enumerations


Enum TAudioCaps

TAudioCaps

Description

Audio capabilities, which include the sample rate and number of channels. The iCaps member is a combination of these flags.

ESampleRateFixed

If specified, the sample rate iSampleRate is the only one supported. If not specified, multiple sample rates may be supported.

ESampleRateAnyInRange

If specified, all sample rates between the minimum and the maximum are supported.

ESampleRate8000Hz

The audio sample supports a sample rate of 8.000KHz.

ESampleRate11025Hz

The audio sample supports a sample rate of 11.025KHz.

ESampleRate12000Hz

The audio sample supports a sample rate of 12.000KHz.

ESampleRate16000Hz

The audio sample supports a sample rate of 16.000KHz.

ESampleRate22050Hz

The audio sample supports a sample rate of 22.000KHz.

ESampleRate24000Hz

The audio sample supports a sample rate of 24.000KHz.

ESampleRate32000Hz

The audio sample supports a sample rate of 32.000KHz.

ESampleRate44100Hz

The audio sample supports a sample rate of 44.100KHz.

ESampleRate48000Hz

The audio sample supports a sample rate of 48.000KHz.

ESampleRate96000Hz

The audio sample supports a sample rate of 96.000KHz.

ESampleRate64000Hz

The audio sample supports a sample rate of 64.000KHz.

EChannelsMono

The audio sample supports mono.

EChannelsStereo

The audio sample supports stereo.

ERoutingControl

Routing related

ERealTime

True if data flow is synchronised with real time (e.g. stream)


Enum TAudioFlags

TAudioFlags

Description

Mutually exclusive flags that specify whether audio data is sent to the local device (speakers) or the network (phone line) or both. The iFlags member uses these flags.

ENoLocalRouting

The sound data is only sent to the network.

ENoNetworkRouting

The sound data is only sent to the local device.

[Top]


Member data


iCaps

TInt iCaps;

Description

Specifies the capabilities of the audio sample. Its value is a combination of the flags contained in the TAudioCaps enum.


iMaxVolume

TInt iMaxVolume;

Description

The maximum volume of the audio device.


iSampleRate

TInt iSampleRate;

Description

The sample rate of the audio sample.


iChannels

TInt iChannels;

Description

The number of channels for the audio sample.


iVolume

TInt iVolume;

Description

The volume. Whether this applies to the audio device or to the audio sample is device-dependent.


iFlags

TInt iFlags;

Description

The flags. Its value can be either of the flags contained in the TAudioFlags enum.