livekit-client 1.15.5 → 1.15.7

package/src/room/track/TrackPublication.ts

@@ -1,16 +1,18 @@
 import { EventEmitter } from 'events';
 import type TypedEventEmitter from 'typed-emitter';
-import log from '../../logger';
+import log, { LoggerNames, getLogger } from '../../logger';
 import { Encryption_Type } from '../../proto/livekit_models_pb';
 import type { SubscriptionError, TrackInfo } from '../../proto/livekit_models_pb';
 import type { UpdateSubscription, UpdateTrackSettings } from '../../proto/livekit_rtc_pb';
 import { TrackEvent } from '../events';
+import type { LoggerOptions } from '../types';
 import LocalAudioTrack from './LocalAudioTrack';
 import LocalVideoTrack from './LocalVideoTrack';
 import RemoteAudioTrack from './RemoteAudioTrack';
 import type RemoteTrack from './RemoteTrack';
 import RemoteVideoTrack from './RemoteVideoTrack';
 import { Track } from './Track';
+import { getLogContextFromTrack } from './utils';
 
 export class TrackPublication extends (EventEmitter as new () => TypedEventEmitter<PublicationEventCallbacks>) {
   kind: Track.Kind;
@@ -39,8 +41,14 @@ export class TrackPublication extends (EventEmitter as new () => TypedEventEmitt
 
   protected encryption: Encryption_Type = Encryption_Type.NONE;
 
-  constructor(kind: Track.Kind, id: string, name: string) {
+  protected log = log;
+
+  private loggerContextCb?: LoggerOptions['loggerContextCb'];
+
+  constructor(kind: Track.Kind, id: string, name: string, loggerOptions?: LoggerOptions) {
     super();
+    this.log = getLogger(loggerOptions?.loggerName ?? LoggerNames.Publication);
+    this.loggerContextCb = this.loggerContextCb;
     this.setMaxListeners(100);
     this.kind = kind;
     this.trackSid = id;
@@ -64,6 +72,13 @@ export class TrackPublication extends (EventEmitter as new () => TypedEventEmitt
     }
   }
 
+  protected get logContext() {
+    return {
+      ...this.loggerContextCb?.(),
+      ...getLogContextFromTrack(this),
+    };
+  }
+
   get isMuted(): boolean {
     return this.metadataMuted;
   }
@@ -121,7 +136,7 @@ export class TrackPublication extends (EventEmitter as new () => TypedEventEmitt
     }
     this.encryption = info.encryption;
     this.trackInfo = info;
-    log.debug('update publication info', { info });
+    this.log.debug('update publication info', { ...this.logContext, info });
   }
 }
 

package/src/room/track/create.ts

@@ -2,17 +2,18 @@ import DeviceManager from '../DeviceManager';
 import { audioDefaults, videoDefaults } from '../defaults';
 import { DeviceUnsupportedError, TrackInvalidError } from '../errors';
 import { mediaTrackToLocalTrack } from '../participant/publishUtils';
+import { isSafari17 } from '../utils';
 import LocalAudioTrack from './LocalAudioTrack';
 import type LocalTrack from './LocalTrack';
 import LocalVideoTrack from './LocalVideoTrack';
 import { Track } from './Track';
-import { ScreenSharePresets } from './options';
 import type {
   AudioCaptureOptions,
   CreateLocalTracksOptions,
   ScreenShareCaptureOptions,
   VideoCaptureOptions,
 } from './options';
+import { ScreenSharePresets } from './options';
 import {
   constraintsForOptions,
   mergeDefaultOptions,
@@ -116,8 +117,8 @@ export async function createLocalScreenTracks(
   if (options === undefined) {
     options = {};
   }
-  if (options.resolution === undefined) {
-    options.resolution = ScreenSharePresets.h1080fps15.resolution;
+  if (options.resolution === undefined && !isSafari17()) {
+    options.resolution = ScreenSharePresets.h1080fps30.resolution;
   }
 
   if (navigator.mediaDevices.getDisplayMedia === undefined) {

package/src/room/track/options.ts

@@ -169,9 +169,10 @@ export interface ScreenShareCaptureOptions {
   video?: true | { displaySurface?: 'window' | 'browser' | 'monitor' };
 
   /**
-   * capture resolution, defaults to screen resolution
-   * NOTE: In Safari 17, specifying any resolution at all would lead to a low-resolution
-   * capture. https://bugs.webkit.org/show_bug.cgi?id=263015
+   * capture resolution, defaults to 1080 for all browsers other than Safari
+   * On Safari 17, default resolution is not capped, due to a bug, specifying
+   * any resolution at all would lead to a low-resolution capture.
+   * https://bugs.webkit.org/show_bug.cgi?id=263015
    */
   resolution?: VideoResolution;
 
@@ -187,6 +188,9 @@ export interface ScreenShareCaptureOptions {
   /** specifies whether the browser should include the system audio among the possible audio sources offered to the user */
   systemAudio?: 'include' | 'exclude';
 
+  /** specify the type of content, see: https://www.w3.org/TR/mst-content-hint/#video-content-hints */
+  contentHint?: 'detail' | 'text' | 'motion';
+
   /**
    * Experimental option to control whether the audio playing in a tab will continue to be played out of a user's
    * local speakers when the tab is captured.
@@ -367,9 +371,12 @@ export const VideoPresets43 = {
 
 export const ScreenSharePresets = {
   h360fps3: new VideoPreset(640, 360, 200_000, 3, 'medium'),
-  h720fps5: new VideoPreset(1280, 720, 400_000, 5, 'medium'),
+  h360fps15: new VideoPreset(640, 360, 400_000, 15, 'medium'),
+  h720fps5: new VideoPreset(1280, 720, 800_000, 5, 'medium'),
   h720fps15: new VideoPreset(1280, 720, 1_500_000, 15, 'medium'),
   h720fps30: new VideoPreset(1280, 720, 2_000_000, 30, 'medium'),
   h1080fps15: new VideoPreset(1920, 1080, 2_500_000, 15, 'medium'),
-  h1080fps30: new VideoPreset(1920, 1080, 4_000_000, 30, 'medium'),
+  h1080fps30: new VideoPreset(1920, 1080, 5_000_000, 30, 'medium'),
+  // original resolution, without resizing
+  original: new VideoPreset(0, 0, 7_000_000, 30, 'medium'),
 } as const;

package/src/room/track/utils.ts

@@ -155,7 +155,8 @@ export function screenCaptureToDisplayMediaStreamOptions(
   options: ScreenShareCaptureOptions,
 ): DisplayMediaStreamOptions {
   let videoConstraints: MediaTrackConstraints | boolean = options.video ?? true;
-  if (options.resolution) {
+  // treat 0 as uncapped
+  if (options.resolution && options.resolution.width > 0 && options.resolution.height > 0) {
     videoConstraints = typeof videoConstraints === 'boolean' ? {} : videoConstraints;
     if (isSafari()) {
       videoConstraints = {
@@ -209,3 +210,24 @@ export function getTrackPublicationInfo<T extends TrackPublication>(
   });
   return infos;
 }
+
+export function getLogContextFromTrack(track: Track | TrackPublication): Record<string, unknown> {
+  if (track instanceof Track) {
+    return {
+      trackSid: track.sid,
+      trackSource: track.source,
+      trackMuted: track.isMuted,
+      trackEnabled: track.mediaStreamTrack.enabled,
+      trackKind: track.kind,
+    };
+  } else {
+    return {
+      trackSid: track.trackSid,
+      trackName: track.trackName,
+      track: track.track ? getLogContextFromTrack(track.track) : undefined,
+      trackEnabled: track.isEnabled,
+      trackEncrypted: track.isEncrypted,
+      trackMimeType: track.mimeType,
+    };
+  }
+}

package/src/room/types.ts

@@ -41,3 +41,8 @@ export type SimulationScenario =
   // this can be used to test application behavior when congested or
   // to disable congestion control entirely (by setting bandwidth to 100Mbps)
   | 'subscriber-bandwidth';
+
+export type LoggerOptions = {
+  loggerName?: string;
+  loggerContextCb?: () => Record<string, unknown>;
+};

package/src/room/utils.ts

@@ -148,6 +148,11 @@ export function isSafari(): boolean {
   return getBrowser()?.name === 'Safari';
 }
 
+export function isSafari17(): boolean {
+  const b = getBrowser();
+  return b?.name === 'Safari' && b.version.startsWith('17.');
+}
+
 export function isMobile(): boolean {
   if (!isWeb()) return false;
   return /Tablet|iPad|Mobile|Android|BlackBerry/.test(navigator.userAgent);