WebRTCTransportProvider

Attributes

class st.matter.generated.zap_clusters.WebRTCTransportProvider.server.attributes.CurrentSessions
ID: number

0x0000 the ID of this attribute

NAME: str

“CurrentSessions” 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 CurrentSessions(…) 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: CurrentSessions => 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 CurrentSessions 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.WebRTCTransportProvider.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.WebRTCTransportProvider.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.WebRTCTransportProvider.client.commands.SolicitOfferResponse: st.matter.data_types.Structure
ID: number

0x0001 the ID of this command

NAME: str

“SolicitOfferResponse” the name of this command

webrtc_sessionid: st.matter.data_types.Uint16
deferred_offer: st.matter.data_types.Boolean
video_streamid: st.matter.data_types.Uint16
audio_streamid: st.matter.data_types.Uint16
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, webrtc_sessionid, deferred_offer, video_streamid, audio_streamid)

Builds an SolicitOfferResponse 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 SolicitOfferResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.WebRTCTransportProvider.client.commands.ProvideOfferResponse: st.matter.data_types.Structure
ID: number

0x0003 the ID of this command

NAME: str

“ProvideOfferResponse” the name of this command

webrtc_sessionid: st.matter.data_types.Uint16
video_streamid: st.matter.data_types.Uint16
audio_streamid: st.matter.data_types.Uint16
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, webrtc_sessionid, video_streamid, audio_streamid)

Builds an ProvideOfferResponse 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 ProvideOfferResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

Server Commands

class st.matter.generated.zap_clusters.WebRTCTransportProvider.server.commands.SolicitOffer: st.matter.data_types.Structure
ID: number

0x0000 the ID of this command

NAME: str

“SolicitOffer” the name of this command

stream_usage: st.matter.generated.zap_clusters.Global.types.StreamUsageEnum
originating_endpointid: st.matter.data_types.Uint16
video_streamid: st.matter.data_types.Uint16
audio_streamid: st.matter.data_types.Uint16
ice_servers: st.matter.data_types.Array
ice_transport_policy: st.matter.data_types.UTF8String1
metadata_enabled: st.matter.data_types.Boolean
s_frame_config: st.matter.generated.zap_clusters.WebRTCTransportProvider.types.SFrameStruct
init(device, stream_usage, originating_endpointid, video_streamid, audio_streamid, ice_servers, ice_transport_policy, metadata_enabled, s_frame_config)

Refer to SolicitOfferResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the SolicitOffer 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.WebRTCTransportProvider.server.commands.ProvideOffer: st.matter.data_types.Structure
ID: number

0x0002 the ID of this command

NAME: str

“ProvideOffer” the name of this command

webrtc_sessionid: st.matter.data_types.Uint16
sdp: st.matter.data_types.UTF8String1
stream_usage: st.matter.generated.zap_clusters.Global.types.StreamUsageEnum
originating_endpointid: st.matter.data_types.Uint16
video_streamid: st.matter.data_types.Uint16
audio_streamid: st.matter.data_types.Uint16
ice_servers: st.matter.data_types.Array
ice_transport_policy: st.matter.data_types.UTF8String1
metadata_enabled: st.matter.data_types.Boolean
s_frame_config: st.matter.generated.zap_clusters.WebRTCTransportProvider.types.SFrameStruct
init(device, webrtc_sessionid, sdp, stream_usage, originating_endpointid, video_streamid, audio_streamid, ice_servers, ice_transport_policy, metadata_enabled, s_frame_config)

Refer to ProvideOfferResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the ProvideOffer 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.WebRTCTransportProvider.server.commands.ProvideAnswer: st.matter.data_types.Structure
ID: number

0x0004 the ID of this command

NAME: str

“ProvideAnswer” the name of this command

webrtc_sessionid: st.matter.data_types.Uint16
sdp: st.matter.data_types.UTF8String1
build_test_command_response(device, endpoint_id, status)

Builds an ProvideAnswer 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, webrtc_sessionid, sdp)

Initialize the ProvideAnswer 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.WebRTCTransportProvider.server.commands.ProvideICECandidates: st.matter.data_types.Structure
ID: number

0x0005 the ID of this command

NAME: str

“ProvideICECandidates” the name of this command

webrtc_sessionid: st.matter.data_types.Uint16
ice_candidates: st.matter.data_types.Array
build_test_command_response(device, endpoint_id, status)

Builds an ProvideICECandidates 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, webrtc_sessionid, ice_candidates)

Initialize the ProvideICECandidates 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.WebRTCTransportProvider.server.commands.EndSession: st.matter.data_types.Structure
ID: number

0x0006 the ID of this command

NAME: str

“EndSession” the name of this command

webrtc_sessionid: st.matter.data_types.Uint16
reason: st.matter.generated.zap_clusters.Global.types.WebRTCEndReasonEnum
build_test_command_response(device, endpoint_id, status)

Builds an EndSession 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, webrtc_sessionid, reason)

Initialize the EndSession 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)

Bitmap types

class st.matter.generated.zap_clusters.WebRTCTransportProvider.types.Feature
METADATA: number

1

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

Struct types

class st.matter.generated.zap_clusters.WebRTCTransportProvider.types.SFrameStruct: st.matter.data_types.Structure
cipher_suite: st.matter.data_types.Uint16
base_key: st.matter.data_types.OctetString1
kid: st.matter.data_types.OctetString1