@ikonai/sdk 1.11.3 → 1.13.0

package/webrtc/webrtc-signaling.d.ts

@@ -1,5 +1,26 @@
-import { ProtocolMessage, Opcode, WebRTCTrackMap } from '@ikonai/protocol';
+import { ProtocolMessage, Opcode, VideoCodec, WebRTCTrackMap } from '@ikonai/protocol';
 import { WebRTCConnectionState } from './webrtc-connection';
+export declare const WEBRTC_CAMERA_SENDER_INDEX = 0;
+export declare const WEBRTC_SCREEN_SENDER_INDEX = 1;
+/** What a WebRTC microphone capture is called on the client; the server names it `webrtc_{sessionId}`. */
+export declare const WEBRTC_AUDIO_CAPTURE_ID = "webrtc-audio";
+export type WebRTCVideoCaptureSource = 'camera' | 'screen';
+export interface WebRTCVideoCaptureSettings {
+    width?: number;
+    height?: number;
+    framerate?: number;
+}
+/**
+ * Track constraints for a WebRTC video capture: the explicit constraints win, and the width, height
+ * and framerate settings fill in only what they leave unset. A screen share takes only the
+ * framerate — the shared surface is captured at its native size, as the protocol-channel path does.
+ */
+export declare function buildWebRTCVideoCaptureConstraints(source: WebRTCVideoCaptureSource, settings: WebRTCVideoCaptureSettings | undefined, baseConstraints: MediaTrackConstraints | undefined): MediaTrackConstraints | undefined;
+/**
+ * The video codec an SDP negotiated: the first media codec (not RTX, RED or FEC) of the first video
+ * m-section, in the m-line's payload order. Null when the SDP has no video section or names none.
+ */
+export declare function negotiatedVideoCodecFromSdp(sdp: string): VideoCodec | null;
 export interface WebRTCSignalingConfig {
     sessionId: number;
     opcodeGroupsFromServer: Opcode;
@@ -23,6 +44,8 @@ export interface WebRTCSignalingConfig {
     onAudioTrack?: (trackIndex: number, track: MediaStreamTrack, stream: MediaStream) => void;
     onVideoTrack?: (trackIndex: number, track: MediaStreamTrack, stream: MediaStream) => void;
     onTrackMap?: (trackMap: WebRTCTrackMap) => void;
+    /** Called after a local video capture starts or stops. */
+    onVideoCaptureChanged?: () => void;
 }
 export declare class WebRTCSignaling {
     /**
@@ -38,6 +61,7 @@ export declare class WebRTCSignaling {
     private audioTrackCount;
     private videoTrackCount;
     private iceServersResolve;
+    private answerVideoCodec;
     constructor(config: WebRTCSignalingConfig);
     get state(): WebRTCConnectionState;
     get peerConnection(): RTCPeerConnection | null;
@@ -71,8 +95,16 @@ export declare class WebRTCSignaling {
      */
     getActiveVideoCaptureStream(): MediaStream | null;
     /**
-     * Look up a local video capture MediaStream by its app-level streamId.
-     * Capture streamId format: `webrtc_video_${sessionId}_${trackIndex}` (see sendVideoStreamBegin).
+     * The app-level stream id of the video capture on a sender: `webrtc_video_{sessionId}_{senderIndex}`,
+     * the id the server's VideoStreamBegin and the app's video input events carry for it.
+     */
+    videoCaptureStreamId(senderIndex: number): string;
+    /** The sender index a {@link videoCaptureStreamId} names, or null when it is not one of this session's. */
+    videoCaptureSenderIndex(streamId: string): number | null;
+    /** Whether a stream id names this session's microphone capture, by the client's or the server's name. */
+    isAudioCaptureStreamId(streamId: string): boolean;
+    /**
+     * Look up a local video capture MediaStream by its app-level streamId ({@link videoCaptureStreamId}).
      * Returns null if no local capture matches.
      */
     getLocalVideoCaptureStreamByStreamId(streamId: string): MediaStream | null;
@@ -90,7 +122,9 @@ export declare class WebRTCSignaling {
     startVideoCapture(constraints?: MediaTrackConstraints, bitrate?: number, senderIndex?: number, correlationId?: string): Promise<MediaStream>;
     startScreenCapture(constraints?: MediaTrackConstraints, bitrate?: number, senderIndex?: number, correlationId?: string): Promise<MediaStream>;
     private releaseVideoStream;
-    stopVideoCapture(senderIndex: number): Promise<void>;
+    /** Stops the video capture on one sender. False when that sender had no capture. */
+    stopVideoCapture(senderIndex: number): Promise<boolean>;
+    private negotiatedVideoCodec;
     private sendVideoStreamBegin;
     private sendVideoStreamEnd;
     /**
@@ -110,7 +144,6 @@ export declare class WebRTCSignaling {
     private requestIceServers;
     private handleIceServersResponse;
     private handleAnswer;
-    private parseVideoCodecFromSdp;
     private handleLocalIceCandidate;
     private handleRemoteIceCandidate;
     private handleReady;

package/webrtc/webrtc-signaling.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webrtc-signaling.d.ts","sourceRoot":"","sources":["../../../../sdk/sdk/src/webrtc/webrtc-signaling.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,MAAM,EA8BX,KAAK,cAAc,EACpB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,KAAK,EAA0B,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAMzF,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,OAAO,CAAC;IACvB,cAAc,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;IAC5B,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;IAC3C;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,MAAM,OAAO,CAAC;IAC/C,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,IAAI,CAAC;IACvD,oBAAoB,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAC;IACnD,iBAAiB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC/B,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAC;IAChC,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IAC1F,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IAC1F,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC;CACjD;AAED,qBAAa,eAAe;IAC1B;;;;OAIG;IACH,mBAAmB,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,GAAG,IAAI,CAAQ;IAE5D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;IAC/C,OAAO,CAAC,UAAU,CAAiC;IACnD,OAAO,CAAC,WAAW,CAAqD;IACxE,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,iBAAiB,CAAoD;gBACjE,MAAM,EAAE,qBAAqB;IAIzC,IAAI,KAAK,IAAI,qBAAqB,CAEjC;IAED,IAAI,cAAc,IAAI,iBAAiB,GAAG,IAAI,CAE7C;IAED,IAAI,iBAAiB,IAAI,OAAO,CAE/B;IAEK,OAAO,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAiE7E,qBAAqB,CAAC,OAAO,EAAE,eAAe,GAAG,UAAU,GAAG,OAAO;IA+BrE;;;;OAIG;IACH,iBAAiB,IAAI,IAAI;IASzB;;;;;;;;OAQG;IACG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAYpC,UAAU,IAAI,IAAI;IAOlB,sBAAsB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAI/C,OAAO,CAAC,kBAAkB,CAA4B;IACtD,OAAO,CAAC,uBAAuB,CAAoC;IACnE,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,mBAAmB,CAAuC;IAElE;;OAEG;IACH,2BAA2B,IAAI,WAAW,GAAG,IAAI;IASjD;;;;OAIG;IACH,oCAAoC,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI;IAmBpE,iBAAiB,CAAC,WAAW,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU3E,iBAAiB,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI;IA6C/C,eAAe,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI;YA6B/B,iBAAiB;IAuB/B,OAAO,CAAC,iBAAiB;IAazB;;;;OAIG;IACH,2BAA2B,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI;IAUxE,iBAAiB,CAAC,WAAW,CAAC,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,WAAW,SAAI,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAyBvI,kBAAkB,CAAC,WAAW,CAAC,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,WAAW,SAAI,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IA0B9I,OAAO,CAAC,kBAAkB;IAWpB,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB1D,OAAO,CAAC,oBAAoB;IAkB5B,OAAO,CAAC,kBAAkB;IAO1B;;;OAGG;IACH,gBAAgB,IAAI,IAAI;IAOlB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;YAmBpB,mBAAmB;IAiBjC,OAAO,CAAC,SAAS;IAoBjB;;;;;OAKG;YACW,iBAAiB;IA4B/B,OAAO,CAAC,wBAAwB;YAoBlB,YAAY;IAa1B,OAAO,CAAC,sBAAsB;IAK9B,OAAO,CAAC,uBAAuB;YAejB,wBAAwB;IAsBtC,OAAO,CAAC,WAAW;IAoBnB,OAAO,CAAC,cAAc;CASvB"}
+{"version":3,"file":"webrtc-signaling.d.ts","sourceRoot":"","sources":["../../../../sdk/sdk/src/webrtc/webrtc-signaling.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,MAAM,EAyBX,UAAU,EAKV,KAAK,cAAc,EACpB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,KAAK,EAA0B,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAMzF,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAC5C,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAE5C,0GAA0G;AAC1G,eAAO,MAAM,uBAAuB,iBAAiB,CAAC;AAEtD,MAAM,MAAM,wBAAwB,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE3D,MAAM,WAAW,0BAA0B;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAgB,kCAAkC,CAChD,MAAM,EAAE,wBAAwB,EAChC,QAAQ,EAAE,0BAA0B,GAAG,SAAS,EAChD,eAAe,EAAE,qBAAqB,GAAG,SAAS,GACjD,qBAAqB,GAAG,SAAS,CAyBnC;AAaD;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CA0B1E;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,OAAO,CAAC;IACvB,cAAc,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;IAC5B,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;IAC3C;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,MAAM,OAAO,CAAC;IAC/C,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,IAAI,CAAC;IACvD,oBAAoB,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAC;IACnD,iBAAiB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC/B,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAC;IAChC,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IAC1F,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IAC1F,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC;IAChD,0DAA0D;IAC1D,qBAAqB,CAAC,EAAE,MAAM,IAAI,CAAC;CACpC;AAED,qBAAa,eAAe;IAC1B;;;;OAIG;IACH,mBAAmB,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,GAAG,IAAI,CAAQ;IAE5D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;IAC/C,OAAO,CAAC,UAAU,CAAiC;IACnD,OAAO,CAAC,WAAW,CAAqD;IACxE,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,iBAAiB,CAAoD;IAC7E,OAAO,CAAC,gBAAgB,CAA2B;gBACvC,MAAM,EAAE,qBAAqB;IAIzC,IAAI,KAAK,IAAI,qBAAqB,CAEjC;IAED,IAAI,cAAc,IAAI,iBAAiB,GAAG,IAAI,CAE7C;IAED,IAAI,iBAAiB,IAAI,OAAO,CAE/B;IAEK,OAAO,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAiE7E,qBAAqB,CAAC,OAAO,EAAE,eAAe,GAAG,UAAU,GAAG,OAAO;IA+BrE;;;;OAIG;IACH,iBAAiB,IAAI,IAAI;IASzB;;;;;;;;OAQG;IACG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAYpC,UAAU,IAAI,IAAI;IAOlB,sBAAsB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAI/C,OAAO,CAAC,kBAAkB,CAA4B;IACtD,OAAO,CAAC,uBAAuB,CAAoC;IACnE,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,mBAAmB,CAAuC;IAElE;;OAEG;IACH,2BAA2B,IAAI,WAAW,GAAG,IAAI;IASjD;;;OAGG;IACH,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAIjD,2GAA2G;IAC3G,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAcxD,yGAAyG;IACzG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIjD;;;OAGG;IACH,oCAAoC,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI;IAUpE,iBAAiB,CAAC,WAAW,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU3E,iBAAiB,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI;IA6C/C,eAAe,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI;YA6B/B,iBAAiB;IAuB/B,OAAO,CAAC,iBAAiB;IAazB;;;;OAIG;IACH,2BAA2B,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI;IAUxE,iBAAiB,CAAC,WAAW,CAAC,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,WAAW,SAA6B,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IA0BhK,kBAAkB,CAAC,WAAW,CAAC,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,WAAW,SAA6B,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IA2BvK,OAAO,CAAC,kBAAkB;IAY1B,oFAAoF;IAC9E,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAsB7D,OAAO,CAAC,oBAAoB;IAoB5B,OAAO,CAAC,oBAAoB;IAkB5B,OAAO,CAAC,kBAAkB;IAO1B;;;OAGG;IACH,gBAAgB,IAAI,IAAI;IAOlB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;YAmBpB,mBAAmB;IAiBjC,OAAO,CAAC,SAAS;IAoBjB;;;;;OAKG;YACW,iBAAiB;IA4B/B,OAAO,CAAC,wBAAwB;YAoBlB,YAAY;IAa1B,OAAO,CAAC,uBAAuB;YAejB,wBAAwB;IAsBtC,OAAO,CAAC,WAAW;IAoBnB,OAAO,CAAC,cAAc;CASvB"}