Symbian^3 Application Developer Library >

MRadioRdsObserver Class Reference

class MRadioRdsObserver

This class provides the interface class to be implemented by object receiving request complete notification from RDS 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 MrroGetFreqByPTYComplete ( TInt , RArray < TInt > &)
void MrroGetFreqByTAComplete ( TInt , RArray < TInt > &)
void MrroGetPSByPTYComplete ( TInt , RArray < TRdsPSName > &)
void MrroGetPSByTAComplete ( TInt , RArray < TRdsPSName > &)
void MrroRdsDataCT ( TDateTime &)
void MrroRdsDataPI ( TInt )
void MrroRdsDataPS ( TRdsPSName &)
void MrroRdsDataPTY ( TRdsProgrammeType )
void MrroRdsDataRT ( TRdsRadioText &)
void MrroRdsDataRTplus ( TRdsRTplusClass , TRdsRadioText &)
void MrroRdsDataTA ( TBool )
void MrroRdsEventAutomaticSwitchingChange ( TBool )
void MrroRdsEventAutomaticTrafficAnnouncement ( TBool )
void MrroRdsEventSignalChange ( TBool )
void MrroRdsSearchBeginAF ()
void MrroRdsSearchEndAF ( TInt , TInt )
void MrroRdsStationChangeTA ( TInt )
void MrroStationSeekByPTYComplete ( TInt , TInt )
void MrroStationSeekByTAComplete ( TInt , TInt )
void MrroStationSeekByTPComplete ( TInt , TInt )

Member Functions Documentation

MrroGetFreqByPTYComplete(TInt, RArray< TInt > &)

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

Get frequencies by Programme Type(PTY) complete event. This event is asynchronous and is received after a call to CRadioRdsUtility::GetFreqByPTY .

Client takes ownership of the array and therefore is responsible for deallocating it.

Since
S60 3.2

Parameters

TInt aError A standard system error code or RDS control error (TRdsControlError).
RArray < TInt > & aFreqList Array of frequencies (Hz), valid only if aError is KErrNone.

MrroGetFreqByTAComplete(TInt, RArray< TInt > &)

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

Get frequencies by Traffic Announcement(TA) complete event. This event is asynchronous and is received after a call to CRadioRdsUtility::GetFreqByTA .

Client takes ownership of the array and therefore is responsible for deallocating it.

Since
S60 3.2

Parameters

TInt aError A standard system error code or RDS control error (TRdsControlError).
RArray < TInt > & aFreqList Array of frequencies (Hz), valid only if aError is KErrNone.

MrroGetPSByPTYComplete(TInt, RArray< TRdsPSName > &)

void MrroGetPSByPTYComplete ( TInt aError,
RArray < TRdsPSName > & aPsList
) [pure virtual]

Get Programme Service names (PS) by Programme Type(PTY) complete event. This event is asynchronous and is received after a call to CRadioRdsUtility::GetPSByPTY .

Client takes ownership of the array and therefore is responsible for deallocating it.

Since
S60 3.2

Parameters

TInt aError A standard system error code or RDS control error (TRdsControlError).
RArray < TRdsPSName > & aPsList Array of programme service names, valid only if aError is KErrNone.

MrroGetPSByTAComplete(TInt, RArray< TRdsPSName > &)

void MrroGetPSByTAComplete ( TInt aError,
RArray < TRdsPSName > & aPsList
) [pure virtual]

Get Programme Service names (PS) by Traffic Announcement(TA) complete event. This event is asynchronous and is received after a call to CRadioRdsUtility::GetPSByTA .

Client takes ownership of the array and therefore is responsible for deallocating it.

Since
S60 3.2

Parameters

TInt aError A standard system error code or RDS control error (TRdsControlError).
RArray < TRdsPSName > & aPsList Array of programme service names, valid only if aError is KErrNone.

MrroRdsDataCT(TDateTime &)

void MrroRdsDataCT ( TDateTime & aCt ) [pure virtual]

Clock Time(CT) is available. This event is asynchronous and is received after a call to CRadioRdsUtility::NotifyRdsDataChange . Client will continue to receive this notification whenever new CT is available until clients unsubscribes.

Since
S60 3.2

Parameters

TDateTime & aCt Clock time

MrroRdsDataPI(TInt)

void MrroRdsDataPI ( TInt aPi ) [pure virtual]

New Programme Identification(PI) is available. This event is asynchronous and is received after a call to CRadioRdsUtility::NotifyRdsDataChange . Client will continue to receive this notification whenever new PI is available until clients unsubscribes.

Since
S60 3.2

Parameters

TInt aPi Programme identification

MrroRdsDataPS(TRdsPSName &)

void MrroRdsDataPS ( TRdsPSName & aPs ) [pure virtual]

New Programme Service(PS) is available. This event is asynchronous and is received after a call to CRadioRdsUtility::NotifyRdsDataChange . Client will continue to receive this notification whenever new PS is available until clients unsubscribes.

Since
S60 3.2

Parameters

TRdsPSName & aPs Programme service

MrroRdsDataPTY(TRdsProgrammeType)

