livekit-client 1.9.1 → 1.9.3

package/dist/src/room/track/Track.d.ts

@@ -1,125 +1,125 @@
-import type TypedEventEmitter from 'typed-emitter';
-import type { SignalClient } from '../../api/SignalClient';
-import { TrackSource, TrackType } from '../../proto/livekit_models';
-import { StreamState as ProtoStreamState } from '../../proto/livekit_rtc';
-declare const Track_base: new () => TypedEventEmitter<TrackEventCallbacks>;
-export declare abstract class Track extends Track_base {
-    kind: Track.Kind;
-    attachedElements: HTMLMediaElement[];
-    isMuted: boolean;
-    source: Track.Source;
-    /**
-     * sid is set after track is published to server, or if it's a remote track
-     */
-    sid?: Track.SID;
-    /**
-     * @internal
-     */
-    mediaStream?: MediaStream;
-    /**
-     * indicates current state of stream, it'll indicate `paused` if the track
-     * has been paused by congestion controller
-     */
-    streamState: Track.StreamState;
-    protected _mediaStreamTrack: MediaStreamTrack;
-    protected _mediaStreamID: string;
-    protected isInBackground: boolean;
-    private backgroundTimeout;
-    protected _currentBitrate: number;
-    protected monitorInterval?: ReturnType<typeof setInterval>;
-    protected constructor(mediaTrack: MediaStreamTrack, kind: Track.Kind);
-    /** current receive bits per second */
-    get currentBitrate(): number;
-    get mediaStreamTrack(): MediaStreamTrack;
-    /**
-     * @internal
-     * used for keep mediaStream's first id, since it's id might change
-     * if we disable/enable a track
-     */
-    get mediaStreamID(): string;
-    /**
-     * creates a new HTMLAudioElement or HTMLVideoElement, attaches to it, and returns it
-     */
-    attach(): HTMLMediaElement;
-    /**
-     * attaches track to an existing HTMLAudioElement or HTMLVideoElement
-     */
-    attach(element: HTMLMediaElement): HTMLMediaElement;
-    /**
-     * Detaches from all attached elements
-     */
-    detach(): HTMLMediaElement[];
-    /**
-     * Detach from a single element
-     * @param element
-     */
-    detach(element: HTMLMediaElement): HTMLMediaElement;
-    stop(): void;
-    protected enable(): void;
-    protected disable(): void;
-    abstract startMonitor(signalClient?: SignalClient): void;
-    stopMonitor(): void;
-    private recycleElement;
-    protected appVisibilityChangedListener: () => void;
-    protected handleAppVisibilityChanged(): Promise<void>;
-    protected addAppVisibilityListener(): void;
-    protected removeAppVisibilityListener(): void;
-}
-/** @internal */
-export declare function attachToElement(track: MediaStreamTrack, element: HTMLMediaElement): void;
-/** @internal */
-export declare function detachTrack(track: MediaStreamTrack, element: HTMLMediaElement): void;
-export declare namespace Track {
-    enum Kind {
-        Audio = "audio",
-        Video = "video",
-        Unknown = "unknown"
-    }
-    type SID = string;
-    enum Source {
-        Camera = "camera",
-        Microphone = "microphone",
-        ScreenShare = "screen_share",
-        ScreenShareAudio = "screen_share_audio",
-        Unknown = "unknown"
-    }
-    enum StreamState {
-        Active = "active",
-        Paused = "paused",
-        Unknown = "unknown"
-    }
-    interface Dimensions {
-        width: number;
-        height: number;
-    }
-    /** @internal */
-    function kindToProto(k: Kind): TrackType;
-    /** @internal */
-    function kindFromProto(t: TrackType): Kind | undefined;
-    /** @internal */
-    function sourceToProto(s: Source): TrackSource;
-    /** @internal */
-    function sourceFromProto(s: TrackSource): Source;
-    /** @internal */
-    function streamStateFromProto(s: ProtoStreamState): StreamState;
-}
-export type TrackEventCallbacks = {
-    message: () => void;
-    muted: (track?: any) => void;
-    unmuted: (track?: any) => void;
-    restarted: (track?: any) => void;
-    ended: (track?: any) => void;
-    updateSettings: () => void;
-    updateSubscription: () => void;
-    audioPlaybackStarted: () => void;
-    audioPlaybackFailed: (error: Error) => void;
-    audioSilenceDetected: () => void;
-    visibilityChanged: (visible: boolean, track?: any) => void;
-    videoDimensionsChanged: (dimensions: Track.Dimensions, track?: any) => void;
-    elementAttached: (element: HTMLMediaElement) => void;
-    elementDetached: (element: HTMLMediaElement) => void;
-    upstreamPaused: (track: any) => void;
-    upstreamResumed: (track: any) => void;
-};
-export {};
+import type TypedEventEmitter from 'typed-emitter';
+import type { SignalClient } from '../../api/SignalClient';
+import { TrackSource, TrackType } from '../../proto/livekit_models';
+import { StreamState as ProtoStreamState } from '../../proto/livekit_rtc';
+declare const Track_base: new () => TypedEventEmitter<TrackEventCallbacks>;
+export declare abstract class Track extends Track_base {
+    kind: Track.Kind;
+    attachedElements: HTMLMediaElement[];
+    isMuted: boolean;
+    source: Track.Source;
+    /**
+     * sid is set after track is published to server, or if it's a remote track
+     */
+    sid?: Track.SID;
+    /**
+     * @internal
+     */
+    mediaStream?: MediaStream;
+    /**
+     * indicates current state of stream, it'll indicate `paused` if the track
+     * has been paused by congestion controller
+     */
+    streamState: Track.StreamState;
+    protected _mediaStreamTrack: MediaStreamTrack;
+    protected _mediaStreamID: string;
+    protected isInBackground: boolean;
+    private backgroundTimeout;
+    protected _currentBitrate: number;
+    protected monitorInterval?: ReturnType<typeof setInterval>;
+    protected constructor(mediaTrack: MediaStreamTrack, kind: Track.Kind);
+    /** current receive bits per second */
+    get currentBitrate(): number;
+    get mediaStreamTrack(): MediaStreamTrack;
+    /**
+     * @internal
+     * used for keep mediaStream's first id, since it's id might change
+     * if we disable/enable a track
+     */
+    get mediaStreamID(): string;
+    /**
+     * creates a new HTMLAudioElement or HTMLVideoElement, attaches to it, and returns it
+     */
+    attach(): HTMLMediaElement;
+    /**
+     * attaches track to an existing HTMLAudioElement or HTMLVideoElement
+     */
+    attach(element: HTMLMediaElement): HTMLMediaElement;
+    /**
+     * Detaches from all attached elements
+     */
+    detach(): HTMLMediaElement[];
+    /**
+     * Detach from a single element
+     * @param element
+     */
+    detach(element: HTMLMediaElement): HTMLMediaElement;
+    stop(): void;
+    protected enable(): void;
+    protected disable(): void;
+    abstract startMonitor(signalClient?: SignalClient): void;
+    stopMonitor(): void;
+    private recycleElement;
+    protected appVisibilityChangedListener: () => void;
+    protected handleAppVisibilityChanged(): Promise<void>;
+    protected addAppVisibilityListener(): void;
+    protected removeAppVisibilityListener(): void;
+}
+/** @internal */
+export declare function attachToElement(track: MediaStreamTrack, element: HTMLMediaElement): void;
+/** @internal */
+export declare function detachTrack(track: MediaStreamTrack, element: HTMLMediaElement): void;
+export declare namespace Track {
+    enum Kind {
+        Audio = "audio",
+        Video = "video",
+        Unknown = "unknown"
+    }
+    type SID = string;
+    enum Source {
+        Camera = "camera",
+        Microphone = "microphone",
+        ScreenShare = "screen_share",
+        ScreenShareAudio = "screen_share_audio",
+        Unknown = "unknown"
+    }
+    enum StreamState {
+        Active = "active",
+        Paused = "paused",
+        Unknown = "unknown"
+    }
+    interface Dimensions {
+        width: number;
+        height: number;
+    }
+    /** @internal */
+    function kindToProto(k: Kind): TrackType;
+    /** @internal */
+    function kindFromProto(t: TrackType): Kind | undefined;
+    /** @internal */
+    function sourceToProto(s: Source): TrackSource;
+    /** @internal */
+    function sourceFromProto(s: TrackSource): Source;
+    /** @internal */
+    function streamStateFromProto(s: ProtoStreamState): StreamState;
+}
+export type TrackEventCallbacks = {
+    message: () => void;
+    muted: (track?: any) => void;
+    unmuted: (track?: any) => void;
+    restarted: (track?: any) => void;
+    ended: (track?: any) => void;
+    updateSettings: () => void;
+    updateSubscription: () => void;
+    audioPlaybackStarted: () => void;
+    audioPlaybackFailed: (error: Error) => void;
+    audioSilenceDetected: () => void;
+    visibilityChanged: (visible: boolean, track?: any) => void;
+    videoDimensionsChanged: (dimensions: Track.Dimensions, track?: any) => void;
+    elementAttached: (element: HTMLMediaElement) => void;
+    elementDetached: (element: HTMLMediaElement) => void;
+    upstreamPaused: (track: any) => void;
+    upstreamResumed: (track: any) => void;
+};
+export {};
 //# sourceMappingURL=Track.d.ts.map

