Collapse all Symbian^3 Application Developer Library

CRCSEAudioCodecRegistry Class Reference

class CRCSEAudioCodecRegistry : public CRCSERegistryBase

Offers getting, setting and updating of Audio codec entries.

RCSE.lib

Since: S60 v3.0

Inherits from

CRCSEAudioCodecRegistry
- CRCSERegistryBase
  - CBase

Public Member Functions
	~CRCSEAudioCodecRegistry ()
IMPORT_C TUint32	AddL (const CRCSEAudioCodecEntry &)
void	AddL ( RPointerArray < CRCSEAudioCodecEntry > &)
IMPORT_C void	DeleteL ( TUint32 )
void	DeleteL (const RArray < TUint32 > &)
IMPORT_C void	FindL ( TUint32 , CRCSEAudioCodecEntry &)
IMPORT_C void	GetAllCodecIdsL ( RArray < TUint32 > &)
IMPORT_C void	GetDefaultCodec ( CRCSEAudioCodecEntry &)
IMPORT_C CRCSEAudioCodecRegistry *	NewL ()
IMPORT_C CRCSEAudioCodecRegistry *	NewLC ()
IMPORT_C void	UpdateL ( TUint32 , const CRCSEAudioCodecEntry &)

Protected Member Functions
	CRCSEAudioCodecRegistry ()

Private Member Functions
void	AddOrUpdateEntryL ( TUint32 &, const CRCSEAudioCodecEntry &)
void	ConstructL ()
void	ConvertEntryToPropertiesL (const CRCSEAudioCodecEntry &, RIpAppPropArray &)
void	ConvertPropertiesToEntryL ( CRCSEAudioCodecEntry &, RIpAppPropArray &)
void	FindEntryL ( TUint32 , CRCSEAudioCodecEntry &)

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()
	CRCSERegistryBase::BaseConstructL()
	CRCSERegistryBase::BeginL()
	CRCSERegistryBase::CRCSERegistryBase(TRCSERegistryType)
	CRCSERegistryBase::CleanupDbPropArray(TAny *)
	CRCSERegistryBase::CreatePropertyL(TUint,const TDesC &,RIpAppPropArray &)
	CRCSERegistryBase::EndL()
	CRCSERegistryBase::FindAllIdsL(RArray< TUint32 > &)
	CRCSERegistryBase::FindIdsByValueL(TUint,const TDesC &,RArray< TUint32 > &)
	CRCSERegistryBase::GetPropertyValueL(TUint,TDes &,RIpAppPropArray &)
	CRCSERegistryBase::HandleBackupOperationEventL()
	CRCSERegistryBase::ImportSettingsL()
	CRCSERegistryBase::ToDes(TInt32,TDes &)
	CRCSERegistryBase::ToDes(TUint32,TDes &)
	CRCSERegistryBase::ToTInt32L(const TDesC &)
	CRCSERegistryBase::ToTUint32L(const TDesC &)
	CRCSERegistryBase::~CRCSERegistryBase()

Inherited Enumerations
	CRCSERegistryBase:TItemType
	CRCSERegistryBase:TRCSERegistryType

Inherited Attributes
	CRCSERegistryBase::iBackupActive
	CRCSERegistryBase::iBackupObserver
	CRCSERegistryBase::iCenRepDb
	CRCSERegistryBase::iType

Constructor & Destructor Documentation

CRCSEAudioCodecRegistry()

CRCSEAudioCodecRegistry

(

)

[protected]

C++ default constructor.

~CRCSEAudioCodecRegistry()

IMPORT_C

~CRCSEAudioCodecRegistry

(

)

[virtual]

Destructor.

Member Functions Documentation

AddL(const CRCSEAudioCodecEntry &)

IMPORT_C TUint32

AddL

(

const CRCSEAudioCodecEntry &

aCodecEntry

)

Adds new audio codec entry.

Since: S60 v3.0

Parameters

const CRCSEAudioCodecEntry & aCodecEntry

New entry.

AddL(RPointerArray< CRCSEAudioCodecEntry > &)

void

AddL

(

RPointerArray < CRCSEAudioCodecEntry > &

aEntries

)

Adds bunch of audio codec entries to store in one transaction.

Since: S60 v3.2

Parameters

RPointerArray < CRCSEAudioCodecEntry > & aEntries

AddOrUpdateEntryL(TUint32 &, const CRCSEAudioCodecEntry &)

void	AddOrUpdateEntryL	(	TUint32 &	aId,
			const CRCSEAudioCodecEntry &	aEntry
		)	[private]

