Collapse all Symbian^3 Product Developer Library

CLoudness Class Reference

class CLoudness : public CAudioEffect

This is the Loudness effect class for managing audio Loudness settings.

LoudnessUtility.lib

Since: 3.0

Inherits from

CLoudness
- CAudioEffect
  - CBase

Public Member Functions
	~CLoudness()
IMPORT_C CLoudness *	NewL(CMdaAudioConvertUtility &)
IMPORT_C CLoudness *	NewL(CMdaAudioInputStream &, TBool)
IMPORT_C CLoudness *	NewL(CMdaAudioOutputStream &, TBool)
IMPORT_C CLoudness *	NewL(CMdaAudioPlayerUtility &, TBool)
IMPORT_C CLoudness *	NewL(CMdaAudioRecorderUtility &, TBool, TBool)
IMPORT_C CLoudness *	NewL(CMdaAudioToneUtility &, TBool)
IMPORT_C CLoudness *	NewL(CMMFDevSound &, TBool)
IMPORT_C CLoudness *	NewL(CCustomCommandUtility *, TBool)
IMPORT_C CLoudness *	NewL(MCustomInterface &, TBool)
IMPORT_C CLoudness *	NewL(CMidiClientUtility &, TBool)
IMPORT_C CLoudness *	NewL(CDrmPlayerUtility &, TBool)
IMPORT_C CLoudness *	NewL(CVideoPlayerUtility &, TBool)
IMPORT_C TUid	Uid()

Protected Member Functions
	CLoudness()
IMPORT_C const TDesC8 &	DoEffectData()
IMPORT_C void	SetEffectData(const TDesC8 &)

Inherited Functions
	CAudioEffect::ApplyL()
	CAudioEffect::CAudioEffect()
	CAudioEffect::DisableL()
	CAudioEffect::EnableL()
	CAudioEffect::EnforceL(TBool)
	CAudioEffect::HaveUpdateRights()const
	CAudioEffect::IsEnabled()const
	CAudioEffect::IsEnforced()const
	CAudioEffect::RegisterObserverL(MAudioEffectObserver &)
	CAudioEffect::UnRegisterObserver(MAudioEffectObserver &)
	CAudioEffect::~CAudioEffect()
	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()

Protected Attributes
TEfLoudnessDataPckg	iDataPckgFrom
TEfLoudnessDataPckg	iDataPckgTo
TEfLoudnessData	iLoudnessData

Inherited Attributes
	CAudioEffect::iEnabled
	CAudioEffect::iEnforced
	CAudioEffect::iHaveUpdateRights
	CAudioEffect::iObservers

Constructor & Destructor Documentation

CLoudness()

IMPORT_C

CLoudness

(

)

[protected]

Private C++ constructor for this class.

Since: 3.0

~CLoudness()

IMPORT_C

~CLoudness

(

)

[virtual]

Destructor

Member Functions Documentation

DoEffectData()

IMPORT_C const TDesC8 &

DoEffectData

(

)

[protected, virtual]

From CAudioEffect Create a package of the effect data

Since: 3.0

NewL(CMdaAudioConvertUtility &)

IMPORT_C CLoudness *

NewL

(

CMdaAudioConvertUtility &

aUtility

)

[static]

Factory function for creating the audio Loudness object.

Since: 3.0

Parameters

CMdaAudioConvertUtility & aUtility

A reference to a convert utility

NewL(CMdaAudioInputStream &, TBool)

IMPORT_C CLoudness *	NewL	(	CMdaAudioInputStream &	aUtility,
			TBool	aEnable = EFalse
		)	[static]

Factory function for creating the Loudness object.

Since: 3.0

Parameters

CMdaAudioInputStream & aUtility	A reference to an audio input stream utility
TBool aEnable = EFalse	Indicate whether the effect will be automatically enabled after creation.

NewL(CMdaAudioOutputStream &, TBool)

IMPORT_C CLoudness *	NewL	(	CMdaAudioOutputStream &	aUtility,
			TBool	aEnable = EFalse
		)	[static]

Factory function for creating the Loudness object.

Since: 3.0

Parameters

CMdaAudioOutputStream & aUtility	A reference to an audio output stream utility
TBool aEnable = EFalse	Indicate whether the effect will be automatically enabled after creation.

NewL(CMdaAudioPlayerUtility &, TBool)

IMPORT_C CLoudness *	NewL	(	CMdaAudioPlayerUtility &	aUtility,
			TBool	aEnable = EFalse
		)	[static]