package/dist/src/room/track/TrackPublication.d.ts

@@ -1,68 +1,68 @@
-import type TypedEventEmitter from 'typed-emitter';
-import type { TrackInfo } from '../../proto/livekit_models';
-import type { UpdateSubscription, UpdateTrackSettings } from '../../proto/livekit_rtc';
-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';
-declare const TrackPublication_base: new () => TypedEventEmitter<PublicationEventCallbacks>;
-export declare class TrackPublication extends TrackPublication_base {
-    kind: Track.Kind;
-    trackName: string;
-    trackSid: Track.SID;
-    track?: Track;
-    source: Track.Source;
-    /** MimeType of the published track */
-    mimeType?: string;
-    /** dimension of the original published stream, video-only */
-    dimensions?: Track.Dimensions;
-    /** true if track was simulcasted to server, video-only */
-    simulcasted?: boolean;
-    /** @internal */
-    trackInfo?: TrackInfo;
-    protected metadataMuted: boolean;
-    constructor(kind: Track.Kind, id: string, name: string);
-    /** @internal */
-    setTrack(track?: Track): void;
-    get isMuted(): boolean;
-    get isEnabled(): boolean;
-    get isSubscribed(): boolean;
-    /**
-     * an [AudioTrack] if this publication holds an audio track
-     */
-    get audioTrack(): LocalAudioTrack | RemoteAudioTrack | undefined;
-    /**
-     * an [VideoTrack] if this publication holds a video track
-     */
-    get videoTrack(): LocalVideoTrack | RemoteVideoTrack | undefined;
-    handleMuted: () => void;
-    handleUnmuted: () => void;
-    /** @internal */
-    updateInfo(info: TrackInfo): void;
-}
-export declare namespace TrackPublication {
-    enum SubscriptionStatus {
-        Desired = "desired",
-        Subscribed = "subscribed",
-        Unsubscribed = "unsubscribed"
-    }
-    enum PermissionStatus {
-        Allowed = "allowed",
-        NotAllowed = "not_allowed"
-    }
-}
-export type PublicationEventCallbacks = {
-    muted: () => void;
-    unmuted: () => void;
-    ended: (track?: Track) => void;
-    updateSettings: (settings: UpdateTrackSettings) => void;
-    subscriptionPermissionChanged: (status: TrackPublication.PermissionStatus, prevStatus: TrackPublication.PermissionStatus) => void;
-    updateSubscription: (sub: UpdateSubscription) => void;
-    subscribed: (track: RemoteTrack) => void;
-    unsubscribed: (track: RemoteTrack) => void;
-    subscriptionStatusChanged: (status: TrackPublication.SubscriptionStatus, prevStatus: TrackPublication.SubscriptionStatus) => void;
-};
-export {};
+import type TypedEventEmitter from 'typed-emitter';
+import type { TrackInfo } from '../../proto/livekit_models';
+import type { UpdateSubscription, UpdateTrackSettings } from '../../proto/livekit_rtc';
+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';
+declare const TrackPublication_base: new () => TypedEventEmitter<PublicationEventCallbacks>;
+export declare class TrackPublication extends TrackPublication_base {
+    kind: Track.Kind;
+    trackName: string;
+    trackSid: Track.SID;
+    track?: Track;
+    source: Track.Source;
+    /** MimeType of the published track */
+    mimeType?: string;
+    /** dimension of the original published stream, video-only */
+    dimensions?: Track.Dimensions;
+    /** true if track was simulcasted to server, video-only */
+    simulcasted?: boolean;
+    /** @internal */
+    trackInfo?: TrackInfo;
+    protected metadataMuted: boolean;
+    constructor(kind: Track.Kind, id: string, name: string);
+    /** @internal */
+    setTrack(track?: Track): void;
+    get isMuted(): boolean;
+    get isEnabled(): boolean;
+    get isSubscribed(): boolean;
+    /**
+     * an [AudioTrack] if this publication holds an audio track
+     */
+    get audioTrack(): LocalAudioTrack | RemoteAudioTrack | undefined;
+    /**
+     * an [VideoTrack] if this publication holds a video track
+     */
+    get videoTrack(): LocalVideoTrack | RemoteVideoTrack | undefined;
+    handleMuted: () => void;
+    handleUnmuted: () => void;
+    /** @internal */
+    updateInfo(info: TrackInfo): void;
+}
+export declare namespace TrackPublication {
+    enum SubscriptionStatus {
+        Desired = "desired",
+        Subscribed = "subscribed",
+        Unsubscribed = "unsubscribed"
+    }
+    enum PermissionStatus {
+        Allowed = "allowed",
+        NotAllowed = "not_allowed"
+    }
+}
+export type PublicationEventCallbacks = {
+    muted: () => void;
+    unmuted: () => void;
+    ended: (track?: Track) => void;
+    updateSettings: (settings: UpdateTrackSettings) => void;
+    subscriptionPermissionChanged: (status: TrackPublication.PermissionStatus, prevStatus: TrackPublication.PermissionStatus) => void;
+    updateSubscription: (sub: UpdateSubscription) => void;
+    subscribed: (track: RemoteTrack) => void;
+    unsubscribed: (track: RemoteTrack) => void;
+    subscriptionStatusChanged: (status: TrackPublication.SubscriptionStatus, prevStatus: TrackPublication.SubscriptionStatus) => void;
+};
+export {};
 //# sourceMappingURL=TrackPublication.d.ts.map

