CameraAvStreamManagement¶
Attributes¶
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.MaxConcurrentEncoders¶
- ID: number¶
0x0000 the ID of this attribute
- NAME: str¶
“MaxConcurrentEncoders” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxConcurrentEncoders(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MaxConcurrentEncoders => 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 MaxConcurrentEncoders test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.MaxEncodedPixelRate¶
- ID: number¶
0x0001 the ID of this attribute
- NAME: str¶
“MaxEncodedPixelRate” the name of this attribute
- data_type: st.matter.data_types.Uint32¶
the data type of this attribute
- new_value(...)¶
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxEncodedPixelRate(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MaxEncodedPixelRate => 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 MaxEncodedPixelRate test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.VideoSensorParams¶
- ID: number¶
0x0002 the ID of this attribute
- NAME: str¶
“VideoSensorParams” the name of this attribute
- data_type: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoSensorParamsStruct¶
the data type of this attribute
- new_value(...)¶
Create a VideoSensorParamsStruct object of this attribute with any additional features provided for the attribute
This is also usable with the VideoSensorParams(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a VideoSensorParamsStruct- Return type:
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoSensorParamsStruct
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: VideoSensorParams => 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 VideoSensorParams test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.NightVisionUsesInfrared¶
- ID: number¶
0x0003 the ID of this attribute
- NAME: str¶
“NightVisionUsesInfrared” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the NightVisionUsesInfrared(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: NightVisionUsesInfrared => 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 NightVisionUsesInfrared test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.MinViewportResolution¶
- ID: number¶
0x0004 the ID of this attribute
- NAME: str¶
“MinViewportResolution” the name of this attribute
- data_type: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
the data type of this attribute
- new_value(...)¶
Create a VideoResolutionStruct object of this attribute with any additional features provided for the attribute
This is also usable with the MinViewportResolution(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a VideoResolutionStruct- Return type:
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MinViewportResolution => 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 MinViewportResolution test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.RateDistortionTradeOffPoints¶
- ID: number¶
0x0005 the ID of this attribute
- NAME: str¶
“RateDistortionTradeOffPoints” 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 RateDistortionTradeOffPoints(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Array- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: RateDistortionTradeOffPoints => 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 RateDistortionTradeOffPoints test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.MaxContentBufferSize¶
- ID: number¶
0x0006 the ID of this attribute
- NAME: str¶
“MaxContentBufferSize” the name of this attribute
- data_type: st.matter.data_types.Uint32¶
the data type of this attribute
- new_value(...)¶
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxContentBufferSize(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MaxContentBufferSize => 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 MaxContentBufferSize test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.MicrophoneCapabilities¶
- ID: number¶
0x0007 the ID of this attribute
- NAME: str¶
“MicrophoneCapabilities” the name of this attribute
- data_type: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.AudioCapabilitiesStruct¶
the data type of this attribute
- new_value(...)¶
Create a AudioCapabilitiesStruct object of this attribute with any additional features provided for the attribute
This is also usable with the MicrophoneCapabilities(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a AudioCapabilitiesStruct- Return type:
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.AudioCapabilitiesStruct
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MicrophoneCapabilities => 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 MicrophoneCapabilities test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.SpeakerCapabilities¶
- ID: number¶
0x0008 the ID of this attribute
- NAME: str¶
“SpeakerCapabilities” the name of this attribute
- data_type: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.AudioCapabilitiesStruct¶
the data type of this attribute
- new_value(...)¶
Create a AudioCapabilitiesStruct object of this attribute with any additional features provided for the attribute
This is also usable with the SpeakerCapabilities(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a AudioCapabilitiesStruct- Return type:
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.AudioCapabilitiesStruct
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: SpeakerCapabilities => 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 SpeakerCapabilities test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.TwoWayTalkSupport¶
- ID: number¶
0x0009 the ID of this attribute
- NAME: str¶
“TwoWayTalkSupport” the name of this attribute
- data_type: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.TwoWayTalkSupportTypeEnum¶
the data type of this attribute
- new_value(...)¶
Create a TwoWayTalkSupportTypeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the TwoWayTalkSupport(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a TwoWayTalkSupportTypeEnum- Return type:
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.TwoWayTalkSupportTypeEnum
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: TwoWayTalkSupport => 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 TwoWayTalkSupport test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.SnapshotCapabilities¶
- ID: number¶
0x000A the ID of this attribute
- NAME: str¶
“SnapshotCapabilities” 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 SnapshotCapabilities(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Array- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: SnapshotCapabilities => 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 SnapshotCapabilities test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.MaxNetworkBandwidth¶
- ID: number¶
0x000B the ID of this attribute
- NAME: str¶
“MaxNetworkBandwidth” the name of this attribute
- data_type: st.matter.data_types.Uint32¶
the data type of this attribute
- new_value(...)¶
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxNetworkBandwidth(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MaxNetworkBandwidth => 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 MaxNetworkBandwidth test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.CurrentFrameRate¶
- ID: number¶
0x000C the ID of this attribute
- NAME: str¶
“CurrentFrameRate” the name of this attribute
- data_type: st.matter.data_types.Uint16¶
the data type of this attribute
- new_value(...)¶
Create a Uint16 object of this attribute with any additional features provided for the attribute
This is also usable with the CurrentFrameRate(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: CurrentFrameRate => 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 CurrentFrameRate test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.HDRModeEnabled¶
- ID: number¶
0x000D the ID of this attribute
- NAME: str¶
“HDRModeEnabled” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the HDRModeEnabled(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Boolean) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: HDRModeEnabled => 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 HDRModeEnabled test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.SupportedStreamUsages¶
- ID: number¶
0x000E the ID of this attribute
- NAME: str¶
“SupportedStreamUsages” 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 SupportedStreamUsages(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Array- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: SupportedStreamUsages => 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 SupportedStreamUsages test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.AllocatedVideoStreams¶
- ID: number¶
0x000F the ID of this attribute
- NAME: str¶
“AllocatedVideoStreams” 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 AllocatedVideoStreams(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Array- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: AllocatedVideoStreams => 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 AllocatedVideoStreams test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.AllocatedAudioStreams¶
- ID: number¶
0x0010 the ID of this attribute
- NAME: str¶
“AllocatedAudioStreams” 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 AllocatedAudioStreams(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Array- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: AllocatedAudioStreams => 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 AllocatedAudioStreams test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.AllocatedSnapshotStreams¶
- ID: number¶
0x0011 the ID of this attribute
- NAME: str¶
“AllocatedSnapshotStreams” 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 AllocatedSnapshotStreams(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Array- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: AllocatedSnapshotStreams => 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 AllocatedSnapshotStreams test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.StreamUsagePriorities¶
- ID: number¶
0x0012 the ID of this attribute
- NAME: str¶
“StreamUsagePriorities” 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 StreamUsagePriorities(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Array- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: StreamUsagePriorities => 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 StreamUsagePriorities test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.SoftRecordingPrivacyModeEnabled¶
- ID: number¶
0x0013 the ID of this attribute
- NAME: str¶
“SoftRecordingPrivacyModeEnabled” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the SoftRecordingPrivacyModeEnabled(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Boolean) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: SoftRecordingPrivacyModeEnabled => 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 SoftRecordingPrivacyModeEnabled test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.SoftLivestreamPrivacyModeEnabled¶
- ID: number¶
0x0014 the ID of this attribute
- NAME: str¶
“SoftLivestreamPrivacyModeEnabled” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the SoftLivestreamPrivacyModeEnabled(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Boolean) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: SoftLivestreamPrivacyModeEnabled => 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 SoftLivestreamPrivacyModeEnabled test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.HardPrivacyModeOn¶
- ID: number¶
0x0015 the ID of this attribute
- NAME: str¶
“HardPrivacyModeOn” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the HardPrivacyModeOn(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: HardPrivacyModeOn => 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 HardPrivacyModeOn test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.NightVision¶
- ID: number¶
0x0016 the ID of this attribute
- NAME: str¶
“NightVision” the name of this attribute
- data_type: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.TriStateAutoEnum¶
the data type of this attribute
- new_value(...)¶
Create a TriStateAutoEnum object of this attribute with any additional features provided for the attribute
This is also usable with the NightVision(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a TriStateAutoEnum- Return type:
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.TriStateAutoEnum
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.TriStateAutoEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: NightVision => 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 NightVision test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.NightVisionIllum¶
- ID: number¶
0x0017 the ID of this attribute
- NAME: str¶
“NightVisionIllum” the name of this attribute
- data_type: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.TriStateAutoEnum¶
the data type of this attribute
- new_value(...)¶
Create a TriStateAutoEnum object of this attribute with any additional features provided for the attribute
This is also usable with the NightVisionIllum(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a TriStateAutoEnum- Return type:
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.TriStateAutoEnum
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.TriStateAutoEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: NightVisionIllum => 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 NightVisionIllum test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.Viewport¶
- ID: number¶
0x0018 the ID of this attribute
- NAME: str¶
“Viewport” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Global.types.ViewportStruct¶
the data type of this attribute
- new_value(...)¶
Create a ViewportStruct object of this attribute with any additional features provided for the attribute
This is also usable with the Viewport(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ViewportStruct- Return type:
st.matter.generated.zap_clusters.Global.types.ViewportStruct
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Global.types.ViewportStruct) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: Viewport => 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 Viewport test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.SpeakerMuted¶
- ID: number¶
0x0019 the ID of this attribute
- NAME: str¶
“SpeakerMuted” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the SpeakerMuted(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Boolean) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: SpeakerMuted => 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 SpeakerMuted test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.SpeakerVolumeLevel¶
- ID: number¶
0x001A the ID of this attribute
- NAME: str¶
“SpeakerVolumeLevel” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the SpeakerVolumeLevel(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Uint8) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: SpeakerVolumeLevel => 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 SpeakerVolumeLevel test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.SpeakerMaxLevel¶
- ID: number¶
0x001B the ID of this attribute
- NAME: str¶
“SpeakerMaxLevel” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the SpeakerMaxLevel(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: SpeakerMaxLevel => 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 SpeakerMaxLevel test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.SpeakerMinLevel¶
- ID: number¶
0x001C the ID of this attribute
- NAME: str¶
“SpeakerMinLevel” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the SpeakerMinLevel(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: SpeakerMinLevel => 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 SpeakerMinLevel test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.MicrophoneMuted¶
- ID: number¶
0x001D the ID of this attribute
- NAME: str¶
“MicrophoneMuted” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the MicrophoneMuted(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Boolean) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MicrophoneMuted => 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 MicrophoneMuted test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.MicrophoneVolumeLevel¶
- ID: number¶
0x001E the ID of this attribute
- NAME: str¶
“MicrophoneVolumeLevel” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the MicrophoneVolumeLevel(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Uint8) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MicrophoneVolumeLevel => 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 MicrophoneVolumeLevel test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.MicrophoneMaxLevel¶
- ID: number¶
0x001F the ID of this attribute
- NAME: str¶
“MicrophoneMaxLevel” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the MicrophoneMaxLevel(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MicrophoneMaxLevel => 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 MicrophoneMaxLevel test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.MicrophoneMinLevel¶
- ID: number¶
0x0020 the ID of this attribute
- NAME: str¶
“MicrophoneMinLevel” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the MicrophoneMinLevel(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MicrophoneMinLevel => 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 MicrophoneMinLevel test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.MicrophoneAGCEnabled¶
- ID: number¶
0x0021 the ID of this attribute
- NAME: str¶
“MicrophoneAGCEnabled” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the MicrophoneAGCEnabled(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Boolean) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MicrophoneAGCEnabled => 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 MicrophoneAGCEnabled test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.ImageRotation¶
- ID: number¶
0x0022 the ID of this attribute
- NAME: str¶
“ImageRotation” the name of this attribute
- data_type: st.matter.data_types.Uint16¶
the data type of this attribute
- new_value(...)¶
Create a Uint16 object of this attribute with any additional features provided for the attribute
This is also usable with the ImageRotation(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Uint16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ImageRotation => 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 ImageRotation test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.ImageFlipHorizontal¶
- ID: number¶
0x0023 the ID of this attribute
- NAME: str¶
“ImageFlipHorizontal” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the ImageFlipHorizontal(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Boolean) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ImageFlipHorizontal => 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 ImageFlipHorizontal test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.ImageFlipVertical¶
- ID: number¶
0x0024 the ID of this attribute
- NAME: str¶
“ImageFlipVertical” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the ImageFlipVertical(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Boolean) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ImageFlipVertical => 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 ImageFlipVertical test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.LocalVideoRecordingEnabled¶
- ID: number¶
0x0025 the ID of this attribute
- NAME: str¶
“LocalVideoRecordingEnabled” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the LocalVideoRecordingEnabled(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Boolean) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: LocalVideoRecordingEnabled => 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 LocalVideoRecordingEnabled test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.LocalSnapshotRecordingEnabled¶
- ID: number¶
0x0026 the ID of this attribute
- NAME: str¶
“LocalSnapshotRecordingEnabled” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the LocalSnapshotRecordingEnabled(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Boolean) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: LocalSnapshotRecordingEnabled => 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 LocalSnapshotRecordingEnabled test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.StatusLightEnabled¶
- ID: number¶
0x0027 the ID of this attribute
- NAME: str¶
“StatusLightEnabled” the name of this attribute
- data_type: st.matter.data_types.Boolean¶
the data type of this attribute
- new_value(...)¶
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the StatusLightEnabled(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Boolean- Return type:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Boolean) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: StatusLightEnabled => 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 StatusLightEnabled test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.attributes.StatusLightBrightness¶
- ID: number¶
0x0028 the ID of this attribute
- NAME: str¶
“StatusLightBrightness” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Global.types.ThreeLevelAutoEnum¶
the data type of this attribute
- new_value(...)¶
Create a ThreeLevelAutoEnum object of this attribute with any additional features provided for the attribute
This is also usable with the StatusLightBrightness(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ThreeLevelAutoEnum- Return type:
st.matter.generated.zap_clusters.Global.types.ThreeLevelAutoEnum
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Global.types.ThreeLevelAutoEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: StatusLightBrightness => 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 StatusLightBrightness test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.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:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- 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 forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.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:
- read(device, endpoint_id)¶
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Returns:
containing an Interaction Request
- Return type:
- 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 forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
Client Commands¶
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.client.commands.AudioStreamAllocateResponse: st.matter.data_types.Structure¶
- ID: number¶
0x0001 the ID of this command
- NAME: str¶
“AudioStreamAllocateResponse” the name of this command
- 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, audio_streamid)¶
Builds an AudioStreamAllocateResponse test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)audio_streamid (
st.matter.data_types.Uint16)
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init()¶
Initialize the AudioStreamAllocateResponse command
- Return type:
nil
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.client.commands.VideoStreamAllocateResponse: st.matter.data_types.Structure¶
- ID: number¶
0x0004 the ID of this command
- NAME: str¶
“VideoStreamAllocateResponse” the name of this command
- video_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, video_streamid)¶
Builds an VideoStreamAllocateResponse test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)video_streamid (
st.matter.data_types.Uint16)
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init()¶
Initialize the VideoStreamAllocateResponse command
- Return type:
nil
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.client.commands.SnapshotStreamAllocateResponse: st.matter.data_types.Structure¶
- ID: number¶
0x0008 the ID of this command
- NAME: str¶
“SnapshotStreamAllocateResponse” the name of this command
- snapshot_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, snapshot_streamid)¶
Builds an SnapshotStreamAllocateResponse test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)snapshot_streamid (
st.matter.data_types.Uint16)
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init()¶
Initialize the SnapshotStreamAllocateResponse command
- Return type:
nil
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.client.commands.CaptureSnapshotResponse: st.matter.data_types.Structure¶
- ID: number¶
0x000D the ID of this command
- NAME: str¶
“CaptureSnapshotResponse” the name of this command
- data: st.matter.data_types.OctetString1¶
- image_codec: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.ImageCodecEnum¶
- resolution: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
- 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, data, image_codec, resolution)¶
Builds an CaptureSnapshotResponse test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)image_codec (
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.ImageCodecEnum)resolution (
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct)
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init()¶
Initialize the CaptureSnapshotResponse command
- Return type:
nil
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
Server Commands¶
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.server.commands.AudioStreamAllocate: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this command
- NAME: str¶
“AudioStreamAllocate” the name of this command
- stream_usage: st.matter.generated.zap_clusters.Global.types.StreamUsageEnum¶
- audio_codec: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.AudioCodecEnum¶
- channel_count: st.matter.data_types.Uint8¶
- sample_rate: st.matter.data_types.Uint32¶
- bit_rate: st.matter.data_types.Uint32¶
- bit_depth: st.matter.data_types.Uint8¶
- init(device, stream_usage, audio_codec, channel_count, sample_rate, bit_rate, bit_depth)¶
Refer to AudioStreamAllocateResponse:build_test_command_response for
building a test command reponse for the driver integration testing framework Initialize the AudioStreamAllocate command
- Parameters:
device (
st.matter.Device) – the device to build this message tostream_usage (
st.matter.generated.zap_clusters.Global.types.StreamUsageEnum)audio_codec (
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.AudioCodecEnum)channel_count (
st.matter.data_types.Uint8)sample_rate (
st.matter.data_types.Uint32)bit_rate (
st.matter.data_types.Uint32)bit_depth (
st.matter.data_types.Uint8)
- Returns:
of type INVOKE
- Return type:
- 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.CameraAvStreamManagement.server.commands.AudioStreamDeallocate: st.matter.data_types.Structure¶
- ID: number¶
0x0002 the ID of this command
- NAME: str¶
“AudioStreamDeallocate” the name of this command
- audio_streamid: st.matter.data_types.Uint16¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an AudioStreamDeallocate test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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, audio_streamid)¶
Initialize the AudioStreamDeallocate command
- Parameters:
device (
st.matter.Device) – the device to build this message toaudio_streamid (
st.matter.data_types.Uint16)
- Returns:
of type INVOKE
- Return type:
- 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.CameraAvStreamManagement.server.commands.VideoStreamAllocate: st.matter.data_types.Structure¶
- ID: number¶
0x0003 the ID of this command
- NAME: str¶
“VideoStreamAllocate” the name of this command
- stream_usage: st.matter.generated.zap_clusters.Global.types.StreamUsageEnum¶
- video_codec: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoCodecEnum¶
- min_frame_rate: st.matter.data_types.Uint16¶
- max_frame_rate: st.matter.data_types.Uint16¶
- min_resolution: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
- max_resolution: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
- min_bit_rate: st.matter.data_types.Uint32¶
- max_bit_rate: st.matter.data_types.Uint32¶
- key_frame_interval: st.matter.data_types.Uint16¶
- watermark_enabled: st.matter.data_types.Boolean¶
- osd_enabled: st.matter.data_types.Boolean¶
- init(device, stream_usage, video_codec, min_frame_rate, max_frame_rate, min_resolution, max_resolution, min_bit_rate, max_bit_rate, key_frame_interval, watermark_enabled, osd_enabled)¶
Refer to VideoStreamAllocateResponse:build_test_command_response for
building a test command reponse for the driver integration testing framework Initialize the VideoStreamAllocate command
- Parameters:
device (
st.matter.Device) – the device to build this message tostream_usage (
st.matter.generated.zap_clusters.Global.types.StreamUsageEnum)video_codec (
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoCodecEnum)min_frame_rate (
st.matter.data_types.Uint16)max_frame_rate (
st.matter.data_types.Uint16)min_resolution (
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct)max_resolution (
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct)min_bit_rate (
st.matter.data_types.Uint32)max_bit_rate (
st.matter.data_types.Uint32)key_frame_interval (
st.matter.data_types.Uint16)watermark_enabled (
st.matter.data_types.Boolean)osd_enabled (
st.matter.data_types.Boolean)
- Returns:
of type INVOKE
- Return type:
- 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.CameraAvStreamManagement.server.commands.VideoStreamModify: st.matter.data_types.Structure¶
- ID: number¶
0x0005 the ID of this command
- NAME: str¶
“VideoStreamModify” the name of this command
- video_streamid: st.matter.data_types.Uint16¶
- watermark_enabled: st.matter.data_types.Boolean¶
- osd_enabled: st.matter.data_types.Boolean¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an VideoStreamModify test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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, video_streamid, watermark_enabled, osd_enabled)¶
Initialize the VideoStreamModify command
- Parameters:
device (
st.matter.Device) – the device to build this message tovideo_streamid (
st.matter.data_types.Uint16)watermark_enabled (
st.matter.data_types.Boolean)osd_enabled (
st.matter.data_types.Boolean)
- Returns:
of type INVOKE
- Return type:
- 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.CameraAvStreamManagement.server.commands.VideoStreamDeallocate: st.matter.data_types.Structure¶
- ID: number¶
0x0006 the ID of this command
- NAME: str¶
“VideoStreamDeallocate” the name of this command
- video_streamid: st.matter.data_types.Uint16¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an VideoStreamDeallocate test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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, video_streamid)¶
Initialize the VideoStreamDeallocate command
- Parameters:
device (
st.matter.Device) – the device to build this message tovideo_streamid (
st.matter.data_types.Uint16)
- Returns:
of type INVOKE
- Return type:
- 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.CameraAvStreamManagement.server.commands.SnapshotStreamAllocate: st.matter.data_types.Structure¶
- ID: number¶
0x0007 the ID of this command
- NAME: str¶
“SnapshotStreamAllocate” the name of this command
- image_codec: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.ImageCodecEnum¶
- max_frame_rate: st.matter.data_types.Uint16¶
- min_resolution: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
- max_resolution: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
- quality: st.matter.data_types.Uint8¶
- watermark_enabled: st.matter.data_types.Boolean¶
- osd_enabled: st.matter.data_types.Boolean¶
- init(device, image_codec, max_frame_rate, min_resolution, max_resolution, quality, watermark_enabled, osd_enabled)¶
Refer to SnapshotStreamAllocateResponse:build_test_command_response for
building a test command reponse for the driver integration testing framework Initialize the SnapshotStreamAllocate command
- Parameters:
device (
st.matter.Device) – the device to build this message toimage_codec (
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.ImageCodecEnum)max_frame_rate (
st.matter.data_types.Uint16)min_resolution (
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct)max_resolution (
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct)quality (
st.matter.data_types.Uint8)watermark_enabled (
st.matter.data_types.Boolean)osd_enabled (
st.matter.data_types.Boolean)
- Returns:
of type INVOKE
- Return type:
- 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.CameraAvStreamManagement.server.commands.SnapshotStreamModify: st.matter.data_types.Structure¶
- ID: number¶
0x0009 the ID of this command
- NAME: str¶
“SnapshotStreamModify” the name of this command
- snapshot_streamid: st.matter.data_types.Uint16¶
- watermark_enabled: st.matter.data_types.Boolean¶
- osd_enabled: st.matter.data_types.Boolean¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an SnapshotStreamModify test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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, snapshot_streamid, watermark_enabled, osd_enabled)¶
Initialize the SnapshotStreamModify command
- Parameters:
device (
st.matter.Device) – the device to build this message tosnapshot_streamid (
st.matter.data_types.Uint16)watermark_enabled (
st.matter.data_types.Boolean)osd_enabled (
st.matter.data_types.Boolean)
- Returns:
of type INVOKE
- Return type:
- 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.CameraAvStreamManagement.server.commands.SnapshotStreamDeallocate: st.matter.data_types.Structure¶
- ID: number¶
0x000A the ID of this command
- NAME: str¶
“SnapshotStreamDeallocate” the name of this command
- snapshot_streamid: st.matter.data_types.Uint16¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an SnapshotStreamDeallocate test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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, snapshot_streamid)¶
Initialize the SnapshotStreamDeallocate command
- Parameters:
device (
st.matter.Device) – the device to build this message tosnapshot_streamid (
st.matter.data_types.Uint16)
- Returns:
of type INVOKE
- Return type:
- 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.CameraAvStreamManagement.server.commands.SetStreamPriorities: st.matter.data_types.Structure¶
- ID: number¶
0x000B the ID of this command
- NAME: str¶
“SetStreamPriorities” the name of this command
- stream_priorities: st.matter.data_types.Array¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an SetStreamPriorities test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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, stream_priorities)¶
Initialize the SetStreamPriorities command
- Parameters:
device (
st.matter.Device) – the device to build this message tostream_priorities (
st.matter.data_types.Array)
- Returns:
of type INVOKE
- Return type:
- 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.CameraAvStreamManagement.server.commands.CaptureSnapshot: st.matter.data_types.Structure¶
- ID: number¶
0x000C the ID of this command
- NAME: str¶
“CaptureSnapshot” the name of this command
- snapshot_streamid: st.matter.data_types.Uint16¶
- requested_resolution: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
- init(device, snapshot_streamid, requested_resolution)¶
Refer to CaptureSnapshotResponse:build_test_command_response for
building a test command reponse for the driver integration testing framework Initialize the CaptureSnapshot command
- Parameters:
device (
st.matter.Device) – the device to build this message tosnapshot_streamid (
st.matter.data_types.Uint16)requested_resolution (
st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct)
- Returns:
of type INVOKE
- Return type:
- 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.CameraAvStreamManagement.types.Feature¶
- AUDIO: number¶
1
- VIDEO: number¶
2
- SNAPSHOT: number¶
4
- PRIVACY: number¶
8
- SPEAKER: number¶
16
- IMAGE_CONTROL: number¶
32
- WATERMARK: number¶
64
- ON_SCREEN_DISPLAY: number¶
128
- LOCAL_STORAGE: number¶
256
- HIGH_DYNAMIC_RANGE: number¶
512
- NIGHT_VISION: number¶
1024
- is_audio_set()¶
- Returns:
True if the value of AUDIO is non-zero
- Return type:
boolean
- set_audio()¶
Set the value of the bit in the AUDIO field to 1
- unset_audio()¶
Set the value of the bits in the AUDIO field to 0
- is_video_set()¶
- Returns:
True if the value of VIDEO is non-zero
- Return type:
boolean
- set_video()¶
Set the value of the bit in the VIDEO field to 1
- unset_video()¶
Set the value of the bits in the VIDEO field to 0
- is_snapshot_set()¶
- Returns:
True if the value of SNAPSHOT is non-zero
- Return type:
boolean
- set_snapshot()¶
Set the value of the bit in the SNAPSHOT field to 1
- unset_snapshot()¶
Set the value of the bits in the SNAPSHOT field to 0
- is_privacy_set()¶
- Returns:
True if the value of PRIVACY is non-zero
- Return type:
boolean
- set_privacy()¶
Set the value of the bit in the PRIVACY field to 1
- unset_privacy()¶
Set the value of the bits in the PRIVACY field to 0
- is_speaker_set()¶
- Returns:
True if the value of SPEAKER is non-zero
- Return type:
boolean
- set_speaker()¶
Set the value of the bit in the SPEAKER field to 1
- unset_speaker()¶
Set the value of the bits in the SPEAKER field to 0
- is_image_control_set()¶
- Returns:
True if the value of IMAGE_CONTROL is non-zero
- Return type:
boolean
- set_image_control()¶
Set the value of the bit in the IMAGE_CONTROL field to 1
- unset_image_control()¶
Set the value of the bits in the IMAGE_CONTROL field to 0
- is_watermark_set()¶
- Returns:
True if the value of WATERMARK is non-zero
- Return type:
boolean
- set_watermark()¶
Set the value of the bit in the WATERMARK field to 1
- unset_watermark()¶
Set the value of the bits in the WATERMARK field to 0
- is_on_screen_display_set()¶
- Returns:
True if the value of ON_SCREEN_DISPLAY is non-zero
- Return type:
boolean
- set_on_screen_display()¶
Set the value of the bit in the ON_SCREEN_DISPLAY field to 1
- unset_on_screen_display()¶
Set the value of the bits in the ON_SCREEN_DISPLAY field to 0
- is_local_storage_set()¶
- Returns:
True if the value of LOCAL_STORAGE is non-zero
- Return type:
boolean
- set_local_storage()¶
Set the value of the bit in the LOCAL_STORAGE field to 1
- unset_local_storage()¶
Set the value of the bits in the LOCAL_STORAGE field to 0
- is_high_dynamic_range_set()¶
- Returns:
True if the value of HIGH_DYNAMIC_RANGE is non-zero
- Return type:
boolean
- set_high_dynamic_range()¶
Set the value of the bit in the HIGH_DYNAMIC_RANGE field to 1
- unset_high_dynamic_range()¶
Set the value of the bits in the HIGH_DYNAMIC_RANGE field to 0
- is_night_vision_set()¶
- Returns:
True if the value of NIGHT_VISION is non-zero
- Return type:
boolean
- set_night_vision()¶
Set the value of the bit in the NIGHT_VISION field to 1
- unset_night_vision()¶
Set the value of the bits in the NIGHT_VISION field to 0
Enum types¶
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.types.AudioCodecEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- OPUS: number¶
0
- AAC_LC: number¶
1
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.types.ImageCodecEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- JPEG: number¶
0
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.types.TriStateAutoEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- OFF: number¶
0
- ON: number¶
1
- AUTO: number¶
2
Struct types¶
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct: st.matter.data_types.Structure¶
- width: st.matter.data_types.Uint16¶
- height: st.matter.data_types.Uint16¶
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoStreamStruct: st.matter.data_types.Structure¶
- video_stream_id: st.matter.data_types.Uint16¶
- stream_usage: st.matter.generated.zap_clusters.Global.types.StreamUsageEnum¶
- video_codec: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoCodecEnum¶
- min_frame_rate: st.matter.data_types.Uint16¶
- max_frame_rate: st.matter.data_types.Uint16¶
- min_resolution: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
- max_resolution: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
- min_bit_rate: st.matter.data_types.Uint32¶
- max_bit_rate: st.matter.data_types.Uint32¶
- key_frame_interval: st.matter.data_types.Uint16¶
- watermark_enabled: st.matter.data_types.Boolean¶
- osd_enabled: st.matter.data_types.Boolean¶
- reference_count: st.matter.data_types.Uint8¶
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.types.SnapshotStreamStruct: st.matter.data_types.Structure¶
- snapshot_stream_id: st.matter.data_types.Uint16¶
- image_codec: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.ImageCodecEnum¶
- frame_rate: st.matter.data_types.Uint16¶
- min_resolution: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
- max_resolution: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
- quality: st.matter.data_types.Uint8¶
- reference_count: st.matter.data_types.Uint8¶
- encoded_pixels: st.matter.data_types.Boolean¶
- hardware_encoder: st.matter.data_types.Boolean¶
- watermark_enabled: st.matter.data_types.Boolean¶
- osd_enabled: st.matter.data_types.Boolean¶
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.types.SnapshotCapabilitiesStruct: st.matter.data_types.Structure¶
- resolution: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
- max_frame_rate: st.matter.data_types.Uint16¶
- image_codec: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.ImageCodecEnum¶
- requires_encoded_pixels: st.matter.data_types.Boolean¶
- requires_hardware_encoder: st.matter.data_types.Boolean¶
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.types.RateDistortionTradeOffPointsStruct: st.matter.data_types.Structure¶
- codec: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoCodecEnum¶
- resolution: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.VideoResolutionStruct¶
- min_bit_rate: st.matter.data_types.Uint32¶
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.types.AudioCapabilitiesStruct: st.matter.data_types.Structure¶
- max_number_of_channels: st.matter.data_types.Uint8¶
- supported_codecs: st.matter.data_types.Array¶
- supported_sample_rates: st.matter.data_types.Array¶
- supported_bit_depths: st.matter.data_types.Array¶
- class st.matter.generated.zap_clusters.CameraAvStreamManagement.types.AudioStreamStruct: st.matter.data_types.Structure¶
- audio_stream_id: st.matter.data_types.Uint16¶
- stream_usage: st.matter.generated.zap_clusters.Global.types.StreamUsageEnum¶
- audio_codec: st.matter.generated.zap_clusters.CameraAvStreamManagement.types.AudioCodecEnum¶
- channel_count: st.matter.data_types.Uint8¶
- sample_rate: st.matter.data_types.Uint32¶
- bit_rate: st.matter.data_types.Uint32¶
- bit_depth: st.matter.data_types.Uint8¶
- reference_count: st.matter.data_types.Uint8¶