PushAvStreamTransport

@Generated(value = ["GoogleHomePlatformCodegen"])
interface PushAvStreamTransport : PushAvStreamTransportTrait.Attributes, MatterTrait, PushAvStreamTransportCommands

API for the PushAvStreamTransport trait. This trait is a minimalistic version of the PushAvStreamTransport standard Matter cluster, and only provides an On/Off-like functionality for cameras.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Descriptor enum for this event's fields.

Descriptor enum for this event's fields.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<PushAvStreamTransport>

Inherited functions
From com.google.home.matter.standard.PushAvStreamTransportCommands
suspend PushAvStreamTransportTrait.AllocatePushTransportCommand.Response

Allocate a push transport.
BatchableCommand<PushAvStreamTransportTrait.AllocatePushTransportCommand.Response>

The batchable version of allocatePushTransport command.
suspend Unit

Deallocate a push transport.
BatchableCommand<Unit>

The batchable version of deallocatePushTransport command.
suspend PushAvStreamTransportTrait.FindTransportCommand.Response
findTransport(connectionId: UShort?)

Get the transport configuration for the specified push transport or all allocated transports if no connectionId is specified.
BatchableCommand<PushAvStreamTransportTrait.FindTransportCommand.Response>

The batchable version of findTransport command.
suspend Unit

Manually trigger a transport.
BatchableCommand<Unit>

The batchable version of manuallyTriggerTransport command.
suspend Unit
modifyPushTransport(
    connectionId: UShort,
    transportOptions: PushAvStreamTransportTrait.TransportOptionsStruct
)

Modify the transport status.
BatchableCommand<Unit>

The batchable version of modifyPushTransport command.
suspend Unit
setTransportStatus(
    connectionId: UShort?,
    transportStatus: PushAvStreamTransportTrait.TransportStatusEnum
)

Set the transport status.
BatchableCommand<Unit>
setTransportStatusBatchable(
    connectionId: UShort?,
    transportStatus: PushAvStreamTransportTrait.TransportStatusEnum
)

The batchable version of setTransportStatus command.
From com.google.home.matter.standard.PushAvStreamTransportTrait.Attributes
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.
From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties
From com.google.home.matter.standard.PushAvStreamTransportTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.
List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.
UShort

The revision of the server cluster specification supported by the cluster instance.
List<PushAvStreamTransportTrait.TransportConfigurationStruct>?

A list of all the allocated connections.
PushAvStreamTransportTrait.Feature

Whether the server supports zero or more optional cluster features.
List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.
List<PushAvStreamTransportTrait.SupportedFormatStruct>?

A list of all the supported formats for the push transport.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: PushAvStreamTransport.Attribute): Boolean

supports

fun supports(command: PushAvStreamTransport.Command): Boolean

Public properties

factory

open val factory: TraitFactory<PushAvStreamTransport>