CBassBoost Class Reference

#include <BassBoostBase.h>

Link against: BassBoostUtility.lib

class CBassBoost : public CAudioEffect

Inherits from

CBassBoost
- CAudioEffect

Protected Attributes
TEfBassBoostData	iBassBoostData
TEfBassBoostDataPckg	iDataPckgFrom
TEfBassBoostDataPckg	iDataPckgTo

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

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

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

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

Detailed Description

This is the bass boost effect class for managing audio bass boost settings.

Since: 3.0

Member Attribute Documentation

iBassBoostData

TEfBassBoostData

iBassBoostData

[protected]

iDataPckgFrom

TEfBassBoostDataPckg

iDataPckgFrom

[protected]

iDataPckgTo

TEfBassBoostDataPckg

iDataPckgTo

[protected]

Constructor & Destructor Documentation

CBassBoost ( )

IMPORT_C

CBassBoost

(

)

[protected]

Private C++ constructor for this class.

Since: 3.0

Returns: -

~CBassBoost ( )

IMPORT_C

~CBassBoost

(

)

[virtual]

Destructor

Member Function Documentation

DoEffectData ( )

IMPORT_C const TDesC8 &

DoEffectData

(

)

[protected, virtual]

Reimplemented from CAudioEffect::DoEffectData()

From CAudioEffect Create a package of the effect data

Since: 3.0

Returns: A descriptor containing the effect data.

NewL ( CMMFDevSound &, TBool )

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

Factory function for creating the bass boost object.

Since: 3.0

Parameter	Description
aDevSound	A reference to a DevSound instance
aEnable	Indicate whether the effect will be automatically enabled after creation.

Returns: pointer to CBassBoost object

NewL ( CMdaAudioConvertUtility &, TBool )

IMPORT_C CBassBoost *	NewL	(	CMdaAudioConvertUtility &	aUtility,
			TBool	aEnable = EFalse
		)	[static]

Factory function for creating the bass boost object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio convert utility
aEnable	Indicate whether the effect will be automatically enabled after creation.

Returns: pointer to CBassBoost object

NewL ( CMdaAudioInputStream &, TBool )

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

Factory function for creating the bass boost object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio input stream utility
aEnable	Indicate whether the effect will be automatically enabled after creation.

Returns: pointer to CBassBoost object

NewL ( CMdaAudioOutputStream &, TBool )

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

Factory function for creating the bass boost object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio output stream utility
aEnable	Indicate whether the effect will be automatically enabled after creation.

Returns: pointer to CBassBoost object

NewL ( CMdaAudioPlayerUtility &, TBool )

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

Factory function for creating the bass boost object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio player utility
aEnable	Indicate whether the effect will be automatically enabled after creation.

Returns: pointer to CBassBoost object

NewL ( CMdaAudioRecorderUtility &, TBool, TBool )

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

Factory function for creating the bass boost object.

Since: 3.0

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

Returns: pointer to CBassBoost object

NewL ( CMdaAudioToneUtility &, TBool )

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

Factory function for creating the bass boost object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio tone utility
aEnable	Indicate whether the effect will be automatically enabled after creation.

Returns: pointer to CBassBoost object

NewL ( CCustomCommandUtility *, TBool )

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

Factory function for creating the bass boost object.

Since: 3.0

Parameter	Description
aUtility	A reference to a custom command utility
aEnable	Indicate whether the effect will be automatically enabled after creation.

Returns: pointer to CBassBoost object

NewL ( MCustomInterface &, TBool )

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

Factory function for creating the bass boost object.

Since: 3.0

Parameter	Description
aCustomInterface	A reference to a custom interface
aEnable	Indicate whether the effect will be automatically enabled after creation.

Returns: pointer to CBassBoost object

NewL ( CMidiClientUtility &, TBool )

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

Factory function for creating the bass boost object.

Since: 3.0

Parameter	Description
aUtility	A reference to a CMidiClientUtility
aEnable	Indicate whether the effect will be automatically enabled after creation.

Returns: pointer to CBassBoost object

NewL ( CDrmPlayerUtility &, TBool )

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

Factory function for creating the bass boost object.

Since: 3.0

Returns: pointer to CBassBoost object

NewL ( CVideoPlayerUtility &, TBool )

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

Factory function for creating the bass boost object.

Since: 3.2

Returns: pointer to CBassBoost object

SetEffectData ( const TDesC8 & )

IMPORT_C void

SetEffectData

(

const TDesC8 &

aEffectDataBuffer

)

[protected, virtual]

Reimplemented from CAudioEffect::SetEffectData(const TDesC8 &)

From CAudioEffect Internal function to unpack effect data

Since: 3.0

Parameter	Description
aEffectDataBuffer	Descriptor containing packed effect data

Returns: -

Uid ( )

IMPORT_C TUid

Uid

(

)

const [virtual]

Reimplemented from CAudioEffect::Uid()const