Collapse all Symbian^3 Application Developer Library

TMdaAudioDataSettings Class Reference

class TMdaAudioDataSettings : public TMdaDatatypeSettings

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().

CMdaAudioType CMdaAudioOutputStream::Open()

Inherits from

TMdaAudioDataSettings
- TMdaDatatypeSettings
  - TMdaPackage
    - TMdaRawPackage

Public Member Functions
	TMdaAudioDataSettings ()
void	Query ()

Inherited Functions
	TMdaDatatypeSettings::TMdaDatatypeSettings(TUid,TInt)
	TMdaPackage::SetUid(TUid)
	TMdaPackage::TMdaPackage(TUid,TUid,TInt)
	TMdaPackage::Type()const
	TMdaPackage::Uid()const
	TMdaPackage::operator==(const TMdaPackage &)
	TMdaRawPackage::Package()
	TMdaRawPackage::Package()const
	TMdaRawPackage::SetSize(TInt)
	TMdaRawPackage::TMdaRawPackage(TInt)

Public Member Enumerations
enum	TAudioCaps { ESampleRateFixed = 0x00000001, ESampleRateAnyInRange = 0x00000002, ESampleRate8000Hz = 0x00000010, ESampleRate11025Hz = 0x00000040, ESampleRate12000Hz = 0x00000080, ESampleRate16000Hz = 0x00000100, ESampleRate22050Hz = 0x00000400, ESampleRate24000Hz = 0x00000800, ESampleRate32000Hz = 0x00001000, ESampleRate44100Hz = 0x00004000, ESampleRate48000Hz = 0x00010000, ESampleRate96000Hz = 0x00020000, ESampleRate64000Hz = 0x00040000, EChannelsMono = 0x02000000, EChannelsStereo = 0x04000000, ERoutingControl = 0x08000000, ERealTime = 0x10000000 }
enum	TAudioFlags { ENoLocalRouting = 0x00000001, ENoNetworkRouting = 0x00000002 }

Public Member Enumerations

enum

TAudioCaps {
ESampleRateFixed = 0x00000001, ESampleRateAnyInRange = 0x00000002, ESampleRate8000Hz = 0x00000010, ESampleRate11025Hz = 0x00000040, ESampleRate12000Hz = 0x00000080, ESampleRate16000Hz = 0x00000100, ESampleRate22050Hz = 0x00000400, ESampleRate24000Hz = 0x00000800, ESampleRate32000Hz = 0x00001000, ESampleRate44100Hz = 0x00004000, ESampleRate48000Hz = 0x00010000, ESampleRate96000Hz = 0x00020000, ESampleRate64000Hz = 0x00040000, EChannelsMono = 0x02000000, EChannelsStereo = 0x04000000, ERoutingControl = 0x08000000, ERealTime = 0x10000000
}

enum

TAudioFlags { ENoLocalRouting = 0x00000001, ENoNetworkRouting = 0x00000002 }

Public Attributes
TInt	iCaps
TInt	iChannels
TInt	iFlags
TInt	iMaxVolume
TInt	iSampleRate
TInt	iVolume

Inherited Attributes
	TMdaRawPackage::iThis

Constructor & Destructor Documentation

TMdaAudioDataSettings()

TMdaAudioDataSettings

(

)

[inline]

Default constructor. The member data is not initialised.

Member Functions Documentation

Query()

void

Query

(

)

[inline]

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.

Member Enumerations Documentation

Enum TAudioCaps

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

Enumerators

ESampleRateFixed = 0x00000001	If specified, the sample rate iSampleRate is the only one supported. If not specified, multiple sample rates may be supported.
ESampleRateAnyInRange = 0x00000002	If specified, all sample rates between the minimum and the maximum are supported.
ESampleRate8000Hz = 0x00000010	The audio sample supports a sample rate of 8.000KHz.
ESampleRate11025Hz = 0x00000040	The audio sample supports a sample rate of 11.025KHz.
ESampleRate12000Hz = 0x00000080	The audio sample supports a sample rate of 12.000KHz.
ESampleRate16000Hz = 0x00000100	The audio sample supports a sample rate of 16.000KHz.
ESampleRate22050Hz = 0x00000400	The audio sample supports a sample rate of 22.000KHz.
ESampleRate24000Hz = 0x00000800	The audio sample supports a sample rate of 24.000KHz.
ESampleRate32000Hz = 0x00001000	The audio sample supports a sample rate of 32.000KHz.
ESampleRate44100Hz = 0x00004000	The audio sample supports a sample rate of 44.100KHz.
ESampleRate48000Hz = 0x00010000	The audio sample supports a sample rate of 48.000KHz.
ESampleRate96000Hz = 0x00020000	The audio sample supports a sample rate of 96.000KHz.
ESampleRate64000Hz = 0x00040000	The audio sample supports a sample rate of 64.000KHz.
EChannelsMono = 0x02000000	The audio sample supports mono.
EChannelsStereo = 0x04000000	The audio sample supports stereo.
ERoutingControl = 0x08000000	Routing related
ERealTime = 0x10000000	True if data flow is synchronised with real time (e.g. stream)

Enum TAudioFlags

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.

Enumerators

ENoLocalRouting = 0x00000001	The sound data is only sent to the network.
ENoNetworkRouting = 0x00000002	The sound data is only sent to the local device.

Member Data Documentation

TInt iCaps

TInt

iCaps

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

TInt iChannels

TInt

iChannels

The number of channels for the audio sample.

TInt iFlags

TInt

iFlags

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

TInt iMaxVolume

TInt	iMaxVolume

The maximum volume of the audio device.

TInt iSampleRate

TInt	iSampleRate

The sample rate of the audio sample.

TInt iVolume

TInt

iVolume

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