AudioOutputTrait.OutputInfoStruct

class AudioOutputTrait.OutputInfoStruct : ClusterStruct


Contains information about an output.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

OutputInfoStruct(
    index: UByte,
    outputType: AudioOutputTrait.OutputTypeEnum,
    name: String
)

Creates the OutputInfoStruct class.

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

Public properties

UByte

The unique index of the output.

String

The name of the output.

AudioOutputTrait.OutputTypeEnum

The type of the output.

Public constructors

OutputInfoStruct

OutputInfoStruct(
    index: UByte,
    outputType: AudioOutputTrait.OutputTypeEnum = OutputTypeEnum.HDMI,
    name: String = ""
)

Creates the OutputInfoStruct class.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

index

val indexUByte

The unique index of the output.

name

val nameString

The name of the output.

outputType

val outputTypeAudioOutputTrait.OutputTypeEnum

The type of the output. Valid values are defined in OutputTypeEnum.