MediaInputTrait.InputInfoStruct

class MediaInputTrait.InputInfoStruct : ClusterStruct


Information about an input.

Summary

Public constructors

InputInfoStruct(
    index: UByte,
    inputType: MediaInputTrait.InputTypeEnum,
    name: String,
    description: String
)

Creates the InputInfoStruct 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

String

The user-editable description of the input.

UByte

The index of the input.

MediaInputTrait.InputTypeEnum

The type of the input.

String

The name of the input.

Public constructors

InputInfoStruct

InputInfoStruct(
    index: UByte,
    inputType: MediaInputTrait.InputTypeEnum = InputTypeEnum.Internal,
    name: String = "",
    description: String = ""
)

Creates the InputInfoStruct class.

Public functions

getDescriptor

open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

open fun getFieldValueById(tagId: UInt): Any?

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

Public properties

description

val descriptionString

The user-editable description of the input.

index

val indexUByte

The index of the input.

inputType

val inputTypeMediaInputTrait.InputTypeEnum

The type of the input.

name

val nameString

The name of the input.