@whereby.com/media 11.0.0 → 11.1.1

package/dist/index.cjs

@@ -3924,7 +3924,7 @@ class VegaConnection extends EventEmitter.EventEmitter {
         this.socket.onclose = this._onClose.bind(this);
         this.socket.onerror = this._onError.bind(this);
     }
-    _tearDown() {
+    _tearDown(event) {
         if (this.socket === null)
             return;
         this.socket.onopen = null;
@@ -3933,7 +3933,7 @@ class VegaConnection extends EventEmitter.EventEmitter {
         this.socket.onerror = null;
         this.socket = null;
         this.sents.forEach((sent) => sent.close());
-        this.emit("close");
+        this.emit("close", event);
     }
     close() {
         var _a;
@@ -3953,9 +3953,9 @@ class VegaConnection extends EventEmitter.EventEmitter {
             this.emit("message", socketMessage);
         }
     }
-    _onClose() {
+    _onClose(event) {
         logger$3.info("Disconnected");
-        this._tearDown();
+        this._tearDown(event);
     }
     _onError(error) {
         logger$3.info("Error", error);
@@ -6621,10 +6621,12 @@ function startPerformanceMonitor({ onMetricsUpdated, onTerminated, isHidden, })
 }
 
 const logger$1 = new Logger();
+const SFU_BASE_URL = "wss://any.sfu.svc.whereby.com";
 class BandwidthTester extends EventEmitter {
-    constructor({ features } = {}) {
+    constructor({ token, features }) {
         super();
         this.closed = false;
+        this._token = token;
         this._features = features || {};
         this._vegaConnection = null;
         this._mediasoupDeviceInitializedAsync = getMediasoupDeviceAsync(this._features);
@@ -6654,22 +6656,33 @@ class BandwidthTester extends EventEmitter {
                     timeout: true,
                 },
             });
-            return this.close();
+            this.close();
+            return;
         }
         this._runTime = runTime;
         this._startTime = Date.now();
-        const host = this._features.sfuServerOverrideHost || "any.sfu.svc.whereby.com";
-        const wsUrl = `wss://${host}`;
-        this._vegaConnection = new VegaConnection(wsUrl, { protocol: "whereby-sfu#bw-test-v1" });
+        const host = this._features.sfuServerOverrideHost && !this._features.sfuServerOverrideHost.startsWith("wss://")
+            ? `wss://${this._features.sfuServerOverrideHost}`
+            : this._features.sfuServerOverrideHost || SFU_BASE_URL;
+        const wsUrl = `${host}?bandwidthTestClaim=${this._token}`;
+        this._vegaConnection = new VegaConnection(wsUrl, {
+            protocol: "whereby-sfu#bw-test-v1",
+        });
         this._vegaConnection.on("open", () => this._start());
-        this._vegaConnection.on("close", () => this.close(true));
+        this._vegaConnection.on("close", (event) => this.close(true, event));
         this._vegaConnection.on("message", (message) => this._onMessage(message));
         this._startTimeout();
     }
-    close(vegaConnectionClosed) {
+    close(vegaConnectionClosed, event) {
         logger$1.info("close()");
         this.closed = true;
-        if (!!this._timeout || Date.now() - this._startTime < 750) {
+        if ((event === null || event === void 0 ? void 0 : event.code) === 1008) {
+            this.emit("result", {
+                error: true,
+                details: Object.assign(Object.assign({}, ((event === null || event === void 0 ? void 0 : event.reason) === "invalidClaim" && { invalidClaim: true })), ((event === null || event === void 0 ? void 0 : event.reason) === "connectionTimeout" && { timeout: true })),
+            });
+        }
+        else if (!!this._timeout || Date.now() - this._startTime < 750) {
             this.emit("result", {
                 error: true,
             });

package/dist/index.d.cts

@@ -1118,6 +1118,10 @@ interface VideoEnableRequestedEvent {
     requestedByClientId: string;
     enable: boolean;
 }
+interface ScreenshareEnableRequestedEvent {
+    requestedByClientId: string;
+    enable: boolean;
+}
 interface SpotlightAddedEvent {
     clientId: string;
     streamId: string;
@@ -1175,6 +1179,7 @@ interface SignalEvents {
     room_session_ended: RoomSessionEndedEvent;
     screenshare_started: ScreenshareStartedEvent;
     screenshare_stopped: ScreenshareStoppedEvent;
+    screenshare_enable_requested: ScreenshareEnableRequestedEvent;
     spotlight_added: SpotlightAddedEvent;
     spotlight_removed: SpotlightRemovedEvent;
     streaming_stopped: void;
@@ -1227,6 +1232,10 @@ interface VideoEnableRequest {
     clientIds: string[];
     enable: boolean;
 }
+interface ScreenshareEnableRequest {
+    clientId: string;
+    enable: boolean;
+}
 interface AddSpotlightRequest {
     clientId: string;
     streamId: string;
@@ -1286,6 +1295,7 @@ interface SignalRequests {
     };
     request_audio_enable: AudioEnableRequest;
     request_video_enable: VideoEnableRequest;
+    request_screenshare_enable: ScreenshareEnableRequest;
     send_client_metadata: {
         type: string;
         payload: {
@@ -1325,6 +1335,7 @@ declare function trackAnnotations(o: MediaStreamTrack): TrackAnnotation;
 
 declare class BandwidthTester extends EventEmitter {
     closed: boolean;
+    _token: string;
     _features: any;
     _vegaConnection: any;
     _mediasoupDeviceInitializedAsync: Promise<Device | null>;
@@ -1342,11 +1353,12 @@ declare class BandwidthTester extends EventEmitter {
     _canvas: any;
     _drawInterval: any;
     _resultTimeout: ClearableTimeout | null;
-    constructor({ features }?: {
+    constructor({ token, features }: {
+        token: string;
         features?: any;
     });
     start(runTime?: number): void;
-    close(vegaConnectionClosed?: boolean): void;
+    close(vegaConnectionClosed?: boolean, event?: any): void;
     _start(): Promise<void>;
     _createTransport(send: any): Promise<void>;
     _getTestTrack(): any;
@@ -1848,11 +1860,11 @@ declare class VegaConnection extends EventEmitter$1 {
     incrementAnalyticMetric?: VegaIncrementAnalyticMetric;
     constructor(wsUrl: string, { protocol, incrementAnalyticMetric }: VegaConnectionOptions);
     _setupSocket(): void;
-    _tearDown(): void;
+    _tearDown(event?: CloseEvent): void;
     close(): void;
     _onOpen(): void;
     _onMessage(event: MessageEvent): void;
-    _onClose(): void;
+    _onClose(event?: CloseEvent): void;
     _onError(error: any): void;
     _handleResponse(socketMessage: any): void;
     send(message: any): void;
@@ -2148,4 +2160,4 @@ declare class VegaRtcManager implements RtcManager {
 }
 
 export { ADDITIONAL_SCREEN_SHARE_SETTINGS, AUDIO_SETTINGS, BandwidthTester, CAMERA_STREAM_ID, EVENTS, FILE_SHARE_ERROR_CODES, KNOCK_MESSAGES, KalmanFilter, Logger, MEDIA_JITTER_BUFFER_TARGET, NoDevicesError, P2pRtcManager, PROTOCOL_ERRORS, PROTOCOL_EVENTS, PROTOCOL_REQUESTS, PROTOCOL_RESPONSES, RELAY_MESSAGES, ReconnectManager, RtcEventNames, RtcManagerDispatcher, SCREEN_SHARE_SETTINGS, SCREEN_SHARE_SIMULCAST_SETTINGS, STREAM_TYPES, ServerSocket, Session, SfuV2Parser, TYPES, VIDEO_SETTINGS_HD, VIDEO_SETTINGS_SD, VIDEO_SETTINGS_VP9, VIDEO_SETTINGS_VP9_LOW_BANDWIDTH, VegaConnection, VegaMediaQualityMonitor, VegaRtcManager, addAbsCaptureTimeExtMap, addExtMap, assert, buildDeviceList, calculateStd, captureAudioSsrcMetrics, captureCandidatePairInfoMetrics, captureCommonSsrcMetrics, captureSsrcInfo, captureVideoSsrcMetrics, cleanSdp, compareLocalDevices, createACFCalculator, createMicAnalyser, createWorker, deprioritizeH264, enumerate, external_stun_servers, filterMidExtension, filterMsidSemantic, fromLocation, generateByteString, getConstraints, getCurrentPeerConnections, getDeviceData, getDisplayMedia, getInitialStream, getIssuesAndMetrics, getMediaConstraints, getMediaSettings, getMediasoupDeviceAsync, getNumFailedStatsReports, getNumFailedTrackSsrcLookups, getNumMissingTrackSsrcLookups, getPeerConnectionIndex, getStats, getStream, getUpdatedDevices, getUpdatedStats, getUserMedia, hasGetDisplayMedia, ipRegex, isFileShareError, isMobile, issueDetectorOrMetricEnabled, maybeTurnOnly, modifyMediaCapabilities, removePeerConnection, replaceTracksInStream, _default as rtcManagerEvents, rtcStats, setClientProvider, setCodecPreferenceSDP, setPeerConnectionsForTests, setVideoBandwidthUsingSetParameters, sortCodecs, standardDeviation, startPerformanceMonitor, stopStreamTracks, subscribeIssues, subscribeStats, trackAnnotations, turnServerOverride, updateRenderedDimensions, variance };
-export type { AddCameraStreamOptions, AddSpotlightRequest, AudioEnableRequest, AudioEnableRequestedEvent, AudioEnabledEvent, BreakoutConfig, BreakoutGroupJoinedEvent, BreakoutSessionUpdateRequest, BreakoutSessionUpdatedEvent, BuildDeviceListOptions, CannotJoinUnclaimedRoomError, ChatFileShare, ChatMessage, ChatMessageError, ChatMessageRemoved, ChatMessageRequest, ClearableTimeout, ClientKickedEvent, ClientLeftEvent, ClientMetadataPayload, ClientMetadataReceivedEvent, ClientRole, ClientUnableToJoinEvent, CloudRecordingStartedEvent, Codec, ConnectionStatus, Credentials, FileShareErrorCode, FileUploadUrl, ForbiddenError, ForbiddenErrorNames, GetConstraintsOptions, GetDeviceDataResult, GetInitialStreamOptions, GetMediaConstraintsOptions, GetStreamOptions, GetStreamResult, GetUpdatedDevicesResult, GetUserMediaAttempt, GetUserMediaAttemptOutcome, HostPresenceControlsError, IdentifyDeviceRequest, InternalServerError, InvalidAssistantKeyError, IssuesAndMetricsByView, JoinRoomRequest, KnockAcceptedEvent, KnockOnHoldEvent, KnockRejectedEvent, KnockResponse, KnockResponseSender, KnockRoomRequest, KnockerLeftEvent, LiveCaptionEvent, LiveCaptionsStartedEvent, LiveCaptionsStoppedEvent, LiveTranscriptionStartedEvent, LiveTranscriptionStoppedEvent, MaxViewerLimitReachedError, MediaPrefs, Metric, NewClientEvent, OrganizationAssistantNotEnabledError, OrganizationAssistantNotFoundError, OrganizationPlanExhaustedError, RemoveScreenshareStreamOptions, RemoveSpotlightRequest, RoleName, RoomConcurrencyControlsError, RoomEmptyError, RoomFullError, RoomJoinPermissionDeniedError, RoomJoinedErrors, RoomJoinedEvent, RoomJoinedSuccess, RoomKnockedEvent, RoomLockedError, RoomLockedEvent, RoomMeetingTimeExhaustedError, RoomMode, RoomSessionEndedEvent, RtcClientConnectionStatusChangedPayload, RtcEventEmitter, RtcEvents, RtcLocalStreamTrackAddedPayload, RtcLocalStreamTrackRemovedPayload, RtcManager, RtcManagerCreatedPayload, RtcManagerOptions, RtcStreamAddedPayload, ScreenshareStartedEvent, ScreenshareStoppedEvent, SendClientMetadataRequest, SignalClient, SignalEvents, SignalIceCandidateMessage, SignalIceEndOfCandidatesMessage, SignalIceServer, SignalKnocker, SignalMediaServerConfig, SignalRTCSessionDescription, SignalReadyToReceiveOfferMessage, SignalRequests, SignalRoom, SignalSDPMessage, SignalSFUServer, SignalTurnServer, SocketConf, SocketManager, Spotlight, SpotlightAddedEvent, SpotlightRemovedEvent, StatsMonitorOptions, StatsMonitorState, StatsSubscription, TurnTransportProtocol, UniqueRoleAlreadyInRoomError, UpdatedDeviceInfo, UpdatedDevicesInfo, VegaConnectionOptions, VegaRtcManagerOptions, VideoEnableRequest, VideoEnableRequestedEvent, VideoEnabledEvent, WebRTCProvider };
+export type { AddCameraStreamOptions, AddSpotlightRequest, AudioEnableRequest, AudioEnableRequestedEvent, AudioEnabledEvent, BreakoutConfig, BreakoutGroupJoinedEvent, BreakoutSessionUpdateRequest, BreakoutSessionUpdatedEvent, BuildDeviceListOptions, CannotJoinUnclaimedRoomError, ChatFileShare, ChatMessage, ChatMessageError, ChatMessageRemoved, ChatMessageRequest, ClearableTimeout, ClientKickedEvent, ClientLeftEvent, ClientMetadataPayload, ClientMetadataReceivedEvent, ClientRole, ClientUnableToJoinEvent, CloudRecordingStartedEvent, Codec, ConnectionStatus, Credentials, FileShareErrorCode, FileUploadUrl, ForbiddenError, ForbiddenErrorNames, GetConstraintsOptions, GetDeviceDataResult, GetInitialStreamOptions, GetMediaConstraintsOptions, GetStreamOptions, GetStreamResult, GetUpdatedDevicesResult, GetUserMediaAttempt, GetUserMediaAttemptOutcome, HostPresenceControlsError, IdentifyDeviceRequest, InternalServerError, InvalidAssistantKeyError, IssuesAndMetricsByView, JoinRoomRequest, KnockAcceptedEvent, KnockOnHoldEvent, KnockRejectedEvent, KnockResponse, KnockResponseSender, KnockRoomRequest, KnockerLeftEvent, LiveCaptionEvent, LiveCaptionsStartedEvent, LiveCaptionsStoppedEvent, LiveTranscriptionStartedEvent, LiveTranscriptionStoppedEvent, MaxViewerLimitReachedError, MediaPrefs, Metric, NewClientEvent, OrganizationAssistantNotEnabledError, OrganizationAssistantNotFoundError, OrganizationPlanExhaustedError, RemoveScreenshareStreamOptions, RemoveSpotlightRequest, RoleName, RoomConcurrencyControlsError, RoomEmptyError, RoomFullError, RoomJoinPermissionDeniedError, RoomJoinedErrors, RoomJoinedEvent, RoomJoinedSuccess, RoomKnockedEvent, RoomLockedError, RoomLockedEvent, RoomMeetingTimeExhaustedError, RoomMode, RoomSessionEndedEvent, RtcClientConnectionStatusChangedPayload, RtcEventEmitter, RtcEvents, RtcLocalStreamTrackAddedPayload, RtcLocalStreamTrackRemovedPayload, RtcManager, RtcManagerCreatedPayload, RtcManagerOptions, RtcStreamAddedPayload, ScreenshareEnableRequest, ScreenshareEnableRequestedEvent, ScreenshareStartedEvent, ScreenshareStoppedEvent, SendClientMetadataRequest, SignalClient, SignalEvents, SignalIceCandidateMessage, SignalIceEndOfCandidatesMessage, SignalIceServer, SignalKnocker, SignalMediaServerConfig, SignalRTCSessionDescription, SignalReadyToReceiveOfferMessage, SignalRequests, SignalRoom, SignalSDPMessage, SignalSFUServer, SignalTurnServer, SocketConf, SocketManager, Spotlight, SpotlightAddedEvent, SpotlightRemovedEvent, StatsMonitorOptions, StatsMonitorState, StatsSubscription, TurnTransportProtocol, UniqueRoleAlreadyInRoomError, UpdatedDeviceInfo, UpdatedDevicesInfo, VegaConnectionOptions, VegaRtcManagerOptions, VideoEnableRequest, VideoEnableRequestedEvent, VideoEnabledEvent, WebRTCProvider };

package/dist/index.d.mts

@@ -1118,6 +1118,10 @@ interface VideoEnableRequestedEvent {
     requestedByClientId: string;
     enable: boolean;
 }
+interface ScreenshareEnableRequestedEvent {
+    requestedByClientId: string;
+    enable: boolean;
+}
 interface SpotlightAddedEvent {
     clientId: string;
     streamId: string;
@@ -1175,6 +1179,7 @@ interface SignalEvents {
     room_session_ended: RoomSessionEndedEvent;
     screenshare_started: ScreenshareStartedEvent;
     screenshare_stopped: ScreenshareStoppedEvent;
+    screenshare_enable_requested: ScreenshareEnableRequestedEvent;
     spotlight_added: SpotlightAddedEvent;
     spotlight_removed: SpotlightRemovedEvent;
     streaming_stopped: void;
@@ -1227,6 +1232,10 @@ interface VideoEnableRequest {
     clientIds: string[];
     enable: boolean;
 }
+interface ScreenshareEnableRequest {
+    clientId: string;
+    enable: boolean;
+}
 interface AddSpotlightRequest {
     clientId: string;
     streamId: string;
@@ -1286,6 +1295,7 @@ interface SignalRequests {
     };
     request_audio_enable: AudioEnableRequest;
     request_video_enable: VideoEnableRequest;
+    request_screenshare_enable: ScreenshareEnableRequest;
     send_client_metadata: {
         type: string;
         payload: {
@@ -1325,6 +1335,7 @@ declare function trackAnnotations(o: MediaStreamTrack): TrackAnnotation;
 
 declare class BandwidthTester extends EventEmitter {
     closed: boolean;
+    _token: string;
     _features: any;
     _vegaConnection: any;
     _mediasoupDeviceInitializedAsync: Promise<Device | null>;
@@ -1342,11 +1353,12 @@ declare class BandwidthTester extends EventEmitter {
     _canvas: any;
     _drawInterval: any;
     _resultTimeout: ClearableTimeout | null;
-    constructor({ features }?: {
+    constructor({ token, features }: {
+        token: string;
         features?: any;
     });
     start(runTime?: number): void;
-    close(vegaConnectionClosed?: boolean): void;
+    close(vegaConnectionClosed?: boolean, event?: any): void;
     _start(): Promise<void>;
     _createTransport(send: any): Promise<void>;
     _getTestTrack(): any;
@@ -1848,11 +1860,11 @@ declare class VegaConnection extends EventEmitter$1 {
     incrementAnalyticMetric?: VegaIncrementAnalyticMetric;
     constructor(wsUrl: string, { protocol, incrementAnalyticMetric }: VegaConnectionOptions);
     _setupSocket(): void;
-    _tearDown(): void;
+    _tearDown(event?: CloseEvent): void;
     close(): void;
     _onOpen(): void;
     _onMessage(event: MessageEvent): void;
-    _onClose(): void;
+    _onClose(event?: CloseEvent): void;
     _onError(error: any): void;
     _handleResponse(socketMessage: any): void;
     send(message: any): void;
@@ -2148,4 +2160,4 @@ declare class VegaRtcManager implements RtcManager {
 }
 
 export { ADDITIONAL_SCREEN_SHARE_SETTINGS, AUDIO_SETTINGS, BandwidthTester, CAMERA_STREAM_ID, EVENTS, FILE_SHARE_ERROR_CODES, KNOCK_MESSAGES, KalmanFilter, Logger, MEDIA_JITTER_BUFFER_TARGET, NoDevicesError, P2pRtcManager, PROTOCOL_ERRORS, PROTOCOL_EVENTS, PROTOCOL_REQUESTS, PROTOCOL_RESPONSES, RELAY_MESSAGES, ReconnectManager, RtcEventNames, RtcManagerDispatcher, SCREEN_SHARE_SETTINGS, SCREEN_SHARE_SIMULCAST_SETTINGS, STREAM_TYPES, ServerSocket, Session, SfuV2Parser, TYPES, VIDEO_SETTINGS_HD, VIDEO_SETTINGS_SD, VIDEO_SETTINGS_VP9, VIDEO_SETTINGS_VP9_LOW_BANDWIDTH, VegaConnection, VegaMediaQualityMonitor, VegaRtcManager, addAbsCaptureTimeExtMap, addExtMap, assert, buildDeviceList, calculateStd, captureAudioSsrcMetrics, captureCandidatePairInfoMetrics, captureCommonSsrcMetrics, captureSsrcInfo, captureVideoSsrcMetrics, cleanSdp, compareLocalDevices, createACFCalculator, createMicAnalyser, createWorker, deprioritizeH264, enumerate, external_stun_servers, filterMidExtension, filterMsidSemantic, fromLocation, generateByteString, getConstraints, getCurrentPeerConnections, getDeviceData, getDisplayMedia, getInitialStream, getIssuesAndMetrics, getMediaConstraints, getMediaSettings, getMediasoupDeviceAsync, getNumFailedStatsReports, getNumFailedTrackSsrcLookups, getNumMissingTrackSsrcLookups, getPeerConnectionIndex, getStats, getStream, getUpdatedDevices, getUpdatedStats, getUserMedia, hasGetDisplayMedia, ipRegex, isFileShareError, isMobile, issueDetectorOrMetricEnabled, maybeTurnOnly, modifyMediaCapabilities, removePeerConnection, replaceTracksInStream, _default as rtcManagerEvents, rtcStats, setClientProvider, setCodecPreferenceSDP, setPeerConnectionsForTests, setVideoBandwidthUsingSetParameters, sortCodecs, standardDeviation, startPerformanceMonitor, stopStreamTracks, subscribeIssues, subscribeStats, trackAnnotations, turnServerOverride, updateRenderedDimensions, variance };
-export type { AddCameraStreamOptions, AddSpotlightRequest, AudioEnableRequest, AudioEnableRequestedEvent, AudioEnabledEvent, BreakoutConfig, BreakoutGroupJoinedEvent, BreakoutSessionUpdateRequest, BreakoutSessionUpdatedEvent, BuildDeviceListOptions, CannotJoinUnclaimedRoomError, ChatFileShare, ChatMessage, ChatMessageError, ChatMessageRemoved, ChatMessageRequest, ClearableTimeout, ClientKickedEvent, ClientLeftEvent, ClientMetadataPayload, ClientMetadataReceivedEvent, ClientRole, ClientUnableToJoinEvent, CloudRecordingStartedEvent, Codec, ConnectionStatus, Credentials, FileShareErrorCode, FileUploadUrl, ForbiddenError, ForbiddenErrorNames, GetConstraintsOptions, GetDeviceDataResult, GetInitialStreamOptions, GetMediaConstraintsOptions, GetStreamOptions, GetStreamResult, GetUpdatedDevicesResult, GetUserMediaAttempt, GetUserMediaAttemptOutcome, HostPresenceControlsError, IdentifyDeviceRequest, InternalServerError, InvalidAssistantKeyError, IssuesAndMetricsByView, JoinRoomRequest, KnockAcceptedEvent, KnockOnHoldEvent, KnockRejectedEvent, KnockResponse, KnockResponseSender, KnockRoomRequest, KnockerLeftEvent, LiveCaptionEvent, LiveCaptionsStartedEvent, LiveCaptionsStoppedEvent, LiveTranscriptionStartedEvent, LiveTranscriptionStoppedEvent, MaxViewerLimitReachedError, MediaPrefs, Metric, NewClientEvent, OrganizationAssistantNotEnabledError, OrganizationAssistantNotFoundError, OrganizationPlanExhaustedError, RemoveScreenshareStreamOptions, RemoveSpotlightRequest, RoleName, RoomConcurrencyControlsError, RoomEmptyError, RoomFullError, RoomJoinPermissionDeniedError, RoomJoinedErrors, RoomJoinedEvent, RoomJoinedSuccess, RoomKnockedEvent, RoomLockedError, RoomLockedEvent, RoomMeetingTimeExhaustedError, RoomMode, RoomSessionEndedEvent, RtcClientConnectionStatusChangedPayload, RtcEventEmitter, RtcEvents, RtcLocalStreamTrackAddedPayload, RtcLocalStreamTrackRemovedPayload, RtcManager, RtcManagerCreatedPayload, RtcManagerOptions, RtcStreamAddedPayload, ScreenshareStartedEvent, ScreenshareStoppedEvent, SendClientMetadataRequest, SignalClient, SignalEvents, SignalIceCandidateMessage, SignalIceEndOfCandidatesMessage, SignalIceServer, SignalKnocker, SignalMediaServerConfig, SignalRTCSessionDescription, SignalReadyToReceiveOfferMessage, SignalRequests, SignalRoom, SignalSDPMessage, SignalSFUServer, SignalTurnServer, SocketConf, SocketManager, Spotlight, SpotlightAddedEvent, SpotlightRemovedEvent, StatsMonitorOptions, StatsMonitorState, StatsSubscription, TurnTransportProtocol, UniqueRoleAlreadyInRoomError, UpdatedDeviceInfo, UpdatedDevicesInfo, VegaConnectionOptions, VegaRtcManagerOptions, VideoEnableRequest, VideoEnableRequestedEvent, VideoEnabledEvent, WebRTCProvider };
+export type { AddCameraStreamOptions, AddSpotlightRequest, AudioEnableRequest, AudioEnableRequestedEvent, AudioEnabledEvent, BreakoutConfig, BreakoutGroupJoinedEvent, BreakoutSessionUpdateRequest, BreakoutSessionUpdatedEvent, BuildDeviceListOptions, CannotJoinUnclaimedRoomError, ChatFileShare, ChatMessage, ChatMessageError, ChatMessageRemoved, ChatMessageRequest, ClearableTimeout, ClientKickedEvent, ClientLeftEvent, ClientMetadataPayload, ClientMetadataReceivedEvent, ClientRole, ClientUnableToJoinEvent, CloudRecordingStartedEvent, Codec, ConnectionStatus, Credentials, FileShareErrorCode, FileUploadUrl, ForbiddenError, ForbiddenErrorNames, GetConstraintsOptions, GetDeviceDataResult, GetInitialStreamOptions, GetMediaConstraintsOptions, GetStreamOptions, GetStreamResult, GetUpdatedDevicesResult, GetUserMediaAttempt, GetUserMediaAttemptOutcome, HostPresenceControlsError, IdentifyDeviceRequest, InternalServerError, InvalidAssistantKeyError, IssuesAndMetricsByView, JoinRoomRequest, KnockAcceptedEvent, KnockOnHoldEvent, KnockRejectedEvent, KnockResponse, KnockResponseSender, KnockRoomRequest, KnockerLeftEvent, LiveCaptionEvent, LiveCaptionsStartedEvent, LiveCaptionsStoppedEvent, LiveTranscriptionStartedEvent, LiveTranscriptionStoppedEvent, MaxViewerLimitReachedError, MediaPrefs, Metric, NewClientEvent, OrganizationAssistantNotEnabledError, OrganizationAssistantNotFoundError, OrganizationPlanExhaustedError, RemoveScreenshareStreamOptions, RemoveSpotlightRequest, RoleName, RoomConcurrencyControlsError, RoomEmptyError, RoomFullError, RoomJoinPermissionDeniedError, RoomJoinedErrors, RoomJoinedEvent, RoomJoinedSuccess, RoomKnockedEvent, RoomLockedError, RoomLockedEvent, RoomMeetingTimeExhaustedError, RoomMode, RoomSessionEndedEvent, RtcClientConnectionStatusChangedPayload, RtcEventEmitter, RtcEvents, RtcLocalStreamTrackAddedPayload, RtcLocalStreamTrackRemovedPayload, RtcManager, RtcManagerCreatedPayload, RtcManagerOptions, RtcStreamAddedPayload, ScreenshareEnableRequest, ScreenshareEnableRequestedEvent, ScreenshareStartedEvent, ScreenshareStoppedEvent, SendClientMetadataRequest, SignalClient, SignalEvents, SignalIceCandidateMessage, SignalIceEndOfCandidatesMessage, SignalIceServer, SignalKnocker, SignalMediaServerConfig, SignalRTCSessionDescription, SignalReadyToReceiveOfferMessage, SignalRequests, SignalRoom, SignalSDPMessage, SignalSFUServer, SignalTurnServer, SocketConf, SocketManager, Spotlight, SpotlightAddedEvent, SpotlightRemovedEvent, StatsMonitorOptions, StatsMonitorState, StatsSubscription, TurnTransportProtocol, UniqueRoleAlreadyInRoomError, UpdatedDeviceInfo, UpdatedDevicesInfo, VegaConnectionOptions, VegaRtcManagerOptions, VideoEnableRequest, VideoEnableRequestedEvent, VideoEnabledEvent, WebRTCProvider };

package/dist/index.d.ts

@@ -1118,6 +1118,10 @@ interface VideoEnableRequestedEvent {
     requestedByClientId: string;
     enable: boolean;
 }
+interface ScreenshareEnableRequestedEvent {
+    requestedByClientId: string;
+    enable: boolean;
+}
 interface SpotlightAddedEvent {
     clientId: string;
     streamId: string;
@@ -1175,6 +1179,7 @@ interface SignalEvents {
     room_session_ended: RoomSessionEndedEvent;
     screenshare_started: ScreenshareStartedEvent;
     screenshare_stopped: ScreenshareStoppedEvent;
+    screenshare_enable_requested: ScreenshareEnableRequestedEvent;
     spotlight_added: SpotlightAddedEvent;
     spotlight_removed: SpotlightRemovedEvent;
     streaming_stopped: void;
@@ -1227,6 +1232,10 @@ interface VideoEnableRequest {
     clientIds: string[];
     enable: boolean;
 }
+interface ScreenshareEnableRequest {
+    clientId: string;
+    enable: boolean;
+}
 interface AddSpotlightRequest {
     clientId: string;
     streamId: string;
@@ -1286,6 +1295,7 @@ interface SignalRequests {
     };
     request_audio_enable: AudioEnableRequest;
     request_video_enable: VideoEnableRequest;
+    request_screenshare_enable: ScreenshareEnableRequest;
     send_client_metadata: {
         type: string;
         payload: {
@@ -1325,6 +1335,7 @@ declare function trackAnnotations(o: MediaStreamTrack): TrackAnnotation;
 
 declare class BandwidthTester extends EventEmitter {
     closed: boolean;
+    _token: string;
     _features: any;
     _vegaConnection: any;
     _mediasoupDeviceInitializedAsync: Promise<Device | null>;
@@ -1342,11 +1353,12 @@ declare class BandwidthTester extends EventEmitter {
     _canvas: any;
     _drawInterval: any;
     _resultTimeout: ClearableTimeout | null;
-    constructor({ features }?: {
+    constructor({ token, features }: {
+        token: string;
         features?: any;
     });
     start(runTime?: number): void;
-    close(vegaConnectionClosed?: boolean): void;
+    close(vegaConnectionClosed?: boolean, event?: any): void;
     _start(): Promise<void>;
     _createTransport(send: any): Promise<void>;
     _getTestTrack(): any;
@@ -1848,11 +1860,11 @@ declare class VegaConnection extends EventEmitter$1 {
     incrementAnalyticMetric?: VegaIncrementAnalyticMetric;
     constructor(wsUrl: string, { protocol, incrementAnalyticMetric }: VegaConnectionOptions);
     _setupSocket(): void;
-    _tearDown(): void;
+    _tearDown(event?: CloseEvent): void;
     close(): void;
     _onOpen(): void;
     _onMessage(event: MessageEvent): void;
-    _onClose(): void;
+    _onClose(event?: CloseEvent): void;
     _onError(error: any): void;
     _handleResponse(socketMessage: any): void;
     send(message: any): void;
@@ -2148,4 +2160,4 @@ declare class VegaRtcManager implements RtcManager {
 }
 
 export { ADDITIONAL_SCREEN_SHARE_SETTINGS, AUDIO_SETTINGS, BandwidthTester, CAMERA_STREAM_ID, EVENTS, FILE_SHARE_ERROR_CODES, KNOCK_MESSAGES, KalmanFilter, Logger, MEDIA_JITTER_BUFFER_TARGET, NoDevicesError, P2pRtcManager, PROTOCOL_ERRORS, PROTOCOL_EVENTS, PROTOCOL_REQUESTS, PROTOCOL_RESPONSES, RELAY_MESSAGES, ReconnectManager, RtcEventNames, RtcManagerDispatcher, SCREEN_SHARE_SETTINGS, SCREEN_SHARE_SIMULCAST_SETTINGS, STREAM_TYPES, ServerSocket, Session, SfuV2Parser, TYPES, VIDEO_SETTINGS_HD, VIDEO_SETTINGS_SD, VIDEO_SETTINGS_VP9, VIDEO_SETTINGS_VP9_LOW_BANDWIDTH, VegaConnection, VegaMediaQualityMonitor, VegaRtcManager, addAbsCaptureTimeExtMap, addExtMap, assert, buildDeviceList, calculateStd, captureAudioSsrcMetrics, captureCandidatePairInfoMetrics, captureCommonSsrcMetrics, captureSsrcInfo, captureVideoSsrcMetrics, cleanSdp, compareLocalDevices, createACFCalculator, createMicAnalyser, createWorker, deprioritizeH264, enumerate, external_stun_servers, filterMidExtension, filterMsidSemantic, fromLocation, generateByteString, getConstraints, getCurrentPeerConnections, getDeviceData, getDisplayMedia, getInitialStream, getIssuesAndMetrics, getMediaConstraints, getMediaSettings, getMediasoupDeviceAsync, getNumFailedStatsReports, getNumFailedTrackSsrcLookups, getNumMissingTrackSsrcLookups, getPeerConnectionIndex, getStats, getStream, getUpdatedDevices, getUpdatedStats, getUserMedia, hasGetDisplayMedia, ipRegex, isFileShareError, isMobile, issueDetectorOrMetricEnabled, maybeTurnOnly, modifyMediaCapabilities, removePeerConnection, replaceTracksInStream, _default as rtcManagerEvents, rtcStats, setClientProvider, setCodecPreferenceSDP, setPeerConnectionsForTests, setVideoBandwidthUsingSetParameters, sortCodecs, standardDeviation, startPerformanceMonitor, stopStreamTracks, subscribeIssues, subscribeStats, trackAnnotations, turnServerOverride, updateRenderedDimensions, variance };
-export type { AddCameraStreamOptions, AddSpotlightRequest, AudioEnableRequest, AudioEnableRequestedEvent, AudioEnabledEvent, BreakoutConfig, BreakoutGroupJoinedEvent, BreakoutSessionUpdateRequest, BreakoutSessionUpdatedEvent, BuildDeviceListOptions, CannotJoinUnclaimedRoomError, ChatFileShare, ChatMessage, ChatMessageError, ChatMessageRemoved, ChatMessageRequest, ClearableTimeout, ClientKickedEvent, ClientLeftEvent, ClientMetadataPayload, ClientMetadataReceivedEvent, ClientRole, ClientUnableToJoinEvent, CloudRecordingStartedEvent, Codec, ConnectionStatus, Credentials, FileShareErrorCode, FileUploadUrl, ForbiddenError, ForbiddenErrorNames, GetConstraintsOptions, GetDeviceDataResult, GetInitialStreamOptions, GetMediaConstraintsOptions, GetStreamOptions, GetStreamResult, GetUpdatedDevicesResult, GetUserMediaAttempt, GetUserMediaAttemptOutcome, HostPresenceControlsError, IdentifyDeviceRequest, InternalServerError, InvalidAssistantKeyError, IssuesAndMetricsByView, JoinRoomRequest, KnockAcceptedEvent, KnockOnHoldEvent, KnockRejectedEvent, KnockResponse, KnockResponseSender, KnockRoomRequest, KnockerLeftEvent, LiveCaptionEvent, LiveCaptionsStartedEvent, LiveCaptionsStoppedEvent, LiveTranscriptionStartedEvent, LiveTranscriptionStoppedEvent, MaxViewerLimitReachedError, MediaPrefs, Metric, NewClientEvent, OrganizationAssistantNotEnabledError, OrganizationAssistantNotFoundError, OrganizationPlanExhaustedError, RemoveScreenshareStreamOptions, RemoveSpotlightRequest, RoleName, RoomConcurrencyControlsError, RoomEmptyError, RoomFullError, RoomJoinPermissionDeniedError, RoomJoinedErrors, RoomJoinedEvent, RoomJoinedSuccess, RoomKnockedEvent, RoomLockedError, RoomLockedEvent, RoomMeetingTimeExhaustedError, RoomMode, RoomSessionEndedEvent, RtcClientConnectionStatusChangedPayload, RtcEventEmitter, RtcEvents, RtcLocalStreamTrackAddedPayload, RtcLocalStreamTrackRemovedPayload, RtcManager, RtcManagerCreatedPayload, RtcManagerOptions, RtcStreamAddedPayload, ScreenshareStartedEvent, ScreenshareStoppedEvent, SendClientMetadataRequest, SignalClient, SignalEvents, SignalIceCandidateMessage, SignalIceEndOfCandidatesMessage, SignalIceServer, SignalKnocker, SignalMediaServerConfig, SignalRTCSessionDescription, SignalReadyToReceiveOfferMessage, SignalRequests, SignalRoom, SignalSDPMessage, SignalSFUServer, SignalTurnServer, SocketConf, SocketManager, Spotlight, SpotlightAddedEvent, SpotlightRemovedEvent, StatsMonitorOptions, StatsMonitorState, StatsSubscription, TurnTransportProtocol, UniqueRoleAlreadyInRoomError, UpdatedDeviceInfo, UpdatedDevicesInfo, VegaConnectionOptions, VegaRtcManagerOptions, VideoEnableRequest, VideoEnableRequestedEvent, VideoEnabledEvent, WebRTCProvider };
+export type { AddCameraStreamOptions, AddSpotlightRequest, AudioEnableRequest, AudioEnableRequestedEvent, AudioEnabledEvent, BreakoutConfig, BreakoutGroupJoinedEvent, BreakoutSessionUpdateRequest, BreakoutSessionUpdatedEvent, BuildDeviceListOptions, CannotJoinUnclaimedRoomError, ChatFileShare, ChatMessage, ChatMessageError, ChatMessageRemoved, ChatMessageRequest, ClearableTimeout, ClientKickedEvent, ClientLeftEvent, ClientMetadataPayload, ClientMetadataReceivedEvent, ClientRole, ClientUnableToJoinEvent, CloudRecordingStartedEvent, Codec, ConnectionStatus, Credentials, FileShareErrorCode, FileUploadUrl, ForbiddenError, ForbiddenErrorNames, GetConstraintsOptions, GetDeviceDataResult, GetInitialStreamOptions, GetMediaConstraintsOptions, GetStreamOptions, GetStreamResult, GetUpdatedDevicesResult, GetUserMediaAttempt, GetUserMediaAttemptOutcome, HostPresenceControlsError, IdentifyDeviceRequest, InternalServerError, InvalidAssistantKeyError, IssuesAndMetricsByView, JoinRoomRequest, KnockAcceptedEvent, KnockOnHoldEvent, KnockRejectedEvent, KnockResponse, KnockResponseSender, KnockRoomRequest, KnockerLeftEvent, LiveCaptionEvent, LiveCaptionsStartedEvent, LiveCaptionsStoppedEvent, LiveTranscriptionStartedEvent, LiveTranscriptionStoppedEvent, MaxViewerLimitReachedError, MediaPrefs, Metric, NewClientEvent, OrganizationAssistantNotEnabledError, OrganizationAssistantNotFoundError, OrganizationPlanExhaustedError, RemoveScreenshareStreamOptions, RemoveSpotlightRequest, RoleName, RoomConcurrencyControlsError, RoomEmptyError, RoomFullError, RoomJoinPermissionDeniedError, RoomJoinedErrors, RoomJoinedEvent, RoomJoinedSuccess, RoomKnockedEvent, RoomLockedError, RoomLockedEvent, RoomMeetingTimeExhaustedError, RoomMode, RoomSessionEndedEvent, RtcClientConnectionStatusChangedPayload, RtcEventEmitter, RtcEvents, RtcLocalStreamTrackAddedPayload, RtcLocalStreamTrackRemovedPayload, RtcManager, RtcManagerCreatedPayload, RtcManagerOptions, RtcStreamAddedPayload, ScreenshareEnableRequest, ScreenshareEnableRequestedEvent, ScreenshareStartedEvent, ScreenshareStoppedEvent, SendClientMetadataRequest, SignalClient, SignalEvents, SignalIceCandidateMessage, SignalIceEndOfCandidatesMessage, SignalIceServer, SignalKnocker, SignalMediaServerConfig, SignalRTCSessionDescription, SignalReadyToReceiveOfferMessage, SignalRequests, SignalRoom, SignalSDPMessage, SignalSFUServer, SignalTurnServer, SocketConf, SocketManager, Spotlight, SpotlightAddedEvent, SpotlightRemovedEvent, StatsMonitorOptions, StatsMonitorState, StatsSubscription, TurnTransportProtocol, UniqueRoleAlreadyInRoomError, UpdatedDeviceInfo, UpdatedDevicesInfo, VegaConnectionOptions, VegaRtcManagerOptions, VideoEnableRequest, VideoEnableRequestedEvent, VideoEnabledEvent, WebRTCProvider };

package/dist/index.mjs

@@ -3904,7 +3904,7 @@ class VegaConnection extends EventEmitter$1 {
         this.socket.onclose = this._onClose.bind(this);
         this.socket.onerror = this._onError.bind(this);
     }
-    _tearDown() {
+    _tearDown(event) {
         if (this.socket === null)
             return;
         this.socket.onopen = null;
@@ -3913,7 +3913,7 @@ class VegaConnection extends EventEmitter$1 {
         this.socket.onerror = null;
         this.socket = null;
         this.sents.forEach((sent) => sent.close());
-        this.emit("close");
+        this.emit("close", event);
     }
     close() {
         var _a;
@@ -3933,9 +3933,9 @@ class VegaConnection extends EventEmitter$1 {
             this.emit("message", socketMessage);
         }
     }
-    _onClose() {
+    _onClose(event) {
         logger$3.info("Disconnected");
-        this._tearDown();
+        this._tearDown(event);
     }
     _onError(error) {
         logger$3.info("Error", error);
@@ -6601,10 +6601,12 @@ function startPerformanceMonitor({ onMetricsUpdated, onTerminated, isHidden, })
 }
 
 const logger$1 = new Logger();
+const SFU_BASE_URL = "wss://any.sfu.svc.whereby.com";
 class BandwidthTester extends EventEmitter {
-    constructor({ features } = {}) {
+    constructor({ token, features }) {
         super();
         this.closed = false;
+        this._token = token;
         this._features = features || {};
         this._vegaConnection = null;
         this._mediasoupDeviceInitializedAsync = getMediasoupDeviceAsync(this._features);
@@ -6634,22 +6636,33 @@ class BandwidthTester extends EventEmitter {
                     timeout: true,
                 },
             });
-            return this.close();
+            this.close();
+            return;
         }
         this._runTime = runTime;
         this._startTime = Date.now();
-        const host = this._features.sfuServerOverrideHost || "any.sfu.svc.whereby.com";
-        const wsUrl = `wss://${host}`;
-        this._vegaConnection = new VegaConnection(wsUrl, { protocol: "whereby-sfu#bw-test-v1" });
+        const host = this._features.sfuServerOverrideHost && !this._features.sfuServerOverrideHost.startsWith("wss://")
+            ? `wss://${this._features.sfuServerOverrideHost}`
+            : this._features.sfuServerOverrideHost || SFU_BASE_URL;
+        const wsUrl = `${host}?bandwidthTestClaim=${this._token}`;
+        this._vegaConnection = new VegaConnection(wsUrl, {
+            protocol: "whereby-sfu#bw-test-v1",
+        });
         this._vegaConnection.on("open", () => this._start());
-        this._vegaConnection.on("close", () => this.close(true));
+        this._vegaConnection.on("close", (event) => this.close(true, event));
         this._vegaConnection.on("message", (message) => this._onMessage(message));
         this._startTimeout();
     }
-    close(vegaConnectionClosed) {
+    close(vegaConnectionClosed, event) {
         logger$1.info("close()");
         this.closed = true;
-        if (!!this._timeout || Date.now() - this._startTime < 750) {
+        if ((event === null || event === void 0 ? void 0 : event.code) === 1008) {
+            this.emit("result", {
+                error: true,
+                details: Object.assign(Object.assign({}, ((event === null || event === void 0 ? void 0 : event.reason) === "invalidClaim" && { invalidClaim: true })), ((event === null || event === void 0 ? void 0 : event.reason) === "connectionTimeout" && { timeout: true })),
+            });
+        }
+        else if (!!this._timeout || Date.now() - this._startTime < 750) {
             this.emit("result", {
                 error: true,
             });

package/dist/legacy-esm.js

@@ -3904,7 +3904,7 @@ class VegaConnection extends EventEmitter$1 {
         this.socket.onclose = this._onClose.bind(this);
         this.socket.onerror = this._onError.bind(this);
     }
-    _tearDown() {
+    _tearDown(event) {
         if (this.socket === null)
             return;
         this.socket.onopen = null;
@@ -3913,7 +3913,7 @@ class VegaConnection extends EventEmitter$1 {
         this.socket.onerror = null;
         this.socket = null;
         this.sents.forEach((sent) => sent.close());
-        this.emit("close");
+        this.emit("close", event);
     }
     close() {
         var _a;
@@ -3933,9 +3933,9 @@ class VegaConnection extends EventEmitter$1 {
             this.emit("message", socketMessage);
         }
     }
-    _onClose() {
+    _onClose(event) {
         logger$3.info("Disconnected");
-        this._tearDown();
+        this._tearDown(event);
     }
     _onError(error) {
         logger$3.info("Error", error);
@@ -6601,10 +6601,12 @@ function startPerformanceMonitor({ onMetricsUpdated, onTerminated, isHidden, })
 }
 
 const logger$1 = new Logger();
+const SFU_BASE_URL = "wss://any.sfu.svc.whereby.com";
 class BandwidthTester extends EventEmitter {
-    constructor({ features } = {}) {
+    constructor({ token, features }) {
         super();
         this.closed = false;
+        this._token = token;
         this._features = features || {};
         this._vegaConnection = null;
         this._mediasoupDeviceInitializedAsync = getMediasoupDeviceAsync(this._features);
@@ -6634,22 +6636,33 @@ class BandwidthTester extends EventEmitter {
                     timeout: true,
                 },
             });
-            return this.close();
+            this.close();
+            return;
         }
         this._runTime = runTime;
         this._startTime = Date.now();
-        const host = this._features.sfuServerOverrideHost || "any.sfu.svc.whereby.com";
-        const wsUrl = `wss://${host}`;
-        this._vegaConnection = new VegaConnection(wsUrl, { protocol: "whereby-sfu#bw-test-v1" });
+        const host = this._features.sfuServerOverrideHost && !this._features.sfuServerOverrideHost.startsWith("wss://")
+            ? `wss://${this._features.sfuServerOverrideHost}`
+            : this._features.sfuServerOverrideHost || SFU_BASE_URL;
+        const wsUrl = `${host}?bandwidthTestClaim=${this._token}`;
+        this._vegaConnection = new VegaConnection(wsUrl, {
+            protocol: "whereby-sfu#bw-test-v1",
+        });
         this._vegaConnection.on("open", () => this._start());
-        this._vegaConnection.on("close", () => this.close(true));
+        this._vegaConnection.on("close", (event) => this.close(true, event));
         this._vegaConnection.on("message", (message) => this._onMessage(message));
         this._startTimeout();
     }
-    close(vegaConnectionClosed) {
+    close(vegaConnectionClosed, event) {
         logger$1.info("close()");
         this.closed = true;
-        if (!!this._timeout || Date.now() - this._startTime < 750) {
+        if ((event === null || event === void 0 ? void 0 : event.code) === 1008) {
+            this.emit("result", {
+                error: true,
+                details: Object.assign(Object.assign({}, ((event === null || event === void 0 ? void 0 : event.reason) === "invalidClaim" && { invalidClaim: true })), ((event === null || event === void 0 ? void 0 : event.reason) === "connectionTimeout" && { timeout: true })),
+            });
+        }
+        else if (!!this._timeout || Date.now() - this._startTime < 750) {
             this.emit("result", {
                 error: true,
             });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@whereby.com/media",
   "description": "Media library for Whereby",
-  "version": "11.0.0",
+  "version": "11.1.1",
   "license": "MIT",
   "homepage": "https://github.com/whereby/sdk",
   "repository": {