Collapse all Symbian^3 Application Developer Library

CGlobalAudioSettings Class Reference

class CGlobalAudioSettings : public CBase

API for accessing global settings that affects Audio behavior.

This is API is intended to be used by Adaptation to read system attributes that affect audio behavior. This API also provides notification when any of these attribute values change.

GlobalAudioSettings.lib

Since: S60 3.2

Inherits from

CGlobalAudioSettings
- CBase

Public Member Functions
	~CGlobalAudioSettings ()
IMPORT_C TInt	GetAudioClientsList ( TAudioClientListType , RArray < TProcessId > &)
IMPORT_C TBool	IsMessageTonesEnabled ()
IMPORT_C TBool	IsPublicSilenceEnabled ()
IMPORT_C TBool	IsSilentProfileEnabled ()
IMPORT_C TBool	IsVibraEnabled ()
IMPORT_C TBool	IsWarningTonesEnabled ()
IMPORT_C CGlobalAudioSettings *	NewL ( MAudioSettingsObserver &)
IMPORT_C TInt	RegisterAudioClientsListObserver ( MAudioClientsListObserver &)
IMPORT_C TInt	UnregisterAudioClientsListObserver ( MAudioClientsListObserver &)

Private Member Functions
	CGlobalAudioSettings ()
void	ConstructL ( MAudioSettingsObserver &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Member Enumerations
enum	TAudioClientListType { EActiveAudioClients , EPausedAudioClients }

Private Attributes
CGlobalAudioSettingsImpl *	iBody

Constructor & Destructor Documentation

CGlobalAudioSettings()

CGlobalAudioSettings

(

)

[private]

~CGlobalAudioSettings()

IMPORT_C

~CGlobalAudioSettings

(

)

Destructor.

Member Functions Documentation

ConstructL(MAudioSettingsObserver &)

void

ConstructL

(

MAudioSettingsObserver &

aAudioSettingsObserver

)

[private]

Second Phase Costructor for GlobalAudioSettings Instance

Since: 3.2

Parameters

MAudioSettingsObserver & aAudioSettingsObserver

GetAudioClientsList(TAudioClientListType, RArray< TProcessId > &)

IMPORT_C TInt	GetAudioClientsList	(	TAudioClientListType	aType,
			RArray < TProcessId > &	aList
		)

Gets audio clients list.

On return of this function, the parameter aList will contain active audio client application process ids.

The parameter aList will be reset in the case

Since: S60 3.2

Parameters

TAudioClientListType aType
RArray < TProcessId > & aList

IsMessageTonesEnabled()

IMPORT_C TBool

IsMessageTonesEnabled

(

)

Returns message tones status set in the current profile.

If message tones are disabled in the current profile, Adaptation should reject play requests having preferences mapped to message tones.

Since: S60 3.2

IsPublicSilenceEnabled()

IMPORT_C TBool

IsPublicSilenceEnabled

(

)

Returns PublicSilence feature.

If PublicSilence feature is enabled and if current profile is Silent Profile, For all play requests having preferences mapped to Public Silence setting, audio should only be played out via private accessory. If no private accessory is connected, then playback should be rejected.

Since: S60 3.2

IsSilentProfileEnabled()

IMPORT_C TBool

IsSilentProfileEnabled

(

)

Returns current silent profile status.

Since: S60 3.2

IsVibraEnabled()

IMPORT_C TBool

IsVibraEnabled

(

)

Returns vibra status set in the current profile..

If vibra is enabled in the current profile and vibra is not part of the content, Adaptation should play vibra periodically for play requests having preferences mapped to vibra settings.

Since: S60 3.2

IsWarningTonesEnabled()

IMPORT_C TBool

IsWarningTonesEnabled

(

)

Returns warning tones status set in the current profile.

If warning tones are disabled in the current profile, Adaptation should reject play requests having preferences mapped to warning tones.

Since: S60 3.2

NewL(MAudioSettingsObserver &)

IMPORT_C CGlobalAudioSettings *

NewL

(

MAudioSettingsObserver &

aAudioSettingsObserver

)

[static]

function for creating the GlobalAudioSettings

Parameters

MAudioSettingsObserver & aAudioSettingsObserver

RegisterAudioClientsListObserver(MAudioClientsListObserver &)

IMPORT_C TInt

RegisterAudioClientsListObserver

(

MAudioClientsListObserver &

aObserver

)

Registers audio clients list observer.

When registered successfully, the observer will start receiveing callback defined in MAudioClientsListObserver when audio clients list changes.

Since: S60 3.2

Parameters

MAudioClientsListObserver & aObserver

UnregisterAudioClientsListObserver(MAudioClientsListObserver &)

IMPORT_C TInt

UnregisterAudioClientsListObserver

(

MAudioClientsListObserver &

aObserver

)

Unregisters audio clients list observer.

When unregistered, the observer will no longer receive callback when audio clients list changes.

Since: S60 3.2

Parameters

MAudioClientsListObserver & aObserver

Member Enumerations Documentation

Enum TAudioClientListType

Enumerators

EActiveAudioClients
EPausedAudioClients

Member Data Documentation

CGlobalAudioSettingsImpl * iBody

CGlobalAudioSettingsImpl *

iBody

[private]