Collapse all Symbian^3 Application Developer Library

CRadioFmPresetUtility Class Reference

class CRadioFmPresetUtility : public CBase

This class provides an interface for controlling the preset for an FM tuner. The maximum number of presets supported by this utility is pre-defined and the client must first query it.

RadioPresetUtility.lib

Since: S60 3.2

Inherits from

CRadioFmPresetUtility
- CBase

Nested Classes and Structures

CRadioFmPresetUtility::CBody

Public Member Functions
	~CRadioFmPresetUtility ()
IMPORT_C void	DeletePresetL ( TInt )
IMPORT_C void	GetFirstPresetL ( TInt &)
IMPORT_C TInt	GetMaxNumberOfPresets ( TInt &)
IMPORT_C void	GetNextPresetL ( TInt , TInt &)
IMPORT_C TInt	GetNumberOfPresets ( TInt &)
IMPORT_C void	GetPresetFavouriteInfoL ( TInt , TBool &)
IMPORT_C void	GetPresetFrequencyL ( TInt , TInt &)
IMPORT_C void	GetPresetL ( TInt , TFmPresetName &, TInt &)
IMPORT_C void	GetPresetNameL ( TInt , TFmPresetName &)
IMPORT_C void	GetPresetPICodeL ( TInt , TUint &)
IMPORT_C void	GetPresetPtyL ( TInt , TUint &)
IMPORT_C void	GetPresetUrlL ( TInt , TFmPresetUrl &)
IMPORT_C void	GetPresetUserRenameInfoL ( TInt , TBool &)
IMPORT_C CRadioFmPresetUtility *	NewL ( MRadioPresetObserver &)
IMPORT_C void	SetPresetFavouriteInfoL ( TInt , TBool )
IMPORT_C void	SetPresetL ( TInt , const TFmPresetName &, TInt )
IMPORT_C void	SetPresetPICodeL ( TInt , TUint )
IMPORT_C void	SetPresetPtyL ( TInt , TUint )
IMPORT_C void	SetPresetUrlL ( TInt , const TFmPresetUrl &)
IMPORT_C void	SetPresetUserRenameInfoL ( TInt , TBool )

Private Member Functions
	CRadioFmPresetUtility ( MRadioPresetObserver &)
void	ConstructL ()

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

Private Attributes
CBody *	iBody

Constructor & Destructor Documentation

CRadioFmPresetUtility(MRadioPresetObserver &)

CRadioFmPresetUtility

(

MRadioPresetObserver &

aObserver

)

[private]

Parameters

MRadioPresetObserver & aObserver

~CRadioFmPresetUtility()

IMPORT_C

~CRadioFmPresetUtility

(

)

[virtual]

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

DeletePresetL(TInt)

IMPORT_C void

DeletePresetL

(

TInt

aIndex

)

From MRadioPreset Reset the specified preset. Has not effect if specified index contains no preset.

NOTE: Specifying aIndex == -1, will reset all presets.

Since: S60 3.2

Parameters

TInt aIndex

A preset index.

GetFirstPresetL(TInt &)

IMPORT_C void

GetFirstPresetL

(

TInt &

aIndex

)

const

From MRadioPreset Get the first preset index that has been set. Leaves with KErrNone if no preset exists.

Since: S60 3.2

Parameters

TInt & aIndex

On return contains the index of the first preset.

GetMaxNumberOfPresets(TInt &)

IMPORT_C TInt

GetMaxNumberOfPresets

(

TInt &

aMaxNumOfPresets

)

const

From MRadioPreset Get the maximum number of presets supported by this utility. The numbering of presets starts from 1 and the largest preset number equals the value returned from this function.

Since: S60 3.2

Parameters

TInt & aMaxNumOfPresets

On return contains the maximum number of presets.

GetNextPresetL(TInt, TInt &)

IMPORT_C void	GetNextPresetL	(	TInt	aIndex,
			TInt &	aNextIndex
		)	const

From MRadioPreset Get the next preset index that has been set, given the current index. Leaves with KErrNone if no other preset exists.

Since: S60 3.2

Parameters

TInt aIndex	Current preset index.
TInt & aNextIndex	On return contains the index of next preset.

GetNumberOfPresets(TInt &)

IMPORT_C TInt

GetNumberOfPresets

(

TInt &

aNumOfPresets

)

const

From MRadioPreset Get the number of presets already set by the client (i.e. contains data).

Since: S60 3.2

Parameters

TInt & aNumOfPresets

On return contains the current number of presets.

GetPresetFavouriteInfoL(TInt, TBool &)

IMPORT_C void	GetPresetFavouriteInfoL	(	TInt	aIndex,
			TBool &	aFavourite
		)

From MRadioFmPresetUtility Get the preset favourite info at the specified index. Leaves with KErrNotFound if invalid index is specified.

Since: S60 5.2

Parameters

TInt aIndex	A preset index.
TBool & aFavourite	On return, contains the preset favourite info.

GetPresetFrequencyL(TInt, TInt &)

IMPORT_C void	GetPresetFrequencyL	(	TInt	aIndex,
			TInt &	aFrequency
		)

Get the preset frequency at the specified index. Leaves with KErrNotFound if invalid index is specified.

Since: S60 5.1

Parameters

TInt aIndex	A preset index.
TInt & aFrequency	On return, contains the preset name.

GetPresetL(TInt, TFmPresetName &, TInt &)

IMPORT_C void	GetPresetL	(	TInt	aIndex,
			TFmPresetName &	aName,
			TInt &	aFrequency
		)

From MRadioFmPreset Get the preset name and frequency at the specified index. Leaves with KErrNotFound if invalid index is specified.

Preset name is maximum of 32 characters. Client must allocate buffer big enough to hold the 32 characters. If not, characters will be truncated to fit the buffer.

