AudioOutputTrait.RenameOutputCommand.Request

class AudioOutputTrait.RenameOutputCommand.Request : ClusterStruct

The request payload for the RenameOutput command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors
Request(index: UByte, name: String)

Creates a request payload for the RenameOutput command.

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 index of the output to rename.
String

The new name of the specified output.

Public constructors

Request

Request(index: UByte, name: String = "")

Creates a request payload for the RenameOutput command.

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 index: UByte

The index of the output to rename.

name

val name: String

The new name of the specified output.