IChannelHandler

Interface for the handler provided by channel cluster providers. It should handle channel cluster supported commands.

​

Methods

​

handleChangeChannel()

handleChangeChannel(matchChannelIdentifierStr: string): Promise<IChangeChannelResponse>

Changes the current stream to a particular channel by a given channel identifier. Used to tune to a channel using the identifier that was provided in ChannelDescriptor.

​

Parameters

matchChannelIdentifierStr

string A user-input string to match in order to identify the target channel. For now, this is a string that needs to case-insensitive exactly match the channel identifier. In the future, this string can also contain values like AffiliateCallSign, CallSign, Name, Number, etc.

​

Returns

Promise<IChangeChannelResponse> A Promise that resolves when the request is successfully handled, or rejects with OperationError if the request fails.

---

​

handleChangeChannelByNumber()

handleChangeChannelByNumber(majorNumber: number, minorNumber: number): Promise<IChangeChannelResponse>

Changes the current stream to a particular channel by a given channel major and minor number. handleChangeChannelByNumber is currently not used, implement and use handleChangeChannel instead to handle channel tuning.

​

Parameters

majorNumber

number The channel major number value (ATSC format) to which the channel should change.

minorNumber

number The channel minor number value (ATSC format) to which the channel should change.

​

Returns

Promise<IChangeChannelResponse> A Promise that resolves when the request is successfully handled, or rejects with OperationError if the request fails.

---

​

handleSkipChannel()

handleSkipChannel(count: number): Promise<IChangeChannelResponse>

Skips a given count of channels from the current channel, and streams the resulting channel.

​

Parameters

count

number The number of steps to increase (count is positive) or decrease (count is negative) the current channel.

​

Returns

Promise<IChangeChannelResponse> A Promise that resolves when the request is successfully handled, or rejects with OperationError if the request fails.