livekit-client 0.17.2 → 0.17.5

package/src/room/Room.ts

@@ -5,7 +5,7 @@ import log from '../logger';
 import { RoomConnectOptions, RoomOptions } from '../options';
 import {
   DataPacket_Kind, ParticipantInfo,
-  ParticipantInfo_State, Room as RoomModel, SpeakerInfo, UserPacket,
+  ParticipantInfo_State, ParticipantPermission, Room as RoomModel, SpeakerInfo, UserPacket,
 } from '../proto/livekit_models';
 import {
   ConnectionQualityUpdate,
@@ -93,6 +93,14 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
     this.participants = new Map();
     this.options = options || {};
 
+    switch (this.options?.publishDefaults?.videoCodec) {
+      case 'av1':
+      case 'vp9':
+        this.options.publishDefaults.simulcast = undefined;
+        break;
+      default:
+    }
+
     this.options.audioCaptureDefaults = {
       ...audioDefaults,
       ...options?.audioCaptureDefaults,
@@ -211,12 +219,9 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       this.state = RoomState.Connected;
       this.emit(RoomEvent.StateChanged, this.state);
       const pi = joinResponse.participant!;
-      this.localParticipant = new LocalParticipant(
-        pi.sid,
-        pi.identity,
-        this.engine,
-        this.options,
-      );
+
+      this.localParticipant.sid = pi.sid;
+      this.localParticipant.identity = pi.identity;
 
       this.localParticipant.updateInfo(pi);
       // forward metadata changed for the local participant
@@ -244,7 +249,15 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
         })
         .on(ParticipantEvent.MediaDevicesError, (e: Error) => {
           this.emit(RoomEvent.MediaDevicesError, e);
-        });
+        })
+        .on(ParticipantEvent.ParticipantPermissionsChanged,
+          (prevPermissions: ParticipantPermission) => {
+            this.emit(
+              RoomEvent.ParticipantPermissionsChanged,
+              prevPermissions,
+              this.localParticipant,
+            );
+          });
 
       // populate remote participants, these should not trigger new events
       joinResponse.otherParticipants.forEach((info) => {
@@ -802,7 +815,11 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       })
       .on(ParticipantEvent.ConnectionQualityChanged, (quality: ConnectionQuality) => {
         this.emit(RoomEvent.ConnectionQualityChanged, quality, participant);
-      });
+      })
+      .on(ParticipantEvent.ParticipantPermissionsChanged,
+        (prevPermissions: ParticipantPermission) => {
+          this.emit(RoomEvent.ParticipantPermissionsChanged, prevPermissions, participant);
+        });
     return participant;
   }
 
@@ -907,6 +924,10 @@ export type RoomEventCallbacks = {
     metadata: string | undefined,
     participant: RemoteParticipant | LocalParticipant
   ) => void,
