| <?xml version="1.0"?> |
| <!-- |
| Copyright (C) Connectivity Standards Alliance (2025). All rights reserved. |
| The information within this document is the property of the Connectivity |
| Standards Alliance and its use and disclosure are restricted, except as |
| expressly set forth herein. |
| |
| Connectivity Standards Alliance hereby grants you a fully-paid, non-exclusive, |
| nontransferable, worldwide, limited and revocable license (without the right to |
| sublicense), under Connectivity Standards Alliance's applicable copyright |
| rights, to view, download, save, reproduce and use the document solely for your |
| own internal purposes and in accordance with the terms of the license set forth |
| herein. This license does not authorize you to, and you expressly warrant that |
| you shall not: (a) permit others (outside your organization) to use this |
| document; (b) post or publish this document; (c) modify, adapt, translate, or |
| otherwise change this document in any manner or create any derivative work |
| based on this document; (d) remove or modify any notice or label on this |
| document, including this Copyright Notice, License and Disclaimer. The |
| Connectivity Standards Alliance does not grant you any license hereunder other |
| than as expressly stated herein. |
| |
| Elements of this document may be subject to third party intellectual property |
| rights, including without limitation, patent, copyright or trademark rights, |
| and any such third party may or may not be a member of the Connectivity |
| Standards Alliance. Connectivity Standards Alliance members grant other |
| Connectivity Standards Alliance members certain intellectual property rights as |
| set forth in the Connectivity Standards Alliance IPR Policy. Connectivity |
| Standards Alliance members do not grant you any rights under this license. The |
| Connectivity Standards Alliance is not responsible for, and shall not be held |
| responsible in any manner for, identifying or failing to identify any or all |
| such third party intellectual property rights. Please visit www.csa-iot.org for |
| more information on how to become a member of the Connectivity Standards |
| Alliance. |
| |
| This document and the information contained herein are provided on an “AS IS” |
| basis and the Connectivity Standards Alliance DISCLAIMS ALL WARRANTIES EXPRESS |
| OR IMPLIED, INCLUDING BUT NOT LIMITED TO (A) ANY WARRANTY THAT THE USE OF THE |
| INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OF THIRD PARTIES (INCLUDING |
| WITHOUT LIMITATION ANY INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT, COPYRIGHT |
| OR TRADEMARK RIGHTS); OR (B) ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS |
| FOR A PARTICULAR PURPOSE, TITLE OR NONINFRINGEMENT. IN NO EVENT WILL THE |
| CONNECTIVITY STANDARDS ALLIANCE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF |
| BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF BUSINESS, OR FOR ANY OTHER |
| DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL |
| DAMAGES OF ANY KIND, IN CONTRACT OR IN TORT, IN CONNECTION WITH THIS DOCUMENT |
| OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH |
| LOSS OR DAMAGE. |
| |
| All company, brand and product names in this document may be trademarks that |
| are the sole property of their respective owners. |
| |
| This notice and disclaimer must be included on all copies of this document. |
| |
| Connectivity Standards Alliance |
| 508 Second Street, Suite 206 |
| Davis, CA 95616, USA |
| |
| :xrefstyle: basic |
| --> |
| <cluster xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="types types.xsd cluster cluster.xsd" id="0x0553" name="WebRTC Transport Provider Cluster" revision="1"> |
| <revisionHistory> |
| <revision revision="1" summary="Initial version of the WebRTC Transport Provider Cluster"/> |
| </revisionHistory> |
| <clusterIds> |
| <clusterId id="0x0553" name="WebRTC Transport Provider"> |
| <provisionalConform/> |
| </clusterId> |
| </clusterIds> |
| <classification hierarchy="base" role="application" picsCode="WEBRTCP" scope="Endpoint"/> |
| <features> |
| <feature bit="0" code="METADATA" name="Metadata" summary="Supports metadata transmission in WebRTC sessions"> |
| <otherwiseConform> |
| <provisionalConform/> |
| <optionalConform/> |
| </otherwiseConform> |
| </feature> |
| </features> |
| <dataTypes> |
| <number name="WebRTCSessionID" type="uint16"/> |
| <enum name="WebRTCEndReasonEnum"> |
| <item value="0" name="IceFailed" summary="No media connection could be established to the other party"> |
| <mandatoryConform/> |
| </item> |
| <item value="1" name="IceTimeout" summary="The call timed out whilst waiting for ICE candidate gathering to complete"> |
| <mandatoryConform/> |
| </item> |
| <item value="2" name="UserHangup" summary="The user chose to end the call"> |
| <mandatoryConform/> |
| </item> |
| <item value="3" name="UserBusy" summary="The remote party is busy"> |
| <mandatoryConform/> |
| </item> |
| <item value="4" name="Replaced" summary="The call was replaced by another call"> |
| <mandatoryConform/> |
| </item> |
| <item value="5" name="NoUserMedia" summary="An error code when there is no local mic/camera to use. This may be because the hardware isn't plugged in, or the user has explicitly denied access"> |
| <mandatoryConform/> |
| </item> |
| <item value="6" name="InviteTimeout" summary="The call timed out whilst waiting for the offer/answer step to complete"> |
| <mandatoryConform/> |
| </item> |
| <item value="7" name="AnsweredElsewhere" summary="The call was answered from a different device"> |
| <mandatoryConform/> |
| </item> |
| <item value="8" name="OutOfResources" summary="The was unable to continue due to not enough resources or available streams"> |
| <mandatoryConform/> |
| </item> |
| <item value="9" name="MediaTimeout" summary="The call ended due to a media timeout"> |
| <mandatoryConform/> |
| </item> |
| <item value="10" name="LowPower" summary="The call ended due to hitting a low power condition"> |
| <mandatoryConform/> |
| </item> |
| <item value="11" name="UnknownReason" summary="Unknown or unspecified reason"> |
| <mandatoryConform/> |
| </item> |
| </enum> |
| <struct name="ICECandidateStruct"> |
| <field id="0" name="Candidate" type="string"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="SDPMid" type="string"> |
| <quality nullable="true"/> |
| <mandatoryConform/> |
| <constraint> |
| <minLength value="1"/> |
| </constraint> |
| </field> |
| <field id="2" name="SDPMLineIndex" type="uint16"> |
| <quality nullable="true"/> |
| <mandatoryConform/> |
| </field> |
| </struct> |
| <struct name="ICEServerStruct"> |
| <field id="0" name="URLs" type="list"> |
| <entry type="string"> |
| <constraint> |
| <maxLength value="2000"/> |
| </constraint> |
| </entry> |
| <mandatoryConform/> |
| <constraint> |
| <maxCount value="10"/> |
| </constraint> |
| </field> |
| <field id="1" name="Username" type="string"> |
| <optionalConform/> |
| <constraint> |
| <maxLength value="508"/> |
| </constraint> |
| </field> |
| <field id="2" name="Credential" type="string"> |
| <optionalConform/> |
| <constraint> |
| <maxLength value="512"/> |
| </constraint> |
| </field> |
| <field id="3" name="CAID" type="TLSCAID"> |
| <optionalConform/> |
| </field> |
| </struct> |
| <struct name="WebRTCSessionStruct"> |
| <field id="0" name="ID" type="WebRTCSessionID"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="PeerNodeID" type="node-id"> |
| <mandatoryConform/> |
| </field> |
| <field id="2" name="PeerEndpointID" type="endpoint-no"> |
| <mandatoryConform/> |
| </field> |
| <field id="3" name="StreamUsage" type="StreamUsageEnum"> |
| <mandatoryConform/> |
| </field> |
| <field id="4" name="VideoStreamID" type="VideoStreamID"> |
| <quality nullable="true"/> |
| <mandatoryConform/> |
| </field> |
| <field id="5" name="AudioStreamID" type="AudioStreamID"> |
| <quality nullable="true"/> |
| <mandatoryConform/> |
| </field> |
| <field id="6" name="MetadataEnabled" type="bool"> |
| <mandatoryConform> |
| <feature name="METADATA"/> |
| </mandatoryConform> |
| </field> |
| <access fabricScoped="true"/> |
| </struct> |
| </dataTypes> |
| <attributes> |
| <attribute id="0x0000" name="CurrentSessions" type="list"> |
| <entry type="WebRTCSessionStruct"/> |
| <access read="true" readPrivilege="manage" fabricSensitive="true"/> |
| <mandatoryConform/> |
| </attribute> |
| </attributes> |
| <commands> |
| <command id="0x00" name="SolicitOffer" direction="commandToServer" response="SolicitOfferResponse"> |
| <quality largeMessage="true"/> |
| <access invokePrivilege="operate" fabricScoped="true"/> |
| <mandatoryConform/> |
| <field id="0" name="StreamUsage" type="StreamUsageEnum"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="OriginatingEndpointID" type="endpoint-no"> |
| <mandatoryConform/> |
| </field> |
| <field id="2" name="VideoStreamID" type="VideoStreamID"> |
| <quality nullable="true"/> |
| <optionalConform choice="a" more="true" min="1"/> |
| </field> |
| <field id="3" name="AudioStreamID" type="AudioStreamID"> |
| <quality nullable="true"/> |
| <optionalConform choice="a" more="true" min="1"/> |
| </field> |
| <field id="4" name="ICEServers" type="list"> |
| <entry type="ICEServerStruct"/> |
| <optionalConform/> |
| <constraint> |
| <maxCount value="10"/> |
| </constraint> |
| </field> |
| <field id="5" name="ICETransportPolicy" type="string"> |
| <optionalConform/> |
| <constraint> |
| <maxLength value="16"/> |
| </constraint> |
| </field> |
| <field id="6" name="MetadataEnabled" type="bool"> |
| <mandatoryConform> |
| <feature name="METADATA"/> |
| </mandatoryConform> |
| </field> |
| </command> |
| <command id="0x01" name="SolicitOfferResponse" direction="responseFromServer"> |
| <quality largeMessage="true"/> |
| <mandatoryConform/> |
| <field id="0" name="WebRTCSessionID" type="WebRTCSessionID"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="DeferredOffer" type="bool"> |
| <mandatoryConform/> |
| </field> |
| <field id="2" name="VideoStreamID" type="VideoStreamID"> |
| <quality nullable="true"/> |
| <mandatoryConform> |
| <command name="SolicitOffer"> |
| <field name="VideoStreamID"/> |
| </command> |
| </mandatoryConform> |
| </field> |
| <field id="3" name="AudioStreamID" type="AudioStreamID"> |
| <quality nullable="true"/> |
| <mandatoryConform> |
| <command name="SolicitOffer"> |
| <field name="AudioStreamID"/> |
| </command> |
| </mandatoryConform> |
| </field> |
| </command> |
| <command id="0x02" name="ProvideOffer" direction="commandToServer" response="ProvideOfferResponse"> |
| <quality largeMessage="true"/> |
| <access invokePrivilege="operate" fabricScoped="true"/> |
| <mandatoryConform/> |
| <field id="0" name="WebRTCSessionID" type="WebRTCSessionID" default="null"> |
| <quality nullable="true"/> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="SDP" type="string"> |
| <mandatoryConform/> |
| </field> |
| <field id="2" name="StreamUsage" type="StreamUsageEnum"> |
| <mandatoryConform/> |
| </field> |
| <field id="3" name="OriginatingEndpointID" type="endpoint-no"> |
| <mandatoryConform/> |
| </field> |
| <field id="4" name="VideoStreamID" type="VideoStreamID"> |
| <quality nullable="true"/> |
| <optionalConform choice="c" more="true" min="1"/> |
| </field> |
| <field id="5" name="AudioStreamID" type="AudioStreamID"> |
| <quality nullable="true"/> |
| <optionalConform choice="c" more="true" min="1"/> |
| </field> |
| <field id="6" name="ICEServers" type="list"> |
| <entry type="ICEServerStruct"/> |
| <optionalConform/> |
| <constraint> |
| <maxCount value="10"/> |
| </constraint> |
| </field> |
| <field id="7" name="ICETransportPolicy" type="string"> |
| <optionalConform/> |
| <constraint> |
| <maxLength value="16"/> |
| </constraint> |
| </field> |
| <field id="8" name="MetadataEnabled" type="bool"> |
| <mandatoryConform> |
| <feature name="METADATA"/> |
| </mandatoryConform> |
| </field> |
| </command> |
| <command id="0x03" name="ProvideOfferResponse" direction="responseFromServer"> |
| <quality largeMessage="true"/> |
| <mandatoryConform/> |
| <field id="0" name="WebRTCSessionID" type="WebRTCSessionID"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="VideoStreamID" type="VideoStreamID"> |
| <quality nullable="true"/> |
| <mandatoryConform> |
| <command name="ProvideOffer"> |
| <field name="VideoStreamID"/> |
| </command> |
| </mandatoryConform> |
| </field> |
| <field id="2" name="AudioStreamID" type="AudioStreamID"> |
| <quality nullable="true"/> |
| <mandatoryConform> |
| <command name="ProvideOffer"> |
| <field name="AudioStreamID"/> |
| </command> |
| </mandatoryConform> |
| </field> |
| </command> |
| <command id="0x04" name="ProvideAnswer" direction="commandToServer" response="Y"> |
| <quality largeMessage="true"/> |
| <access invokePrivilege="operate" fabricScoped="true"/> |
| <mandatoryConform/> |
| <field id="0" name="WebRTCSessionID" type="WebRTCSessionID"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="SDP" type="string"> |
| <mandatoryConform/> |
| </field> |
| </command> |
| <command id="0x05" name="ProvideICECandidates" direction="commandToServer" response="Y"> |
| <quality largeMessage="true"/> |
| <access invokePrivilege="operate" fabricScoped="true"/> |
| <mandatoryConform/> |
| <field id="0" name="WebRTCSessionID" type="WebRTCSessionID"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="ICECandidates" type="list"> |
| <entry type="ICECandidateStruct"/> |
| <mandatoryConform/> |
| <constraint> |
| <minCount value="1"/> |
| </constraint> |
| </field> |
| </command> |
| <command id="0x06" name="EndSession" direction="commandToServer" response="Y"> |
| <quality largeMessage="true"/> |
| <access invokePrivilege="operate" fabricScoped="true"/> |
| <mandatoryConform/> |
| <field id="0" name="WebRTCSessionID" type="WebRTCSessionID"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="Reason" type="WebRTCEndReasonEnum"> |
| <default> |
| <enum default="UnknownReason"/> |
| </default> |
| <mandatoryConform/> |
| </field> |
| </command> |
| </commands> |
| </cluster> |
