Collapse all Symbian^3 Product Developer Library

CRadioUtility::CBody Class Reference

class CRadioUtility::CBody : public CBase

This class encapsulates the implementation body of the CRadioUtility interface.

radio_utility.lib

Since: S60 3.2

Inherits from

CRadioUtility::CBody
- CBase

Public Member Functions
	~CBody()
CBody *	NewL(TBool)
CRadioFmTunerUtility &	RadioFmTunerUtilityL(MRadioFmTunerObserver &)
CRadioPlayerUtility &	RadioPlayerUtilityL(MRadioPlayerObserver &)
CRadioRdsUtility &	RadioRdsUtilityL(MRadioRdsObserver &)

Private Member Functions
	CBody()
void	ConstructL(TBool)
void	GetFreqByPTYComplete(TInt, RArray< TInt > &)
void	GetFreqByTAComplete(TInt, RArray< TInt > &)
void	GetPSByPTYComplete(TInt, RArray< TRsRdsPSName > &)
void	GetPSByTAComplete(TInt, 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, TInt)
void	RadioEventTransmitterStatusChange(TBool)
void	RadioEventVolumeChange(TInt)
void	RequestTunerControlComplete(TRadioServerError)
void	SetFrequencyComplete(TRadioServerError)
void	SetFrequencyRangeComplete(TRadioServerError)
void	StationSeekByPTYComplete(TInt, TInt)
void	StationSeekByTAComplete(TInt, TInt)
void	StationSeekByTPComplete(TInt, TInt)
void	StationSeekComplete(TRadioServerError, TInt)

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
CRadioFmTunerUtility *	iFmTunerUtility
MRadioPlayerObserver *	iPlayerObserver
CRadioPlayerUtility *	iPlayerUtility
RRadioSession *	iRadioSession
MRadioRdsObserver *	iRdsObserver
CRadioRdsUtility *	iRdsUtility
MRadioFmTunerObserver *	iTunerObserver

Constructor & Destructor Documentation

CBody()

CBody

(

)

[private]

~CBody()

~CBody

(

)

Member Functions Documentation

ConstructL(TBool)

void

ConstructL

(

TBool

aPrimaryClient

)

[private]

Parameters

TBool aPrimaryClient

GetFreqByPTYComplete(TInt, RArray< TInt > &)

void	GetFreqByPTYComplete	(	TInt	aError,
			RArray< TInt > &	aFreqList
		)	[private]

From MRadioObserver Completion message for GetFreqByPTY request.

Since: S60 3.2

Parameters

TInt 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(TInt, RArray< TInt > &)

void	GetFreqByTAComplete	(	TInt	aError,
			RArray< TInt > &	aFreqList
		)	[private]

From MRadioObserver Completion message for GetFreqByTA request.

Since: S60 3.2

Parameters

TInt 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(TInt, RArray< TRsRdsPSName > &)

void	GetPSByPTYComplete	(	TInt	aError,
			RArray< TRsRdsPSName > &	aPsList
		)	[private]

From MRadioObserver Completion message for StatGetPSByPTY request.

Since: S60 3.2

Parameters

TInt 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(TInt, RArray< TRsRdsPSName > &)

void	GetPSByTAComplete	(	TInt	aError,
			RArray< TRsRdsPSName > &	aPsList
		)	[private]

From MRadioObserver Completion message for GetPSByTA request.

Since: S60 3.2

Parameters

TInt 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.

NewL(TBool)

CBody *

NewL

(

TBool

aPrimaryClient

)

[static]

Parameters

TBool aPrimaryClient

RadioEventAntennaStatusChange(TBool)

void

RadioEventAntennaStatusChange

(

TBool

aAttached

)

[private]

From MRadioObserver Antenna status has changed.

Since: Series 60 3.0

Parameters

TBool aAttached

ETrue if antenna is attached.

RadioEventBalanceChange(TInt, TInt)

void	RadioEventBalanceChange	(	TInt	aLeftPercentage,
			TInt	aRightPercentage
		)	[private]

From MRadioObserver 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

)

[private]

From MRadioObserver 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

)

[private]

From MRadioObserver 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

)

[private]

From MRadioObserver 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

)

[private]

From MRadioObserver Event notification indicating mute setting change.

Since: S60 3.2

Parameters

TBool aMute

ETrue indicates audio is muted.

RadioEventOfflineModeChange(TBool)

void

RadioEventOfflineModeChange

(

TBool

aOfflineMode

)

[private]

From MRadioObserver 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

)

[private]

From MRadioObserver 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

)

[private]

From MRadioObserver 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

)

[private]

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

Since: S60 3.2

