Collapse all Symbian^3 Application Developer Library

MRadioObserver Class Reference

class MRadioObserver

Defines functions that client must implement in order to receive events from the radio server.

RadioSession.lib

Since: S60 3.0

Public Member Functions
void	GetFreqByPTYComplete ( TRadioServerError , RArray < TInt > &)
void	GetFreqByTAComplete ( TRadioServerError , RArray < TInt > &)
void	GetPSByPTYComplete ( TRadioServerError , RArray < TRsRdsPSName > &)
void	GetPSByTAComplete ( TRadioServerError , RArray < TRsRdsPSName > &)
void	RadioEventAntennaStatusChange ( TBool )
void	RadioEventBalanceChange ( TInt , TInt )
void	RadioEventForcedMonoChanged ( TBool )
void	RadioEventFrequencyChange ( TInt )
void	RadioEventFrequencyRangeChanged ( TRsFrequencyRange )
void	RadioEventMuteChange ( TBool )
void	RadioEventOfflineModeChange ( TBool )
void	RadioEventRdsAutomaticSwitchingChange ( TBool )
void	RadioEventRdsAutomaticTrafficAnnouncement ( TBool )
void	RadioEventRdsDataCT ( TDateTime &)
void	RadioEventRdsDataPI ( TInt )
void	RadioEventRdsDataPS ( TRsRdsPSName &)
void	RadioEventRdsDataPTY ( TRsRdsProgrammeType )
void	RadioEventRdsDataRT ( TRsRdsRadioText &)
void	RadioEventRdsDataRTplus ( TRsRdsRTplusClass , TRsRdsRadioText &)
void	RadioEventRdsDataTA ( TBool )
void	RadioEventRdsSearchBeginAF ()
void	RadioEventRdsSearchEndAF ( TRadioServerError , TInt )
void	RadioEventRdsSignalChange ( TBool )
void	RadioEventRdsStationChangeTA ( TInt )
void	RadioEventSquelchChanged ( TBool )
void	RadioEventStateChange ( TBool , TRadioServerError )
void	RadioEventTransmitterStatusChange ( TBool )
void	RadioEventVolumeChange ( TInt )
void	RequestTunerControlComplete ( TRadioServerError )
void	SetFrequencyComplete ( TRadioServerError )
void	SetFrequencyRangeComplete ( TRadioServerError )
void	StationSeekByPTYComplete ( TRadioServerError , TInt )
void	StationSeekByTAComplete ( TRadioServerError , TInt )
void	StationSeekByTPComplete ( TRadioServerError , TInt )
void	StationSeekComplete ( TRadioServerError , TInt )

Member Functions Documentation

GetFreqByPTYComplete(TRadioServerError, RArray< TInt > &)

void	GetFreqByPTYComplete	(	TRadioServerError	aError,
			RArray < TInt > &	aFreqList
		)	[pure virtual]

Completion message for GetFreqByPTY request.

Since: S60 3.2

Parameters

TRadioServerError aError	KErrNone if successful, otherwise one of the system/RadioServer errors.
RArray < TInt > & aFreqList	Array of frequencies (Hz), valid only if aError is KErrNone.

GetFreqByTAComplete(TRadioServerError, RArray< TInt > &)

void	GetFreqByTAComplete	(	TRadioServerError	aError,
			RArray < TInt > &	aFreqList
		)	[pure virtual]

Completion message for GetFreqByTA request.

Since: S60 3.2

Parameters

TRadioServerError aError	KErrNone if successful, otherwise one of the system/RadioServer errors.
RArray < TInt > & aFreqList	Array of frequencies (Hz), valid only if aError is KErrNone.

GetPSByPTYComplete(TRadioServerError, RArray< TRsRdsPSName > &)

void	GetPSByPTYComplete	(	TRadioServerError	aError,
			RArray < TRsRdsPSName > &	aPsList
		)	[pure virtual]

Completion message for StatGetPSByPTY request.

Since: S60 3.2

Parameters

TRadioServerError aError	KErrNone if successful, otherwise one of the system/RadioServer errors.
RArray < TRsRdsPSName > & aPsList	Array of programme service names, valid only if aError is KErrNone.

GetPSByTAComplete(TRadioServerError, RArray< TRsRdsPSName > &)

void	GetPSByTAComplete	(	TRadioServerError	aError,
			RArray < TRsRdsPSName > &	aPsList
		)	[pure virtual]

Completion message for GetPSByTA request.

Since: S60 3.2

Parameters

TRadioServerError aError	KErrNone if successful, otherwise one of the system/RadioServer errors.
RArray < TRsRdsPSName > & aPsList	Array of programme service names, valid only if aError is KErrNone.

RadioEventAntennaStatusChange(TBool)

void

RadioEventAntennaStatusChange

(

TBool

aAttached

)

[pure virtual]

Event notification indicating antenna status change.

Since: S60 3.0

Parameters

TBool aAttached

ETrue if antenna is attached.

RadioEventBalanceChange(TInt, TInt)

void	RadioEventBalanceChange	(	TInt	aLeftPercentage,
			TInt	aRightPercentage
		)	[pure virtual]

