PushAvStreamTransportTrait.ManuallyTriggerTransportCommand.Request
class PushAvStreamTransportTrait.ManuallyTriggerTransportCommand.Request : ClusterStruct
The request payload for the ManuallyTriggerTransport command.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the ManuallyTriggerTransport 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 |
|
|---|---|
PushAvStreamTransportTrait.TriggerActivationReasonEnum |
The reason for transport trigger activation. |
UShort |
The connection ID of the transport. |
OptionalValue<PushAvStreamTransportTrait.TransportMotionTriggerTimeControlStruct> |
Control over the duration and timing of the stream transport. |
OptionalValue<ByteArray> |
This optional parameter allows for including arbitrary, user-defined binary data as a long octet string within the ManuallyTriggerTransportCommand. |
Public constructors
Request
Request(
connectionId: UShort,
activationReason: PushAvStreamTransportTrait.TriggerActivationReasonEnum = TriggerActivationReasonEnum.UserInitiated,
timeControl: OptionalValue<PushAvStreamTransportTrait.TransportMotionTriggerTimeControlStruct> = OptionalValue.absent(),
userDefined: OptionalValue<ByteArray> = OptionalValue.absent()
)
Creates a request payload for the ManuallyTriggerTransport command.
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
activationReason
val activationReason: PushAvStreamTransportTrait.TriggerActivationReasonEnum
The reason for transport trigger activation. Valid values are defined in TriggerActivationReasonEnum.
timeControl
val timeControl: OptionalValue<PushAvStreamTransportTrait.TransportMotionTriggerTimeControlStruct>
Control over the duration and timing of the stream transport.
userDefined
val userDefined: OptionalValue<ByteArray>
This optional parameter allows for including arbitrary, user-defined binary data as a long octet string within the ManuallyTriggerTransportCommand.