Interface IChannelHandlerAsync
interface IChannelHandlerAsync
Extends com.amazon.apmf.IStandard
Interface for the handler that handles supported Channel cluster commands.
Methods
handleChangeChannelAsync()
Changes the current stream to the channel case-insensitive exact matching the value passed as an argument. Used to tune to a channel using the identifier that was provided in ChannelDescriptor.IChangeChannelPromise*handleChangeChannelAsync(stringmatchChannelIdentifierStr)
Parameters
matchChannelIdentifierStr
string — Required
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
IChangeChannelPromise*
IChangeChannelPromise* A Promise object indicating success/failure of the request.
handleChangeChannelByNumberAsync()
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.IChangeChannelPromise*handleChangeChannelByNumberAsync(i32majorNumber,i32minorNumber)
Parameters
majorNumber
i32 — Required
the major number of a channel.
minorNumber
i32 — Required
the minor number of a channel.
Returns
IChangeChannelPromise*
IChangeChannelPromise* A Promise object indicating success/failure of the request.
Throws
InvalidArgumentError— if the major or minor number provided is negative.
handleSkipChannelAsync()
Skips a given offset count of channels from the current channel and streams the channel that was skipped to.IChangeChannelPromise*handleSkipChannelAsync(i32count)
Parameters
count
i32 — Required
The count of channels to skip from the current channel.
If the count is negative, the count will be subtracted from the current channel number
to determine which channel to tune to.
Returns
IChangeChannelPromise*
IChangeChannelPromise* A Promise object indicating success/failure of the request.
