MediaInputTrait.RenameInputCommand.Request

class MediaInputTrait.RenameInputCommand.Request : ClusterStruct

The request payload for the RenameInput 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 RenameInput 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 input to be renamed.
String

The new name for the specified input.

Public constructors

Request

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

Creates a request payload for the RenameInput 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 input to be renamed.

name

val name: String

The new name for the specified input.