Event notification indicating balance setting change.

Since: S60 3.2

Parameters

TInt aLeftPercentage	Left speaker volume percentage. This value ranges from 0 to 100.
TInt aRightPercentage	Right speaker volume percentage. This value ranges from 0 to 100.

RadioEventForcedMonoChanged(TBool)

void

RadioEventForcedMonoChanged

(

TBool

aForcedMono

)

[pure virtual]

Event notification indicating forced mono status change.

Since: S60 3.2

Parameters

TBool aForcedMono

ETrue if forced mode is enabled; EFalse otherwise.

RadioEventFrequencyChange(TInt)

void

RadioEventFrequencyChange

(

TInt

aFrequency

)

[pure virtual]

Event notification indicating frequency(Hz) change. This may be caused by other applications or RDS if AF/TA is enabled.

Since: S60 3.2

Parameters

TInt aFrequency

New frequency where tuner is currently tuned.

RadioEventFrequencyRangeChanged(TRsFrequencyRange)

void

RadioEventFrequencyRangeChanged

(

TRsFrequencyRange

aNewRange

)

[pure virtual]

Event notification indicating frequency range change. This may be caused by other applications.

Since: S60 3.2

Parameters

TRsFrequencyRange aNewRange

New frequency range.

RadioEventMuteChange(TBool)

void

RadioEventMuteChange

(

TBool

aMute

)

[pure virtual]

Event notification indicating mute setting change.

Since: S60 3.2

Parameters

TBool aMute

ETrue indicates audio is muted.

RadioEventOfflineModeChange(TBool)

void

RadioEventOfflineModeChange

(

TBool

aOfflineMode

)

[pure virtual]

Event notification indicating offline mode change.

Since: S60 3.0

Parameters

TBool aOfflineMode

ETrue if device is in offline mode.

RadioEventRdsAutomaticSwitchingChange(TBool)

void

RadioEventRdsAutomaticSwitchingChange

(

TBool

aAuto

)

[pure virtual]

Event notification indicating automatic switching (AF) setting change.

Since: S60 3.2

Parameters

TBool aAuto

ETrue indicates that automatic switching is on.

RadioEventRdsAutomaticTrafficAnnouncement(TBool)

void

RadioEventRdsAutomaticTrafficAnnouncement

(

TBool

aAuto

)

[pure virtual]

Event notification indicating automatic traffic announcement setting change.

Since: S60 3.2

Parameters

TBool aAuto

ETrue indicates that automatic traffic announcement is on.

RadioEventRdsDataCT(TDateTime &)

void

RadioEventRdsDataCT

(

TDateTime &

aCt

)

[pure virtual]

Event notification indicating new Clock Time(CT) is available.

Since: S60 3.2

Parameters

TDateTime & aCt

Clock time

RadioEventRdsDataPI(TInt)

void

RadioEventRdsDataPI

(

TInt

aPi

)

[pure virtual]

Event notification indicating new Programme Identification(PI) is available.

Since: S60 3.2

Parameters

TInt aPi

Programme identification

RadioEventRdsDataPS(TRsRdsPSName &)

void

RadioEventRdsDataPS

(

TRsRdsPSName &

aPs

)

[pure virtual]

Event notification indicating new Programme Service(PS) is available.

Since: S60 3.2

Parameters

TRsRdsPSName & aPs

Programme service

RadioEventRdsDataPTY(TRsRdsProgrammeType)

void

RadioEventRdsDataPTY

(

TRsRdsProgrammeType

aPty

)

[pure virtual]

Event notification indicating new Programme Type(PTY) is available.

Since: S60 3.2

Parameters

TRsRdsProgrammeType aPty

Programme type

RadioEventRdsDataRT(TRsRdsRadioText &)

void

RadioEventRdsDataRT

(

TRsRdsRadioText &

aRt

)

[pure virtual]

Event notification indicating new Radio Text(RT) is available.

Since: S60 3.2

Parameters

TRsRdsRadioText & aRt

Radio text

RadioEventRdsDataRTplus(TRsRdsRTplusClass, TRsRdsRadioText &)

void	RadioEventRdsDataRTplus	(	TRsRdsRTplusClass	aRtPlusClass,
			TRsRdsRadioText &	aRtPlusData
		)	[pure virtual]

Event notification indicating new Radio Text+(RT+) is available.

Since: S60 3.2

Parameters

TRsRdsRTplusClass aRtPlusClass	Radio text plus class
TRsRdsRadioText & aRtPlusData	Radio text plus data

RadioEventRdsDataTA(TBool)

void

RadioEventRdsDataTA

(

TBool

aTaOn

)

[pure virtual]

Event notification indicating Traffice Announcement(TA) status change.

Since: S60 3.2

Parameters

TBool aTaOn

ETrue indicates that Traffic Announcement is on.

RadioEventRdsSearchBeginAF()

void

RadioEventRdsSearchBeginAF

(

)

[pure virtual]

Event notification indicating the beginning of Alternate Frequency(AF) search.

Since: S60 3.2

RadioEventRdsSearchEndAF(TRadioServerError, TInt)

