ChannelCommands

interface ChannelCommands

Known direct subclasses
Channel

API for the Channel trait.

Summary

Public functions
suspend Unit
cancelRecordProgram(
    programIdentifier: String,
    shouldRecordSeries: Boolean,
    externalIdList: List<ChannelTrait.AdditionalInfoStruct>,
    data: ByteArray
)
suspend ChannelTrait.ChangeChannelCommand.Response

Change the channel to the specified channel.
suspend Unit
changeChannelByNumber(majorNumber: UShort, minorNumber: UShort)

Change the channel to the channel specified by majorNumber and minorNumber.
suspend ChannelTrait.GetProgramGuideCommand.Response
suspend Unit
recordProgram(
    programIdentifier: String,
    shouldRecordSeries: Boolean,
    externalIdList: List<ChannelTrait.AdditionalInfoStruct>,
    data: ByteArray
)
suspend Unit

Provides channel up and channel down functionality, by allowing the index of the selected channel to jump by the specified number of steps.

Public functions

cancelRecordProgram

suspend fun cancelRecordProgram(
    programIdentifier: String,
    shouldRecordSeries: Boolean,
    externalIdList: List<ChannelTrait.AdditionalInfoStruct>,
    data: ByteArray
): Unit

changeChannel

suspend fun changeChannel(match: String): ChannelTrait.ChangeChannelCommand.Response

Change the channel to the specified channel.

Parameters
match: String

A string used to identify the intended channel, which may be a call sign, a name, or a number.
Returns
ChannelTrait.ChangeChannelCommand.Response

The status of the ChangeChannel command.

changeChannelByNumber

suspend fun changeChannelByNumber(majorNumber: UShort, minorNumber: UShort): Unit

Change the channel to the channel specified by majorNumber and minorNumber.

Parameters
majorNumber: UShort

The channel major number value to which the channel should change, in ATSC format.
minorNumber: UShort

The channel minor number value to which the channel should change, in ATSC format.

getProgramGuide

suspend fun getProgramGuide(optionalArgs: ChannelTrait.GetProgramGuideCommand.OptionalArgs.() -> Unit = {}): ChannelTrait.GetProgramGuideCommand.Response

recordProgram

suspend fun recordProgram(
    programIdentifier: String,
    shouldRecordSeries: Boolean,
    externalIdList: List<ChannelTrait.AdditionalInfoStruct>,
    data: ByteArray
): Unit

skipChannel

suspend fun skipChannel(count: Short): Unit

Provides channel up and channel down functionality, by allowing the index of the selected channel to jump by the specified number of steps.

Parameters
count: Short

When positive, count specifies the number of steps to increase the current channel number. When negative, it specifies the number of steps to decrease the current channel number.