Since: S60 3.2

Parameters

TInt aIndex	A preset index.
TFmPresetName & aName
TInt & aFrequency	On return, contains the preset name.

GetPresetNameL(TInt, TFmPresetName &)

IMPORT_C void	GetPresetNameL	(	TInt	aIndex,
			TFmPresetName &	aName
		)

From MRadioFmPreset Get the preset name at the specified index. Leaves with KErrNotFound if invalid index is specified.

Preset name is maximum of 32 characters. Client must allocate buffer big enough to hold the 32 characters. If not, characters will be truncated to fit the buffer.

Since: S60 5.1

Parameters

TInt aIndex	A preset index.
TFmPresetName & aName	On return, contains the preset name.

GetPresetPICodeL(TInt, TUint &)

IMPORT_C void	GetPresetPICodeL	(	TInt	aIndex,
			TUint &	aPICode
		)

From MRadioFmPresetUtility Get the preset PI code (programme identification) at the specified index. Leaves with KErrNotFound if invalid index is specified.

Since: S60 5.2

Parameters

TInt aIndex	A preset index.
TUint & aPICode	On return, contains the preset programme identification.

GetPresetPtyL(TInt, TUint &)

IMPORT_C void	GetPresetPtyL	(	TInt	aIndex,
			TUint &	aPty
		)

From MRadioFmPresetUtility Get the preset PTY (programme type) at the specified index. Leaves with KErrNotFound if invalid index is specified.

Since: S60 5.2

Parameters

TInt aIndex	A preset index.
TUint & aPty	On return, contains the preset PTY.

GetPresetUrlL(TInt, TFmPresetUrl &)

IMPORT_C void	GetPresetUrlL	(	TInt	aIndex,
			TFmPresetUrl &	aUrl
		)

From MRadioFmPresetUtility Get the preset URL at the specified index. Leaves with KErrNotFound if invalid index is specified.

Preset URL is maximum of 64 characters. Client must allocate buffer big enough to hold the 64 characters. If not, characters will be truncated to fit the buffer.

Since: S60 5.2

Parameters

TInt aIndex	A preset index.
TFmPresetUrl & aUrl	On return, contains the preset name.

GetPresetUserRenameInfoL(TInt, TBool &)

IMPORT_C void	GetPresetUserRenameInfoL	(	TInt	aIndex,
			TBool &	aRename
		)

From MRadioFmPresetUtility Get the preset user rename info at the specified index. Leaves with KErrNotFound if invalid index is specified.

Since: S60 5.2

Parameters

TInt aIndex	A preset index.
TBool & aRename	On return, contains the preset rename info.

NewL(MRadioPresetObserver &)

IMPORT_C CRadioFmPresetUtility *

NewL

(

MRadioPresetObserver &

aObserver

)

[static]

Factory function to create a new instance of the FM tuner.

Since: S60 3.2

Parameters

MRadioPresetObserver & aObserver

The observer object

SetPresetFavouriteInfoL(TInt, TBool)

IMPORT_C void	SetPresetFavouriteInfoL	(	TInt	aIndex,
			TBool	aFavourite
		)

From MRadioFmPresetUtility Set the preset with specified favourite information. Previous content in the specified index will be overwritten with the new information.

Since: S60 5.2

Parameters

TInt aIndex	A preset index.
TBool aFavourite	Preset favourite info.

SetPresetL(TInt, const TFmPresetName &, TInt)

IMPORT_C void	SetPresetL	(	TInt	aIndex,
			const TFmPresetName &	aName,
			TInt	aFrequency
		)

From MRadioFmPresetUtility Set the preset with specified frequency and name. Previous content in the specified index will be overwritten with the new information.

The maximum length for the preset name is 32 characters. Names longer than 32 characters will be truncated.

Since: S60 3.2

Parameters

TInt aIndex	A preset index.
const TFmPresetName & aName	Preset name.
TInt aFrequency	Frequency in Hz.

SetPresetPICodeL(TInt, TUint)

IMPORT_C void	SetPresetPICodeL	(	TInt	aIndex,
			TUint	aPICode
		)

From MRadioFmPresetUtility Set the preset with specified PI code. Previous content in the specified index will be overwritten with the new information.

Since: S60 5.2

Parameters

TInt aIndex	A preset index.
TUint aPICode	Preset PI (programme identification).

SetPresetPtyL(TInt, TUint)

IMPORT_C void	SetPresetPtyL	(	TInt	aIndex,
			TUint	aPty
		)

From MRadioFmPresetUtility Set the preset with specified PTY. Previous content in the specified index will be overwritten with the new information.

Since: S60 5.2

Parameters

TInt aIndex	A preset index.
TUint aPty	Preset PTY (programme type).

SetPresetUrlL(TInt, const TFmPresetUrl &)

IMPORT_C void	SetPresetUrlL	(	TInt	aIndex,
			const TFmPresetUrl &	aUrl
		)

From MRadioFmPresetUtility Set the preset with specified URL. Previous content in the specified index will be overwritten with the new information.

The maximum length for the preset URL is 64 characters. URLs longer than 32 characters will be truncated.

Since: S60 5.2

Parameters

TInt aIndex	A preset index.
const TFmPresetUrl & aUrl	Preset URL.

SetPresetUserRenameInfoL(TInt, TBool)

IMPORT_C void	SetPresetUserRenameInfoL	(	TInt	aIndex,
			TBool	aRename
		)

From MRadioFmPresetUtility Set the preset with specified user rename information. Previous content in the specified index will be overwritten with the new information.

Since: S60 5.2

Parameters

TInt aIndex	A preset index.
TBool aRename	Preset user rename info.

Member Data Documentation

CBody * iBody

CBody *

iBody

[private]

Preset utility implementation body Own.