import "ToiDvbCScanner.idl";
Public Member Functions | |
| void | addFrequencyScanParameters (in ToiDvbCScannerDvbCFrontendParameters frontendParameters, in long startFrequency, in long endFrequency, in long step) raises (TToiInvalidPreconditionException, TToiInvalidArgumentException) |
| void | addNitScanParametersByNetworkId (in ToiDvbCScannerDvbCFrontendParameters frontendParameters, in long frequency, in long networkId) raises (TToiInvalidPreconditionException, TToiInvalidArgumentException) |
| void | clear () raises (TToiInvalidPreconditionException) |
| void | startScan (in ToiOperationManager::TToiOperationId operationId, in TToiStoreMode storeMode) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException) |
| void | releaseInstance () |
Public Attributes | |
TToiDvbCModulation | |
| const TToiDvbCModulation | MODULATION_ANY = 0 |
| const TToiDvbCModulation | MODULATION_16_QAM = 1 |
| const TToiDvbCModulation | MODULATION_32_QAM = 2 |
| const TToiDvbCModulation | MODULATION_64_QAM = 3 |
| const TToiDvbCModulation | MODULATION_128_QAM = 4 |
| const TToiDvbCModulation | MODULATION_256_QAM = 5 |
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 | TToiDvbCModulation |
| typedef long | TToiStoreMode |
| typedef long ToiDvbCScanner::TToiDvbCModulation |
The carrier modulation scheme.
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 ToiDvbCScanner::addFrequencyScanParameters | ( | in ToiDvbCScannerDvbCFrontendParameters | frontendParameters, | |
| in long | startFrequency, | |||
| in long | endFrequency, | |||
| in long | step | |||
| ) | raises (TToiInvalidPreconditionException, TToiInvalidArgumentException) |
Add one 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. If this method is called with the same values several times, only the first call has any effect.
| frontendParameters | DVB-C tuning parameters. | |
| startFrequency | Start frequency in Hz. | |
| endFrequency | End frequency in Hz. | |
| step | Frequency interval used when scanning, in Hz. |
| TToiInvalidPreconditionException | Raised if a scan is already active. | |
| TToiInvalidArgumentException | Raised if the arguments are not valid. |
| void ToiDvbCScanner::addNitScanParametersByNetworkId | ( | in ToiDvbCScannerDvbCFrontendParameters | frontendParameters, | |
| in long | frequency, | |||
| in long | networkId | |||
| ) | raises (TToiInvalidPreconditionException, TToiInvalidArgumentException) |
Add a set of parameters for a scan based on Network Id. The scan will tune to a specific frequency and start listening on SI on that frequency. This method should be called before ToiScanner::startScan().
Repeatly calling this method is allowed, parameters are stored. When the scan is started the scan operation will perform the scan one parameter set by one, in the order they were added. If this method is called with the same values several times, only the first call will have any effect.
When found, all Service Description Tables (SDTs) associated with that Network Information Table (NIT) are read. Service Information (SI) is acquired without actually scanning different frequencies. It is acquired by reading Service Information on the specified channel.
| frontendParameters | Cable tuning parameters. | |
| frequency | The frequency in Hz. | |
| networkId | The network id to look for in NIT actual/other. |
| TToiInvalidPreconditionException | Raised if a scan is already 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. |
Quadrature amplitude modulation with 128 constellation points.
This constant can also be accessed from toi.consts.ToiDvbCScanner.MODULATION_128_QAM.
Quadrature amplitude modulation with 16 constellation points.
This constant can also be accessed from toi.consts.ToiDvbCScanner.MODULATION_16_QAM.
Quadrature amplitude modulation with 256 constellation points.
This constant can also be accessed from toi.consts.ToiDvbCScanner.MODULATION_256_QAM.
Quadrature amplitude modulation with 32 constellation points.
This constant can also be accessed from toi.consts.ToiDvbCScanner.MODULATION_32_QAM.
Quadrature amplitude modulation with 64 constellation points.
This constant can also be accessed from toi.consts.ToiDvbCScanner.MODULATION_64_QAM.
Any modulation.
This constant can also be accessed from toi.consts.ToiDvbCScanner.MODULATION_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.