import "ToiDvbTScanner.idl";
Public Member Functions | |
| void | addFrequencyScanParameters (in ToiDvbTScannerDvbTFrontendParameters tunerParams, in long startFrequency, in long endFrequency, in long step) raises (TToiInvalidPreconditionException, TToiInvalidArgumentException) |
| void | clear () raises (TToiInvalidPreconditionException) |
| void | startScan (in ToiOperationManager::TToiOperationId operationId, in TToiStoreMode storeMode) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException) |
| void | releaseInstance () |
Public Attributes | |
TToiDvbTBandwidth | |
| const TToiDvbTBandwidth | BANDWIDTH_ANY = 0 |
| const TToiDvbTBandwidth | BANDWIDTH_8MHZ = 1 |
| const TToiDvbTBandwidth | BANDWIDTH_7MHZ = 2 |
| const TToiDvbTBandwidth | BANDWIDTH_6MHZ = 3 |
| const TToiDvbTBandwidth | BANDWIDTH_5MHZ = 4 |
Operation properties | |
The operation properties defined for scan operations. See ToiOperationManager for more info. | |
| const ToiOperationManager::TToiPropertyId | OP_PROPERTY_SERVICES_FOUND = 1 |
TToiStoreMode | |
| const TToiStoreMode | STORE_MODE_OVERWRITE = 0 |
| const TToiStoreMode | STORE_MODE_UPDATE = 1 |
Public Types | |
| typedef long | TToiDvbTBandwidth |
| typedef long | TToiStoreMode |
| typedef long ToiDvbTScanner::TToiDvbTBandwidth |
The DVB-T bandwidth.
typedef long ToiScanner::TToiStoreMode [inherited] |
This structure defines the store mode that is used when the service information is written to the permanent storage.
| void ToiDvbTScanner::addFrequencyScanParameters | ( | in ToiDvbTScannerDvbTFrontendParameters | 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 ToiScanner::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.
| tunerParams | Terrestrial tuning parameters. | |
| startFrequency | Start frequency in Hz. | |
| endFrequency | End frequency in Hz. | |
| step | Step used when scanning in Hz. |
| TToiInvalidPreconditionException | Raised if one scan is active. | |
| TToiInvalidArgumentException | Raised if the arguments are not valid. |
| void ToiScanner::clear | ( | ) | raises (TToiInvalidPreconditionException) [inherited] |
Clear all the scan parameters set by the derived scan interface.
| TToiInvalidPreconditionException | Raised if a scan is active. |
| void ToiScanner::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 ToiScanner::startScan | ( | in ToiOperationManager::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 ToiOperationOperationResultEvent call with the operation result ToiOperationManager::OP_RESULT_NONE, then the application can get the number of found services from ToiOperationManager::TToiPropertySequence. The property for this is identified by id ToiScanner::OP_PROPERTY_SERVICES_FOUND. Only when the state in ToiOperationManagerOperationInfo reach OPERATION_COMPLETED, the application can get channel info via ToiChannelService.
Calling ToiOperationManager::cancelOperation() will immediately stop an ongoing channel scan. The found services since StartScan() are not saved to permanent storage. Calling ToiOperationManager::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.
| operationId | The operation identifier created by ToiOperationManager retrieved from ToiFrontendService. | |
| storeMode | The store mode used for saving the found service information. |
| TToiInvalidArgumentException | Raised if the function was called with invalid arguments. | |
| TToiInvalidPreconditionException | Raised if no scan parameters are set or one scan is active. |
Bandwidth of 5MHz.
This constant can also be accessed from toi.consts.ToiDvbTScanner.BANDWIDTH_5MHZ.
Bandwidth of 6MHz.
This constant can also be accessed from toi.consts.ToiDvbTScanner.BANDWIDTH_6MHZ.
Bandwidth of 7MHz.
This constant can also be accessed from toi.consts.ToiDvbTScanner.BANDWIDTH_7MHZ.
Bandwidth of 8MHz.
This constant can also be accessed from toi.consts.ToiDvbTScanner.BANDWIDTH_8MHZ.
Any bandwidth.
This constant can also be accessed from toi.consts.ToiDvbTScanner.BANDWIDTH_ANY.
const ToiOperationManager::TToiPropertyId ToiScanner::OP_PROPERTY_SERVICES_FOUND = 1 [inherited] |
This property indicates the number of services found since the start of the scan, See ToiScanner::startScan().
This constant can also be accessed from toi.consts.ToiScanner.OP_PROPERTY_SERVICES_FOUND.
const TToiStoreMode ToiScanner::STORE_MODE_OVERWRITE = 0 [inherited] |
Remove all previous channels for this modulation system and replace them with the ones found.
This constant can also be accessed from toi.consts.ToiScanner.STORE_MODE_OVERWRITE.
const TToiStoreMode ToiScanner::STORE_MODE_UPDATE = 1 [inherited] |
Update the existing channels, and add the new channels to the permanent storage.
This constant can also be accessed from toi.consts.ToiScanner.STORE_MODE_UPDATE.