void	RadioEventRdsSearchEndAF	(	TRadioServerError	aError,
			TInt	aFrequency
		)	[pure virtual]

Event notification indicating the end of Alternate Frequency(AF) search.

Since: S60 3.2

Parameters

TRadioServerError aError	KErrNone if successful, otherwise one of the system/RadioServer errors.
TInt aFrequency	The frequency(Hz) of the radio station that was found.

RadioEventRdsSignalChange(TBool)

void

RadioEventRdsSignalChange

(

TBool

aSignal

)

[pure virtual]

Event notification indicating RDS signal status change (i.e. signal is lost/restored).

Since: S60 3.2

Parameters

TBool aSignal

ETrue indicates that RDS signal is available in the tuned frequency.

RadioEventRdsStationChangeTA(TInt)

void

RadioEventRdsStationChangeTA

(

TInt

aFrequency

)

[pure virtual]

Event notification indicating station change to another frequency(Hz) that is broadcasting Traffic Announcement(TA).

Since: S60 3.2

Parameters

TInt aFrequency

The frequency(Hz) of the radio station that was found.

RadioEventSquelchChanged(TBool)

void

RadioEventSquelchChanged

(

TBool

aSquelch

)

[pure virtual]

Event notification indicating squelch (muting the frequencies without broadcast) status change.

Since: S60 3.2

Parameters

TBool aSquelch

ETrue if squelch is enabled; EFalse otherwise.

RadioEventStateChange(TBool, TRadioServerError)

void	RadioEventStateChange	(	TBool	aRadioOn,
			TRadioServerError	aError
		)	[pure virtual]

Event notification indicating radio player state change. This may be caused by other applications.

Since: S60 3.0

Parameters

TBool aRadioOn	ETrue if radio is playing, otherwise radio is off.
TRadioServerError aError	Valid only if aRadioOn is EFalse. Contains the reason why radio is off.

RadioEventTransmitterStatusChange(TBool)

void

RadioEventTransmitterStatusChange

(

TBool

aActive

)

[pure virtual]

Event notification indicating FM transmitter status change. Radio receiver is turned off when FM transmitter is active.

Since: S60 3.2

Parameters

TBool aActive

ETrue if FM transmitter is active; EFalse otherwise.

RadioEventVolumeChange(TInt)

void

RadioEventVolumeChange

(

TInt

aVolume

)

[pure virtual]

Event notification indicating volume change.

Since: S60 3.2

Parameters

TInt aVolume

New volume.

RequestTunerControlComplete(TRadioServerError)

void

RequestTunerControlComplete

(

TRadioServerError

aError

)

[pure virtual]

Completion message for RequestTunerControl request.

Since: S60 3.2

Parameters

TRadioServerError aError

KErrNone if successful, otherwise one of the system/RadioServer errors.

SetFrequencyComplete(TRadioServerError)

void

SetFrequencyComplete

(

TRadioServerError

aError

)

[pure virtual]

Completion message for SetFrequency request.

Since: S60 3.0

Parameters

TRadioServerError aError

KErrNone if successful, otherwise one of the system/RadioServer errors.

SetFrequencyRangeComplete(TRadioServerError)

void

SetFrequencyRangeComplete

(

TRadioServerError

aError

)

[pure virtual]

Completion message for SetFrequencyRange request.

Since: S60 3.2

Parameters

TRadioServerError aError

KErrNone if successful, otherwise one of the system/RadioServer errors.

StationSeekByPTYComplete(TRadioServerError, TInt)

void	StationSeekByPTYComplete	(	TRadioServerError	aError,
			TInt	aFrequency
		)	[pure virtual]

Completion message for StationSeekByPTY request.

Since: S60 3.2

Parameters

TRadioServerError aError	KErrNone if successful, otherwise one of the system/RadioServer errors.
TInt aFrequency	The frequency(Hz) of the radio station that was found.

StationSeekByTAComplete(TRadioServerError, TInt)

void	StationSeekByTAComplete	(	TRadioServerError	aError,
			TInt	aFrequency
		)	[pure virtual]

Completion message for StationSeekByTA request.

Since: S60 3.2

Parameters

TRadioServerError aError	KErrNone if successful, otherwise one of the system/RadioServer errors.
TInt aFrequency	The frequency(Hz) of the radio station that was found.

StationSeekByTPComplete(TRadioServerError, TInt)

void	StationSeekByTPComplete	(	TRadioServerError	aError,
			TInt	aFrequency
		)	[pure virtual]

Completion message for StationSeekByTP request.

Since: S60 3.2

Parameters

TRadioServerError aError	KErrNone if successful, otherwise one of the system/RadioServer errors.
TInt aFrequency	The frequency(Hz) of the radio station that was found.

StationSeekComplete(TRadioServerError, TInt)

void	StationSeekComplete	(	TRadioServerError	aError,
			TInt	aFrequency
		)	[pure virtual]

Completion message for StationSeek request.

Since: S60 3.0

Parameters

TRadioServerError aError	KErrNone if successful, otherwise one of the system/RadioServer errors.
TInt aFrequency	Valid only if aError is KErrNone. Contains the new frequency in Hz.