@fishjam-cloud/ts-client 0.25.1 → 0.25.2

package/dist/index.d.mts

@@ -928,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;
@@ -1569,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",