Factory function for creating the Loudness object.

Since: 3.0

Parameters

CMdaAudioPlayerUtility & aUtility	A reference to an audio player utility
TBool aEnable = EFalse	Indicate whether the effect will be automatically enabled after creation.

NewL(CMdaAudioRecorderUtility &, TBool, TBool)

IMPORT_C CLoudness *	NewL	(	CMdaAudioRecorderUtility &	aUtility,
			TBool	aRecordStream,
			TBool	aEnable = EFalse
		)	[static]

Factory function for creating the Loudness object.

Since: 3.0

Parameters

CMdaAudioRecorderUtility & aUtility	A reference to an audio record utility
TBool aRecordStream	ETrue if the effect is to be applied to the recording, EFalse if the effect is to be applied only to the playback
TBool aEnable = EFalse	Indicate whether the effect will be automatically enabled after creation.

NewL(CMdaAudioToneUtility &, TBool)

IMPORT_C CLoudness *	NewL	(	CMdaAudioToneUtility &	aUtility,
			TBool	aEnable = EFalse
		)	[static]

Factory function for creating the Loudness object.

Since: 3.0

Parameters

CMdaAudioToneUtility & aUtility	A reference to an audio tone utility
TBool aEnable = EFalse	Indicate whether the effect will be automatically enabled after creation.

NewL(CMMFDevSound &, TBool)

IMPORT_C CLoudness *	NewL	(	CMMFDevSound &	aDevSound,
			TBool	aEnable = EFalse
		)	[static]

Factory function for creating the Loudness object.

Since: 3.0

Parameters

CMMFDevSound & aDevSound	A reference to a DevSound instance
TBool aEnable = EFalse	Indicate whether the effect will be automatically enabled after creation.

NewL(CCustomCommandUtility *, TBool)

IMPORT_C CLoudness *	NewL	(	CCustomCommandUtility *	aUtility,
			TBool	aEnable = EFalse
		)	[static]

Factory function for creating the Loudness object.

Since: 3.0

Parameters

CCustomCommandUtility * aUtility	A reference to a custom command utility
TBool aEnable = EFalse	Indicate whether the effect will be automatically enabled after creation.

NewL(MCustomInterface &, TBool)

IMPORT_C CLoudness *	NewL	(	MCustomInterface &	aCustomInterface,
			TBool	aEnable = EFalse
		)	[static]

Factory function for creating the Loudness object.

Since: 3.0

Parameters

MCustomInterface & aCustomInterface	A reference to a custom interface
TBool aEnable = EFalse	Indicate whether the effect will be automatically enabled after creation.

NewL(CMidiClientUtility &, TBool)

IMPORT_C CLoudness *	NewL	(	CMidiClientUtility &	aUtility,
			TBool	aEnable = EFalse
		)	[static]

Factory function for creating the Loudness object.

Since: 3.0

Parameters

CMidiClientUtility & aUtility	A reference to a CMidiClientUtility
TBool aEnable = EFalse	Indicate whether the effect will be automatically enabled after creation.

NewL(CDrmPlayerUtility &, TBool)

IMPORT_C CLoudness *	NewL	(	CDrmPlayerUtility &	aUtility,
			TBool	aEnable = EFalse
		)	[static]

Factory function for creating the Loudness object.

Since: 3.0

Parameters

CDrmPlayerUtility & aUtility
TBool aEnable = EFalse

NewL(CVideoPlayerUtility &, TBool)

IMPORT_C CLoudness *	NewL	(	CVideoPlayerUtility &	aUtility,
			TBool	aEnable = EFalse
		)	[static]

Factory function for creating the Loudness object.

Since: 3.2

Parameters

CVideoPlayerUtility & aUtility
TBool aEnable = EFalse

SetEffectData(const TDesC8 &)

IMPORT_C void

SetEffectData

(

const TDesC8 &

aEffectDataBuffer

)

[protected, virtual]

From CAudioEffect Internal function to unpack effect data

Since: 3.0

Parameters

const TDesC8 & aEffectDataBuffer

Descriptor containing packed effect data

Uid()

IMPORT_C TUid

Uid

(

)

const [virtual]

Member Data Documentation

TEfLoudnessDataPckg iDataPckgFrom

TEfLoudnessDataPckg

iDataPckgFrom

[protected]

TEfLoudnessDataPckg iDataPckgTo

TEfLoudnessDataPckg

iDataPckgTo

[protected]

TEfLoudnessData iLoudnessData

TEfLoudnessData

iLoudnessData

[protected]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.