CRadioFmTunerUtility::CBody Class Reference

class CRadioFmTunerUtility::CBody : public CBase

This class encapsulates the implementation body of CRadioFmTunerUtility interface.

Radio_Utility.lib
Since
S60 3.2

Inherits from

  • CRadioFmTunerUtility::CBody

Constructor & Destructor Documentation

CBody()

CBody ( ) [private]

~CBody()

~CBody ( )

Member Functions Documentation

CancelSetFrequency()

void CancelSetFrequency ( )

Cancels an ongoing tune operation, as initiated by a call to Tune. The usual callback will not occur if this has been called.

Has not effect if no tune operation is ongoing.

Since
S60 3.2

CancelSetFrequencyRange()

void CancelSetFrequencyRange ( )

Cancels an ongoing set frequency range operation, as initiated by a call to SetFrequencyRange. The usual callback will not occur if this has been called.

Has not effect if no set frequency range operation is ongoing.

Since
S60 3.2

CancelStationSeek()

void CancelStationSeek ( )

Cancels an ongoing station seek operation, as initiated by a call to StationSeek. The usual callback will not occur if this has been called.

Has not effect if no station seek operation is ongoing.

Since
S60 3.2

Close()

void Close ( )

Close the tuner and free all memory allocated. Any ongoing playing activity will be stopped, control of the tuner will be released, and the hardware will be powered down if no other clients need it.

Since
S60 3.2

ConstructL()

void ConstructL ( ) [private]

EnableTunerInOfflineMode(TBool)

TInt EnableTunerInOfflineMode ( TBool aEnable )

Enable tuner functions when the device is in offline mode. Client should first check the capabilities to see if this feature is supported. Tuner functions are disabled in offline mode by default.

Since
S60 3.2

Parameters

TBool aEnable ETrue to enable tuner functions in offline mode, EFalse to disable.

ForceMonoReception(TBool)

TInt ForceMonoReception ( TBool aForcedMono )

Indicates whether the reception should be forced into monophonic mode.

Since
S60 3.2

Parameters

TBool aForcedMono

GetCapabilities(TFmTunerCapabilities &)

TInt GetCapabilities ( TFmTunerCapabilities & aCaps ) const

Get the capabilities of the FM tuner on the device.

Since
S60 3.2

Parameters

TFmTunerCapabilities & aCaps The capabilities object to fill

GetForcedMonoReception(TBool &)

TInt GetForcedMonoReception ( TBool & aForcedMono ) const

Find out whether reception is forced into monophonic mode or not.

Since
S60 3.2

Parameters

TBool & aForcedMono On return, will be ETrue if a forced mono is currently enabled.

GetFrequency(TInt &)

TInt GetFrequency ( TInt & aFrequency ) const

Get the currently tuned frequency.

Since
S60 3.2

Parameters

TInt & aFrequency On return contains the current frequency (Hz).

GetFrequencyRange(TFmRadioFrequencyRange &, TInt &, TInt &)

TInt GetFrequencyRange ( TFmRadioFrequencyRange & aRange,
TInt & aMinFreq,
TInt & aMaxFreq
) const

Get the current frequency range. It also returns the minimum and maximum frequencies (Hz) for the returned range. Client should always use the minimum and maximum frequencies returned by the tuner device, since it may vary slightly depending on the hardware.

Since
S60 3.2

Parameters

TFmRadioFrequencyRange & aRange On return contains the current frequency range.
TInt & aMinFreq On return contains the minimum frequency for the current frequency range.
TInt & aMaxFreq On return contains the maximum frequency for the current frequency range.

GetMaxSignalStrength(TInt &)

TInt GetMaxSignalStrength ( TInt & aMaxSignalStrength ) const

Get the maximum possible signal strength of a tuned frequency.

Since
S60 3.2

Parameters

TInt & aMaxSignalStrength On return contains the maximum signal strength.

GetSignalStrength(TInt &)

TInt GetSignalStrength ( TInt & aSignalStrength ) const

Get the signal strenth of the currently tuned frequency.

Since
S60 3.2

Parameters

TInt & aSignalStrength On return contains the signal strength.

GetSquelch(TBool &)

TInt GetSquelch ( TBool & aSquelch ) const

Get the current squelching (muting in frequencies without reception) setting.

Since
S60 3.2

Parameters

TBool & aSquelch On return, will be ETrue if a squelching is currently enabled.

GetStereoMode(TBool &)

TInt GetStereoMode ( TBool & aStereo ) const

Get the current frequency's stereo mode (stereo or mono).

Since
S60 3.2

Parameters

TBool & aStereo On return, will be ETrue if a stereo signal is currently being received.

NewL(RRadioSession &, MRadioFmTunerObserver &)

CBody * NewL ( RRadioSession & aRadioSession,
MRadioFmTunerObserver & aObserver
) [static]

Parameters

RRadioSession & aRadioSession
MRadioFmTunerObserver & aObserver

RequestTunerControl()

void RequestTunerControl ( )

Asynchronous request to get control of the FM tuner. User must be ready to receive callback method MrftoRequestTunerControlComplete. Control to the tuner must be granted before any functions that require control of the tuner (such as Tune) can be made.

SetFrequency(TInt)

void SetFrequency ( TInt aFrequency )

Asynchronous request to tune the tuner to the speficied frequency (Hz). User must be ready to receive callback method MrftoTuneComplete.

Since
S60 3.2
MRadioFmTunerObserver::MrftoTuneComplete

Parameters

TInt aFrequency The frequency to tune to

SetFrequencyRange(TFmRadioFrequencyRange)

void SetFrequencyRange ( TFmRadioFrequencyRange aRange )

Asynchronous request to set the frequency range. User must be ready to receive callback method MrftoSetFrequencyRangeComplete. If not set, it will be defaulted to EFmRangeEuroAmerica.

Since
S60 3.2

Parameters

TFmRadioFrequencyRange aRange Frequency range

SetSquelch(TBool)

TInt SetSquelch ( TBool aSquelch )

Set the current squleching (muting in frequencies without reception) setting. Squelching is enabled by default.

Since
S60 3.2

Parameters

TBool aSquelch

StationSeek(TBool)

void StationSeek ( TBool aUpwards )

Asynchronous request to find a radio station, 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 MrftoSeekComplete. The station found is returned in the callback.

If no station is found after a complete loop, seek will stop and return KErrNotfound in the callback method and frequency will not change.

Parameters

TBool aUpwards The direction to search in. Searches upwards if set to ETrue.

Member Data Documentation

MRadioFmTunerObserver * iRadioFmTunerUtilityClient

MRadioFmTunerObserver * iRadioFmTunerUtilityClient [private]

RRadioSession * iRadioSession

RRadioSession * iRadioSession [private]