Collapse all Symbian^3 Product Developer Library

MRadioFmTunerObserver Class Reference

class MRadioFmTunerObserver

This class provides the interface class to be implemented by object receiving request complete notification from FM tuner control. These functions are called once the asynchronous request completes successfully or with an error.

In addition, this class provides the interface for receiving events from FM tuner control.

Since: S60 3.2

Public Member Functions
void	MrftoAntennaStatusChange(TBool)
void	MrftoFmTransmitterStatusChange(TBool)
void	MrftoForcedMonoChange(TBool)
void	MrftoFrequencyChange(TInt)
void	MrftoFrequencyRangeChange(TFmRadioFrequencyRange)
void	MrftoOfflineModeStatusChange(TBool)
void	MrftoRequestTunerControlComplete(TInt)
void	MrftoSetFrequencyComplete(TInt)
void	MrftoSetFrequencyRangeComplete(TInt)
void	MrftoSquelchChange(TBool)
void	MrftoStationSeekComplete(TInt, TInt)

Member Functions Documentation

MrftoAntennaStatusChange(TBool)

void

MrftoAntennaStatusChange

(

TBool

aAttached

)

[pure virtual]

Called when antenna status changes.

Since: S60 3.2

Parameters

TBool aAttached

ETrue if antenna is attached; EFalse otherwise.

MrftoFmTransmitterStatusChange(TBool)

void

MrftoFmTransmitterStatusChange

(

TBool

aActive

)

[pure virtual]

Called when FM Transmitter status changes (if one is present in the device). Tuner receiver is forced to be turned off due to hardware conflicts when FM transmitter is activated.

Since: S60 3.2

Parameters

TBool aActive

ETrue if FM transmitter is active; EFalse otherwise.

MrftoForcedMonoChange(TBool)

void

MrftoForcedMonoChange

(

TBool

aForcedMono

)

[pure virtual]

Called when the forced mono status change. This may be caused by other applications.

Since: S60 3.2

Parameters

TBool aForcedMono

ETrue if forced mono mode is enabled; EFalse otherwise.

MrftoFrequencyChange(TInt)

void

MrftoFrequencyChange

(

TInt

aNewFrequency

)

[pure virtual]

Called when the tuned frequency changes. This may be caused by other applications or RDS if AF/TA is enabled.

Since: S60 3.2

Parameters

TInt aNewFrequency

The new tuned frequency(Hz).

MrftoFrequencyRangeChange(TFmRadioFrequencyRange)

void

MrftoFrequencyRangeChange

(

TFmRadioFrequencyRange

aNewRange

)

[pure virtual]

Called when the frequency range changes. This may be caused by other applications.

Since: S60 3.2

Parameters

TFmRadioFrequencyRange aNewRange

New frequency range.

MrftoOfflineModeStatusChange(TBool)

void

MrftoOfflineModeStatusChange

(

TBool

aOfflineMode

)

[pure virtual]

Called when offline mode status changes.

Since: S60 3.2

Parameters

TBool aOfflineMode

MrftoRequestTunerControlComplete(TInt)

void

MrftoRequestTunerControlComplete

(

TInt

aError

)

[pure virtual]

Request for tuner control complete event. This event is asynchronous and is received after a call to CRadioFmTunerUtility::RequestTunerControl.

If this function returns KErrNone, control of the tuner has been granted.

If this function returns KFMRadioErrAntennaNotConnected, KFMRadioErrFmTransmitterActive, or KFMRadioErrOfflineMode, client will receive the following events respectively: MrfteoAntennaStatusChanged, MrfteoFmTransmitterStatusChanged, MrfteoOfflineModeStatusChanged. At this time, client must re-issue RequestTunerControl. Note that functions that require control of the tuner (such as Tune) will return one of the above error codes.

In case of multiple clients accessing the tuner, or when RequestTunerControl is re-issued, this function returns KErrAlreadyExists.

Since: S60 3.2

Parameters

TInt aError

A standard system error code or FM tuner error (TFmRadioTunerError).

MrftoSetFrequencyComplete(TInt)

void

MrftoSetFrequencyComplete

(

TInt

aError

)

[pure virtual]

Set frequency complete event. This event is asynchronous and is received after a call to CRadioFmTunerUtility::SetFrequency.

Since: S60 3.2

Parameters

TInt aError

A standard system error code or FM tuner error (TFmRadioTunerError).

MrftoSetFrequencyRangeComplete(TInt)

void

MrftoSetFrequencyRangeComplete

(

TInt

aError

)

[pure virtual]

Set frequency range complete event. This event is asynchronous and is received after a call to CRadioFmTunerUtility::SetFrequencyRange.

Since: S60 3.2

Parameters

TInt aError

A standard system error code or FM tuner error (TFmRadioTunerError).

MrftoSquelchChange(TBool)

void

MrftoSquelchChange

(

TBool

aSquelch

)

[pure virtual]

Called when the squelch (muting the frequencies without broadcast) status change. This may be caused by other applications.

Since: S60 3.2

Parameters

TBool aSquelch

ETrue if squelch is enabled; EFalse otherwise.

MrftoStationSeekComplete(TInt, TInt)

void	MrftoStationSeekComplete	(	TInt	aError,
			TInt	aFrequency
		)	[pure virtual]

Station seek complete event. This event is asynchronous and is received after a call to CRadioFmTunerUtility::StationSeek.

Since: S60 3.2

Parameters

TInt aError	A standard system error code or FM tuner error (TFmRadioTunerError).
TInt aFrequency	The frequency(Hz) of the radio station that was found.