ChannelCommands

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ChannelCommands

Known direct subclasses

Channel

Channel

API for the Channel trait.

Commands for the Channel trait.

Summary

Public functions
`suspend Unit`	`cancelRecordProgram( programIdentifier: String, shouldRecordSeries: Boolean, externalIdList: List<ChannelTrait.AdditionalInfoStruct>, data: ByteArray )` Cancel recording for a specific program or series.
`BatchableCommand<Unit>`	`cancelRecordProgramBatchable( programIdentifier: String, shouldRecordSeries: Boolean, externalIdList: List<ChannelTrait.AdditionalInfoStruct>, data: ByteArray )` The batchable version of `cancelRecordProgram` command.
`suspend ChannelTrait.ChangeChannelCommand.Response`	`changeChannel(match: String)` Change the channel to the specified channel.
`BatchableCommand<ChannelTrait.ChangeChannelCommand.Response>`	`changeChannelBatchable(match: String)` The batchable version of `changeChannel` command.
`suspend Unit`	`changeChannelByNumber(majorNumber: UShort, minorNumber: UShort)` Change the channel to the channel specified by `majorNumber` and `minorNumber`.
`BatchableCommand<Unit>`	`changeChannelByNumberBatchable(majorNumber: UShort, minorNumber: UShort)` The batchable version of `changeChannelByNumber` command.
`suspend ChannelTrait.GetProgramGuideCommand.Response`	`getProgramGuide(optionalArgs: ChannelTrait.GetProgramGuideCommand.OptionalArgs.() -> Unit)` Retrieves the program guide.
`BatchableCommand<ChannelTrait.GetProgramGuideCommand.Response>`	`getProgramGuideBatchable(optionalArgs: ChannelTrait.GetProgramGuideCommand.OptionalArgs.() -> Unit)` The batchable version of `getProgramGuide` command.
`suspend Unit`	`recordProgram( programIdentifier: String, shouldRecordSeries: Boolean, externalIdList: List<ChannelTrait.AdditionalInfoStruct>, data: ByteArray )` Record a specific program or series when it goes live.
`BatchableCommand<Unit>`	`recordProgramBatchable( programIdentifier: String, shouldRecordSeries: Boolean, externalIdList: List<ChannelTrait.AdditionalInfoStruct>, data: ByteArray )` The batchable version of `recordProgram` command.
`suspend Unit`	`skipChannel(count: Short)` Provides channel up and channel down functionality, by allowing the index of the selected channel to jump by the specified number of steps.
`BatchableCommand<Unit>`	`skipChannelBatchable(count: Short)` The batchable version of `skipChannel` command.

Public functions

cancelRecordProgram

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

Cancel recording for a specific program or series.

Parameters
`programIdentifier: String`	The program identifier for the program that should be cancelled from recording.
`shouldRecordSeries: Boolean`	Whether the whole series associated to the program should be cancelled from recording.
`data: ByteArray`	Optional app-specific data.

cancelRecordProgramBatchable

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

The batchable version of cancelRecordProgram command.

Cancel recording for a specific program or series.

Parameters
`programIdentifier: String`	The program identifier for the program that should be cancelled from recording.
`shouldRecordSeries: Boolean`	Whether the whole series associated to the program should be cancelled from recording.
`data: ByteArray`	Optional app-specific data.

Returns
`BatchableCommand<Unit>`	BatchableCommand

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.

changeChannelBatchable

fun changeChannelBatchable(match: String): BatchableCommand<ChannelTrait.ChangeChannelCommand.Response>

The batchable version of changeChannel command.

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
`BatchableCommand<ChannelTrait.ChangeChannelCommand.Response>`	BatchableCommand

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.

changeChannelByNumberBatchable

fun changeChannelByNumberBatchable(majorNumber: UShort, minorNumber: UShort): BatchableCommand<Unit>

The batchable version of changeChannelByNumber command.

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.

Returns
`BatchableCommand<Unit>`	BatchableCommand

getProgramGuide

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

Retrieves the program guide.

Parameters
`optionalArgs: ChannelTrait.GetProgramGuideCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`ChannelTrait.GetProgramGuideCommand.Response`	The program guide response.

getProgramGuideBatchable

fun getProgramGuideBatchable(optionalArgs: ChannelTrait.GetProgramGuideCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<ChannelTrait.GetProgramGuideCommand.Response>

The batchable version of getProgramGuide command.

Retrieves the program guide.

Parameters
`optionalArgs: ChannelTrait.GetProgramGuideCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`BatchableCommand<ChannelTrait.GetProgramGuideCommand.Response>`	BatchableCommand

recordProgram

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

Record a specific program or series when it goes live.

Parameters
`programIdentifier: String`	The program identifier for the program that should be recorded.
`shouldRecordSeries: Boolean`	Whether the whole series associated to the program should be recorded.
`data: ByteArray`	Optional app-specific data.

recordProgramBatchable

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

The batchable version of recordProgram command.

Record a specific program or series when it goes live.

Parameters
`programIdentifier: String`	The program identifier for the program that should be recorded.
`shouldRecordSeries: Boolean`	Whether the whole series associated to the program should be recorded.
`data: ByteArray`	Optional app-specific data.

Returns
`BatchableCommand<Unit>`	BatchableCommand

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.

skipChannelBatchable

fun skipChannelBatchable(count: Short): BatchableCommand<Unit>

The batchable version of skipChannel command.

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.

Returns
`BatchableCommand<Unit>`	BatchableCommand