Title here
Summary here
AbstractChannelScanService
AbstractChannelScanService ⇐ Abstract
Kind: global abstract class
Extends: Abstract
Mixes: MServiceCache
Service:
Properties
| Name | Type | Description |
|---|---|---|
| scanChannelType | number | Integer - The types of channel that should be discovered during the scan. @see MediaConst |
| replaceExisting | Boolean | If true (default), any existing channels in the channel list SHALL be removed and the new channel list SHALL consist only of channels found during the channel scan operation. |
| scanTimeout | number | Integer - Scan timeout (in milliseconds) before scan fails if progress freezes; -1 disable timeout |
| _scanInProgress | Boolean | Internal use; true if a scan is in progress |
- AbstractChannelScanService ⇐
Abstract- new AbstractChannelScanService()
- instance
- .newChannelScanParameters(properties) ⇒
AbstractChannelScanParameters - .newChannelScanStatus(properties) ⇒
AbstractChannelScanStatus - .startScan(channelScanParameters) ⇒
Promise.<AbstractChannelScanStatus, Error> - .stopScan() ⇒
Promise.<AbstractChannelScanStatus, Error> - ._onChannelScan(channelScanStatus) ⇒
Promise - ._onError(e) ⇒
Promise - “channelScan” (channelScanStatus)
- “error”
- .newChannelScanParameters(properties) ⇒
- static
- .MODULATION_TYPE_QPSK :
number - .MODULATION_TYPE_QAM16 :
number - .MODULATION_TYPE_QAM32 :
number - .MODULATION_TYPE_QAM64 :
number - .MODULATION_TYPE_QAM128 :
number - .MODULATION_TYPE_QAM256 :
number - .MODULATION_TYPE_QAM1024 :
number - .MODULATION_TYPE_QAM4096 :
number
- .MODULATION_TYPE_QPSK :
AbstractChannelScanService()
A service to scan channels from DVB.
newChannelScanParameters(properties) ⇒ AbstractChannelScanParameters
Create a new ChannelScanParameters model.
Kind: instance method of AbstractChannelScanService
Returns: AbstractChannelScanParameters - The channelScanParameters model
| Param | Type | Description |
|---|---|---|
| properties | Object | The channel scan parameters properties |
newChannelScanStatus(properties) ⇒ AbstractChannelScanStatus
Create a new ChannelScanStatus model.
Kind: instance method of AbstractChannelScanService
Returns: AbstractChannelScanStatus - The channelScanStatus model
| Param | Type | Description |
|---|---|---|
| properties | Object | The channel scan status properties |
startScan(channelScanParameters) ⇒ Promise.<AbstractChannelScanStatus, Error>
Start a scan Promise is resolved once the scan has been completed or aborted (error).
Kind: instance method of AbstractChannelScanService
Returns: Promise.<AbstractChannelScanStatus, Error> - A promise (abstractChannelScanStatus,error)
| Param | Type | Description |
|---|---|---|
| channelScanParameters | AbstractChannelScanParameters | The parameters to use to do the scan |
stopScan() ⇒ Promise.<AbstractChannelScanStatus, Error>
Stop a scan
Kind: instance method of AbstractChannelScanService
Returns: Promise.<AbstractChannelScanStatus, Error> - A promise (abstractChannelScanStatus,error)
_onChannelScan(channelScanStatus) ⇒ Promise
Kind: instance method of AbstractChannelScanService
Access: protected
| Param | Type |
|---|---|
| channelScanStatus | * |
_onError(e) ⇒ Promise
Kind: instance method of AbstractChannelScanService
Access: protected
| Param | Type |
|---|---|
| e | Error |
“channelScan” (channelScanStatus)
Fired when the status of a scan is changed.
Kind: event emitted by AbstractChannelScanService
| Param | Type | Description |
|---|---|---|
| channelScanStatus | AbstractChannelScanStatus | The status of the scan |
“error”
Fired when an error occurred during a scan.
Kind: event emitted by AbstractChannelScanService
MODULATION_TYPE_QPSK : number
Kind: static constant of AbstractChannelScanService
MODULATION_TYPE_QAM16 : number
Kind: static constant of AbstractChannelScanService
MODULATION_TYPE_QAM32 : number
Kind: static constant of AbstractChannelScanService
MODULATION_TYPE_QAM64 : number
Kind: static constant of AbstractChannelScanService
MODULATION_TYPE_QAM128 : number
Kind: static constant of AbstractChannelScanService
MODULATION_TYPE_QAM256 : number
Kind: static constant of AbstractChannelScanService
MODULATION_TYPE_QAM1024 : number
Kind: static constant of AbstractChannelScanService
MODULATION_TYPE_QAM4096 : number
Kind: static constant of AbstractChannelScanService