void MrroRdsDataPTY ( TRdsProgrammeType aPty ) [pure virtual]

New Programme Type(PTY) is available. This event is asynchronous and is received after a call to CRadioRdsUtility::NotifyRdsDataChange . Client will continue to receive this notification whenever new PTY is available until clients unsubscribes.

Since
S60 3.2

Parameters

TRdsProgrammeType aPty Programme type

MrroRdsDataRT(TRdsRadioText &)

void MrroRdsDataRT ( TRdsRadioText & aRt ) [pure virtual]

New Radio Text(RT) is available. This event is asynchronous and is received after a call to CRadioRdsUtility::NotifyRdsDataChange . Client will continue to receive this notification whenever new RT is available until clients unsubscribes.

Since
S60 3.2

Parameters

TRdsRadioText & aRt Radio text

MrroRdsDataRTplus(TRdsRTplusClass, TRdsRadioText &)

void MrroRdsDataRTplus ( TRdsRTplusClass aRtPlusClass,
TRdsRadioText & aRtPlusData
) [pure virtual]

New Radio Text+(RT+) is available. This event is asynchronous and is received after a call to CRadioRdsUtility::NotifyRadioTextPlusChange . Client will continue to receive this notification whenever new RT+ is available until clients unsubscribes.

Since
S60 3.2

Parameters

TRdsRTplusClass aRtPlusClass Radio text plus class
TRdsRadioText & aRtPlusData Radio text plus data

MrroRdsDataTA(TBool)

void MrroRdsDataTA ( TBool aTaOn ) [pure virtual]

Called when Traffice Announcement(TA) status changes. This event is asynchronous and is received after a call to CRadioRdsUtility::NotifyRdsDataChange . Client will continue to receive this notification whenever TA status changes until clients unsubscribes.

Since
S60 3.2

Parameters

TBool aTaOn ETrue indicates that Traffic Announcement is on.

MrroRdsEventAutomaticSwitchingChange(TBool)

void MrroRdsEventAutomaticSwitchingChange ( TBool aAuto ) [pure virtual]

Called when automatic switching (AF) setting changes.

Since
S60 3.2

Parameters

TBool aAuto ETrue indicates that automatic switching is on.

MrroRdsEventAutomaticTrafficAnnouncement(TBool)

void MrroRdsEventAutomaticTrafficAnnouncement ( TBool aAuto ) [pure virtual]

Called when automatic traffic announcement setting changes.

Since
S60 3.2

Parameters

TBool aAuto ETrue indicates that automatic traffic announcement is on.

MrroRdsEventSignalChange(TBool)

void MrroRdsEventSignalChange ( TBool aSignal ) [pure virtual]

Called when 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.

MrroRdsSearchBeginAF()

void MrroRdsSearchBeginAF ( ) [pure virtual]

Called when tuner starts to search for an Alternate Frequency(AF) with stronger signal. This event is asynchronous and is received after a call to CRadioRdsUtility::SetAutomaticSwitching . Client will continue to receive this notification whenever new search is started until clients turns automatic switching off.

Since
S60 3.2

MrroRdsSearchEndAF(TInt, TInt)

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

Called when search for an Alternate Frequency(AF) ends. This event is asynchronous and is received after a call to CRadioRdsUtility::SetAutomaticSwitching . Client will continue to receive this notification until clients turns automatic switching off.

Most common error codes: KErrNone - Successful, new frequency found KErrNotFound - Ended, but frequency hasn't changed KErrCancel - Cancelled

Since
S60 3.2

Parameters

TInt aError A standard system error code or RDS control error (TRdsControlError).
TInt aFrequency The frequency(Hz) of the radio station that was found.

MrroRdsStationChangeTA(TInt)

void MrroRdsStationChangeTA ( TInt aFrequency ) [pure virtual]

Called when the tuner has re-tuned to another frequency that is broadcasting Traffic Announcement(TA). This notification sent only when the client has turned the automatic traffic announcement on.

Since
S60 3.2

Parameters

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

MrroStationSeekByPTYComplete(TInt, TInt)

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

Station seek by Programme Type(PTY) complete event. This event is asynchronous and is received after a call to CRadioRdsUtility::StationSeekByPTY .

Since
S60 3.2

Parameters

TInt aError A standard system error code or RDS control error (TRdsControlError).
TInt aFrequency The frequency(Hz) of the radio station that was found.

MrroStationSeekByTAComplete(TInt, TInt)

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

Station seek by Traffic Announcement(TA) complete event. This event is asynchronous and is received after a call to CRadioRdsUtility::StationSeekByTA .

Since
S60 3.2

Parameters

TInt aError A standard system error code or RDS control error (TRdsControlError).
TInt aFrequency The frequency(Hz) of the radio station that was found.

MrroStationSeekByTPComplete(TInt, TInt)

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

Station seek by Traffic Programme(TP) complete event. This event is asynchronous and is received after a call to CRadioRdsUtility::StationSeekByTP .

Since
S60 3.2

Parameters

TInt aError A standard system error code or RDS control error (TRdsControlError).
TInt aFrequency The frequency(Hz) of the radio station that was found.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.