@fishjam-cloud/ts-client 0.25.0 → 0.25.2

package/dist/index.d.mts

@@ -9,6 +9,38 @@ declare class TrackTypeError extends Error {
     constructor();
 }
 
+declare enum PeerMessage_SdkDeprecation_Status {
+    STATUS_UNSPECIFIED = 0,
+    STATUS_UP_TO_DATE = 1,
+    STATUS_DEPRECATED = 2,
+    STATUS_UNSUPPORTED = 3,
+    UNRECOGNIZED = -1
+}
+/** Deprecation status for SDK version */
+interface PeerMessage_SdkDeprecation {
+    status: PeerMessage_SdkDeprecation_Status;
+    message: string;
+}
+declare const PeerMessage_SdkDeprecation: MessageFns$3<PeerMessage_SdkDeprecation>;
+type Builtin$3 = Date | Function | Uint8Array | string | number | boolean | undefined;
+type DeepPartial$3<T> = T extends Builtin$3 ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial$3<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial$3<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial$3<T[K]>;
+} : Partial<T>;
+type KeysOfUnion$3<T> = T extends T ? keyof T : never;
+type Exact$3<P, I extends P> = P extends Builtin$3 ? P : P & {
+    [K in keyof P]: Exact$3<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion$3<P>>]: never;
+};
+interface MessageFns$3<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact$3<DeepPartial$3<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact$3<DeepPartial$3<T>, I>>(object: I): T;
+}
+
 declare const getLogger: (enableLogging: boolean) => {
     readonly debug: (arg: unknown, ...args: unknown[]) => void;
     readonly warn: (arg: unknown, ...args: unknown[]) => void;
@@ -896,9 +928,17 @@ type ReconnectConfig = {
     addTracksOnReconnect?: boolean;
 };
 
+/**
+ * Metadata attached to a track published by a peer.
+ * Sent over the signaling channel so other peers know what kind of track they're receiving.
+ * @category Tracks
+ */
 type TrackMetadata = {
+    /** The kind of media this track carries. */
     type: 'camera' | 'microphone' | 'screenShareVideo' | 'screenShareAudio' | 'customVideo' | 'customAudio';
+    /** Whether the track is currently muted/disabled. */
     paused: boolean;
+    /** The peer's display name, used in recordings. */
     displayName?: string;
 };
 type GenericMetadata = Record<string, unknown> | undefined;
@@ -1171,6 +1211,7 @@ declare class FishjamClient<PeerMetadata = GenericMetadata, ServerMetadata = Gen
     private initConnection;
     private getUrl;
     private initWebsocket;
+    handleSdkDeprecation(sdkDeprecation: PeerMessage_SdkDeprecation): void;
     /**
      * Retrieves statistics related to the RTCPeerConnection.
      * These statistics provide insights into the performance and status of the connection.
@@ -1536,9 +1577,11 @@ declare class FishjamClient<PeerMetadata = GenericMetadata, ServerMetadata = Gen
 type ReceiveLivestreamResult = {
     stream: MediaStream;
     stop: () => Promise<void>;
+    getStatistics: () => Promise<RTCStatsReport>;
 };
 type PublishLivestreamResult = {
     stopPublishing: () => Promise<void>;
+    getStatistics: () => Promise<RTCStatsReport>;
 };
 declare enum LivestreamError {
     UNAUTHORIZED = "unauthorized",