PushAvStreamTransportTrait.TransportTriggerOptionsStruct
class PushAvStreamTransportTrait.TransportTriggerOptionsStruct : ClusterStruct
Settings related to triggering events.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this struct's fields. |
Public constructors |
|---|
TransportTriggerOptionsStruct(Creates the TransportTriggerOptionsStruct 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 |
|
|---|---|
OptionalValue<UShort> |
The maximum length of pre-roll content (video or audio) that can be included when a transport trigger occurs. |
OptionalValue<UByte?> |
The sensitivity level for motion-triggered stream transport. |
OptionalValue<PushAvStreamTransportTrait.TransportMotionTriggerTimeControlStruct> |
The time control for the motion-triggered stream transport. |
OptionalValue<List<PushAvStreamTransportTrait.TransportZoneOptionsStruct>?> |
The motion zones to trigger the stream. |
PushAvStreamTransportTrait.TransportTriggerTypeEnum |
The trigger type of the transport. |
Public constructors
TransportTriggerOptionsStruct
TransportTriggerOptionsStruct(
triggerType: PushAvStreamTransportTrait.TransportTriggerTypeEnum = TransportTriggerTypeEnum.Command,
motionZones: OptionalValue<List<PushAvStreamTransportTrait.TransportZoneOptionsStruct>?> = OptionalValue.absent(),
motionSensitivity: OptionalValue<UByte?> = OptionalValue.absent(),
motionTimeControl: OptionalValue<PushAvStreamTransportTrait.TransportMotionTriggerTimeControlStruct> = OptionalValue.absent(),
maxPreRollLen: OptionalValue<UShort> = OptionalValue.absent()
)
Creates the TransportTriggerOptionsStruct class.
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
maxPreRollLen
val maxPreRollLen: OptionalValue<UShort>
The maximum length of pre-roll content (video or audio) that can be included when a transport trigger occurs.
motionSensitivity
val motionSensitivity: OptionalValue<UByte?>
The sensitivity level for motion-triggered stream transport.
motionTimeControl
val motionTimeControl: OptionalValue<PushAvStreamTransportTrait.TransportMotionTriggerTimeControlStruct>
The time control for the motion-triggered stream transport.
motionZones
val motionZones: OptionalValue<List<PushAvStreamTransportTrait.TransportZoneOptionsStruct>?>
The motion zones to trigger the stream.
triggerType
val triggerType: PushAvStreamTransportTrait.TransportTriggerTypeEnum
The trigger type of the transport.