livekit-client 1.4.4 → 1.5.0

package/dist/ts4.2/src/connectionHelper/checks/Checker.d.ts

@@ -0,0 +1,59 @@
+import type TypedEmitter from 'typed-emitter';
+import type { RoomConnectOptions, RoomOptions } from '../../options';
+import Room from '../../room/Room';
+import type RTCEngine from '../../room/RTCEngine';
+declare type LogMessage = {
+    level: 'info' | 'warning' | 'error';
+    message: string;
+};
+export declare enum CheckStatus {
+    IDLE = 0,
+    RUNNING = 1,
+    SKIPPED = 2,
+    SUCCESS = 3,
+    FAILED = 4
+}
+export declare type CheckInfo = {
+    name: string;
+    logs: Array<LogMessage>;
+    status: CheckStatus;
+    description: string;
+};
+export interface CheckerOptions {
+    errorsAsWarnings?: boolean;
+    roomOptions?: RoomOptions;
+    connectOptions?: RoomConnectOptions;
+}
+declare const Checker_base: new () => TypedEmitter<CheckerCallbacks>;
+export declare abstract class Checker extends Checker_base {
+    protected url: string;
+    protected token: string;
+    room: Room;
+    connectOptions?: RoomConnectOptions;
+    status: CheckStatus;
+    logs: Array<LogMessage>;
+    errorsAsWarnings: boolean;
+    name: string;
+    constructor(url: string, token: string, options?: CheckerOptions);
+    abstract get description(): string;
+    protected abstract perform(): Promise<void>;
+    run(onComplete?: () => void): Promise<CheckInfo>;
+    protected isSuccess(): boolean;
+    protected connect(): Promise<Room>;
+    protected disconnect(): Promise<void>;
+    protected skip(): void;
+    protected appendMessage(message: string): void;
+    protected appendWarning(message: string): void;
+    protected appendError(message: string): void;
+    protected setStatus(status: CheckStatus): void;
+    protected get engine(): RTCEngine | undefined;
+    getInfo(): CheckInfo;
+}
+export declare type InstantiableCheck<T extends Checker> = {
+    new (url: string, token: string, options?: CheckerOptions): T;
+};
+declare type CheckerCallbacks = {
+    update: (info: CheckInfo) => void;
+};
+export {};
+//# sourceMappingURL=Checker.d.ts.map

package/dist/ts4.2/src/connectionHelper/checks/publishAudio.d.ts

@@ -0,0 +1,6 @@
+import { Checker } from './Checker';
+export declare class PublishAudioCheck extends Checker {
+    get description(): string;
+    perform(): Promise<void>;
+}
+//# sourceMappingURL=publishAudio.d.ts.map

package/dist/ts4.2/src/connectionHelper/checks/publishVideo.d.ts

@@ -0,0 +1,6 @@
+import { Checker } from './Checker';
+export declare class PublishVideoCheck extends Checker {
+    get description(): string;
+    perform(): Promise<void>;
+}
+//# sourceMappingURL=publishVideo.d.ts.map

package/dist/ts4.2/src/connectionHelper/checks/reconnect.d.ts

@@ -0,0 +1,6 @@
+import { Checker } from './Checker';
+export declare class ReconnectCheck extends Checker {
+    get description(): string;
+    perform(): Promise<void>;
+}
+//# sourceMappingURL=reconnect.d.ts.map

package/dist/ts4.2/src/connectionHelper/checks/turn.d.ts

@@ -0,0 +1,6 @@
+import { Checker } from './Checker';
+export declare class TURNCheck extends Checker {
+    get description(): string;
+    perform(): Promise<void>;
+}
+//# sourceMappingURL=turn.d.ts.map

package/dist/ts4.2/src/connectionHelper/checks/webrtc.d.ts

@@ -0,0 +1,6 @@
+import { Checker } from './Checker';
+export declare class WebRTCCheck extends Checker {
+    get description(): string;
+    protected perform(): Promise<void>;
+}
+//# sourceMappingURL=webrtc.d.ts.map