+  participantPermissionsChanged: (
+    prevPermissions: ParticipantPermission,
+    participant: RemoteParticipant | LocalParticipant
+  ) => void,
   activeSpeakersChanged: (speakers: Array<Participant>) => void,
   roomMetadataChanged: (metadata: string) => void,
   dataReceived: (

package/src/room/events.ts

@@ -225,6 +225,12 @@ export enum RoomEvent {
    * args: (error: Error)
    */
   MediaDevicesError = 'mediaDevicesError',
+
+  /**
+   * A participant's permission has changed. Currently only fired on LocalParticipant.
+   * args: (prevPermissions: [[ParticipantPermission]], participant: [[Participant]])
+   */
+  ParticipantPermissionsChanged = 'participantPermissionsChanged',
 }
 
 export enum ParticipantEvent {
@@ -370,6 +376,12 @@ export enum ParticipantEvent {
   // fired only on LocalParticipant
   /** @internal */
   MediaDevicesError = 'mediaDevicesError',
+
+  /**
+   * A participant's permission has changed. Currently only fired on LocalParticipant.
+   * args: (prevPermissions: [[ParticipantPermission]])
+   */
+  ParticipantPermissionsChanged = 'participantPermissionsChanged',
 }
 
 /** @internal */

package/src/room/participant/LocalParticipant.ts

@@ -1,10 +1,11 @@
 import log from '../../logger';
 import { RoomOptions } from '../../options';
 import {
-  DataPacket, DataPacket_Kind,
+  DataPacket, DataPacket_Kind, ParticipantPermission,
 } from '../../proto/livekit_models';
 import {
-  AddTrackRequest, DataChannelInfo, SubscribedQualityUpdate, TrackPublishedResponse,
+  AddTrackRequest, DataChannelInfo,
+  SubscribedQualityUpdate, TrackPublishedResponse, TrackUnpublishedResponse,
 } from '../../proto/livekit_rtc';
 import {
   TrackInvalidError,
@@ -71,6 +72,8 @@ export default class LocalParticipant extends Participant {
     };
 
     this.engine.client.onSubscribedQualityUpdate = this.handleSubscribedQualityUpdate;
+
+    this.engine.client.onLocalTrackUnpublished = this.handleLocalTrackUnpublished;
   }
 
   get lastCameraError(): Error | undefined {
@@ -120,6 +123,16 @@ export default class LocalParticipant extends Participant {
     return this.setTrackEnabled(Track.Source.ScreenShare, enabled);
   }
 
+  /** @internal */
+  setPermissions(permissions: ParticipantPermission): boolean {
+    const prevPermissions = this.permissions;
+    const changed = super.setPermissions(permissions);
+    if (changed && prevPermissions) {
+      this.emit(ParticipantEvent.ParticipantPermissionsChanged, prevPermissions);
+    }
+    return changed;
+  }
+
   /**
    * Enable or disable publishing for a track by source. This serves as a simple
    * way to manage the common tracks (camera, mic, or screen share)
@@ -620,6 +633,16 @@ export default class LocalParticipant extends Participant {
     pub.videoTrack?.setPublishingLayers(update.subscribedQualities);
   };
 
+  private handleLocalTrackUnpublished = (unpublished: TrackUnpublishedResponse) => {
+    const track = this.tracks.get(unpublished.trackSid);
+    if (!track) {
+      log.warn('handleLocalTrackUnpublished',
+        'received unpublished event for unknown track', unpublished.trackSid);
+      return;
+    }
+    this.unpublishTrack(track.track!);
+  };
+
   private onTrackUnpublish = (track: LocalTrack) => {
     this.unpublishTrack(track);
   };

package/src/room/participant/Participant.ts

@@ -1,6 +1,8 @@
 import { EventEmitter } from 'events';
 import type TypedEmitter from 'typed-emitter';
-import { ConnectionQuality as ProtoQuality, DataPacket_Kind, ParticipantInfo } from '../../proto/livekit_models';
+import {
+  ConnectionQuality as ProtoQuality, DataPacket_Kind, ParticipantInfo, ParticipantPermission,
+} from '../../proto/livekit_models';
 import { ParticipantEvent, TrackEvent } from '../events';
 import LocalTrackPublication from '../track/LocalTrackPublication';
 import RemoteTrackPublication from '../track/RemoteTrackPublication';
@@ -60,6 +62,8 @@ export default class Participant extends (
 
   lastSpokeAt?: Date | undefined;
 
+  permissions?: ParticipantPermission;
+
   private _connectionQuality: ConnectionQuality = ConnectionQuality.Unknown;
 
   /** @internal */
@@ -153,13 +157,16 @@ export default class Participant extends (
     this.sid = info.sid;
     this.name = info.name;
     this.setMetadata(info.metadata);
+    if (info.permission) {
+      this.setPermissions(info.permission);
+    }
     // set this last so setMetadata can detect changes
     this.participantInfo = info;
   }
 
   /** @internal */
   setMetadata(md: string) {
-    const changed = !this.participantInfo || this.participantInfo.metadata !== md;
+    const changed = this.metadata !== md;
     const prevMetadata = this.metadata;
     this.metadata = md;
 
@@ -169,6 +176,18 @@ export default class Participant extends (
     }
   }
 
+  /** @internal */
+  setPermissions(permissions: ParticipantPermission): boolean {
+    const changed = permissions.canPublish !== this.permissions?.canPublish
+      || permissions.canSubscribe !== this.permissions?.canSubscribe
+      || permissions.canPublishData !== this.permissions?.canPublishData
+      || permissions.hidden !== this.permissions?.hidden
+      || permissions.recorder !== this.permissions?.recorder;
+    this.permissions = permissions;
+
+    return changed;
+  }
+
   /** @internal */
   setIsSpeaking(speaking: boolean) {
     if (speaking === this.isSpeaking) {
@@ -246,4 +265,5 @@ export type ParticipantEventCallbacks = {
     status: TrackPublication.SubscriptionStatus
   ) => void,
   mediaDevicesError: (error: Error) => void,
+  participantPermissionsChanged: (prevPermissions: ParticipantPermission) => void,
 };

package/src/room/track/Track.ts

@@ -3,7 +3,7 @@ import type TypedEventEmitter from 'typed-emitter';
 import { TrackSource, TrackType } from '../../proto/livekit_models';
 import { StreamState as ProtoStreamState } from '../../proto/livekit_rtc';
 import { TrackEvent } from '../events';
-import { isFireFox, isSafari } from '../utils';
+import { isFireFox, isSafari, isWeb } from '../utils';
 
 // keep old audio elements when detached, we would re-use them since on iOS
 // Safari tracks which audio elements have been "blessed" by the user.
@@ -36,8 +36,12 @@ export class Track extends (EventEmitter as new () => TypedEventEmitter<TrackEve
     this.kind = kind;
     this.mediaStreamTrack = mediaTrack;
     this.source = Track.Source.Unknown;
-    this.isInBackground = document.visibilityState === 'hidden';
-    document.addEventListener('visibilitychange', this.appVisibilityChangedListener);
+    if (isWeb()) {
+      this.isInBackground = document.visibilityState === 'hidden';
+      document.addEventListener('visibilitychange', this.appVisibilityChangedListener);
+    } else {
+      this.isInBackground = false;
+    }
   }
 
   /** current receive bits per second */
@@ -135,7 +139,9 @@ export class Track extends (EventEmitter as new () => TypedEventEmitter<TrackEve
 
   stop() {
     this.mediaStreamTrack.stop();
-    document.removeEventListener('visibilitychange', this.appVisibilityChangedListener);
+    if (isWeb()) {
+      document.removeEventListener('visibilitychange', this.appVisibilityChangedListener);
+    }
   }
 
   protected enable() {

package/src/room/track/options.ts

@@ -198,7 +198,7 @@ export interface AudioPreset {
   maxBitrate: number;
 }
 
-export type VideoCodec = 'vp8' | 'h264';
+export type VideoCodec = 'vp8' | 'h264' | 'av1' | 'vp9';
 
 export namespace AudioPresets {
   export const telephone: AudioPreset = {

package/src/version.ts

@@ -1,2 +1,2 @@
-export const version = '0.17.2';
-export const protocolVersion = 6;
+export const version = '0.17.5';
+export const protocolVersion = 7;