ChannelConfig class

The ChannelConfig class provides the entry point for applications to get information about the list of channels available. It can be obtained in two ways:

By calling the method getChannelConfig() of the [video/broadcast](/references/broadcast-video-management/the-video-broadcast-embedded-object) embedded object
By calling the method createChannelConfig() of the object factory API.

Properties

This section details the properties of a `ChannelConfig` object.

readonly ChannelList channelList

The list of channels.

If the terminal includes a platform-specific application that enables the end-user to choose a channel to be presented from a list then all the channels in the list offered to the user by that application will be included in this ChannelList.

The list of channels will be a subset of all those available to the terminal. The precise algorithm by which this subset is selected will be market and/or implementation dependent. For example;

· If a terminal with a DVB-T tuner receives multiple versions of the same channel, one would be included in the list and the duplicates discarded

· A terminal with a DVB tuner will often filter services based on service type to discard those which are obviously inappropriate or impossible for that device to present to the end-user, e.g. firmware download services.

The order of the channels in the list corresponds to the channel ordering as managed by the terminal. The method returns the value null if the channel list is not (partially) managed by the terminal (i.e., if the channel list information is managed entirely in the network).

The properties of channels making up the channel list will be set by the terminal to the appropriate values as defined for a Channel object. The terminal will store all these values as part of the channel list.

Some values are set according to the data carried in the broadcast stream. In this case, the terminal may set these values to undefined until such time as the relevant data has been received by the terminal, for example after tuning to the channel. Once the data has been received, the terminal will update the properties of the channel in the channel list according to the received data.

Note: There is no requirement for the terminal to pro-actively tune to every channel to gather such data.

Methods

A channelConfig object has no methods.