Adds or updates settings entry to storage depending of the aId parameter. Entry is stored as new entry if aId parameter have been set to KNoEntryId, otherwise existing entry is updated.

Since: S60 v3.2

Parameters

TUint32 & aId	ID of entry if exists.
const CRCSEAudioCodecEntry & aEntry	Entry to be added to storage.

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

ConvertEntryToPropertiesL(const CRCSEAudioCodecEntry &, RIpAppPropArray &)

void	ConvertEntryToPropertiesL	(	const CRCSEAudioCodecEntry &	aEntry,
			RIpAppPropArray &	properties
		)	[private]

Convert xxx

Since: S60 v3.2.

Parameters

const CRCSEAudioCodecEntry & aEntry
RIpAppPropArray & properties

ConvertPropertiesToEntryL(CRCSEAudioCodecEntry &, RIpAppPropArray &)

void	ConvertPropertiesToEntryL	(	CRCSEAudioCodecEntry &	aEntry,
			RIpAppPropArray &	aProperties
		)	[private]

Convert xxx

Since: S60 v3.2.

Parameters

CRCSEAudioCodecEntry & aEntry
RIpAppPropArray & aProperties

DeleteL(TUint32)

IMPORT_C void

DeleteL

(

TUint32

aCodecId

)

Deletes a codec, which codec id is same than aCodecId.

Since: S60 v3.0

Parameters

TUint32 aCodecId

Audio Codec identifier

DeleteL(const RArray< TUint32 > &)

void

DeleteL

(

const RArray < TUint32 > &

aIds

)

Delete bunch of audio codec entries from store in one transaction.

Since: S60 v3.2

Parameters

const RArray < TUint32 > & aIds

Codec IDs

FindEntryL(TUint32, CRCSEAudioCodecEntry &)

void	FindEntryL	(	TUint32	aProfileId,
			CRCSEAudioCodecEntry &	aFoundEntry
		)	[private]

Do actual search of requested entry. Leaves with KErrNotFound if such profile is not found. Default values are reseted to aFoundEntry before the search.

Since: S60 v3.0.

leave: KErrNotFound if audio codec doesn't exist.

Parameters

TUint32 aProfileId	Search criteria for profiles.
CRCSEAudioCodecEntry & aFoundEntry	A found profile entry

FindL(TUint32, CRCSEAudioCodecEntry &)

IMPORT_C void	FindL	(	TUint32	aCodecId,
			CRCSEAudioCodecEntry &	aFoundEntry
		)

Search a Audio Codec entry, which id is same as aCodecId. Leaves with KErrNotFound if such profile is not found. Default values are reseted to aFoundEntry before the search. the new values are set to it.

Since: S60 v3.0

Parameters

TUint32 aCodecId	Search criteria for Audio Codec.
CRCSEAudioCodecEntry & aFoundEntry	A found audio codec entry.

GetAllCodecIdsL(RArray< TUint32 > &)

IMPORT_C void

GetAllCodecIdsL

(

RArray < TUint32 > &

aAllIds

)

Gets all codec identifiers which are stored to RCSE. If there are no codecs stored, aAllIds will contain zero entries.

Since: S60 v3.0

Parameters

RArray < TUint32 > & aAllIds

Array, where the codec identifiers are stored.

GetDefaultCodec(CRCSEAudioCodecEntry &)

IMPORT_C void

GetDefaultCodec

(

CRCSEAudioCodecEntry &

aDefaultCodec

)

const

Gets default codec. Default codec is a codec, which can be used when no other codec is available. AFoundEntrys buffers and arrays are freed, before the new values are set to it.

Since: S60 v3.0

Parameters

CRCSEAudioCodecEntry & aDefaultCodec

Default codec settings are set to this.

NewL()

IMPORT_C CRCSEAudioCodecRegistry *

NewL

(

)

[static]

Two-phased constructor.

NewLC()

IMPORT_C CRCSEAudioCodecRegistry *

NewLC

(

)

[static]

Two-phased constructor.

UpdateL(TUint32, const CRCSEAudioCodecEntry &)

IMPORT_C void	UpdateL	(	TUint32	aCodecId,
			const CRCSEAudioCodecEntry &	aUpdateData
		)

Updates codec, which codec identifier is same than aCodecId. Only settings that are set in aUpdateData are updated in codec. Leaves with KErrNotFound if codec is not found.

Since: S60 v3.0

Parameters

TUint32 aCodecId	codec identifier.
const CRCSEAudioCodecEntry & aUpdateData	Updated data, which are updated to codec.