CRadioRdsUtility Class Reference
class CRadioRdsUtility : public CBase |
This class provides an interface to allow clients to control the RDS hardware present on a device.
RadioUtility.lib
- Since
- S60 3.2
Nested Classes and Structures
Constructor & Destructor Documentation
CRadioRdsUtility()
CRadioRdsUtility | ( | ) | [private] |
~CRadioRdsUtility()
~CRadioRdsUtility | ( | ) | [private, virtual] |
Member Functions Documentation
CancelAFSearch()
IMPORT_C void | CancelAFSearch | ( | ) | |
CancelGetFreqByPTY()
IMPORT_C void | CancelGetFreqByPTY | ( | ) | |
Cancels an ongoing request to find all frequencies sending a given Programme Type (PTY). The usual callback will not occur if this has been called.
CancelGetFreqByTA()
IMPORT_C void | CancelGetFreqByTA | ( | ) | |
Cancels an ongoing request to find all frequencies sending Traffic Announcement. The usual callback will not occur if this has been called.
CancelGetPSByPTY()
IMPORT_C void | CancelGetPSByPTY | ( | ) | |
Cancels an ongoing request to find all Programme Service names (PS) sending a given Programme Type (PTY). The usual callback will not occur if this has been called.
CancelGetPSByTA()
IMPORT_C void | CancelGetPSByTA | ( | ) | |
Cancels an ongoing request to find all Programme Service names (PS) sending Traffic Announcement. The usual callback will not occur if this has been called.
CancelNotifyRadioTextPlusChange()
IMPORT_C void | CancelNotifyRadioTextPlusChange | ( | ) | |
Cancel NotifyRadioTextPlusChange request.
CancelNotifyRdsDataChange()
IMPORT_C void | CancelNotifyRdsDataChange | ( | ) | |
Cancel NotifyRdsDataChange request.
CancelRdsStationSeek()
IMPORT_C void | CancelRdsStationSeek | ( | ) | |
Cancels an ongoing retune operation, as initiated by a call to StationSeekByPTY, StationSeekByTA, or StationSeekByTP. The usual callback will not occur if this has been called.
Close()
Close the RDS utility and free all memory allocated.
ConstructL()
void | ConstructL | ( | ) | [private] |
GetAutomaticSwitching(TBool &)
IMPORT_C TInt | GetAutomaticSwitching | ( | TBool & | aAuto | ) | |
Find out whether automatic switching is on or off.
Parameters
TBool & aAuto | On return, ETrue indicates that automatic switching is enabled. |
GetAutomaticTrafficAnnouncement(TBool &)
IMPORT_C TInt | GetAutomaticTrafficAnnouncement | ( | TBool & | aAuto | ) | |
Find out whether automatic traffic announcement is enabled.
Parameters
TBool & aAuto | On return, ETrue indicates that automatic traffic announcement is on. |
GetCapabilities(TRdsCapabilities &)
Get the capabilities of the RDS control on the device.
GetClockTime(TDateTime &)
Get the current Clock Time and date. RDS data is received over the air and may not be available immediately following tune operation. If data is not available, this function will return KErrNotFound. If a value is returned, this is the last known value, which may not be up to date. To be notified of the most recent value, client should use NotifyRdsDataChange.
Parameters
TDateTime & aCt | On return contains current time and date |
GetFreqByPTY(TRdsProgrammeType)
Asynchronous request to find all frequencies sending the given Programme Type (PTY). User must be ready to receive callback method MrroGetFreqByPTYComplete.
NOTE: This is only supported in dual tuner configuration since the secondary tuner needs to perform continuous scanning for frequencies broadcasting given Programme Type while the primary tuner is used for normal tuner activities. Client should first check the tuner capabilities. Will return KErrNotSupported in callback method if this feature is not supported.
GetFreqByTA()
IMPORT_C void | GetFreqByTA | ( | ) | |
Asynchronous request to find all frequencies sending Traffic Announcement (TA). User must be ready to receive callback method MrroGetFreqByTAComplete.
NOTE: This is only supported in dual tuner configuration since the secondary tuner needs to perform continuous scanning for frequencies broadcasting given Traffic Announcement while the primary tuner is used for normal tuner activities. Client should first check the tuner capabilities. Will return KErrNotSupported in callback method if this feature is not supported.
GetPSByPTY(TRdsProgrammeType)
Asynchronous request to find all Programme Service names (PS) sending the given Programme Type (PTY). User must be ready to receive callback method MrroGetPSByPTYComplete.
NOTE: This is only supported in dual tuner configuration since the secondary tuner needs to perform continuous scanning for frequencies broadcasting given Programme Type while the primary tuner is used for normal tuner activities. Client should first check the tuner capabilities. Will return KErrNotSupported in callback method if this feature is not supported.
GetPSByTA()
Asynchronous request to find all Programme Service names (PS) sending Traffic Announcement (TA). User must be ready to receive callback method MrroGetPSByTAComplete.
NOTE: This is only supported in dual tuner configuration since the secondary tuner needs to perform continuous scanning for frequencies broadcasting given Traffic Announcement while the primary tuner is used for normal tuner activities. Client should first check the tuner capabilities. Will return KErrNotSupported in callback method if this feature is not supported.
GetProgrammeIdentification(TInt &)
IMPORT_C TInt | GetProgrammeIdentification | ( | TInt & | aPi | ) | |
Get the current Programme Identification code. RDS data is received over the air and may not be available immediately following tune operation. If data is not available, this function will return KErrNotFound. If a value is returned, this is the last known value, which may not be up to date. To be notified of the most recent value, client should use NotifyRdsDataChange.
Parameters
TInt & aPi | On return contains Programme Identification code |
GetProgrammeService(TRdsPSName &)
Get the current Programme Service name. RDS data is received over the air and may not be available immediately following tune operation. If data is not available, this function will return KErrNotFound. If a value is returned, this is the last known value, which may not be up to date. To be notified of the most recent value, client should use NotifyRdsDataChange.
Programme Service name is fixed to 8 characters.
Parameters
TRdsPSName & aPs | On return contains Programme Service name |
GetProgrammeType(TRdsProgrammeType &)
Get the current Programme Type. RDS data is received over the air and may not be available immediately following tune operation. If data is not available, this function will return KErrNotFound. If a value is returned, this is the last known value, which may not be up to date. To be notified of the most recent value, client should use NotifyRdsDataChange.
GetRadioText(TRdsRadioText &)
Get the current Radio Text. RDS data is received over the air and may not be available immediately following tune operation. If data is not available, this function will return KErrNotFound. If a value is returned, this is the last known value, which may not be up to date. To be notified of the most recent value, client should use NotifyRdsDataChange.
The maximum possible length for radio text is 64 characters.
GetRadioTextPlus(TRdsRTplusClass, TRdsRadioText &)
Get the current Radio Text+. RDS data is received over the air and may not be available immediately following tune operation. If data is not available, this function will return KErrNotFound. If a value is returned, this is the last known value, which may not be up to date. To be notified of the most recent value, client should use NotifyRdsDataChange.
The maximum possible length for radio text+ field is 64 characters.
GetRdsSignalStatus(TBool &)
IMPORT_C TInt | GetRdsSignalStatus | ( | TBool & | aRdsSignal | ) | const |
Get the status of the RDS reception.
Parameters
TBool & aRdsSignal | On return, will be ETrue if RDS signal can be recepted, EFalse otherwise. |
GetTrafficAnnouncementStatus(TBool &)
IMPORT_C TInt | GetTrafficAnnouncementStatus | ( | TBool & | aTaStatus | ) | |
Get Traffic Announcement status at the current station.
Parameters
TBool & aTaStatus | On return, will be ETrue if current station has ongoing traffic announcement |
GetTrafficProgrammeStatus(TBool &)
IMPORT_C TInt | GetTrafficProgrammeStatus | ( | TBool & | aTpStatus | ) | |
Get Traffic Programme status at the current station.
Parameters
TBool & aTpStatus | On return, will be ETrue if current station supports traffic programme |
NewL(RRadioSession &, MRadioRdsObserver &)
Factory function to create a new instance of the RDS utility.
NotifyRadioTextPlusChange(RArray< TInt > &)
IMPORT_C TInt | NotifyRadioTextPlusChange | ( | RArray< TInt > & | aRtPlusClasses | ) | |
Subscribe for notification for the specified RadioText+ data. Client should first check the capabilities to see if RT+ feature is supported. Returns KErrNotSupported if RT+ is not supported.
For example, if the client wishes to be notified only when new Title and Genre are available: iRtPlusClassArray.Append(ERTplusItemTitle); iRtPlusClassArray.Append(ERTplusItemTitle); iRdsUtility->NotifyRadioTextPlusChangeL(iRtPlusClassArray);
Note that if the client wishes to receive the entire radio text data chunk, client should subscribe for ERdsRadioText using NotifyRdsDataChange instead.
Parameters
RArray< TInt > & aRtPlusClasses | Array of RT+ class to be notified |
NotifyRdsDataChange(TRdsData)
Subscribe for notification for the specified RDS data. Client should first check the capabilities to see if a feature is supported. Request for notification for non-supported features will simply be ignored.
For example, if the client wishes to be notified when new Programme Type and Traffic Announcement is available: iRdsData = ERdsProgrammeType | ERdsTrafficAnnouncement; iRdsUtility->NotifyRdsDataChange(iRdsData);
Parameters
TRdsData aRdsData | Bitfield indicating notification request. |
SetAutomaticSwitching(TBool)
IMPORT_C TInt | SetAutomaticSwitching | ( | TBool | aAuto | ) | |
Turn on/off automatic switching of frequency based on Alternate Frequency. This will cause RDS device to search for alternate frequency when the signal strength deteriorates. User should be ready to receive MrroRdsSearchBeginAF and MrroRdsSearchEndAF. Automatic switching is off by default.
Parameters
TBool aAuto | ETrue to turn automatic switching on, EFalse to turn it off. |
SetAutomaticTrafficAnnouncement(TBool)
IMPORT_C TInt | SetAutomaticTrafficAnnouncement | ( | TBool | aAuto | ) | |
Turns on/off automatic switching of frequency based on Traffic Announcement. This will cause RDS device to search for frequencies broadcasting traffic announcement. Client will be notified of frequency change though the tuner event. It's up to the client to return to the previous frequency when the traffic announcement is finished.
NOTE: This is only supported in dual tuner configuration since the secondary tuner needs to perform continuous scanning for frequency broadcasting traffic announcement, while the primary tuner is used for normal tuner activities.
Parameters
TBool aAuto | ETrue indicates that automatic switching is on. |
StationSeekByPTY(TRdsProgrammeType, TBool)
Asynchronous request to find a radio station with the specified Programme Type(PTY), starting from the currently tuned frequency and searching in the direction specified (i.e. up or down). User must be ready to receive callback method MrroStationSeekByPTYComplete The station found is returned in the callback.
Parameters
TRdsProgrammeType aPty | The type of programme to search for. |
TBool aSeekUp | The direction to search in. Searches upwards if set to ETrue. |
StationSeekByTA(TBool)
IMPORT_C void | StationSeekByTA | ( | TBool | aSeekUp | ) | |
Asynchronous request to find a radio station with Traffic Announcement(TA), starting from the currently tuned frequency and searching in the direction specified (i.e. up or down). User must be ready to receive callback method MrroStationSeekByTAComplete The station found is returned in the callback.
Parameters
TBool aSeekUp | The direction to search in. Searches upwards if set to ETrue. |
StationSeekByTP(TBool)
IMPORT_C void | StationSeekByTP | ( | TBool | aSeekUp | ) | |
Asynchronous request to find a radio station with Traffic Programme(TP), starting from the currently tuned frequency and searching in the direction specified (i.e. up or down). User must be ready to receive callback method MrroStationSeekByTPComplete The station found is returned in the callback.
Parameters
TBool aSeekUp | The direction to search in. Searches upwards if set to ETrue. |
Member Data Documentation
CBody * iBody
RDS utility implementation body Own.
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.