@whereby.com/media 8.0.5 → 8.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -382,6 +382,40 @@ declare function sortCodecs(codecs: Codec[], features: {
382
382
  av1On?: boolean;
383
383
  }): Promise<Codec[]>;
384
384
 
385
+ type VegaTransportDirection = "send" | "recv";
386
+
387
+ type VegaAnalytics = {
388
+ vegaUnknownResponse: number;
389
+ vegaRequestTimeout: number;
390
+ vegaJoinFailed: number;
391
+ vegaJoinWithoutVegaConnection: number;
392
+ vegaCreateTransportWithoutVegaConnection: number;
393
+ vegaIceRestarts: number;
394
+ vegaIceRestartMissingTransport: number;
395
+ vegaIceRestartWrongTransportId: number;
396
+ vegaNonErrorRejectionValueGUMError: number;
397
+ vegaReplaceTrackNoProducerNoEnabledTrack: number;
398
+ micTrackEndedCount: number;
399
+ camTrackEndedCount: number;
400
+ };
401
+
402
+ type VegaAnalyticMetric = keyof VegaAnalytics;
403
+
404
+ type VegaIncrementAnalyticMetric = (metric: VegaAnalyticMetric) => void;
405
+
406
+ type MediaStreamWhichMayHaveInboundId = MediaStream & { inboundId?: string };
407
+
408
+ type ClientState = {
409
+ hasAcceptedWebcamStream: Boolean;
410
+ hasAcceptedScreenStream: Boolean;
411
+ hasEmittedWebcamStream: Boolean;
412
+ hasEmittedScreenStream: Boolean;
413
+ webcamStream?: MediaStreamWhichMayHaveInboundId;
414
+ screenStream?: MediaStreamWhichMayHaveInboundId;
415
+ screenShareStreamId?: string;
416
+ camStreamId?: string;
417
+ };
418
+
385
419
  declare enum RtcEventNames {
386
420
  rtc_manager_created = "rtc_manager_created",
387
421
  stream_added = "stream_added"
@@ -400,6 +434,10 @@ interface RtcManagerOptions {
400
434
  interface VegaRtcManagerOptions extends RtcManagerOptions {
401
435
  eventClaim: string;
402
436
  }
437
+ interface VegaConnectionOptions {
438
+ protocol?: string;
439
+ incrementAnalyticMetric?: VegaIncrementAnalyticMetric;
440
+ }
403
441
  interface RtcManager {
404
442
  acceptNewStream: ({ clientId, streamId }: {
405
443
  clientId: string;
@@ -1281,17 +1319,12 @@ type P2PAnalytics = {
1281
1319
  numPcOnAnswerFailure: number;
1282
1320
  numPcOnOfferFailure: number;
1283
1321
  numPcSldFailure: number;
1284
- P2PChangeBandwidthEmptySDPType: number;
1285
1322
  P2PReplaceTrackNoStream: number;
1286
1323
  P2PReplaceTrackNewTrackNotInStream: number;
1287
1324
  P2POnTrackNoStream: number;
1288
- P2PSetCodecPreferenceError: number;
1289
- P2PCreateOfferNoSDP: number;
1290
- P2PCreateAnswerNoSDP: number;
1291
1325
  P2PMicNotWorking: number;
1292
1326
  P2PLocalNetworkFailed: number;
1293
1327
  P2PRelayedIceCandidate: number;
1294
- P2PStartScreenshareNoStream: number;
1295
1328
  };
1296
1329
  type P2PAnalyticMetric = keyof P2PAnalytics;
1297
1330
  type P2PIncrementAnalyticMetric = (metric: P2PAnalyticMetric) => void;
@@ -1437,9 +1470,8 @@ declare const rtcStats: {
1437
1470
  interface SetCodecPreferenceSDPOptions {
1438
1471
  sdp: string;
1439
1472
  redOn: boolean;
1440
- incrementAnalyticMetric: P2PIncrementAnalyticMetric;
1441
1473
  }
1442
- declare function setCodecPreferenceSDP({ sdp, redOn, incrementAnalyticMetric }: SetCodecPreferenceSDPOptions): string;
1474
+ declare function setCodecPreferenceSDP({ sdp, redOn }: SetCodecPreferenceSDPOptions): string;
1443
1475
  declare function cleanSdp(sdp: string): string;
1444
1476
  declare function deprioritizeH264(sdp: any): string;
1445
1477
  declare function filterMidExtension(sdp: any): any;
@@ -1482,7 +1514,8 @@ declare class VegaConnection extends EventEmitter$1 {
1482
1514
  protocol: string;
1483
1515
  socket: WebSocket | null;
1484
1516
  sents: Map<any, any>;
1485
- constructor(wsUrl: string, protocol?: string);
1517
+ incrementAnalyticMetric?: VegaIncrementAnalyticMetric;
1518
+ constructor(wsUrl: string, { protocol, incrementAnalyticMetric }: VegaConnectionOptions);
1486
1519
  _setupSocket(): void;
1487
1520
  _tearDown(): void;
1488
1521
  close(): void;
@@ -1584,40 +1617,12 @@ declare function createVegaConnectionManager(config: {
1584
1617
  onDisconnected?: () => void;
1585
1618
  onFailed?: () => void;
1586
1619
  }): {
1587
- connect: () => void;
1620
+ connect: (incrementAnalyticMetric?: VegaIncrementAnalyticMetric) => void;
1588
1621
  updateHostList: (updatedHostList: string | HostListEntryOptionalDC[]) => void;
1589
1622
  networkIsUp: () => void;
1590
1623
  networkIsPossiblyDown: () => void;
1591
1624
  };
1592
1625
 
1593
- type VegaTransportDirection = "send" | "recv";
1594
-
1595
- type VegaAnalytics = {
1596
- vegaJoinFailed: number;
1597
- vegaJoinWithoutVegaConnection: number;
1598
- vegaCreateTransportWithoutVegaConnection: number;
1599
- vegaIceRestarts: number;
1600
- vegaIceRestartMissingTransport: number;
1601
- vegaIceRestartWrongTransportId: number;
1602
- vegaNonErrorRejectionValueGUMError: number;
1603
- vegaReplaceTrackNoProducerNoEnabledTrack: number;
1604
- micTrackEndedCount: number;
1605
- camTrackEndedCount: number;
1606
- };
1607
-
1608
- type MediaStreamWhichMayHaveInboundId = MediaStream & { inboundId?: string };
1609
-
1610
- type ClientState = {
1611
- hasAcceptedWebcamStream: Boolean;
1612
- hasAcceptedScreenStream: Boolean;
1613
- hasEmittedWebcamStream: Boolean;
1614
- hasEmittedScreenStream: Boolean;
1615
- webcamStream?: MediaStreamWhichMayHaveInboundId;
1616
- screenStream?: MediaStreamWhichMayHaveInboundId;
1617
- screenShareStreamId?: string;
1618
- camStreamId?: string;
1619
- };
1620
-
1621
1626
  declare class VegaRtcManager implements RtcManager {
1622
1627
  _selfId: any;
1623
1628
  _room: any;
@@ -1953,4 +1958,4 @@ declare const STREAM_TYPES: {
1953
1958
  };
1954
1959
 
1955
1960
  export { ADDITIONAL_SCREEN_SHARE_SETTINGS, AUDIO_SETTINGS, BandwidthTester, CAMERA_STREAM_ID, EVENTS, 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, detectMicrophoneNotWorking, enumerate, external_stun_servers, filterMidExtension, filterMsidSemantic, fromLocation, generateByteString, getConstraints, getCurrentPeerConnections, getDeviceData, getDisplayMedia, getIssuesAndMetrics, getMediaConstraints, getMediaSettings, getMediasoupDeviceAsync, getNumFailedStatsReports, getNumFailedTrackSsrcLookups, getNumMissingTrackSsrcLookups, getPeerConnectionIndex, getStats, getStream, getUpdatedDevices, getUpdatedStats, getUserMedia, hasGetDisplayMedia, ipRegex, isMobile, issueDetectorOrMetricEnabled, maybeTurnOnly, modifyMediaCapabilities, removePeerConnection, replaceTracksInStream, _default as rtcManagerEvents, rtcStats, setClientProvider, setCodecPreferenceSDP, setPeerConnectionsForTests, setVideoBandwidthUsingSetParameters, sortCodecs, standardDeviation, startPerformanceMonitor, stopStreamTracks, subscribeIssues, subscribeStats, trackAnnotations, turnServerOverride, variance };
1956
- export type { AddCameraStreamOptions, AddSpotlightRequest, AudioEnableRequest, AudioEnableRequestedEvent, AudioEnabledEvent, BreakoutConfig, BreakoutGroupJoinedEvent, BreakoutSessionUpdatedEvent, BuildDeviceListOptions, CannotJoinUnclaimedRoomError, ChatMessage, ClearableTimeout, ClientKickedEvent, ClientLeftEvent, ClientMetadataPayload, ClientMetadataReceivedEvent, ClientRole, ClientUnableToJoinEvent, CloudRecordingStartedEvent, Codec, Credentials, ForbiddenError, ForbiddenErrorNames, GetConstraintsOptions, GetDeviceDataResult, GetMediaConstraintsOptions, GetStreamOptions, GetStreamResult, GetUpdatedDevicesResult, HostPresenceControlsError, IdentifyDeviceRequest, InternalServerError, InvalidAssistantKeyError, IssuesAndMetricsByView, JoinRoomRequest, KnockAcceptedEvent, KnockRejectedEvent, KnockRoomRequest, KnockerLeftEvent, LiveTranscriptionStartedEvent, LiveTranscriptionStoppedEvent, MaxViewerLimitReachedError, 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, VegaRtcManagerOptions, VideoEnableRequest, VideoEnableRequestedEvent, VideoEnabledEvent, WebRTCProvider };
1961
+ export type { AddCameraStreamOptions, AddSpotlightRequest, AudioEnableRequest, AudioEnableRequestedEvent, AudioEnabledEvent, BreakoutConfig, BreakoutGroupJoinedEvent, BreakoutSessionUpdatedEvent, BuildDeviceListOptions, CannotJoinUnclaimedRoomError, ChatMessage, ClearableTimeout, ClientKickedEvent, ClientLeftEvent, ClientMetadataPayload, ClientMetadataReceivedEvent, ClientRole, ClientUnableToJoinEvent, CloudRecordingStartedEvent, Codec, Credentials, ForbiddenError, ForbiddenErrorNames, GetConstraintsOptions, GetDeviceDataResult, GetMediaConstraintsOptions, GetStreamOptions, GetStreamResult, GetUpdatedDevicesResult, HostPresenceControlsError, IdentifyDeviceRequest, InternalServerError, InvalidAssistantKeyError, IssuesAndMetricsByView, JoinRoomRequest, KnockAcceptedEvent, KnockRejectedEvent, KnockRoomRequest, KnockerLeftEvent, LiveTranscriptionStartedEvent, LiveTranscriptionStoppedEvent, MaxViewerLimitReachedError, 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 };
package/dist/index.d.mts CHANGED
@@ -382,6 +382,40 @@ declare function sortCodecs(codecs: Codec[], features: {
382
382
  av1On?: boolean;
383
383
  }): Promise<Codec[]>;
384
384
 
385
+ type VegaTransportDirection = "send" | "recv";
386
+
387
+ type VegaAnalytics = {
388
+ vegaUnknownResponse: number;
389
+ vegaRequestTimeout: number;
390
+ vegaJoinFailed: number;
391
+ vegaJoinWithoutVegaConnection: number;
392
+ vegaCreateTransportWithoutVegaConnection: number;
393
+ vegaIceRestarts: number;
394
+ vegaIceRestartMissingTransport: number;
395
+ vegaIceRestartWrongTransportId: number;
396
+ vegaNonErrorRejectionValueGUMError: number;
397
+ vegaReplaceTrackNoProducerNoEnabledTrack: number;
398
+ micTrackEndedCount: number;
399
+ camTrackEndedCount: number;
400
+ };
401
+
402
+ type VegaAnalyticMetric = keyof VegaAnalytics;
403
+
404
+ type VegaIncrementAnalyticMetric = (metric: VegaAnalyticMetric) => void;
405
+
406
+ type MediaStreamWhichMayHaveInboundId = MediaStream & { inboundId?: string };
407
+
408
+ type ClientState = {
409
+ hasAcceptedWebcamStream: Boolean;
410
+ hasAcceptedScreenStream: Boolean;
411
+ hasEmittedWebcamStream: Boolean;
412
+ hasEmittedScreenStream: Boolean;
413
+ webcamStream?: MediaStreamWhichMayHaveInboundId;
414
+ screenStream?: MediaStreamWhichMayHaveInboundId;
415
+ screenShareStreamId?: string;
416
+ camStreamId?: string;
417
+ };
418
+
385
419
  declare enum RtcEventNames {
386
420
  rtc_manager_created = "rtc_manager_created",
387
421
  stream_added = "stream_added"
@@ -400,6 +434,10 @@ interface RtcManagerOptions {
400
434
  interface VegaRtcManagerOptions extends RtcManagerOptions {
401
435
  eventClaim: string;
402
436
  }
437
+ interface VegaConnectionOptions {
438
+ protocol?: string;
439
+ incrementAnalyticMetric?: VegaIncrementAnalyticMetric;
440
+ }
403
441
  interface RtcManager {
404
442
  acceptNewStream: ({ clientId, streamId }: {
405
443
  clientId: string;
@@ -1281,17 +1319,12 @@ type P2PAnalytics = {
1281
1319
  numPcOnAnswerFailure: number;
1282
1320
  numPcOnOfferFailure: number;
1283
1321
  numPcSldFailure: number;
1284
- P2PChangeBandwidthEmptySDPType: number;
1285
1322
  P2PReplaceTrackNoStream: number;
1286
1323
  P2PReplaceTrackNewTrackNotInStream: number;
1287
1324
  P2POnTrackNoStream: number;
1288
- P2PSetCodecPreferenceError: number;
1289
- P2PCreateOfferNoSDP: number;
1290
- P2PCreateAnswerNoSDP: number;
1291
1325
  P2PMicNotWorking: number;
1292
1326
  P2PLocalNetworkFailed: number;
1293
1327
  P2PRelayedIceCandidate: number;
1294
- P2PStartScreenshareNoStream: number;
1295
1328
  };
1296
1329
  type P2PAnalyticMetric = keyof P2PAnalytics;
1297
1330
  type P2PIncrementAnalyticMetric = (metric: P2PAnalyticMetric) => void;
@@ -1437,9 +1470,8 @@ declare const rtcStats: {
1437
1470
  interface SetCodecPreferenceSDPOptions {
1438
1471
  sdp: string;
1439
1472
  redOn: boolean;
1440
- incrementAnalyticMetric: P2PIncrementAnalyticMetric;
1441
1473
  }
1442
- declare function setCodecPreferenceSDP({ sdp, redOn, incrementAnalyticMetric }: SetCodecPreferenceSDPOptions): string;
1474
+ declare function setCodecPreferenceSDP({ sdp, redOn }: SetCodecPreferenceSDPOptions): string;
1443
1475
  declare function cleanSdp(sdp: string): string;
1444
1476
  declare function deprioritizeH264(sdp: any): string;
1445
1477
  declare function filterMidExtension(sdp: any): any;
@@ -1482,7 +1514,8 @@ declare class VegaConnection extends EventEmitter$1 {
1482
1514
  protocol: string;
1483
1515
  socket: WebSocket | null;
1484
1516
  sents: Map<any, any>;
1485
- constructor(wsUrl: string, protocol?: string);
1517
+ incrementAnalyticMetric?: VegaIncrementAnalyticMetric;
1518
+ constructor(wsUrl: string, { protocol, incrementAnalyticMetric }: VegaConnectionOptions);
1486
1519
  _setupSocket(): void;
1487
1520
  _tearDown(): void;
1488
1521
  close(): void;
@@ -1584,40 +1617,12 @@ declare function createVegaConnectionManager(config: {
1584
1617
  onDisconnected?: () => void;
1585
1618
  onFailed?: () => void;
1586
1619
  }): {
1587
- connect: () => void;
1620
+ connect: (incrementAnalyticMetric?: VegaIncrementAnalyticMetric) => void;
1588
1621
  updateHostList: (updatedHostList: string | HostListEntryOptionalDC[]) => void;
1589
1622
  networkIsUp: () => void;
1590
1623
  networkIsPossiblyDown: () => void;
1591
1624
  };
1592
1625
 
1593
- type VegaTransportDirection = "send" | "recv";
1594
-
1595
- type VegaAnalytics = {
1596
- vegaJoinFailed: number;
1597
- vegaJoinWithoutVegaConnection: number;
1598
- vegaCreateTransportWithoutVegaConnection: number;
1599
- vegaIceRestarts: number;
1600
- vegaIceRestartMissingTransport: number;
1601
- vegaIceRestartWrongTransportId: number;
1602
- vegaNonErrorRejectionValueGUMError: number;
1603
- vegaReplaceTrackNoProducerNoEnabledTrack: number;
1604
- micTrackEndedCount: number;
1605
- camTrackEndedCount: number;
1606
- };
1607
-
1608
- type MediaStreamWhichMayHaveInboundId = MediaStream & { inboundId?: string };
1609
-
1610
- type ClientState = {
1611
- hasAcceptedWebcamStream: Boolean;
1612
- hasAcceptedScreenStream: Boolean;
1613
- hasEmittedWebcamStream: Boolean;
1614
- hasEmittedScreenStream: Boolean;
1615
- webcamStream?: MediaStreamWhichMayHaveInboundId;
1616
- screenStream?: MediaStreamWhichMayHaveInboundId;
1617
- screenShareStreamId?: string;
1618
- camStreamId?: string;
1619
- };
1620
-
1621
1626
  declare class VegaRtcManager implements RtcManager {
1622
1627
  _selfId: any;
1623
1628
  _room: any;
@@ -1953,4 +1958,4 @@ declare const STREAM_TYPES: {
1953
1958
  };
1954
1959
 
1955
1960
  export { ADDITIONAL_SCREEN_SHARE_SETTINGS, AUDIO_SETTINGS, BandwidthTester, CAMERA_STREAM_ID, EVENTS, 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, detectMicrophoneNotWorking, enumerate, external_stun_servers, filterMidExtension, filterMsidSemantic, fromLocation, generateByteString, getConstraints, getCurrentPeerConnections, getDeviceData, getDisplayMedia, getIssuesAndMetrics, getMediaConstraints, getMediaSettings, getMediasoupDeviceAsync, getNumFailedStatsReports, getNumFailedTrackSsrcLookups, getNumMissingTrackSsrcLookups, getPeerConnectionIndex, getStats, getStream, getUpdatedDevices, getUpdatedStats, getUserMedia, hasGetDisplayMedia, ipRegex, isMobile, issueDetectorOrMetricEnabled, maybeTurnOnly, modifyMediaCapabilities, removePeerConnection, replaceTracksInStream, _default as rtcManagerEvents, rtcStats, setClientProvider, setCodecPreferenceSDP, setPeerConnectionsForTests, setVideoBandwidthUsingSetParameters, sortCodecs, standardDeviation, startPerformanceMonitor, stopStreamTracks, subscribeIssues, subscribeStats, trackAnnotations, turnServerOverride, variance };
1956
- export type { AddCameraStreamOptions, AddSpotlightRequest, AudioEnableRequest, AudioEnableRequestedEvent, AudioEnabledEvent, BreakoutConfig, BreakoutGroupJoinedEvent, BreakoutSessionUpdatedEvent, BuildDeviceListOptions, CannotJoinUnclaimedRoomError, ChatMessage, ClearableTimeout, ClientKickedEvent, ClientLeftEvent, ClientMetadataPayload, ClientMetadataReceivedEvent, ClientRole, ClientUnableToJoinEvent, CloudRecordingStartedEvent, Codec, Credentials, ForbiddenError, ForbiddenErrorNames, GetConstraintsOptions, GetDeviceDataResult, GetMediaConstraintsOptions, GetStreamOptions, GetStreamResult, GetUpdatedDevicesResult, HostPresenceControlsError, IdentifyDeviceRequest, InternalServerError, InvalidAssistantKeyError, IssuesAndMetricsByView, JoinRoomRequest, KnockAcceptedEvent, KnockRejectedEvent, KnockRoomRequest, KnockerLeftEvent, LiveTranscriptionStartedEvent, LiveTranscriptionStoppedEvent, MaxViewerLimitReachedError, 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, VegaRtcManagerOptions, VideoEnableRequest, VideoEnableRequestedEvent, VideoEnabledEvent, WebRTCProvider };
1961
+ export type { AddCameraStreamOptions, AddSpotlightRequest, AudioEnableRequest, AudioEnableRequestedEvent, AudioEnabledEvent, BreakoutConfig, BreakoutGroupJoinedEvent, BreakoutSessionUpdatedEvent, BuildDeviceListOptions, CannotJoinUnclaimedRoomError, ChatMessage, ClearableTimeout, ClientKickedEvent, ClientLeftEvent, ClientMetadataPayload, ClientMetadataReceivedEvent, ClientRole, ClientUnableToJoinEvent, CloudRecordingStartedEvent, Codec, Credentials, ForbiddenError, ForbiddenErrorNames, GetConstraintsOptions, GetDeviceDataResult, GetMediaConstraintsOptions, GetStreamOptions, GetStreamResult, GetUpdatedDevicesResult, HostPresenceControlsError, IdentifyDeviceRequest, InternalServerError, InvalidAssistantKeyError, IssuesAndMetricsByView, JoinRoomRequest, KnockAcceptedEvent, KnockRejectedEvent, KnockRoomRequest, KnockerLeftEvent, LiveTranscriptionStartedEvent, LiveTranscriptionStoppedEvent, MaxViewerLimitReachedError, 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 };
package/dist/index.d.ts CHANGED
@@ -382,6 +382,40 @@ declare function sortCodecs(codecs: Codec[], features: {
382
382
  av1On?: boolean;
383
383
  }): Promise<Codec[]>;
384
384
 
385
+ type VegaTransportDirection = "send" | "recv";
386
+
387
+ type VegaAnalytics = {
388
+ vegaUnknownResponse: number;
389
+ vegaRequestTimeout: number;
390
+ vegaJoinFailed: number;
391
+ vegaJoinWithoutVegaConnection: number;
392
+ vegaCreateTransportWithoutVegaConnection: number;
393
+ vegaIceRestarts: number;
394
+ vegaIceRestartMissingTransport: number;
395
+ vegaIceRestartWrongTransportId: number;
396
+ vegaNonErrorRejectionValueGUMError: number;
397
+ vegaReplaceTrackNoProducerNoEnabledTrack: number;
398
+ micTrackEndedCount: number;
399
+ camTrackEndedCount: number;
400
+ };
401
+
402
+ type VegaAnalyticMetric = keyof VegaAnalytics;
403
+
404
+ type VegaIncrementAnalyticMetric = (metric: VegaAnalyticMetric) => void;
405
+
406
+ type MediaStreamWhichMayHaveInboundId = MediaStream & { inboundId?: string };
407
+
408
+ type ClientState = {
409
+ hasAcceptedWebcamStream: Boolean;
410
+ hasAcceptedScreenStream: Boolean;
411
+ hasEmittedWebcamStream: Boolean;
412
+ hasEmittedScreenStream: Boolean;
413
+ webcamStream?: MediaStreamWhichMayHaveInboundId;
414
+ screenStream?: MediaStreamWhichMayHaveInboundId;
415
+ screenShareStreamId?: string;
416
+ camStreamId?: string;
417
+ };
418
+
385
419
  declare enum RtcEventNames {
386
420
  rtc_manager_created = "rtc_manager_created",
387
421
  stream_added = "stream_added"
@@ -400,6 +434,10 @@ interface RtcManagerOptions {
400
434
  interface VegaRtcManagerOptions extends RtcManagerOptions {
401
435
  eventClaim: string;
402
436
  }
437
+ interface VegaConnectionOptions {
438
+ protocol?: string;
439
+ incrementAnalyticMetric?: VegaIncrementAnalyticMetric;
440
+ }
403
441
  interface RtcManager {
404
442
  acceptNewStream: ({ clientId, streamId }: {
405
443
  clientId: string;
@@ -1281,17 +1319,12 @@ type P2PAnalytics = {
1281
1319
  numPcOnAnswerFailure: number;
1282
1320
  numPcOnOfferFailure: number;
1283
1321
  numPcSldFailure: number;
1284
- P2PChangeBandwidthEmptySDPType: number;
1285
1322
  P2PReplaceTrackNoStream: number;
1286
1323
  P2PReplaceTrackNewTrackNotInStream: number;
1287
1324
  P2POnTrackNoStream: number;
1288
- P2PSetCodecPreferenceError: number;
1289
- P2PCreateOfferNoSDP: number;
1290
- P2PCreateAnswerNoSDP: number;
1291
1325
  P2PMicNotWorking: number;
1292
1326
  P2PLocalNetworkFailed: number;
1293
1327
  P2PRelayedIceCandidate: number;
1294
- P2PStartScreenshareNoStream: number;
1295
1328
  };
1296
1329
  type P2PAnalyticMetric = keyof P2PAnalytics;
1297
1330
  type P2PIncrementAnalyticMetric = (metric: P2PAnalyticMetric) => void;
@@ -1437,9 +1470,8 @@ declare const rtcStats: {
1437
1470
  interface SetCodecPreferenceSDPOptions {
1438
1471
  sdp: string;
1439
1472
  redOn: boolean;
1440
- incrementAnalyticMetric: P2PIncrementAnalyticMetric;
1441
1473
  }
1442
- declare function setCodecPreferenceSDP({ sdp, redOn, incrementAnalyticMetric }: SetCodecPreferenceSDPOptions): string;
1474
+ declare function setCodecPreferenceSDP({ sdp, redOn }: SetCodecPreferenceSDPOptions): string;
1443
1475
  declare function cleanSdp(sdp: string): string;
1444
1476
  declare function deprioritizeH264(sdp: any): string;
1445
1477
  declare function filterMidExtension(sdp: any): any;
@@ -1482,7 +1514,8 @@ declare class VegaConnection extends EventEmitter$1 {
1482
1514
  protocol: string;
1483
1515
  socket: WebSocket | null;
1484
1516
  sents: Map<any, any>;
1485
- constructor(wsUrl: string, protocol?: string);
1517
+ incrementAnalyticMetric?: VegaIncrementAnalyticMetric;
1518
+ constructor(wsUrl: string, { protocol, incrementAnalyticMetric }: VegaConnectionOptions);
1486
1519
  _setupSocket(): void;
1487
1520
  _tearDown(): void;
1488
1521
  close(): void;
@@ -1584,40 +1617,12 @@ declare function createVegaConnectionManager(config: {
1584
1617
  onDisconnected?: () => void;
1585
1618
  onFailed?: () => void;
1586
1619
  }): {
1587
- connect: () => void;
1620
+ connect: (incrementAnalyticMetric?: VegaIncrementAnalyticMetric) => void;
1588
1621
  updateHostList: (updatedHostList: string | HostListEntryOptionalDC[]) => void;
1589
1622
  networkIsUp: () => void;
1590
1623
  networkIsPossiblyDown: () => void;
1591
1624
  };
1592
1625
 
1593
- type VegaTransportDirection = "send" | "recv";
1594
-
1595
- type VegaAnalytics = {
1596
- vegaJoinFailed: number;
1597
- vegaJoinWithoutVegaConnection: number;
1598
- vegaCreateTransportWithoutVegaConnection: number;
1599
- vegaIceRestarts: number;
1600
- vegaIceRestartMissingTransport: number;
1601
- vegaIceRestartWrongTransportId: number;
1602
- vegaNonErrorRejectionValueGUMError: number;
1603
- vegaReplaceTrackNoProducerNoEnabledTrack: number;
1604
- micTrackEndedCount: number;
1605
- camTrackEndedCount: number;
1606
- };
1607
-
1608
- type MediaStreamWhichMayHaveInboundId = MediaStream & { inboundId?: string };
1609
-
1610
- type ClientState = {
1611
- hasAcceptedWebcamStream: Boolean;
1612
- hasAcceptedScreenStream: Boolean;
1613
- hasEmittedWebcamStream: Boolean;
1614
- hasEmittedScreenStream: Boolean;
1615
- webcamStream?: MediaStreamWhichMayHaveInboundId;
1616
- screenStream?: MediaStreamWhichMayHaveInboundId;
1617
- screenShareStreamId?: string;
1618
- camStreamId?: string;
1619
- };
1620
-
1621
1626
  declare class VegaRtcManager implements RtcManager {
1622
1627
  _selfId: any;
1623
1628
  _room: any;
@@ -1953,4 +1958,4 @@ declare const STREAM_TYPES: {
1953
1958
  };
1954
1959
 
1955
1960
  export { ADDITIONAL_SCREEN_SHARE_SETTINGS, AUDIO_SETTINGS, BandwidthTester, CAMERA_STREAM_ID, EVENTS, 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, detectMicrophoneNotWorking, enumerate, external_stun_servers, filterMidExtension, filterMsidSemantic, fromLocation, generateByteString, getConstraints, getCurrentPeerConnections, getDeviceData, getDisplayMedia, getIssuesAndMetrics, getMediaConstraints, getMediaSettings, getMediasoupDeviceAsync, getNumFailedStatsReports, getNumFailedTrackSsrcLookups, getNumMissingTrackSsrcLookups, getPeerConnectionIndex, getStats, getStream, getUpdatedDevices, getUpdatedStats, getUserMedia, hasGetDisplayMedia, ipRegex, isMobile, issueDetectorOrMetricEnabled, maybeTurnOnly, modifyMediaCapabilities, removePeerConnection, replaceTracksInStream, _default as rtcManagerEvents, rtcStats, setClientProvider, setCodecPreferenceSDP, setPeerConnectionsForTests, setVideoBandwidthUsingSetParameters, sortCodecs, standardDeviation, startPerformanceMonitor, stopStreamTracks, subscribeIssues, subscribeStats, trackAnnotations, turnServerOverride, variance };
1956
- export type { AddCameraStreamOptions, AddSpotlightRequest, AudioEnableRequest, AudioEnableRequestedEvent, AudioEnabledEvent, BreakoutConfig, BreakoutGroupJoinedEvent, BreakoutSessionUpdatedEvent, BuildDeviceListOptions, CannotJoinUnclaimedRoomError, ChatMessage, ClearableTimeout, ClientKickedEvent, ClientLeftEvent, ClientMetadataPayload, ClientMetadataReceivedEvent, ClientRole, ClientUnableToJoinEvent, CloudRecordingStartedEvent, Codec, Credentials, ForbiddenError, ForbiddenErrorNames, GetConstraintsOptions, GetDeviceDataResult, GetMediaConstraintsOptions, GetStreamOptions, GetStreamResult, GetUpdatedDevicesResult, HostPresenceControlsError, IdentifyDeviceRequest, InternalServerError, InvalidAssistantKeyError, IssuesAndMetricsByView, JoinRoomRequest, KnockAcceptedEvent, KnockRejectedEvent, KnockRoomRequest, KnockerLeftEvent, LiveTranscriptionStartedEvent, LiveTranscriptionStoppedEvent, MaxViewerLimitReachedError, 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, VegaRtcManagerOptions, VideoEnableRequest, VideoEnableRequestedEvent, VideoEnabledEvent, WebRTCProvider };
1961
+ export type { AddCameraStreamOptions, AddSpotlightRequest, AudioEnableRequest, AudioEnableRequestedEvent, AudioEnabledEvent, BreakoutConfig, BreakoutGroupJoinedEvent, BreakoutSessionUpdatedEvent, BuildDeviceListOptions, CannotJoinUnclaimedRoomError, ChatMessage, ClearableTimeout, ClientKickedEvent, ClientLeftEvent, ClientMetadataPayload, ClientMetadataReceivedEvent, ClientRole, ClientUnableToJoinEvent, CloudRecordingStartedEvent, Codec, Credentials, ForbiddenError, ForbiddenErrorNames, GetConstraintsOptions, GetDeviceDataResult, GetMediaConstraintsOptions, GetStreamOptions, GetStreamResult, GetUpdatedDevicesResult, HostPresenceControlsError, IdentifyDeviceRequest, InternalServerError, InvalidAssistantKeyError, IssuesAndMetricsByView, JoinRoomRequest, KnockAcceptedEvent, KnockRejectedEvent, KnockRoomRequest, KnockerLeftEvent, LiveTranscriptionStartedEvent, LiveTranscriptionStoppedEvent, MaxViewerLimitReachedError, 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 };