Class CMMTunerScannerUtility

class CMMTunerScannerUtility : public CBase;

Description

This class augments CMMTunerUtility to provide station scanning functionality, whereby the frequency spectrum is searched, pausing for a specified amount of time when a station is found.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CMMTunerScannerUtility - This class augments CMMTunerUtility to provide station scanning functionality, w...

Members

Defined in CMMTunerScannerUtility:

• NewL(CMMTunerUtility &,MMMTunerObserver &)Factory function to create a new CMMTunerScannerUtility.
• StopScan()Stop scanning and use the currently tuned station
• ~CMMTunerScannerUtility()Destrucutor

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Interface status:

deprecated

Use CMMTunerUtility::GetTunerScannerUtility() instead

IMPORT_C static CMMTunerScannerUtility* NewL(CMMTunerUtility &aTuner, MMMTunerObserver &aObserver);

Description

Factory function to create a new CMMTunerScannerUtility.

Parameters

CMMTunerUtility &aTuner The tuner with which to perform the scanning. MMMTunerObserver &aObserver

Return value

CMMTunerScannerUtility * A newly contructed tuner scanner utility.

Leave codes

KErrNoMemory Out of memory.

IMPORT_C virtual ~CMMTunerScannerUtility();

Description

Destrucutor

IMPORT_C void StationScan(TFrequency aStartFrequency, CMMTunerUtility::TTunerBand aBand, CMMTunerUtility::TSearchDirection aSearchDirection, TTimeIntervalMicroSeconds32 aPauseDuration, TBool aCircularScan=ETrue);

Description

Continuously scan for a radio station, pausing for the time specified before continuing on to the next station. Call StopScan to select the currently tuned station. The search is limited to the specified band.

Parameters

TFrequency aStartFrequency The frequency to start searching at CMMTunerUtility::TTunerBand aBand The band to which aStartFrequency belongs CMMTunerUtility::TSearchDirection aSearchDirection The direction to search in TTimeIntervalMicroSeconds32 aPauseDuration Time to pause at each station TBool aCircularScan If set to ETrue the station scan will loop back to the other end of the band once the end of the band has been reached. (Defaults to ETrue)

IMPORT_C void StationScan(TChannel aStartChannel, CMMTunerUtility::TTunerBand aBand, CMMTunerUtility::TSearchDirection aSearchDirection, TTimeIntervalMicroSeconds32 aPauseDuration, TBool aCircularScan=ETrue);

Description

Continuously scan for a radio station, pausing for the time specified before continuing on to the next station. Call StopScan to select the currently tuned station.

Parameters

TChannel aStartChannel The channel to start searching from CMMTunerUtility::TTunerBand aBand The channel band to search CMMTunerUtility::TSearchDirection aSearchDirection the direction to search in TTimeIntervalMicroSeconds32 aPauseDuration Time to pause at each station TBool aCircularScan If set to ETrue the station scan will loop back to the other end of the channel range once the end of the channel range has been reached. (Defaults to ETrue)

IMPORT_C TBool StopScan();

Description

Stop scanning and use the currently tuned station

Return value

TBool ETrue if a station is tuned, EFalse otherwise