IToiDvbTScanner Interface Reference


Description

Technical Preview:
This interface is a TECHNICAL PREVIEW, it may change. The IToiDvbTScanner interface is used for specifying scan criterias for a DVB-T service scan.
See also:
IToiScanner

import "IToiDvbTScanner.idl";

List of all members.

Public Member Functions

void AddFrequencyScanParameters (in TToiDvbTFrontendParameters tunerParams, in long startFrequency, in long endFrequency, in long step) raises (TToiInvalidPreconditionException, TToiInvalidArgumentException)
void Clear () raises (TToiInvalidPreconditionException)
void StartScan (in IToiOperationManager::TToiOperationId operationId, in TToiStoreMode storeMode) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
void ReleaseInstance ()

Public Attributes

Operation properties

The operation properties defined for scan operations. See IToiOperationManager for more info.

const
IToiOperationManager::TToiPropertyId 
OP_PROPERTY_SERVICES_FOUND = 1

Classes

struct  TToiDvbTFrontendParameters

Public Types

enum  TToiDvbTBandwidth {
  BANDWIDTH_ANY, BANDWIDTH_8MHZ, BANDWIDTH_7MHZ, BANDWIDTH_6MHZ,
  BANDWIDTH_5MHZ
}
enum  TToiStoreMode { STORE_MODE_OVERWRITE, STORE_MODE_UPDATE }

Member Enumeration Documentation

The DVB-T bandwidth.

Enumerator:
BANDWIDTH_ANY 

Any bandwidth.

BANDWIDTH_8MHZ 

Bandwidth of 8MHz.

BANDWIDTH_7MHZ 

Bandwidth of 7MHz.

BANDWIDTH_6MHZ 

Bandwidth of 6MHz.

BANDWIDTH_5MHZ 

Bandwidth of 5MHz.

enum IToiScanner::TToiStoreMode [inherited]

This structure defines the store mode that is used when the service information is written to the permanent storage.

Enumerator:
STORE_MODE_OVERWRITE 

Remove all previous channels for this modulation system and replace them with the ones found.

STORE_MODE_UPDATE 

Update the existing channels, and add the new channels to the permanent storage.


Member Function Documentation

void IToiDvbTScanner::AddFrequencyScanParameters ( in TToiDvbTFrontendParameters  tunerParams,
in long  startFrequency,
in long  endFrequency,
in long  step 
) raises (TToiInvalidPreconditionException, TToiInvalidArgumentException)

Add a set of parameters for a frequency band based scan. This method should be called before IToiScanner::StartScan()

Repeatly calling this method is allowed, parameters are stored and when the scan is started each set of parameters/band is scanned, one by one.

Parameters:
tunerParams Terrestrial tuning parameters.
startFrequency Start frequency in Hz.
endFrequency End frequency in Hz.
step Step used when scanning in Hz.
Exceptions:
TToiInvalidPreconditionException Raised if one scan is active.
TToiInvalidArgumentException Raised if the arguments are not valid.
See also:
IToiScanner::StartScan()
TToiScanner::Clear()
void IToiScanner::Clear (  )  raises (TToiInvalidPreconditionException) [inherited]

Clear all the scan parameters set by the derived scan interface.

Exceptions:
TToiInvalidPreconditionException Raised if a scan is active.
void IToiScanner::ReleaseInstance (  )  [inherited]

This function releases the resources used by this instance. Upon return this object will no longer be available and must not be called.

void IToiScanner::StartScan ( in IToiOperationManager::TToiOperationId  operationId,
in TToiStoreMode  storeMode 
) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException) [inherited]

Starts a scan based on the parameters set by the functions of the derived scan interface. The found channel information is stored into permanent storage based on the store mode once the scan process is completed.

When the application receives a IToiOperationObserver::OnOperationResult() call with the operation result IToiOperationManager::OP_RESULT_NONE, then the application can get the number of found services from IToiOperationManager::TToiPropertySequence. The property for this is identified by id OP_PROPERTY_SERVICES_FOUND. Only when the state in IToiOperationManager::TToiOperationInfo reach OPERATION_COMPLETED, the application can get channel info via IToiChannelService.

Calling IToiOperationManager::CancelOperation() will immediately stop an ongoing channel scan. The found services since StartScan() are not saved to permanent storage. Calling IToiOperationManager::ReleaseOperation() will remove the operation identified by operationId. If a scan is in progress, it will immediatly stop and the found services since StartScan() are not saved to permanent storage.

Parameters:
operationId The operation identifier created by IToiOperationManager retrieved from IToiFrontendService.
storeMode The store mode used for saving the found service information.
Exceptions:
TToiInvalidArgumentException Raised if the function was called with invalid arguments.
TToiInvalidPreconditionException Raised if no scan parameters are set or one scan is active.

Member Data Documentation

This property indicates the number of services found since the start of the scan, See StartScan().

This constant can also be accessed from toi.consts.IToiScanner.OP_PROPERTY_SERVICES_FOUND.