Scanner service
import "IScannerService.idl";
Public Member Functions | |
void | SetRegionCode (in long regionCode) raises (TToiInvalidArgumentException) |
void | UpdateOneTouchButton (in TDeliverySystemType type, in long oneTouchButton, in long originalNetworkId, in long transportStreamId, in long serviceId) raises (TToiInvalidArgumentException) |
void | SetScanMode (in TScanMode scanMode) raises (TToiInvalidArgumentException) |
void | ScanFrequencyBands (in TDeliverySystemType type, in TBandList bandList) raises (TToiNotEnoughResourcesException, TToiInvalidArgumentException) |
void | Scan (in TDeliverySystemType type, in string serverAddress) raises (TToiNotEnoughResourcesException, TToiInvalidArgumentException) |
void | Abort () raises (TToiInvalidPreconditionException) |
void | Clear (in TDeliverySystemType type) raises (TToiNotEnoughResourcesException, TToiInvalidArgumentException) |
void | StartFrontendMonitor (in TDeliverySystemType deliverySystemType, in string deliverySystemDescriptor) raises (TToiNotEnoughResourcesException, TToiInvalidArgumentException) |
void | StopFrontendMonitor () raises (TToiInvalidPreconditionException) |
void | RegisterObserver (in long applicationId, in string address) raises (TToiInvalidArgumentException) |
void | ReleaseObserver (in string address) raises (TToiInvalidArgumentException) |
Public Types | |
enum | TDeliverySystemType { ISDB_T, ISDB_CS, ISDB_BS, IPSP, ISDB_T_RETRANSMISSION, DVB_T, DVB_C } |
enum | TScanMode { SCAN_MODE_INITIAL, SCAN_MODE_RESCAN } |
enum | TBand { BAND_UHF, BAND_VHF, BAND_MID, BAND_SHB } |
typedef sequence< TBand > | TBandList |
void IScannerService::Abort | ( | ) | raises (TToiInvalidPreconditionException) |
Immediatly stop an ongoing channel scan. Observers will receive an OnScanAborted event when this method is invoked.
TToiInvalidPreconditionException | Raised if the function was called when there was no scan started. |
void IScannerService::Clear | ( | in TDeliverySystemType | type | ) | raises (TToiNotEnoughResourcesException, TToiInvalidArgumentException) |
Removes all service data that belongs to a delivery system.
type | The delivery system type service list to be cleared. |
TToiInvalidArgumentException | Raised if the arguments are not valid. | |
TToiNotEnoughResourcesException | Raised if another scan operation is active. |
void IScannerService::RegisterObserver | ( | in long | applicationId, | |
in string | address | |||
) | raises (TToiInvalidArgumentException) |
RegisterObserver
applicationId | The id of the observing application. | |
address | The address where the IScannerService can find an IScannerObserver interface. |
TToiInvalidArgumentException | Raised if the specified address is invalid or if the application has already registered itself as an observer with the same address. |
void IScannerService::ReleaseObserver | ( | in string | address | ) | raises (TToiInvalidArgumentException) |
ReleaseObserver
address | The address where the IScannerService can find the registered IScannerObserver interface. |
TToiInvalidArgumentException | Raised if the specified address is invalid. |
void IScannerService::Scan | ( | in TDeliverySystemType | type, | |
in string | serverAddress | |||
) | raises (TToiNotEnoughResourcesException, TToiInvalidArgumentException) |
Performs an automatic channel search on a delivery system. If used for scanning terrestrial channels all frequency bands are scanned. OnProgress events are sent at regular intervals. The result is stored in the service information database if the search is completed successfully, overwriting any previous data,
type | The system delivery type to be scanned. | |
serverAddress | This parameter is only checked when type is IPSP or ISDB_T_RETRANSMISSION. |
TToiNotEnoughResourcesException | Raised if the scan operation can not be started. | |
TToiInvalidArgumentException | Raised if the arguments are not valid. |
void IScannerService::ScanFrequencyBands | ( | in TDeliverySystemType | type, | |
in TBandList | bandList | |||
) | raises (TToiNotEnoughResourcesException, TToiInvalidArgumentException) |
Performs an automatic terrestrial channel search with specified frequency bands. The result is stored in the service information database if the search is completed successfully, overwriting any previous data,
type | The system delivery type to be scanned. | |
bandList | A list of frequency bands used for terrestrial scanning. |
TToiNotEnoughResourcesException | Raised if the scan operation can not be started. | |
TToiInvalidArgumentException | Raised if the arguments are not valid. |
void IScannerService::SetRegionCode | ( | in long | regionCode | ) | raises (TToiInvalidArgumentException) |
Customizes scan to filter service information with respect to the supplied region code. Only applicable in ARIB/ISDB-T.
regionCode | The region code. |
TToiInvalidArgumentException | Raised if the arguments are not valid. |
void IScannerService::SetScanMode | ( | in TScanMode | scanMode | ) | raises (TToiInvalidArgumentException) |
Sets scanning mode.
scanMode | The scan mode to use for channel scanning. |
TToiInvalidArgumentException | Raised if the arguments are not valid. |
void IScannerService::StartFrontendMonitor | ( | in TDeliverySystemType | deliverySystemType, | |
in string | deliverySystemDescriptor | |||
) | raises (TToiNotEnoughResourcesException, TToiInvalidArgumentException) |
Start the frontend monitor with the specified delivery system type and delivery system descriptor.
deliverySystemType | The delivery system type. | |
deliverySystemDescriptor | The delivery system descriptor according to ETSI EN 300 468 or ARIB STD-B10 in hexadecimal string format. |
TToiNotEnoughResourcesException | Raised if the scan operation can not be started. | |
TToiInvalidArgumentException | Raised if the arguments are not valid. |
void IScannerService::StopFrontendMonitor | ( | ) | raises (TToiInvalidPreconditionException) |
Stop the active frontend monitor.
TToiInvalidPreconditionException | Raised if the function was called when there was no signal quality monitor started. |
void IScannerService::UpdateOneTouchButton | ( | in TDeliverySystemType | type, | |
in long | oneTouchButton, | |||
in long | originalNetworkId, | |||
in long | transportStreamId, | |||
in long | serviceId | |||
) | raises (TToiInvalidArgumentException) |
Sets the OneTouchButton assignment on the service specified by OriginalNetworkId, TransportStreamId and ServiceId.
type | The system delivery type to be scanned. | |
oneTouchButton | OneTouchButton | |
originalNetworkId | OriginalNetworkId | |
transportStreamId | TransportStreamId | |
serviceId | ServiceId |
TToiInvalidArgumentException | Raised if the service is not found. |