Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: mda\common\audio.h
Link against: n/a

Class TMdaAudioDataSettings

TMdaAudioDataSettings

Support

Supported from 6.0

Description

The settings for audio data played through the media server.

These can be the settings for an audio clip 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.

Derivation

TMdaAudioDataSettingsThe settings for audio data played through the media server
TMdaDatatypeSettingsBase class used in the derivation of specific data type config packages
TMdaPackageA data structure used to package messages (that include the package type) sent between the media server and its clients
TMdaRawPackageAbstract base class for all media server package types

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

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

See also:


Member functions


TMdaAudioDataSettings()

TMdaAudioDataSettings();

Description

Default constructor. The member data is not initialised.


Query()

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]


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 8KHz.

ESampleRate11025Hz

The audio sample supports a sample rate of 11.025KHz.

ESampleRate16000Hz

The audio sample supports a sample rate of 16KHz.

ESampleRate22050Hz

The audio sample supports a sample rate of 22KHz.

ESampleRate32000Hz

The audio sample supports a sample rate of 32KHz.

ESampleRate44100Hz

The audio sample supports a sample rate of 44.1KHz.

ESampleRate48000Hz

The audio sample supports a sample rate of 48KHz.

EChannelsMono

The audio sample supports mono.

EChannelsStereo

The audio sample supports stereo.

ERoutingControl

This flag is not currently used.

ERealTime

This flag is not currently used.


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]


Data members


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.