Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: Tuner.h
Link against: tuner.lib

This item is not part of the S60 3rd Edition SDK for Symbian OS, Feature Pack 2.

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

Members

Defined in CMMTunerScannerUtility:
NewL(), StationScan(), StationScan(), StopScan(), ~CMMTunerScannerUtility()

Inherited from CBase:
Delete(), Extension_(), operator new()


Construction and destruction


NewL()

static IMPORT_C 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.


~CMMTunerScannerUtility()

virtual IMPORT_C ~CMMTunerScannerUtility();

Description

Destrucutor

[Top]


Member functions


StationScan()

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)


StationScan()

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)


StopScan()

IMPORT_C TBool StopScan();

Description

Stop scanning and use the currently tuned station

Return value

TBool

ETrue if a station is tuned, EFalse otherwise