Skip to content

Commit

Permalink
Re-generated with latest spec, using ./alchemy zap --attribute="in-pr…
Browse files Browse the repository at this point in the history 
…ogress" ... /PushAVStreamTransport.adoc
  • Loading branch information
@gmarcosb
gmarcosb committed Dec 18, 2024
1 parent 3445e84 commit 8a02f5b
Showing 1 changed file with 91 additions and 78 deletions.
169 changes: 91 additions & 78 deletions src/app/zap-templates/zcl/data-model/chip/push-av-stream-transport-cluster.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,199 +18,212 @@ limitations under the License.
XML generated by Alchemy; DO NOT EDIT.
Source: src/app_clusters/PushAVStreamTransport.adoc
Parameters: in-progress
Git: 0.7-fall2024-ncr-1158-g413e195c2
Git: 1.4-443-g049435a77
-->
<configurator xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../zcl.xsd">
<domain name="General"/>
<bitmap name="PushAVStreamTransportSupportedContainerFormatsBitmap" type="bitmap8">
<bitmap name="SupportedContainerFormatsBitmap" type="bitmap8">
<cluster code="0x0555"/>
<field name="CMAF" mask="0x01"/>
</bitmap>

<bitmap name="PushAVStreamTransportSupportedIngestMethodsBitmap" type="bitmap8">
<bitmap name="SupportedIngestMethodsBitmap" type="bitmap8">
<cluster code="0x0555"/>
<field name="CMAFIngest" mask="0x01"/>
</bitmap>

<enum name="PushAVStreamTransportContainerFormatEnum" type="enum8">
<enum name="ContainerFormatEnum" type="enum8">
<cluster code="0x0555"/>
<item name="CMAF" value="0x00"/>
</enum>

<enum name="PushAVStreamTransportIngestMethodEnum" type="enum8">
<enum name="IngestMethodsEnum" type="enum8">
<cluster code="0x0555"/>
<item name="CMAFIngest" value="0x00"/>
</enum>

<enum name="PushAVStreamTransportStatusEnum" type="enum8">
<enum name="StatusCodeEnum" type="enum8">
<cluster code="0x0555"/>
<item name="Active" value="0x00"/>
<item name="Inactive" value="0x01"/>
<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="PushAVStreamTransportStreamMultiplexingEnum" type="enum8">
<enum name="StreamMultiplexingEnum" type="enum8">
<cluster code="0x0555"/>
<item name="Interleaved" value="0x00"/>
</enum>

<enum name="PushAVStreamTransportTriggerActivationReasonEnum" type="enum8">
<enum name="TransportStatusEnum" type="enum8">
<cluster code="0x0555"/>
<item name="UserInitiated" value="0x00"/>
<item name="Automation" value="0x01"/>
<item name="Emergency" value="0x02"/>
<item name="Active" value="0x00"/>
<item name="Inactive" value="0x01"/>
</enum>

<enum name="PushAVStreamTransportTriggerTypeEnum" type="enum8">
<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="StatusCodeEnum" type="enum8">
<enum name="TriggerActivationReasonEnum" type="enum8">
<cluster code="0x0555"/>
<item name="ALLOCATION_NOT_PERMITTED" value="0x02"/>
<item name="INVALID_PARAMETERS" value="0x03"/>
<item name="INVALID_URL" value="0x04"/>
<item name="INVALID_TRIGGER_OPTIONS" value="0x05"/>
<item name="UNSUPPORTED_CONTAINER_FORMAT" value="0x06"/>
<item name="UNSUPPORTED_INGEST_METHOD" value="0x07"/>
<item name="PAVST_NOT_IN_USE" value="0x08"/>
<item name="INVALID_TRIGGER_FORMAT" value="0x09"/>
<item name="INVALID_TRANSPORT_STATUS" value="0x10"/>
<item name="UserInitiated" value="0x00"/>
<item name="Automation" value="0x01"/>
<item name="Emergency" value="0x02"/>
</enum>

<struct name="PushAVStreamConfigurationStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="ConnectionID" type="int16u"/>
<item fieldId="1" name="StreamTransportStatus" type="PushAVStreamTransportStatusEnum" min="0x00" max="0x01"/>
<item fieldId="2" name="StreamTransportOptions" type="PushAVStreamTransportOptionsStruct"/>
</struct>

<struct name="PushAVStreamTransportCMAFContainerOptionsStruct" apiMaturity="provisional">
<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" isNullable="true" optional="true"/>
</struct>

<struct name="PushAVStreamTransportContainerOptionsStruct" apiMaturity="provisional">
<struct name="ContainerOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="ContainerType" type="PushAVStreamTransportContainerFormatEnum" min="0x00" max="0x00"/>
<item fieldId="1" name="CMAFContainerOptions" type="PushAVStreamTransportCMAFContainerOptionsStruct" isNullable="true" optional="true"/>
<item fieldId="0" name="ContainerType" type="ContainerFormatEnum" min="0x00" max="0x00"/>
<item fieldId="1" name="CMAFContainerOptions" type="CMAFContainerOptionsStruct" isNullable="true" optional="true"/>
</struct>

