Collapse all Symbian^3 Product Developer Library

MRadioFmPreset Class Reference

class MRadioFmPreset

This class provides an interface for controlling the preset for an FM tuner. This is an abstract interface that must be implemented by all preset utilities supporting FM tuner preset.

RadioPresetUtility.lib

Since: S60 3.2

Public Member Functions
void	GetPresetFrequencyL(TInt, TInt &)
void	GetPresetL(TInt, TFmPresetName &, TInt &)
void	GetPresetNameL(TInt, TFmPresetName &)
void	SetPresetL(TInt, const TFmPresetName &, TInt)

Member Functions Documentation

GetPresetFrequencyL(TInt, TInt &)

void	GetPresetFrequencyL	(	TInt	aIndex,
			TInt &	aFrequency
		)	[pure virtual]

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

void	GetPresetL	(	TInt	aIndex,
			TFmPresetName &	aName,
			TInt &	aFrequency
		)	[pure virtual]

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

void	GetPresetNameL	(	TInt	aIndex,
			TFmPresetName &	aName
		)	[pure virtual]

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.

SetPresetL(TInt, const TFmPresetName &, TInt)

void	SetPresetL	(	TInt	aIndex,
			const TFmPresetName &	aName,
			TInt	aFrequency
		)	[pure virtual]

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.