@stream-io/video-client 1.8.3 → 1.9.0

package/src/devices/CameraManager.ts

@@ -4,7 +4,8 @@ import { CameraDirection, CameraManagerState } from './CameraManagerState';
 import { InputMediaDeviceManager } from './InputMediaDeviceManager';
 import { getVideoDevices, getVideoStream } from './devices';
 import { TrackType } from '../gen/video/sfu/models/models';
-import { PreferredCodec, PublishOptions } from '../types';
+import { PreferredCodec } from '../types';
+import { isMobile } from '../compatibility';
 
 export class CameraManager extends InputMediaDeviceManager<CameraManagerState> {
   private targetResolution = {
@@ -12,13 +13,6 @@ export class CameraManager extends InputMediaDeviceManager<CameraManagerState> {
     height: 720,
   };
 
-  /**
-   * The options to use when publishing the video stream.
-   *
-   * @internal
-   */
-  publishOptions: PublishOptions | undefined;
-
   /**
    * Constructs a new CameraManager.
    *
@@ -34,10 +28,14 @@ export class CameraManager extends InputMediaDeviceManager<CameraManagerState> {
    * @param direction the direction of the camera to select.
    */
   async selectDirection(direction: Exclude<CameraDirection, undefined>) {
-    this.state.setDirection(direction);
-    // Providing both device id and direction doesn't work, so we deselect the device
-    this.state.setDevice(undefined);
-    await this.applySettingsToStream();
+    if (isMobile()) {
+      this.state.setDirection(direction);
+      // Providing both device id and direction doesn't work, so we deselect the device
+      this.state.setDevice(undefined);
+      await this.applySettingsToStream();
+    } else {
+      this.logger('warn', 'Camera direction ignored for desktop devices');
+    }
   }
 
   /**
@@ -65,10 +63,10 @@ export class CameraManager extends InputMediaDeviceManager<CameraManagerState> {
         this.logger('warn', 'could not apply target resolution', error);
       }
     }
-    if (this.enabled) {
-      const { width, height } = this.state
-        .mediaStream!.getVideoTracks()[0]
-        ?.getSettings();
+    if (this.enabled && this.state.mediaStream) {
+      const [videoTrack] = this.state.mediaStream.getVideoTracks();
+      if (!videoTrack) return;
+      const { width, height } = videoTrack.getSettings();
       if (
         width !== this.targetResolution.width ||
         height !== this.targetResolution.height
@@ -86,38 +84,11 @@ export class CameraManager extends InputMediaDeviceManager<CameraManagerState> {
    * Sets the preferred codec for encoding the video.
    *
    * @internal internal use only, not part of the public API.
+   * @deprecated use {@link call.updatePublishOptions} instead.
    * @param codec the codec to use for encoding the video.
    */
   setPreferredCodec(codec: PreferredCodec | undefined) {
-    this.updatePublishOptions({ preferredCodec: codec });
-  }
-
-  /**
-   * Updates the preferred publish options for the video stream.
-   *
-   * @internal
-   * @param options the options to use.
-   */
-  updatePublishOptions(options: PublishOptions) {
-    this.publishOptions = { ...this.publishOptions, ...options };
-  }
-
-  /**
-   * Returns the capture resolution of the camera.
-   */
-  getCaptureResolution() {
-    const { mediaStream } = this.state;
-    if (!mediaStream) return;
-
-    const [videoTrack] = mediaStream.getVideoTracks();
-    if (!videoTrack) return;
-
-    const settings = videoTrack.getSettings();
-    return {
-      width: settings.width,
-      height: settings.height,
-      frameRate: settings.frameRate,
-    };
+    this.call.updatePublishOptions({ preferredCodec: codec });
   }
 
   protected getDevices(): Observable<MediaDeviceInfo[]> {
@@ -131,7 +102,7 @@ export class CameraManager extends InputMediaDeviceManager<CameraManagerState> {
     constraints.height = this.targetResolution.height;
     // We can't set both device id and facing mode
     // Device id has higher priority
-    if (!constraints.deviceId && this.state.direction) {
+    if (!constraints.deviceId && this.state.direction && isMobile()) {
       constraints.facingMode =
         this.state.direction === 'front' ? 'user' : 'environment';
     }
@@ -139,7 +110,7 @@ export class CameraManager extends InputMediaDeviceManager<CameraManagerState> {
   }
 
   protected publishStream(stream: MediaStream): Promise<void> {
-    return this.call.publishVideoStream(stream, this.publishOptions);
+    return this.call.publishVideoStream(stream);
   }
 
   protected stopPublishStream(stopTracks: boolean): Promise<void> {

package/src/devices/ScreenShareManager.ts

@@ -80,9 +80,7 @@ export class ScreenShareManager extends InputMediaDeviceManager<
   }
 
   protected publishStream(stream: MediaStream): Promise<void> {
-    return this.call.publishScreenShareStream(stream, {
-      screenShareSettings: this.state.settings,
-    });
+    return this.call.publishScreenShareStream(stream);
   }
 
   protected async stopPublishStream(stopTracks: boolean): Promise<void> {

package/src/devices/__tests__/CameraManager.test.ts

@@ -36,6 +36,13 @@ vi.mock('../../Call.ts', () => {
   };
 });
 
+vi.mock('../../compatibility.ts', () => {
+  console.log('MOCKING mobile device');
+  return {
+    isMobile: () => true,
+  };
+});
+
 describe('CameraManager', () => {
   let manager: CameraManager;
 
@@ -82,21 +89,6 @@ describe('CameraManager', () => {
 
     expect(manager['call'].publishVideoStream).toHaveBeenCalledWith(
       manager.state.mediaStream,
-      undefined,
-    );
-  });
-
-  it('publish stream with preferred codec', async () => {
-    manager['call'].state.setCallingState(CallingState.JOINED);
-    manager.setPreferredCodec('h264');
-
-    await manager.enable();
-
-    expect(manager['call'].publishVideoStream).toHaveBeenCalledWith(
-      manager.state.mediaStream,
-      {
-        preferredCodec: 'h264',
-      },
     );
   });
 

package/src/devices/__tests__/ScreenShareManager.test.ts

@@ -115,20 +115,6 @@ describe('ScreenShareManager', () => {
     await manager.enable();
     expect(call.publishScreenShareStream).toHaveBeenCalledWith(
       manager.state.mediaStream,
-      { screenShareSettings: undefined },
-    );
-  });
-
-  it('publishes screen share stream with settings', async () => {
-    const call = manager['call'];
-    call.state.setCallingState(CallingState.JOINED);
-
-    manager.setSettings({ maxFramerate: 15, maxBitrate: 1000 });
-
-    await manager.enable();
-    expect(call.publishScreenShareStream).toHaveBeenCalledWith(
-      manager.state.mediaStream,
-      { screenShareSettings: { maxFramerate: 15, maxBitrate: 1000 } },
     );
   });
 

package/src/events/callEventHandlers.ts

@@ -7,7 +7,6 @@ import {
   watchCallEnded,
   watchCallGrantsUpdated,
   watchCallRejected,
-  watchChangePublishQuality,
   watchConnectionQualityChanged,
   watchDominantSpeakerChanged,
   watchLiveEnded,
@@ -46,7 +45,6 @@ export const registerEventHandlers = (call: Call, dispatcher: Dispatcher) => {
 
     watchLiveEnded(dispatcher, call),
     watchSfuErrorReports(dispatcher),
-    watchChangePublishQuality(dispatcher, call),
     watchConnectionQualityChanged(dispatcher, state),
     watchParticipantCountChanged(dispatcher, state),
 

package/src/events/internal.ts

@@ -10,22 +10,6 @@ import {
 } from '../gen/video/sfu/models/models';
 import { OwnCapability } from '../gen/coordinator';
 
-/**
- * An event responder which handles the `changePublishQuality` event.
- */
-export const watchChangePublishQuality = (
-  dispatcher: Dispatcher,
-  call: Call,
-) => {
-  return dispatcher.on('changePublishQuality', (e) => {
-    const { videoSenders } = e;
-    videoSenders.forEach((videoSender) => {
-      const { layers } = videoSender;
-      call.updatePublishQuality(layers.filter((l) => l.active));
-    });
-  });
-};
-
 export const watchConnectionQualityChanged = (
   dispatcher: Dispatcher,
   state: CallState,

package/src/gen/video/sfu/event/events.ts

@@ -682,45 +682,15 @@ export interface AudioLevelChanged {
    */
   audioLevels: AudioLevel[];
 }
-/**
- * @generated from protobuf message stream.video.sfu.event.AudioMediaRequest
- */
-export interface AudioMediaRequest {
-  /**
-   * @generated from protobuf field: int32 channel_count = 1;
-   */
-  channelCount: number;
-}
 /**
  * @generated from protobuf message stream.video.sfu.event.AudioSender
  */
 export interface AudioSender {
-  /**
-   * @generated from protobuf field: stream.video.sfu.event.AudioMediaRequest media_request = 1;
-   */
-  mediaRequest?: AudioMediaRequest;
   /**
    * @generated from protobuf field: stream.video.sfu.models.Codec codec = 2;
    */
   codec?: Codec;
 }
-/**
- * @generated from protobuf message stream.video.sfu.event.VideoMediaRequest
- */
-export interface VideoMediaRequest {
-  /**
-   * @generated from protobuf field: int32 ideal_height = 1;
-   */
-  idealHeight: number;
-  /**
-   * @generated from protobuf field: int32 ideal_width = 2;
-   */
-  idealWidth: number;
-  /**
-   * @generated from protobuf field: int32 ideal_frame_rate = 3;
-   */
-  idealFrameRate: number;
-}
 /**
  * VideoLayerSetting is used to specify various parameters of a particular encoding in simulcast.
  * The parameters are specified here - https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpEncodingParameters
@@ -745,10 +715,6 @@ export interface VideoLayerSetting {
    * @generated from protobuf field: float scale_resolution_down_by = 4;
    */
   scaleResolutionDownBy: number;
-  /**
-   * @generated from protobuf field: stream.video.sfu.event.VideoLayerSetting.Priority priority = 5;
-   */
-  priority: VideoLayerSetting_Priority;
   /**
    * @generated from protobuf field: stream.video.sfu.models.Codec codec = 6;
    */
@@ -757,36 +723,15 @@ export interface VideoLayerSetting {
    * @generated from protobuf field: uint32 max_framerate = 7;
    */
   maxFramerate: number;
-}
-/**
- * @generated from protobuf enum stream.video.sfu.event.VideoLayerSetting.Priority
- */
-export enum VideoLayerSetting_Priority {
-  /**
-   * @generated from protobuf enum value: PRIORITY_HIGH_UNSPECIFIED = 0;
-   */
-  HIGH_UNSPECIFIED = 0,
-  /**
-   * @generated from protobuf enum value: PRIORITY_LOW = 1;
-   */
-  LOW = 1,
-  /**
-   * @generated from protobuf enum value: PRIORITY_MEDIUM = 2;
-   */
-  MEDIUM = 2,
   /**
-   * @generated from protobuf enum value: PRIORITY_VERY_LOW = 3;
+   * @generated from protobuf field: string scalability_mode = 8;
    */
-  VERY_LOW = 3,
+  scalabilityMode: string;
 }
 /**
  * @generated from protobuf message stream.video.sfu.event.VideoSender
  */
 export interface VideoSender {
-  /**
-   * @generated from protobuf field: stream.video.sfu.event.VideoMediaRequest media_request = 1;
-   */
-  mediaRequest?: VideoMediaRequest;
   /**
    * @generated from protobuf field: stream.video.sfu.models.Codec codec = 2;
    */
@@ -1537,32 +1482,9 @@ class AudioLevelChanged$Type extends MessageType<AudioLevelChanged> {
  */
 export const AudioLevelChanged = new AudioLevelChanged$Type();
 // @generated message type with reflection information, may provide speed optimized methods
-class AudioMediaRequest$Type extends MessageType<AudioMediaRequest> {
-  constructor() {
-    super('stream.video.sfu.event.AudioMediaRequest', [
-      {
-        no: 1,
-        name: 'channel_count',
-        kind: 'scalar',
-        T: 5 /*ScalarType.INT32*/,
-      },
-    ]);
-  }
-}
-/**
- * @generated MessageType for protobuf message stream.video.sfu.event.AudioMediaRequest
- */
-export const AudioMediaRequest = new AudioMediaRequest$Type();
-// @generated message type with reflection information, may provide speed optimized methods
 class AudioSender$Type extends MessageType<AudioSender> {
   constructor() {
     super('stream.video.sfu.event.AudioSender', [
-      {
-        no: 1,
-        name: 'media_request',
-        kind: 'message',
-        T: () => AudioMediaRequest,
-      },
       { no: 2, name: 'codec', kind: 'message', T: () => Codec },
     ]);
   }
@@ -1572,30 +1494,6 @@ class AudioSender$Type extends MessageType<AudioSender> {
  */
 export const AudioSender = new AudioSender$Type();
 // @generated message type with reflection information, may provide speed optimized methods
-class VideoMediaRequest$Type extends MessageType<VideoMediaRequest> {
-  constructor() {
-    super('stream.video.sfu.event.VideoMediaRequest', [
-      {
-        no: 1,
-        name: 'ideal_height',
-        kind: 'scalar',
-        T: 5 /*ScalarType.INT32*/,
-      },
-      { no: 2, name: 'ideal_width', kind: 'scalar', T: 5 /*ScalarType.INT32*/ },
-      {
-        no: 3,
-        name: 'ideal_frame_rate',
-        kind: 'scalar',
-        T: 5 /*ScalarType.INT32*/,
-      },
-    ]);
-  }
-}
-/**
- * @generated MessageType for protobuf message stream.video.sfu.event.VideoMediaRequest
- */
-export const VideoMediaRequest = new VideoMediaRequest$Type();
-// @generated message type with reflection information, may provide speed optimized methods
 class VideoLayerSetting$Type extends MessageType<VideoLayerSetting> {
   constructor() {
     super('stream.video.sfu.event.VideoLayerSetting', [
@@ -1608,16 +1506,6 @@ class VideoLayerSetting$Type extends MessageType<VideoLayerSetting> {
         kind: 'scalar',
         T: 2 /*ScalarType.FLOAT*/,
       },
-      {
-        no: 5,
-        name: 'priority',
-        kind: 'enum',
-        T: () => [
-          'stream.video.sfu.event.VideoLayerSetting.Priority',
-          VideoLayerSetting_Priority,
-          'PRIORITY_',
-        ],
-      },
       { no: 6, name: 'codec', kind: 'message', T: () => Codec },
       {
         no: 7,
@@ -1625,6 +1513,12 @@ class VideoLayerSetting$Type extends MessageType<VideoLayerSetting> {
         kind: 'scalar',
         T: 13 /*ScalarType.UINT32*/,
       },
+      {
+        no: 8,
+        name: 'scalability_mode',
+        kind: 'scalar',
+        T: 9 /*ScalarType.STRING*/,
+      },
     ]);
   }
 }
@@ -1636,12 +1530,6 @@ export const VideoLayerSetting = new VideoLayerSetting$Type();
 class VideoSender$Type extends MessageType<VideoSender> {
   constructor() {
     super('stream.video.sfu.event.VideoSender', [
-      {
-        no: 1,
-        name: 'media_request',
-        kind: 'message',
-        T: () => VideoMediaRequest,
-      },
       { no: 2, name: 'codec', kind: 'message', T: () => Codec },
       {
         no: 3,

package/src/helpers/sdp-munging.ts

@@ -118,21 +118,15 @@ const getOpusFmtp = (sdp: string): Fmtp | undefined => {
  */
 export const toggleDtx = (sdp: string, enable: boolean): string => {
   const opusFmtp = getOpusFmtp(sdp);
-  if (opusFmtp) {
-    const matchDtx = /usedtx=(\d)/.exec(opusFmtp.config);
-    const requiredDtxConfig = `usedtx=${enable ? '1' : '0'}`;
-    if (matchDtx) {
-      const newFmtp = opusFmtp.original.replace(
-        /usedtx=(\d)/,
-        requiredDtxConfig,
-      );
-      return sdp.replace(opusFmtp.original, newFmtp);
-    } else {
-      const newFmtp = `${opusFmtp.original};${requiredDtxConfig}`;
-      return sdp.replace(opusFmtp.original, newFmtp);
-    }
-  }
-  return sdp;
+  if (!opusFmtp) return sdp;
+
+  const matchDtx = /usedtx=(\d)/.exec(opusFmtp.config);
+  const requiredDtxConfig = `usedtx=${enable ? '1' : '0'}`;
+  const newFmtp = matchDtx
+    ? opusFmtp.original.replace(/usedtx=(\d)/, requiredDtxConfig)
+    : `${opusFmtp.original};${requiredDtxConfig}`;
+
+  return sdp.replace(opusFmtp.original, newFmtp);
 };
 
 /**
@@ -181,3 +175,32 @@ export const enableHighQualityAudio = (
 
   return SDP.write(parsedSdp);
 };
+
+/**
+ * Extracts the mid from the transceiver or the SDP.
+ *
+ * @param transceiver the transceiver.
+ * @param transceiverInitIndex the index of the transceiver in the transceiver's init array.
+ * @param sdp the SDP.
+ */
+export const extractMid = (
+  transceiver: RTCRtpTransceiver,
+  transceiverInitIndex: number,
+  sdp: string | undefined,
+): string => {
+  if (transceiver.mid) return transceiver.mid;
+  if (!sdp) return '';
+
+  const track = transceiver.sender.track!;
+  const parsedSdp = SDP.parse(sdp);
+  const media = parsedSdp.media.find((m) => {
+    return (
+      m.type === track.kind &&
+      // if `msid` is not present, we assume that the track is the first one
+      (m.msid?.includes(track.id) ?? true)
+    );
+  });
+  if (typeof media?.mid !== 'undefined') return String(media.mid);
+  if (transceiverInitIndex === -1) return '';
+  return String(transceiverInitIndex);
+};