PushAvStreamTransport

Attributes

class st.matter.generated.zap_clusters.PushAvStreamTransport.server.attributes.SupportedFormats
ID: number

0x0000 the ID of this attribute

NAME: str

“SupportedFormats” the name of this attribute

data_type: st.matter.data_types.Array

the data type of this attribute

augment_type(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the SupportedFormats(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Array

Return type:

st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: SupportedFormats => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an SupportedFormats test attribute reponse for the driver integration testing framework

Parameters:

  • device (st.matter.Device) – the device to build this message for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.PushAvStreamTransport.server.attributes.CurrentConnections
ID: number

0x0001 the ID of this attribute

NAME: str

“CurrentConnections” the name of this attribute

data_type: st.matter.data_types.Array

the data type of this attribute

augment_type(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the CurrentConnections(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Array

Return type:

st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: CurrentConnections => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an CurrentConnections test attribute reponse for the driver integration testing framework

Parameters:

  • device (st.matter.Device) – the device to build this message for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.PushAvStreamTransport.server.attributes.AcceptedCommandList
ID: number

0xFFF9 the ID of this attribute

NAME: str

“AcceptedCommandList” the name of this attribute

data_type: st.matter.data_types.Array

the data type of this attribute

augment_type(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AcceptedCommandList(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Array

Return type:

st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AcceptedCommandList => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an AcceptedCommandList test attribute reponse for the driver integration testing framework

Parameters:

  • device (st.matter.Device) – the device to build this message for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.PushAvStreamTransport.server.attributes.AttributeList
ID: number

0xFFFB the ID of this attribute

NAME: str

“AttributeList” the name of this attribute

data_type: st.matter.data_types.Array

the data type of this attribute

augment_type(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AttributeList(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Array

Return type:

st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AttributeList => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an AttributeList test attribute reponse for the driver integration testing framework

Parameters:

  • device (st.matter.Device) – the device to build this message for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

Client Commands

class st.matter.generated.zap_clusters.PushAvStreamTransport.client.commands.AllocatePushTransportResponse: st.matter.data_types.Structure
ID: number

0x0001 the ID of this command

NAME: str

“AllocatePushTransportResponse” the name of this command

transport_configuration: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportConfigurationStruct
augment_type(base_type_obj)

Add field names to each command field

Parameters:

base_type_obj (st.matter.data_types.Structure)

build_test_command_response(device, endpoint_id, transport_configuration)

Builds an AllocatePushTransportResponse test command reponse for the driver integration testing framework

Parameters:
Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the AllocatePushTransportResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.PushAvStreamTransport.client.commands.FindTransportResponse: st.matter.data_types.Structure
ID: number

0x0007 the ID of this command

NAME: str

“FindTransportResponse” the name of this command

transport_configurations: st.matter.data_types.Array
augment_type(base_type_obj)

Add field names to each command field

Parameters:

base_type_obj (st.matter.data_types.Structure)

build_test_command_response(device, endpoint_id, transport_configurations)

Builds an FindTransportResponse test command reponse for the driver integration testing framework

Parameters:
Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the FindTransportResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

Server Commands

class st.matter.generated.zap_clusters.PushAvStreamTransport.server.commands.AllocatePushTransport: st.matter.data_types.Structure
ID: number

0x0000 the ID of this command

NAME: str

“AllocatePushTransport” the name of this command

transport_options: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportOptionsStruct
init(device, transport_options)

Refer to AllocatePushTransportResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the AllocatePushTransport command

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

augment_type(base_type_obj)

Add field names to each command field

Parameters:

base_type_obj (st.matter.data_types.Structure)

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.PushAvStreamTransport.server.commands.DeallocatePushTransport: st.matter.data_types.Structure
ID: number

0x0002 the ID of this command

NAME: str

“DeallocatePushTransport” the name of this command

connectionid: st.matter.data_types.Uint16
build_test_command_response(device, endpoint_id, status)

Builds an DeallocatePushTransport test command reponse for the driver integration testing framework

Parameters:

  • device (st.matter.Device) – the device to build this message to

  • endpoint_id (number or nil)

  • status (str) – Interaction status associated with the path

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init(device, connectionid)

Initialize the DeallocatePushTransport command

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

augment_type(base_type_obj)

Add field names to each command field

Parameters:

base_type_obj (st.matter.data_types.Structure)

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.PushAvStreamTransport.server.commands.ModifyPushTransport: st.matter.data_types.Structure
ID: number

0x0003 the ID of this command

NAME: str

“ModifyPushTransport” the name of this command

connectionid: st.matter.data_types.Uint16
transport_options: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportOptionsStruct
build_test_command_response(device, endpoint_id, status)

Builds an ModifyPushTransport test command reponse for the driver integration testing framework

Parameters:

  • device (st.matter.Device) – the device to build this message to

  • endpoint_id (number or nil)

  • status (str) – Interaction status associated with the path

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init(device, connectionid, transport_options)

Initialize the ModifyPushTransport command

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

augment_type(base_type_obj)

Add field names to each command field

Parameters:

base_type_obj (st.matter.data_types.Structure)

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.PushAvStreamTransport.server.commands.SetTransportStatus: st.matter.data_types.Structure
ID: number

0x0004 the ID of this command

NAME: str

“SetTransportStatus” the name of this command

connectionid: st.matter.data_types.Uint16
transport_status: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportStatusEnum
build_test_command_response(device, endpoint_id, status)

Builds an SetTransportStatus test command reponse for the driver integration testing framework

Parameters:

  • device (st.matter.Device) – the device to build this message to

  • endpoint_id (number or nil)

  • status (str) – Interaction status associated with the path

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init(device, connectionid, transport_status)

Initialize the SetTransportStatus command

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

augment_type(base_type_obj)

Add field names to each command field

Parameters:

base_type_obj (st.matter.data_types.Structure)

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.PushAvStreamTransport.server.commands.ManuallyTriggerTransport: st.matter.data_types.Structure
ID: number

0x0005 the ID of this command

NAME: str

“ManuallyTriggerTransport” the name of this command

connectionid: st.matter.data_types.Uint16
activation_reason: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TriggerActivationReasonEnum
time_control: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportMotionTriggerTimeControlStruct
user_defined: st.matter.data_types.OctetString2
build_test_command_response(device, endpoint_id, status)

Builds an ManuallyTriggerTransport test command reponse for the driver integration testing framework

Parameters:

  • device (st.matter.Device) – the device to build this message to

  • endpoint_id (number or nil)

  • status (str) – Interaction status associated with the path

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init(device, connectionid, activation_reason, time_control, user_defined)

Initialize the ManuallyTriggerTransport command

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

augment_type(base_type_obj)

Add field names to each command field

Parameters:

base_type_obj (st.matter.data_types.Structure)

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.PushAvStreamTransport.server.commands.FindTransport: st.matter.data_types.Structure
ID: number

0x0006 the ID of this command

NAME: str

“FindTransport” the name of this command

connectionid: st.matter.data_types.Uint16
init(device, connectionid)

Refer to FindTransportResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the FindTransport command

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

augment_type(base_type_obj)

Add field names to each command field

Parameters:

base_type_obj (st.matter.data_types.Structure)

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

Events

class st.matter.generated.zap_clusters.PushAvStreamTransport.server.events.PushTransportBegin: st.matter.data_types.Structure
ID: number

0x0000 the ID of this event

NAME: str

“PushTransportBegin” the name of this event

connectionid: st.matter.data_types.Uint16
trigger_type: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportTriggerTypeEnum
activation_reason: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TriggerActivationReasonEnum
augment_type(base_type_obj)

Add field names to each event field

Parameters:

base_type_obj (st.matter.data_types.Structure)

read(device, endpoint_id)

Constructs a read InteractionRequest for the Event

Parameters:
Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Constructs a subscribe InteractionRequest for the Event

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

st.matter.interaction_model.InteractionRequest

build_test_event_report(device, endpoint_id, fields, status)

Builds an PushTransportBegin test event report reponse to be used by

the driver integration testing framework.

Parameters:

  • device (st.matter.Device) – the device to build this message for

  • endpoint_id (number or nil)

  • fields (table) – containing the event fields

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.PushAvStreamTransport.server.events.PushTransportEnd: st.matter.data_types.Structure
ID: number

0x0001 the ID of this event

NAME: str

“PushTransportEnd” the name of this event

connectionid: st.matter.data_types.Uint16
augment_type(base_type_obj)

Add field names to each event field

Parameters:

base_type_obj (st.matter.data_types.Structure)

read(device, endpoint_id)

Constructs a read InteractionRequest for the Event

Parameters:
Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Constructs a subscribe InteractionRequest for the Event

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

st.matter.interaction_model.InteractionRequest

build_test_event_report(device, endpoint_id, fields, status)

Builds an PushTransportEnd test event report reponse to be used by

the driver integration testing framework.

Parameters:

  • device (st.matter.Device) – the device to build this message for

  • endpoint_id (number or nil)

  • fields (table) – containing the event fields

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

Bitmap types

class st.matter.generated.zap_clusters.PushAvStreamTransport.types.Feature
PER_ZONE_SENSITIVITY: number

1

METADATA: number

2

is_per_zone_sensitivity_set()
Returns:

True if the value of PER_ZONE_SENSITIVITY is non-zero

Return type:

boolean

set_per_zone_sensitivity()

Set the value of the bit in the PER_ZONE_SENSITIVITY field to 1

unset_per_zone_sensitivity()

Set the value of the bits in the PER_ZONE_SENSITIVITY field to 0

is_metadata_set()
Returns:

True if the value of METADATA is non-zero

Return type:

boolean

set_metadata()

Set the value of the bit in the METADATA field to 1

unset_metadata()

Set the value of the bits in the METADATA field to 0

Enum types

class st.matter.generated.zap_clusters.PushAvStreamTransport.types.CMAFInterfaceEnum: st.matter.data_types.Uint8
byte_length: number

1

INTERFACE1: number

0

INTERFACE2DASH: number

1

INTERFACE2HLS: number

2

class st.matter.generated.zap_clusters.PushAvStreamTransport.types.ContainerFormatEnum: st.matter.data_types.Uint8
byte_length: number

1

CMAF: number

0

class st.matter.generated.zap_clusters.PushAvStreamTransport.types.IngestMethodsEnum: st.matter.data_types.Uint8
byte_length: number

1

CMAF_INGEST: number

0

class st.matter.generated.zap_clusters.PushAvStreamTransport.types.StatusCodeEnum: st.matter.data_types.Uint8
byte_length: number

1

INVALIDTLS_ENDPOINT: number

2

INVALID_STREAM: number

3

INVALIDURL: number

4

INVALID_ZONE: number

5

INVALID_COMBINATION: number

6

INVALID_TRIGGER_TYPE: number

7

INVALID_TRANSPORT_STATUS: number

8

INVALID_OPTIONS: number

9

INVALID_STREAM_USAGE: number

10

INVALID_TIME: number

11

class st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportStatusEnum: st.matter.data_types.Uint8
byte_length: number

1

ACTIVE: number

0

INACTIVE: number

1

class st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportTriggerTypeEnum: st.matter.data_types.Uint8
byte_length: number

1

COMMAND: number

0

MOTION: number

1

CONTINUOUS: number

2

class st.matter.generated.zap_clusters.PushAvStreamTransport.types.TriggerActivationReasonEnum: st.matter.data_types.Uint8
byte_length: number

1

USER_INITIATED: number

0

AUTOMATION: number

1

EMERGENCY: number

2

Struct types

class st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportMotionTriggerTimeControlStruct: st.matter.data_types.Structure
initial_duration: st.matter.data_types.Uint16
augmentation_duration: st.matter.data_types.Uint16
max_duration: st.matter.data_types.Uint32
blind_duration: st.matter.data_types.Uint16
class st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportZoneOptionsStruct: st.matter.data_types.Structure
zone: st.matter.data_types.Uint16
sensitivity: st.matter.data_types.Uint8
class st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportTriggerOptionsStruct: st.matter.data_types.Structure
trigger_type: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportTriggerTypeEnum
motion_zones: st.matter.data_types.Array
motion_sensitivity: st.matter.data_types.Uint8
motion_time_control: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportMotionTriggerTimeControlStruct
max_pre_roll_len: st.matter.data_types.Uint16
class st.matter.generated.zap_clusters.PushAvStreamTransport.types.CMAFContainerOptionsStruct: st.matter.data_types.Structure
cmaf_interface: st.matter.generated.zap_clusters.PushAvStreamTransport.types.CMAFInterfaceEnum
segment_duration: st.matter.data_types.Uint16
chunk_duration: st.matter.data_types.Uint16
session_group: st.matter.data_types.Uint8
track_name: st.matter.data_types.UTF8String1
cenc_key: st.matter.data_types.OctetString1
cenc_key_id: st.matter.data_types.OctetString1
metadata_enabled: st.matter.data_types.Boolean
class st.matter.generated.zap_clusters.PushAvStreamTransport.types.ContainerOptionsStruct: st.matter.data_types.Structure
container_type: st.matter.generated.zap_clusters.PushAvStreamTransport.types.ContainerFormatEnum
cmaf_container_options: st.matter.generated.zap_clusters.PushAvStreamTransport.types.CMAFContainerOptionsStruct
class st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportOptionsStruct: st.matter.data_types.Structure
stream_usage: st.matter.generated.zap_clusters.Global.types.StreamUsageEnum
video_stream_id: st.matter.data_types.Uint16
audio_stream_id: st.matter.data_types.Uint16
tls_endpoint_id: st.matter.data_types.Uint16
url: st.matter.data_types.UTF8String2
trigger_options: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportTriggerOptionsStruct
ingest_method: st.matter.generated.zap_clusters.PushAvStreamTransport.types.IngestMethodsEnum
container_options: st.matter.generated.zap_clusters.PushAvStreamTransport.types.ContainerOptionsStruct
expiry_time: st.matter.data_types.Uint32
class st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportConfigurationStruct: st.matter.data_types.Structure
connection_id: st.matter.data_types.Uint16
transport_status: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportStatusEnum
transport_options: st.matter.generated.zap_clusters.PushAvStreamTransport.types.TransportOptionsStruct
fabric_index: st.matter.data_types.Uint8
class st.matter.generated.zap_clusters.PushAvStreamTransport.types.SupportedFormatStruct: st.matter.data_types.Structure
container_format: st.matter.generated.zap_clusters.PushAvStreamTransport.types.ContainerFormatEnum
ingest_method: st.matter.generated.zap_clusters.PushAvStreamTransport.types.IngestMethodsEnum