-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
Copy pathpush-av-stream-transport-cluster.xml
229 lines (199 loc) · 11.4 KB
/
push-av-stream-transport-cluster.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
<?xml version="1.0"?>
<!--
Copyright (c) 2024-2025 Project CHIP Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!--
XML generated by Alchemy; DO NOT EDIT.
Source: src/app_clusters/PushAVStreamTransport.adoc
Parameters: in-progress
Git: 1.4-534-g3214b3502
-->
<configurator xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../zcl.xsd">
<domain name="Cameras"/>
<bitmap name="SupportedContainerFormatsBitmap" type="bitmap8">
<cluster code="0x0555"/>
<field name="CMAF" mask="0x01"/>
</bitmap>
<bitmap name="SupportedIngestMethodsBitmap" type="bitmap8">
<cluster code="0x0555"/>
<field name="CMAFIngest" mask="0x01"/>
</bitmap>
<enum name="ContainerFormatEnum" type="enum8">
<cluster code="0x0555"/>
<item name="CMAF" value="0x00"/>
</enum>
<enum name="IngestMethodsEnum" type="enum8">
<cluster code="0x0555"/>
<item name="CMAFIngest" value="0x00"/>
</enum>
<enum name="StatusCodeEnum" type="enum8">
<cluster code="0x0555"/>
<item name="AllocationNotPermitted" value="0x02"/>
<item name="InvalidTLSEndpoint" value="0x03"/>
<item name="InvalidStream" value="0x04"/>
<item name="InvalidURL" value="0x05"/>
<item name="InvalidZone" value="0x06"/>
<item name="UnsupportedContainerFormat" value="0x07"/>
<item name="UnsupportedIngestMethod" value="0x08"/>
<item name="InvalidTriggerType" value="0x09"/>
<item name="InvalidTransportStatus" value="0x10"/>
</enum>
<enum name="StreamMultiplexingEnum" type="enum8">
<cluster code="0x0555"/>
<item name="Interleaved" value="0x00"/>
</enum>
<enum name="TransportStatusEnum" type="enum8">
<cluster code="0x0555"/>
<item name="Active" value="0x00"/>
<item name="Inactive" value="0x01"/>
</enum>
<enum name="TransportTriggerTypeEnum" type="enum8">
<cluster code="0x0555"/>
<item name="Command" value="0x00"/>
<item name="Motion" value="0x01"/>
<item name="Continuous" value="0x02"/>
</enum>
<enum name="TriggerActivationReasonEnum" type="enum8">
<cluster code="0x0555"/>
<item name="UserInitiated" value="0x00"/>
<item name="Automation" value="0x01"/>
<item name="Emergency" value="0x02"/>
</enum>
<struct name="CMAFContainerOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="ChunkDuration" type="int16u" default="4"/>
<item fieldId="1" name="CENCKey" type="octet_string" optional="true"/>
</struct>
<struct name="ContainerOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="ContainerType" type="ContainerFormatEnum" min="0x00" max="0x00"/>
<item fieldId="1" name="CMAFContainerOptions" type="CMAFContainerOptionsStruct" optional="true"/>
</struct>
<struct name="MetadataOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="Multiplexing" type="StreamMultiplexingEnum" min="0x00" max="0x00"/>
<item fieldId="1" name="IncludeMotionZones" type="boolean"/>
<item fieldId="2" name="EnableMetadataPrivacySensitive" type="boolean"/>
</struct>
<struct name="TransportConfigurationStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="ConnectionID" type="int16u"/>
<item fieldId="1" name="TransportStatus" type="TransportStatusEnum" min="0x00" max="0x01"/>
<item fieldId="2" name="TransportOptions" type="TransportOptionsStruct"/>
</struct>
<struct name="TransportMotionTriggerTimeControlStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="InitialDuration" type="int16u" default="10" min="1"/>
<item fieldId="1" name="AugmentationDuration" type="int16u" default="5"/>
<item fieldId="2" name="MaxDuration" type="elapsed_s" default="30" min="1"/>
<item fieldId="3" name="BlindDuration" type="int16u" default="30"/>
</struct>
<struct name="TransportOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="StreamUsage" type="StreamUsageEnum" min="0x00" max="0x03"/>
<item fieldId="1" name="VideoStreamID" type="int16u" optional="true"/>
<item fieldId="2" name="AudioStreamID" type="int16u" optional="true"/>
<item fieldId="3" name="EndpointID" type="int16u"/>
<item fieldId="4" name="URL" type="long_char_string" length="2000"/>
<item fieldId="5" name="TriggerOptions" type="TransportTriggerOptionsStruct"/>
<item fieldId="6" name="IngestMethod" type="IngestMethodsEnum" min="0x00" max="0x00"/>
<item fieldId="7" name="ContainerFormat" type="ContainerFormatEnum" min="0x00" max="0x00"/>
<item fieldId="8" name="ContainerOptions" type="ContainerOptionsStruct"/>
<item fieldId="9" name="MetadataOptions" type="MetadataOptionsStruct" optional="true"/>
<item fieldId="10" name="ExpiryTime" type="epoch_s" optional="true"/>
</struct>
<struct name="TransportTriggerOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="TriggerType" type="TransportTriggerTypeEnum" min="0x00" max="0x02"/>
<item fieldId="1" name="MotionZones" array="true" type="TransportZoneOptionsStruct" isNullable="true" optional="true"/>
<item fieldId="2" name="MotionSensitivity" type="int8u" isNullable="true" optional="true" default="5" min="1" max="10"/>
<item fieldId="3" name="MotionTimeControl" type="TransportMotionTriggerTimeControlStruct" optional="true"/>
<item fieldId="4" name="MaxPreRollLen" type="int16u" optional="true"/>
</struct>
<struct name="TransportZoneOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="1" name="Zone" type="int16u" isNullable="true"/>
<item fieldId="2" name="Sensitivity" type="int8u" optional="true" default="5" min="1" max="10"/>
</struct>
<cluster>
<domain name="Cameras"/>
<name>Push AV Stream Transport</name>
<code>0x0555</code>
<define>PUSH_AV_STREAM_TRANSPORT_CLUSTER</define>
<description>This cluster implements the upload of Audio and Video streams from the Push AV Stream Transport Cluster using suitable push-based transports.</description>
<client init="false" tick="false">true</client>
<features>
<feature bit="0" code="PERZONESENS" name="PerZoneSensitivity" summary="Supports a sensitivity value per Zone">
<optionalConform/>
</feature>
</features>
<server init="false" tick="false">true</server>
<globalAttribute code="0xFFFD" side="either" value="1"/>
<attribute code="0x0000" side="server" define="SUPPORTED_CONTAINER_FORMATS" type="SupportedContainerFormatsBitmap" min="0x00" max="0x01">SupportedContainerFormats</attribute>
<attribute code="0x0001" side="server" define="SUPPORTED_INGEST_METHODS" type="SupportedIngestMethodsBitmap" min="0x00" max="0x01">SupportedIngestMethods</attribute>
<attribute code="0x0002" side="server" define="CURRENT_CONNECTIONS" type="array" entryType="int16u">CurrentConnections</attribute>
<command code="0x00" source="client" name="AllocatePushTransport" optional="false" response="AllocatePushTransportResponse">
<description>This command SHALL allocate a transport and return a PushTransportConnectionID.</description>
<access op="invoke" privilege="manage"/>
<arg id="0" name="TransportOptions" type="TransportOptionsStruct"/>
</command>
<command code="0x01" source="server" name="AllocatePushTransportResponse" optional="false" disableDefaultResponse="true">
<description>This command SHALL be generated in response to an AllocatePushTransport command.</description>
<arg id="0" name="ConnectionID" type="int16u"/>
<arg id="1" name="TransportOptions" type="TransportOptionsStruct"/>
<arg id="2" name="TransportStatus" type="TransportStatusEnum" min="0x00" max="0x01"/>
</command>
<command code="0x02" source="client" name="DeallocatePushTransport" optional="false">
<description>This command SHALL be generated to request the Node deallocates the specified transport.</description>
<access op="invoke" privilege="manage"/>
<arg id="0" name="ConnectionID" type="int16u"/>
</command>
<command code="0x03" source="client" name="ModifyPushTransport" optional="false">
<description>This command is used to request the Node modifies the configuration of the specified push transport.</description>
<access op="invoke" privilege="manage"/>
<arg id="0" name="ConnectionID" type="int16u"/>
<arg id="1" name="TransportOptions" type="TransportOptionsStruct"/>
</command>
<command code="0x04" source="client" name="SetTransportStatus" optional="false">
<description>This command SHALL be generated to request the Node modifies the Transport Status of the transport.</description>
<access op="invoke" privilege="manage"/>
<arg id="0" name="ConnectionID" type="int16u"/>
<arg id="1" name="TransportStatus" type="TransportStatusEnum" min="0x00" max="0x01"/>
</command>
<command code="0x05" source="client" name="ManuallyTriggerTransport" optional="false">
<description>This command SHALL be generated to request the Node to manually start the specified push transport.</description>
<arg id="0" name="ConnectionID" type="int16u"/>
<arg id="1" name="ActivationReason" type="TriggerActivationReasonEnum" min="0x00" max="0x02"/>
<arg id="2" name="TimeControl" type="TransportMotionTriggerTimeControlStruct" optional="true"/>
</command>
<command code="0x06" source="client" name="FindTransport" optional="false" response="FindTransportResponse">
<description>This command SHALL return the Stream Options Configuration for the specified push transport.</description>
<arg id="0" name="ConnectionID" type="int16u" optional="true" isNullable="true"/>
</command>
<command code="0x07" source="server" name="FindTransportResponse" optional="false" disableDefaultResponse="true">
<description>This command SHALL be generated in response to a FindTransport command.</description>
<arg id="0" name="StreamConfigurations" array="true" type="TransportConfigurationStruct"/>
</command>
<event code="0x0000" name="PushTransportBegin" priority="info" side="server">
<field id="0" name="ConnectionID" type="int16u"/>
<field id="1" name="TriggerType" type="TransportTriggerTypeEnum" min="0x00" max="0x02"/>
<field id="2" name="ActivationReason" type="TriggerActivationReasonEnum" optional="true" min="0x00" max="0x02"/>
<description>This event SHALL indicate a push transport transmission has begun.</description>
</event>
<event code="0x0001" name="PushTransportEnd" priority="info" side="server">
<field id="0" name="ConnectionID" type="int16u"/>
<field id="1" name="TriggerType" type="TransportTriggerTypeEnum" min="0x00" max="0x02"/>
<field id="2" name="ActivationReason" type="TriggerActivationReasonEnum" optional="true" min="0x00" max="0x02"/>
<description>This event SHALL indicate a push transport transmission has ended.</description>
</event>
</cluster>
</configurator>