Parameters

TDateTime & aCt

Clock time

RadioEventRdsDataPI(TInt)

void

RadioEventRdsDataPI

(

TInt

aPi

)

[private]

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

Since: S60 3.2

Parameters

TInt aPi

Programme identification

RadioEventRdsDataPS(TRsRdsPSName &)

void

RadioEventRdsDataPS

(

TRsRdsPSName &

aPs

)

[private]

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

Since: S60 3.2

Parameters

TRsRdsPSName & aPs

Programme service

RadioEventRdsDataPTY(TRsRdsProgrammeType)

void

RadioEventRdsDataPTY

(

TRsRdsProgrammeType

aPty

)

[private]

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

Since: S60 3.2

Parameters

TRsRdsProgrammeType aPty

Programme type

RadioEventRdsDataRT(TRsRdsRadioText &)

void

RadioEventRdsDataRT

(

TRsRdsRadioText &

aRt

)

[private]

From MRadioObserver 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
		)	[private]

From MRadioObserver 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

)

[private]

From MRadioObserver 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

(

)

[private]

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

Since: S60 3.2

RadioEventRdsSearchEndAF(TRadioServerError, TInt)

void	RadioEventRdsSearchEndAF	(	TRadioServerError	aError,
			TInt	aFrequency
		)	[private]

From MRadioObserver 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

)

[private]

From MRadioObserver 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

)

[private]

From MRadioObserver 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

)

[private]

From MRadioObserver 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, TInt)

void	RadioEventStateChange	(	TBool	aRadioOn,
			TInt	aError
		)	[private]

From MRadioObserver 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.
TInt aError	Valid only if aRadioOn is EFalse. Contains the reason why radio is off.

RadioEventTransmitterStatusChange(TBool)

void

RadioEventTransmitterStatusChange

(

TBool

aActive

)

[private]

From MRadioObserver 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

)

[private]

From MRadioObserver Event notification indicating volume change.

Since: S60 3.2

Parameters

TInt aVolume

New volume.

RadioFmTunerUtilityL(MRadioFmTunerObserver &)

CRadioFmTunerUtility &

RadioFmTunerUtilityL

(

MRadioFmTunerObserver &

aObserver

)

Returns a reference to FM Tuner Utility class for controlling the tuner settings.

Since: S60 3.2

Parameters

MRadioFmTunerObserver & aObserver

The observer object for receiving async completion callbacks

RadioPlayerUtilityL(MRadioPlayerObserver &)

CRadioPlayerUtility &

RadioPlayerUtilityL

(

MRadioPlayerObserver &

aObserver

)

Returns a reference to Radio Player Utility class for controlling the radio playback.

Since: S60 3.2

Parameters

MRadioPlayerObserver & aObserver

The observer object for receiving async completion callbacks

RadioRdsUtilityL(MRadioRdsObserver &)

CRadioRdsUtility &

RadioRdsUtilityL

(

MRadioRdsObserver &

aObserver

)

Returns a reference to Radio RDS Utility class for accessing the Radio Data System (RDS).

Since: S60 3.2

Parameters

MRadioRdsObserver & aObserver

The observer object for receiving async completion callbacks

RequestTunerControlComplete(TRadioServerError)

void

RequestTunerControlComplete

(

TRadioServerError

aError

)

[private]

From MRadioObserver 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

)

[private]

From MRadioObserver Completion message for SetFrequency request.

Since: S60 3.2

Parameters

TRadioServerError aError

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

SetFrequencyRangeComplete(TRadioServerError)

void

SetFrequencyRangeComplete

(

TRadioServerError

aError

)

[private]

From MRadioObserver Completion message for SetFrequencyRange request.

Since: S60 3.2

Parameters

TRadioServerError aError

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

StationSeekByPTYComplete(TInt, TInt)

void	StationSeekByPTYComplete	(	TInt	aError,
			TInt	aFrequency
		)	[private]

From MRadioObserver Completion message for StationSeekByPTY request.

Since: S60 3.2

Parameters

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

StationSeekByTAComplete(TInt, TInt)

void	StationSeekByTAComplete	(	TInt	aError,
			TInt	aFrequency
		)	[private]

From MRadioObserver Completion message for StationSeekByTA request.

Since: S60 3.2

Parameters

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

StationSeekByTPComplete(TInt, TInt)

void	StationSeekByTPComplete	(	TInt	aError,
			TInt	aFrequency
		)	[private]

From MRadioObserver Completion message for StationSeekByTP request.

Since: S60 3.2

Parameters

TInt 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
		)	[private]

From MRadioObserver Completion message for StationSeek request.

Since: Series 60 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.