package/dist/ts4.2/src/connectionHelper/checks/websocket.d.ts

@@ -0,0 +1,6 @@
+import { Checker } from './Checker';
+export declare class WebSocketCheck extends Checker {
+    get description(): string;
+    protected perform(): Promise<void>;
+}
+//# sourceMappingURL=websocket.d.ts.map

package/dist/ts4.2/src/index.d.ts

@@ -0,0 +1,30 @@
+import { LogLevel, setLogExtension, setLogLevel } from './logger';
+import { DataPacket_Kind, DisconnectReason, VideoQuality } from './proto/livekit_models';
+import DefaultReconnectPolicy from './room/DefaultReconnectPolicy';
+import LocalParticipant from './room/participant/LocalParticipant';
+import Participant, { ConnectionQuality } from './room/participant/Participant';
+import type { ParticipantTrackPermission } from './room/participant/ParticipantTrackPermission';
+import RemoteParticipant from './room/participant/RemoteParticipant';
+import Room, { ConnectionState, RoomState } from './room/Room';
+import LocalAudioTrack from './room/track/LocalAudioTrack';
+import LocalTrack from './room/track/LocalTrack';
+import LocalTrackPublication from './room/track/LocalTrackPublication';
+import LocalVideoTrack from './room/track/LocalVideoTrack';
+import RemoteAudioTrack from './room/track/RemoteAudioTrack';
+import RemoteTrack from './room/track/RemoteTrack';
+import RemoteTrackPublication from './room/track/RemoteTrackPublication';
+import RemoteVideoTrack from './room/track/RemoteVideoTrack';
+import type { ElementInfo } from './room/track/RemoteVideoTrack';
+import { TrackPublication } from './room/track/TrackPublication';
+import { getEmptyAudioStreamTrack, getEmptyVideoStreamTrack, isBrowserSupported, supportsAdaptiveStream, supportsAV1, supportsDynacast } from './room/utils';
+export * from './options';
+export * from './room/errors';
+export * from './room/events';
+export * from './room/track/create';
+export * from './room/track/options';
+export * from './room/track/Track';
+export * from './room/track/types';
+export * from './version';
+export * from './connectionHelper/ConnectionCheck';
+export { setLogLevel, setLogExtension, getEmptyAudioStreamTrack, getEmptyVideoStreamTrack, isBrowserSupported, supportsAdaptiveStream, supportsDynacast, supportsAV1, LogLevel, Room, ConnectionState, RoomState, DataPacket_Kind, DisconnectReason, Participant, RemoteParticipant, LocalParticipant, LocalAudioTrack, LocalVideoTrack, LocalTrack, LocalTrackPublication, RemoteTrack, RemoteAudioTrack, RemoteVideoTrack, RemoteTrackPublication, ParticipantTrackPermission, TrackPublication, VideoQuality, ConnectionQuality, ElementInfo, DefaultReconnectPolicy, };
+//# sourceMappingURL=index.d.ts.map

package/dist/ts4.2/src/logger.d.ts

@@ -0,0 +1,26 @@
+export declare enum LogLevel {
+    trace = 0,
+    debug = 1,
+    info = 2,
+    warn = 3,
+    error = 4,
+    silent = 5
+}
+declare type LogLevelString = keyof typeof LogLevel;
+declare type StructuredLogger = {
+    trace: (msg: string, context?: object) => void;
+    debug: (msg: string, context?: object) => void;
+    info: (msg: string, context?: object) => void;
+    warn: (msg: string, context?: object) => void;
+    error: (msg: string, context?: object) => void;
+};
+declare const _default: StructuredLogger;
+export default _default;
+export declare function setLogLevel(level: LogLevel | LogLevelString): void;
+export declare type LogExtension = (level: LogLevel, msg: string, context?: object) => void;
+/**
+ * use this to hook into the logging function to allow sending internal livekit logs to third party services
+ * if set, the browser logs will lose their stacktrace information (see https://github.com/pimterry/loglevel#writing-plugins)
+ */
+export declare function setLogExtension(extension: LogExtension): void;
+//# sourceMappingURL=logger.d.ts.map

