stbDvbChannelList

stbDvbChannelList

Since:
  • v343
Tutorials:

stbDvbChannelList instance.

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

Any manual modification with add, remove or clear will be lost after stbDvbInput.startScan call.

Members

(static, readonly) size :number

Amount of channels in this channel list.

Type:
  • number

Methods

(static) add(id) → {boolean}

Add the channel to this channel list.

Affects this channel list only till the next stbDvbInput.startScan call.

Parameters:
Name Type Description
id string

channel unique identifier

Returns:

operation status

Type
boolean

(static) remove(channel) → {boolean}

Remove the given channel from this channel list.

Affects this channel list only till the next stbDvbInput.startScan call.

Examples
if ( someChannelList.remove(5) ) {
    // successful removal by channel index
}
if ( someChannelList.remove('C.0.000506.06875-00') ) {
    // successful removal by channel id
}
Parameters:
Name Type Description
channel number | string

channel index or channel unique identifier

Returns:

operation status

Type
boolean

(static) clear()

Remove all channels from this channel list.

Affects this channel list only till the next stbDvbInput.startScan call.

(static) get(index) → {stbDvbChannelList~dvbChannelInfo}

Get channel detailed info.

Example
var channel1 = someChannelList.get(5);
    channel2 = someChannelList.get('C.0.000506.06875-00');

// start playback
gSTB.Play(channel1.uri);
Parameters:
Name Type Description
index number | string

channel index or channel unique identifier

Returns:

data

Type
stbDvbChannelList~dvbChannelInfo

(static) slice(index, size) → {Array.<stbDvbChannelList~dvbChannelInfo>}

Get channel range.

It's not recommended to use big values for size argument.

Parameters:
Name Type Description
index number

range start position

size number

range size

Returns:

data

Type
Array.<stbDvbChannelList~dvbChannelInfo>

(static) indexOf(id) → {number}

Get the channel index in this channel list.

Parameters:
Name Type Description
id string

channel unique identifier

Returns:

index

Type
number

Type Definitions

dvbChannelInfo

See:
Properties:
Name Type Attributes Description
frequency number

channel frequency (in kHz)

inputIndex number

antenna (input connector) index [0..n]

polarization string <optional>

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

symbolRate number <optional>

satellite/cable signal symbol rate (symbols per second)

id string

unique channel identifier

type stbDvbInput~dvbSignalType

DVB signal type

scrambled boolean

scrambled channel indication

name string

channel name

provider string

service provider name

isRadio boolean

radio channel indicator

channelNumber number

logical channel number in network (can be automatically generated)

uri string

channel address

Information about a channel.

Type:
  • Object
Example
{
    bandwidth: 8,
    channelNumber: 1,
    frequency: 650015,
    id: 'T2_11_650000',
    inputIndex: 0,
    isRadio: false,
    name: 'Інтер',
    provider: 'ZEONBUD',
    scrambled: false,
    symbolRate: 0,
    type: 3,
    uri: 'dvb://T2_11_650000'
}