<struct name="PushAVStreamTransportMetadataOptionsStruct" apiMaturity="provisional">
<struct name="MetadataOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="Multiplexing" type="PushAVStreamTransportStreamMultiplexingEnum" min="0x00" max="0x00"/>
<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="PushAVStreamTransportMotionTriggerTimeControlStruct" apiMaturity="provisional">
<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="int32u" default="30" min="1"/>
<item fieldId="2" name="MaxDuration" type="elapsed_s" default="30" min="1"/>
<item fieldId="3" name="BlindDuration" type="int16u" default="30"/>
</struct>

<struct name="PushAVStreamTransportOptionsStruct" apiMaturity="provisional">
<struct name="TransportOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="StreamType" type="StreamTypeEnum" min="0x00" max="0x03"/>
<item fieldId="1" name="VideoStreamID" type="int16u" isNullable="true" optional="true"/>
<item fieldId="2" name="AudioStreamID" type="int16u" isNullable="true" optional="true"/>
<item fieldId="3" name="TLSEndpointID" type="int16u"/>
<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="256"/>
<item fieldId="5" name="TriggerOptions" type="PushAVStreamTransportTriggerOptionsStruct"/>
<item fieldId="6" name="ContainerFormat" type="PushAVStreamTransportContainerFormatEnum" min="0x00" max="0x00"/>
<item fieldId="7" name="IngestMethod" type="PushAVStreamTransportIngestMethodEnum" min="0x00" max="0x00"/>
<item fieldId="8" name="ContainerOptions" type="PushAVStreamTransportContainerOptionsStruct"/>
<item fieldId="9" name="MetadataOptions" type="PushAVStreamTransportMetadataOptionsStruct" isNullable="true" optional="true"/>
<item fieldId="10" name="ExpiryTime" type="int32u" isNullable="true" optional="true"/>
<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" isNullable="true" optional="true"/>
<item fieldId="10" name="ExpiryTime" type="epoch_s" isNullable="true" optional="true"/>
</struct>

<struct name="PushAVStreamTransportTriggerOptionsStruct" apiMaturity="provisional">
<struct name="TransportTriggerOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="TriggerType" type="PushAVStreamTransportTriggerTypeEnum" min="0x00" max="0x02"/>
<item fieldId="1" name="MotionZones" array="true" type="int16u" isNullable="true" optional="true"/>
<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="PushAVStreamTransportMotionTriggerTimeControlStruct" isNullable="true" optional="true"/>
<item fieldId="4" name="ActivationReason" type="PushAVStreamTransportTriggerActivationReasonEnum" isNullable="true" optional="true" min="0x00" max="0x02"/>
<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="General"/>
<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 Camera AV Stream Management 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="PushAVStreamTransportSupportedContainerFormatsBitmap" min="0x00" max="0x01">SupportedContainerFormats</attribute>
<attribute code="0x0001" side="server" define="SUPPORTED_INGEST_METHODS" type="PushAVStreamTransportSupportedIngestMethodsBitmap" min="0x00" max="0x01">SupportedIngestMethods</attribute>
<attribute code="0x0002" side="server" define="CURRENT_CONNECTIONS" type="array" entryType="int16u" default="0">CurrentConnections</attribute>
<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="administer"/>
<arg id="0" name="StreamTransportOptions" type="PushAVStreamTransportOptionsStruct"/>
<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="StreamTransportOptions" type="PushAVStreamTransportOptionsStruct"/>
<arg id="2" name="TransportStatus" type="PushAVStreamTransportStatusEnum" min="0x00" max="0x01"/>
<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="administer"/>
<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="administer"/>
<access op="invoke" privilege="manage"/>
<arg id="0" name="ConnectionID" type="int16u"/>
<arg id="1" name="StreamTransportOptions" type="PushAVStreamTransportOptionsStruct"/>
<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="administer"/>
<access op="invoke" privilege="manage"/>
<arg id="0" name="ConnectionID" type="int16u" isNullable="true"/>
<arg id="1" name="StreamTransportStatus" type="PushAVStreamTransportStatusEnum" min="0x00" max="0x01"/>
<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>
<access op="invoke" privilege="administer"/>
<arg id="0" name="ConnectionID" type="int16u"/>
<arg id="1" name="ActivationReason" type="PushAVStreamTransportTriggerActivationReasonEnum" isNullable="true" min="0x00" max="0x02"/>
<arg id="2" name="TimeControl" type="PushAVStreamTransportMotionTriggerTimeControlStruct" optional="true" isNullable="true"/>
<arg id="1" name="ActivationReason" type="TriggerActivationReasonEnum" isNullable="true" min="0x00" max="0x02"/>
<arg id="2" name="TimeControl" type="TransportMotionTriggerTimeControlStruct" optional="true" isNullable="true"/>
</command>

<command code="0x06" source="client" name="FindStreamConfiguration" optional="false" response="FindStreamConfigurationResponse">
<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>
<access op="invoke" privilege="administer"/>
<arg id="0" name="ConnectionID" type="int16u" optional="true" isNullable="true"/>
</command>

<command code="0x07" source="server" name="FindStreamConfigurationResponse" optional="false" disableDefaultResponse="true">
<description>This command SHALL be generated in response to a FindStreamConfiguration command.</description>
<arg id="0" name="StreamConfigurations" array="true" type="PushAVStreamConfigurationStruct"/>
<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">
<description/>
<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="TriggerDetails" type="PushAVStreamTransportTriggerOptionsStruct"/>
<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>
</configurator>

0 comments on commit 8a02f5b

Please sign in to comment.