package/dist/ts4.2/src/options.d.ts

@@ -0,0 +1,91 @@
+import type { ReconnectPolicy } from './room/ReconnectPolicy';
+import type { AudioCaptureOptions, AudioOutputOptions, TrackPublishDefaults, VideoCaptureOptions } from './room/track/options';
+import type { AdaptiveStreamSettings } from './room/track/types';
+/**
+ * @internal
+ */
+export interface InternalRoomOptions {
+    /**
+     * AdaptiveStream lets LiveKit automatically manage quality of subscribed
+     * video tracks to optimize for bandwidth and CPU.
+     * When attached video elements are visible, it'll choose an appropriate
+     * resolution based on the size of largest video element it's attached to.
+     *
+     * When none of the video elements are visible, it'll temporarily pause
+     * the data flow until they are visible again.
+     */
+    adaptiveStream: AdaptiveStreamSettings | boolean;
+    /**
+     * enable Dynacast, off by default. With Dynacast dynamically pauses
+     * video layers that are not being consumed by any subscribers, significantly
+     * reducing publishing CPU and bandwidth usage.
+     */
+    dynacast: boolean;
+    /**
+     * default options to use when capturing user's audio
+     */
+    audioCaptureDefaults?: AudioCaptureOptions;
+    /**
+     * default options to use when capturing user's video
+     */
+    videoCaptureDefaults?: VideoCaptureOptions;
+    /**
+     * default options to use when publishing tracks
+     */
+    publishDefaults?: TrackPublishDefaults;
+    /**
+     * audio output for the room
+     */
+    audioOutput?: AudioOutputOptions;
+    /**
+     * should local tracks be stopped when they are unpublished. defaults to true
+     * set this to false if you would prefer to clean up unpublished local tracks manually.
+     */
+    stopLocalTrackOnUnpublish: boolean;
+    /**
+     * policy to use when attempting to reconnect
+     */
+    reconnectPolicy: ReconnectPolicy;
+    /**
+     * @internal
+     * experimental flag, introduce a delay before sending signaling messages
+     */
+    expSignalLatency?: number;
+    /**
+     * @internal
+     * @experimental
+     * experimental flag, mix all audio tracks in web audio
+     */
+    expWebAudioMix: boolean;
+}
+/**
+ * Options for when creating a new room
+ */
+export interface RoomOptions extends Partial<InternalRoomOptions> {
+}
+/**
+ * @internal
+ */
+export interface InternalRoomConnectOptions {
+    /** autosubscribe to room tracks after joining, defaults to true */
+    autoSubscribe: boolean;
+    /** amount of time for PeerConnection to be established, defaults to 15s */
+    peerConnectionTimeout: number;
+    /**
+     * use to override any RTCConfiguration options.
+     */
+    rtcConfig?: RTCConfiguration;
+    /**
+     * @deprecated
+     * publish only mode
+     */
+    publishOnly?: string;
+    /** specifies how often an initial join connection is allowed to retry (only applicable if server is not reachable) */
+    maxRetries: number;
+}
+/**
+ * Options for Room.connect()
+ */
+export interface RoomConnectOptions extends Partial<InternalRoomConnectOptions> {
+}
+//# sourceMappingURL=options.d.ts.map

package/dist/ts4.2/src/proto/google/protobuf/timestamp.d.ts

