@matter/types 0.17.4 → 0.17.5-alpha.0-20260702-a2cd6f764

package/src/clusters/web-rtc-transport-definitions.d.ts

@@ -16,7 +16,7 @@ import type { FabricIndex } from "../datatype/FabricIndex.js";
 /**
  * Definitions for the WebRtcTransportDefinitions cluster.
  *
- * @see {@link MatterSpecification.v151.Cluster} § 11.4
+ * @see {@link MatterSpecification.v16.Cluster} § 11.4
  */
 export declare namespace WebRtcTransportDefinitions {
     /**
@@ -25,7 +25,7 @@ export declare namespace WebRtcTransportDefinitions {
     export const name: "WebRtcTransportDefinitions";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 1;
 
@@ -37,7 +37,7 @@ export declare namespace WebRtcTransportDefinitions {
     export const schema: ClusterModel;
 
     /**
-     * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.2
+     * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.2
      */
     export enum WebRtcEndReason {
         /**
@@ -124,7 +124,7 @@ export declare namespace WebRtcTransportDefinitions {
      *     such as when devices are behind symmetric NATs, which STUN cannot traverse. TURN servers act as a relay
      *     between the peers, routing the media traffic between them.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.3
+     * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.3
      */
     export class IceServer {
         constructor(values?: Partial<IceServer>);
@@ -134,7 +134,7 @@ export declare namespace WebRtcTransportDefinitions {
          * distinguishes whether it is a STUN or TURN server (stun:, stuns:, turn:, or turns: respectively). This field
          * maps to the RTCIceServer urls field.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.3.1
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.3.1
          */
         urLs: string[];
 
@@ -143,7 +143,7 @@ export declare namespace WebRtcTransportDefinitions {
          * authentication with the STUN or TURN servers found in the URLs field. This field maps to the RTCIceServer
          * username field.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.3.2
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.3.2
          */
         username?: string;
 
@@ -152,7 +152,7 @@ export declare namespace WebRtcTransportDefinitions {
          * (password) used for authentication with the STUN or TURN servers found in the URLs field. This field maps to
          * the RTCIceServer credential field.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.3.3
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.3.3
          */
         credential?: string;
 
@@ -163,7 +163,7 @@ export declare namespace WebRtcTransportDefinitions {
          * if a turns: or stuns: url is present in the urls field and shall be used to validate those servers' presented
          * TLS root certificates.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.3.4
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.3.4
          */
         caid?: number;
     }
@@ -173,7 +173,7 @@ export declare namespace WebRtcTransportDefinitions {
      * connections through NATs (Network Address Translators) and firewalls. It mimics the model used in the W3C WebRTC
      * API RTCIceCandidate dictionary.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.4
+     * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.4
      */
     export class IceCandidate {
         constructor(values?: Partial<IceCandidate>);
@@ -188,7 +188,7 @@ export declare namespace WebRtcTransportDefinitions {
          * sdpMLineIndex into the resulting string, but this is not defined in the W3 specification. This specification
          * requires those fields to be passed directly using the named struct fields SDPMid and SDPMLineIndex.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.4.1
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.4.1
          */
         candidate: string;
 
@@ -198,7 +198,7 @@ export declare namespace WebRtcTransportDefinitions {
          * This is the same value as the W3C WebRTC API RTCIceCandidate sdpMid value. The RFCs define no max length on
          * this value.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.4.2
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.4.2
          */
         sdpMid: string | null;
 
@@ -207,7 +207,7 @@ export declare namespace WebRtcTransportDefinitions {
          * SDP with which the Candidate is associated or null if no such association exists. This is the same value as
          * the W3C WebRTC API RTCIceCandidate sdpMLineIndex value.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.4.3
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.4.3
          */
         sdpmLineIndex: number | null;
     }
@@ -219,7 +219,7 @@ export declare namespace WebRtcTransportDefinitions {
      * target, for WebRTC session related commands. The implicit field FabricIndex exists since this structure is
      * defined as Fabric Scoped.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.5
+     * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.5
      */
     export class WebRtcSession {
         constructor(values?: Partial<WebRtcSession>);
@@ -227,28 +227,28 @@ export declare namespace WebRtcTransportDefinitions {
         /**
          * This field contains the WebRTC Session ID for this session.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.5.1
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.5.1
          */
         id: number;
 
         /**
          * This field contains the NodeId for the peer entity involved in this session.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.5.2
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.5.2
          */
         peerNodeId: NodeId;
 
         /**
          * This field contains the EndpointId for the peer entity involved in this session.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.5.3
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.5.3
          */
         peerEndpointId: EndpointNumber;
 
         /**
          * This field contains the StreamUsageEnum of this session.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.5.4
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.5.4
          */
         streamUsage: StreamUsage;
 
@@ -259,7 +259,7 @@ export declare namespace WebRtcTransportDefinitions {
          * VideoStreams field shall be populated here, or null if no video stream is currently associated with this
          * session.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.5.5
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.5.5
          */
         videoStreamId?: number | null;
 
@@ -270,14 +270,14 @@ export declare namespace WebRtcTransportDefinitions {
          * AudioStreams field shall be populated here, or null if no audio stream is currently associated with this
          * session.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.5.6
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.5.6
          */
         audioStreamId?: number | null;
 
         /**
          * This field indicates if metadata is active in this session.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.5.7
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.5.7
          */
         metadataEnabled: boolean;
 
@@ -289,7 +289,7 @@ export declare namespace WebRtcTransportDefinitions {
          *
          *   - If not present, this session has no video.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.5.8
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.5.8
          */
         videoStreams?: number[];
 
@@ -301,7 +301,7 @@ export declare namespace WebRtcTransportDefinitions {
          *
          *   - If not present, this session has no audio.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 11.4.6.5.9
+         * @see {@link MatterSpecification.v16.Cluster} § 11.4.5.5.9
          */
         audioStreams?: number[];