Channel

interface Channel : ChannelTrait.Attributes, MatterTrait, ChannelCommands


API for the Channel trait. This trait provides an interface for selecting channels on a device or endpoint.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions

Boolean
Boolean

Public properties

open TraitFactory<Channel>

Inherited functions

From com.google.home.matter.standard.ChannelCommands
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.

From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties

From com.google.home.matter.standard.ChannelTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

List<ChannelTrait.ChannelInfoStruct>?

A list of the supported channels.

UShort

The revision of the server cluster specification supported by the cluster instance.

ChannelTrait.ChannelInfoStruct?

The currently selected channel.

ChannelTrait.Feature

Whether the server supports zero or more optional cluster features.

List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

ChannelTrait.LineupInfoStruct?

A reference to an external source of channel lineup information.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: Channel.Attribute): Boolean

supports

fun supports(command: Channel.Command): Boolean

Public properties

factory

open val factoryTraitFactory<Channel>