@@ -0,0 +1,141 @@
+import _m0 from "protobufjs/minimal";
+export declare const protobufPackage = "google.protobuf";
+/**
+ * A Timestamp represents a point in time independent of any time zone or local
+ * calendar, encoded as a count of seconds and fractions of seconds at
+ * nanosecond resolution. The count is relative to an epoch at UTC midnight on
+ * January 1, 1970, in the proleptic Gregorian calendar which extends the
+ * Gregorian calendar backwards to year one.
+ *
+ * All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+ * second table is needed for interpretation, using a [24-hour linear
+ * smear](https://developers.google.com/time/smear).
+ *
+ * The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
+ * restricting to that range, we ensure that we can convert to and from [RFC
+ * 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
+ *
+ * # Examples
+ *
+ * Example 1: Compute Timestamp from POSIX `time()`.
+ *
+ *     Timestamp timestamp;
+ *     timestamp.set_seconds(time(NULL));
+ *     timestamp.set_nanos(0);
+ *
+ * Example 2: Compute Timestamp from POSIX `gettimeofday()`.
+ *
+ *     struct timeval tv;
+ *     gettimeofday(&tv, NULL);
+ *
+ *     Timestamp timestamp;
+ *     timestamp.set_seconds(tv.tv_sec);
+ *     timestamp.set_nanos(tv.tv_usec * 1000);
+ *
+ * Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
+ *
+ *     FILETIME ft;
+ *     GetSystemTimeAsFileTime(&ft);
+ *     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+ *
+ *     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+ *     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+ *     Timestamp timestamp;
+ *     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+ *     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+ *
+ * Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
+ *
+ *     long millis = System.currentTimeMillis();
+ *
+ *     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+ *         .setNanos((int) ((millis % 1000) * 1000000)).build();
+ *
+ * Example 5: Compute Timestamp from Java `Instant.now()`.
+ *
+ *     Instant now = Instant.now();
+ *
+ *     Timestamp timestamp =
+ *         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+ *             .setNanos(now.getNano()).build();
+ *
+ * Example 6: Compute Timestamp from current time in Python.
+ *
+ *     timestamp = Timestamp()
+ *     timestamp.GetCurrentTime()
+ *
+ * # JSON Mapping
+ *
+ * In JSON format, the Timestamp type is encoded as a string in the
+ * [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+ * format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
+ * where {year} is always expressed using four digits while {month}, {day},
+ * {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
+ * seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+ * are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+ * is required. A proto3 JSON serializer should always use UTC (as indicated by
+ * "Z") when printing the Timestamp type and a proto3 JSON parser should be
+ * able to accept both UTC and other timezones (as indicated by an offset).
+ *
+ * For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+ * 01:30 UTC on January 15, 2017.
+ *
+ * In JavaScript, one can convert a Date object to this format using the
+ * standard
+ * [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
+ * method. In Python, a standard `datetime.datetime` object can be converted
+ * to this format using
+ * [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
+ * the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
+ * the Joda Time's [`ISODateTimeFormat.dateTime()`](
+ * http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
+ * ) to obtain a formatter capable of generating timestamps in this format.
+ */
+export interface Timestamp {
+    /**
+     * Represents seconds of UTC time since Unix epoch
+     * 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+     * 9999-12-31T23:59:59Z inclusive.
+     */
+    seconds: number;
+    /**
+     * Non-negative fractions of a second at nanosecond resolution. Negative
+     * second values with fractions must still have non-negative nanos values
+     * that count forward in time. Must be from 0 to 999,999,999
+     * inclusive.
+     */
+    nanos: number;
+}
+export declare const Timestamp: {
+    encode(message: Timestamp, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): Timestamp;
+    fromJSON(object: any): Timestamp;
+    toJSON(message: Timestamp): unknown;
+    fromPartial<I extends {
+        seconds?: number | undefined;
+        nanos?: number | undefined;
+    } & {
+        seconds?: number | undefined;
+        nanos?: number | undefined;
+    } & {
+        [K in Exclude<keyof I, keyof Timestamp>]: never;
+    }>(object: I): Timestamp;
+};
+declare type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export declare type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
+    $case: string;
+} ? {
+    [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]>;
+} & {
+    $case: T["$case"];
+} : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+declare type KeysOfUnion<T> = T extends T ? keyof T : never;
+export declare type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export {};
+//# sourceMappingURL=timestamp.d.ts.map