package/dist/src/room/track/create.d.ts

@@ -1,24 +1,24 @@
-import LocalAudioTrack from './LocalAudioTrack';
-import type LocalTrack from './LocalTrack';
-import LocalVideoTrack from './LocalVideoTrack';
-import { AudioCaptureOptions, CreateLocalTracksOptions, ScreenShareCaptureOptions, VideoCaptureOptions } from './options';
-/**
- * Creates a local video and audio track at the same time. When acquiring both
- * audio and video tracks together, it'll display a single permission prompt to
- * the user instead of two separate ones.
- * @param options
- */
-export declare function createLocalTracks(options?: CreateLocalTracksOptions): Promise<Array<LocalTrack>>;
-/**
- * Creates a [[LocalVideoTrack]] with getUserMedia()
- * @param options
- */
-export declare function createLocalVideoTrack(options?: VideoCaptureOptions): Promise<LocalVideoTrack>;
-export declare function createLocalAudioTrack(options?: AudioCaptureOptions): Promise<LocalAudioTrack>;
-/**
- * Creates a screen capture tracks with getDisplayMedia().
- * A LocalVideoTrack is always created and returned.
- * If { audio: true }, and the browser supports audio capture, a LocalAudioTrack is also created.
- */
-export declare function createLocalScreenTracks(options?: ScreenShareCaptureOptions): Promise<Array<LocalTrack>>;
+import LocalAudioTrack from './LocalAudioTrack';
+import type LocalTrack from './LocalTrack';
+import LocalVideoTrack from './LocalVideoTrack';
+import type { AudioCaptureOptions, CreateLocalTracksOptions, ScreenShareCaptureOptions, VideoCaptureOptions } from './options';
+/**
+ * Creates a local video and audio track at the same time. When acquiring both
+ * audio and video tracks together, it'll display a single permission prompt to
+ * the user instead of two separate ones.
+ * @param options
+ */
+export declare function createLocalTracks(options?: CreateLocalTracksOptions): Promise<Array<LocalTrack>>;
+/**
+ * Creates a [[LocalVideoTrack]] with getUserMedia()
+ * @param options
+ */
+export declare function createLocalVideoTrack(options?: VideoCaptureOptions): Promise<LocalVideoTrack>;
+export declare function createLocalAudioTrack(options?: AudioCaptureOptions): Promise<LocalAudioTrack>;
+/**
+ * Creates a screen capture tracks with getDisplayMedia().
+ * A LocalVideoTrack is always created and returned.
+ * If { audio: true }, and the browser supports audio capture, a LocalAudioTrack is also created.
+ */
+export declare function createLocalScreenTracks(options?: ScreenShareCaptureOptions): Promise<Array<LocalTrack>>;
 //# sourceMappingURL=create.d.ts.map

package/dist/src/room/track/create.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../../src/room/track/create.ts"],"names":[],"mappings":"AAIA,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,mBAAmB,EAEpB,MAAM,WAAW,CAAC;AAGnB;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CA2C5B;AAED;;;GAGG;AACH,wBAAsB,qBAAqB,CACzC,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,eAAe,CAAC,CAM1B;AAED,wBAAsB,qBAAqB,CACzC,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,eAAe,CAAC,CAM1B;AAED;;;;GAIG;AACH,wBAAsB,uBAAuB,CAC3C,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAwC5B"}
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../../src/room/track/create.ts"],"names":[],"mappings":"AAIA,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAGhD,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,mBAAmB,EACpB,MAAM,WAAW,CAAC;AAGnB;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CA2C5B;AAED;;;GAGG;AACH,wBAAsB,qBAAqB,CACzC,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,eAAe,CAAC,CAM1B;AAED,wBAAsB,qBAAqB,CACzC,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,eAAe,CAAC,CAM1B;AAED;;;;GAIG;AACH,wBAAsB,uBAAuB,CAC3C,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAwC5B"}