ChannelList class

The ChannelList object is defined by the Open IPTV Forum (OIPF) in the OIPF DAE Specification and is used within HbbTV to provide access to the list of broadcast and IP-delivered channels available to an HbbTV Application.

Properties

This section details the properties of a ChannelList object.

readonly Integer length

The number of channels in the ChannelList.

Methods

This section details the methods of a ChannelList object.

Channel item( Integer index )
Description	Returns the Channel at position index in the ChannelList, or undefined if no channel is present at that position.
Arguments	index	The index of the Channel that is to be returned

Channel getChannel( String channelID )
Description	Returns the first channel in the list with the specified channel identifier. Returns null if no corresponding channel can be found.
Arguments	channelID	The channel identifier of the channel to be retrieved, which is a value as defined for the ccid and ipBroadcastID properties of the Channel object.

Channel getChannelByTriplet( Integer onid, Integer tsid, Integer sid, Integer nid )
Description	Returns the first (IPTV or non-IPTV) channel in the list that matches the specified DVB triplet (original network ID, transport stream ID, service ID). Where no channels of type ID_DVB_* are available, or no channel identified by this triplet are found, this method returns null.
Arguments	onid	The original network ID of the channel to be retrieved.
	tsid	The transport stream ID of the channel to be retrieved. If set to null the channel defined by the combination of onid and sid will be retrieved. This makes it possible to retrieve the correct channel also in case a remultiplexing took place which led to a changed tsid.
	sid	The service ID of the channel to be retrieved.
	nid	An optional argument, indicating the network id to be used select the channel when the channel list contains more than one entry with the same onid, tsid and sid.