stbDvbInput

stbDvbInput

Since:
  • v343
Tutorials:

Main object to manage DVB-C/T/T2 subsystem.

Not accessible in global scope.
Can't be manually created but can be received from other STB global objects.

Members

(static) antennaPower :boolean

Default Value:
  • false

Manual control of antenna power state.

Used to supply power to active antenna.

Triggers stbDvbInput.onAntennaPower hook.

In case when connected antenna is not active a legacy event 33 (0x2B)
will be triggered and antenna power will be disabled.

Type:
  • boolean

(static, readonly) capabilities :stbDvbInput~capabilitiesConfig

Get run-time input capabilities.

Type:
Example
// output input antennaPower support
console.log(stbDvbManager.inputs[0].capabilities.antennaPower);

(static, readonly) TYPE_DVB_C :number

See:
Type:
  • number

(static, readonly) TYPE_DVB_T :number

See:
Type:
  • number

(static, readonly) TYPE_DVB_T2 :number

See:

not available for MAG270

Type:
  • number

(static, readonly) TYPE_DVB_S :number

See:
Type:
  • number

(static, readonly) TYPE_DVB_S2 :number

See:
Type:
  • number

(static, readonly) supportedScanTypes :Array.<stbDvbInput~dvbSignalType>

Get supported scan types for this input.

Type:
Example
[1, 2, 3]

(static, readonly) currentScanTypes :Array.<stbDvbInput~dvbSignalType>

Get currently supported scan types for this input.

The difference with stbDvbInput.supportedScanTypes is:
result of stbDvbInput.currentScanTypes depends on current DVB type
e.i. for MAG275 it can be either DVB-C or DVB-T and DVB-T2, for MAG356 it can be DVB-S2.

Type:
Example
[2, 3]

(static, readonly) STATE_START :number

See:
Type:
  • number

(static, readonly) STATE_STOP :number

See:
Type:
  • number

(static, readonly) STATE_ERROR :number

See:
Type:
  • number

Methods

(static) setSignalType(type) → {boolean}

Set current scan type for this input.
On some devices may require reboot to apply this config.
To determine if reboot is required please check flag requireReboot in stbDvbInput.capabilities.

Example
var input = stbDvbManager.inputs[0];
input.setSignalType(input.TYPE_DVB_C);
Parameters:
Name Type Description
type stbDvbInput~dvbSignalType

DVB signal type
Returns:

operation status

Type
boolean

(static) startScan(config) → {boolean}

Start channel scanning.

Warning: some options can be unsupported on some devices (see scanOptions in stbDvbInput.capabilities).

During scan 2 events can be triggered.

Parameters:
Name Type Description
config Object

scan configuration object

Properties
Name Type Attributes Description
from number <optional>

scan range start frequency (in kHz)
to number <optional>

scan range end frequency (in kHz)
type stbDvbInput~dvbSignalType

DVB signal type
symbolRate number <optional>

satellite/cable signal symbol rate (symbols per second) (only for DVB-C and DVB-S/DVB-S2)
bandwidth number <optional>

channel bandwidth in MHz. e.i. 6, 7, 8 (only for DVB-T/DVB-T2)
step number <optional>

frequency step (in kHz)
modulation number <optional>

signal modulation

Value Description
0 AUTO
1 16QAM
2 32QAM
3 64QAM
4 128QAM
5 256QAM
scanMode number

0 - network, 1 - full, 2 - fast (use NIT) (only for DVB-C)
frequency number <optional>

channel frequency (in kHz)
networkId string <optional>

network ID (0 - auto)
Returns:

operation status

Type
boolean

(static) stopScan() → {boolean}

Stop channel scan.

Returns:

operation status

Type
boolean

(static) onScanProgress(data)

See:

DVB channels scanning is in progress (when scan starts to search new frequency).

Example
{
    state: 0,
    channel: 12,
    frequency: 226500,
    progress: 12,
    polarization: 'H'
}
Parameters:
Name Type Description
data Object

event info

Properties
Name Type Attributes Description
state stbDvbInput~scanState

scan state
channel number

channel number in frequency grid
frequency number

channel frequency (in kHz)
progress number

scan progress in range [0..100]
polarization string <optional>

optional satellite signal polarization ("V" - vertical, "H" - horizontal, "CL" - circular left, "CR" - circular right ) to tune to

(static) onChannelFound(data)

See:

DVB channel is found.

Example
{
    id: 'T2_41_490000',
    name: 'some channel name',
    frequency: 490000,
    symbolRate: 0,
    type: 3
}
Parameters:
Name Type Description
data Object

event info

Properties
Name Type Attributes Description
id string

channel unique identifier
type stbDvbInput~dvbSignalType

DVB signal type
name string

channel name
frequency number

channel frequency (in kHz)
polarization number <optional>

optional satellite signal polarization ("V" - vertical, "H" - horizontal, "CL" - circular left, "CR" - circular right ) to tune to
symbolRate number <optional>

optional satellite/cable signal symbol rate (symbols per second)

(static) onAntennaPower(status)

See:

DVB antenna power status change.

Parameters:
Name Type Description
status boolean

power state

Type Definitions

capabilitiesConfig

See:
Properties:
Name Type Description
antennaPower boolean

indicates whether input can change antennaPower
requireReboot boolean

indicates whether device should be restarted to apply some changed options
scanOptions Array

supported scanning options

Set of flags that represent what input is capable to do at the moment.

Type:
  • Object

dvbSignalType

See:

DVB signal type.

Type:
  • number

scanState

See:

DVB channels scanning state.

Type:
  • number