@fishjam-cloud/js-server-sdk 0.21.0 → 0.22.0

package/dist/index.d.mts

@@ -27,10 +27,16 @@ interface Peer$1 {
     'status': PeerStatus;
     /**
      *
-     * @type {SubscribeOptions}
+     * @type {SubscribeMode}
      * @memberof Peer
      */
-    'subscribe': SubscribeOptions | null;
+    'subscribeMode': SubscribeMode;
+    /**
+     * Describes peer\'s subscriptions in manual mode
+     * @type {Array<string>}
+     * @memberof Peer
+     */
+    'subscriptions': Array<string>;
     /**
      * List of all peer\'s tracks
      * @type {Array<Track>}
@@ -49,7 +55,59 @@ interface Peer$1 {
  * Peer-specific options
  * @export
  */
-type PeerOptions = PeerOptionsWebRTC | object;
+type PeerOptions = PeerOptionsAgent | PeerOptionsWebRTC;
+/**
+ * Options specific to the Agent peer
+ * @export
+ * @interface PeerOptionsAgent
+ */
+interface PeerOptionsAgent {
+    /**
+     *
+     * @type {PeerOptionsAgentOutput}
+     * @memberof PeerOptionsAgent
+     */
+    'output'?: PeerOptionsAgentOutput;
+    /**
+     * Configuration of peer\'s subscribing policy
+     * @type {string}
+     * @memberof PeerOptionsAgent
+     */
+    'subscribeMode'?: PeerOptionsAgentSubscribeModeEnum;
+}
+declare const PeerOptionsAgentSubscribeModeEnum: {
+    readonly Auto: "auto";
+    readonly Manual: "manual";
+};
+type PeerOptionsAgentSubscribeModeEnum = typeof PeerOptionsAgentSubscribeModeEnum[keyof typeof PeerOptionsAgentSubscribeModeEnum];
+/**
+ * Output audio options
+ * @export
+ * @interface PeerOptionsAgentOutput
+ */
+interface PeerOptionsAgentOutput {
+    /**
+     * The format of the output audio
+     * @type {string}
+     * @memberof PeerOptionsAgentOutput
+     */
+    'audioFormat'?: PeerOptionsAgentOutputAudioFormatEnum;
+    /**
+     * The sample rate of the output audio
+     * @type {number}
+     * @memberof PeerOptionsAgentOutput
+     */
+    'audioSampleRate'?: PeerOptionsAgentOutputAudioSampleRateEnum;
+}
+declare const PeerOptionsAgentOutputAudioFormatEnum: {
+    readonly Pcm16: "pcm16";
+};
+type PeerOptionsAgentOutputAudioFormatEnum = typeof PeerOptionsAgentOutputAudioFormatEnum[keyof typeof PeerOptionsAgentOutputAudioFormatEnum];
+declare const PeerOptionsAgentOutputAudioSampleRateEnum: {
+    readonly NUMBER_16000: 16000;
+    readonly NUMBER_24000: 24000;
+};
+type PeerOptionsAgentOutputAudioSampleRateEnum = typeof PeerOptionsAgentOutputAudioSampleRateEnum[keyof typeof PeerOptionsAgentOutputAudioSampleRateEnum];
 /**
  * Options specific to the WebRTC peer
  * @export
@@ -71,12 +129,17 @@ interface PeerOptionsWebRTC {
         [key: string]: any;
     };
     /**
-     *
-     * @type {SubscribeOptions1}
+     * Configuration of peer\'s subscribing policy
+     * @type {string}
      * @memberof PeerOptionsWebRTC
      */
-    'subscribe'?: SubscribeOptions1 | null;
+    'subscribeMode'?: PeerOptionsWebRTCSubscribeModeEnum;
 }
+declare const PeerOptionsWebRTCSubscribeModeEnum: {
+    readonly Auto: "auto";
+    readonly Manual: "manual";
+};
+type PeerOptionsWebRTCSubscribeModeEnum = typeof PeerOptionsWebRTCSubscribeModeEnum[keyof typeof PeerOptionsWebRTCSubscribeModeEnum];
 /**
  * Informs about the peer status
  * @export
@@ -140,6 +203,7 @@ declare const RoomConfigRoomTypeEnum: {
     readonly Broadcaster: "broadcaster";
     readonly Livestream: "livestream";
     readonly Conference: "conference";
+    readonly AudioOnlyLivestream: "audio_only_livestream";
 };
 type RoomConfigRoomTypeEnum = typeof RoomConfigRoomTypeEnum[keyof typeof RoomConfigRoomTypeEnum];
 declare const RoomConfigVideoCodecEnum: {
@@ -161,69 +225,23 @@ interface StreamerToken {
     'token': string;
 }
 /**
- * Configuration of server-side subscriptions to the peer\'s tracks
- * @export
- * @interface SubscribeOptions
- */
-interface SubscribeOptions {
-    /**
-     * The format of the output audio
-     * @type {string}
-     * @memberof SubscribeOptions
-     */
-    'audioFormat'?: SubscribeOptionsAudioFormatEnum;
-    /**
-     * The sample rate of the output audio
-     * @type {number}
-     * @memberof SubscribeOptions
-     */
-    'audioSampleRate'?: SubscribeOptionsAudioSampleRateEnum;
-}
-declare const SubscribeOptionsAudioFormatEnum: {
-    readonly Pcm16: "pcm16";
-};
-type SubscribeOptionsAudioFormatEnum = typeof SubscribeOptionsAudioFormatEnum[keyof typeof SubscribeOptionsAudioFormatEnum];
-declare const SubscribeOptionsAudioSampleRateEnum: {
-    readonly NUMBER_16000: 16000;
-    readonly NUMBER_24000: 24000;
-};
-type SubscribeOptionsAudioSampleRateEnum = typeof SubscribeOptionsAudioSampleRateEnum[keyof typeof SubscribeOptionsAudioSampleRateEnum];
-/**
- * Configuration of server-side subscriptions to the peer\'s tracks
+ * Configuration of peer\'s subscribing policy
  * @export
- * @interface SubscribeOptions1
+ * @enum {string}
  */
-interface SubscribeOptions1 {
-    /**
-     * The format of the output audio
-     * @type {string}
-     * @memberof SubscribeOptions1
-     */
-    'audioFormat'?: SubscribeOptions1AudioFormatEnum;
-    /**
-     * The sample rate of the output audio
-     * @type {number}
-     * @memberof SubscribeOptions1
-     */
-    'audioSampleRate'?: SubscribeOptions1AudioSampleRateEnum;
-}
-declare const SubscribeOptions1AudioFormatEnum: {
-    readonly Pcm16: "pcm16";
-};
-type SubscribeOptions1AudioFormatEnum = typeof SubscribeOptions1AudioFormatEnum[keyof typeof SubscribeOptions1AudioFormatEnum];
-declare const SubscribeOptions1AudioSampleRateEnum: {
-    readonly NUMBER_16000: 16000;
-    readonly NUMBER_24000: 24000;
+declare const SubscribeMode: {
+    readonly Auto: "auto";
+    readonly Manual: "manual";
 };
-type SubscribeOptions1AudioSampleRateEnum = typeof SubscribeOptions1AudioSampleRateEnum[keyof typeof SubscribeOptions1AudioSampleRateEnum];
+type SubscribeMode = typeof SubscribeMode[keyof typeof SubscribeMode];
 /**
- * Describes media track of a Peer or Component
+ * Describes media track of a Peer
  * @export
  * @interface Track
  */
 interface Track$1 {
     /**
-     *
+     * Assigned track id
      * @type {string}
      * @memberof Track
      */
@@ -327,10 +345,14 @@ interface ServerMessage {
     trackMetadataUpdated?: ServerMessage_TrackMetadataUpdated | undefined;
     peerAdded?: ServerMessage_PeerAdded | undefined;
     peerDeleted?: ServerMessage_PeerDeleted | undefined;
+    /** @deprecated */
     streamConnected?: ServerMessage_StreamConnected | undefined;
+    /** @deprecated */
     streamDisconnected?: ServerMessage_StreamDisconnected | undefined;
     viewerConnected?: ServerMessage_ViewerConnected | undefined;
     viewerDisconnected?: ServerMessage_ViewerDisconnected | undefined;
+    streamerConnected?: ServerMessage_StreamerConnected | undefined;
+    streamerDisconnected?: ServerMessage_StreamerDisconnected | undefined;
 }
 declare const ServerMessage: MessageFns$1<ServerMessage>;
 /** Notification sent when a room crashes */
@@ -479,6 +501,16 @@ interface ServerMessage_ViewerDisconnected {
     viewerId: string;
 }
 declare const ServerMessage_ViewerDisconnected: MessageFns$1<ServerMessage_ViewerDisconnected>;
+interface ServerMessage_StreamerConnected {
+    streamId: string;
+    streamerId: string;
+}
+declare const ServerMessage_StreamerConnected: MessageFns$1<ServerMessage_StreamerConnected>;
+interface ServerMessage_StreamerDisconnected {
+    streamId: string;
+    streamerId: string;
+}
+declare const ServerMessage_StreamerDisconnected: MessageFns$1<ServerMessage_StreamerDisconnected>;
 type Builtin$1 = Date | Function | Uint8Array | string | number | boolean | undefined;
 type DeepPartial$1<T> = T extends Builtin$1 ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial$1<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial$1<U>> : T extends {} ? {
     [K in keyof T]?: DeepPartial$1<T[K]>;
@@ -606,8 +638,7 @@ type Room = {
     config: RoomConfig;
 };
 type FishjamConfig = {
-    fishjamId?: string;
-    fishjamUrl?: string;
+    fishjamId: string;
     managementToken: string;
 };
 type ErrorEventHandler = (msg: Event) => void;
@@ -721,7 +752,7 @@ declare class FishjamAgent extends FishjamAgent_base {
 
 /**
  * Client class that allows to manage Rooms and Peers for a Fishjam App.
- * It requires the Fishjam URL and management token that can be retrieved from the Fishjam Dashboard.
+ * It requires the Fishjam ID and management token that can be retrieved from the Fishjam Dashboard.
  * @category Client
  */
 declare class FishjamClient {
@@ -735,7 +766,7 @@ declare class FishjamClient {
      * Example usage:
      * ```
      * const fishjamClient = new FishjamClient({
-     *   fishjamUrl: fastify.config.FISHJAM_URL,
+     *   fishjamId: fastify.config.FISHJAM_ID,
      *   managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN,
      * });
      * ```
@@ -775,6 +806,16 @@ declare class FishjamClient {
      * Delete a peer - this will also disconnect the peer from the room.
      */
     deletePeer(roomId: RoomId, peerId: PeerId): Promise<void>;
+    /**
+     * Subscribe a peer to another peer - this will make all tracks from the publisher available to the subscriber.
+     * Using this function only makes sense if subscribeMode is set to manual
+     */
+    subscribePeer(roomId: RoomId, subscriberPeerId: PeerId, publisherPeerId: PeerId): Promise<void>;
+    /**
+     * Subscribe a peer to specific tracks from another peer - this will make only the specified tracks from the publisher available to the subscriber.
+     * Using this function only makes sense if subscribeMode is set to manual
+     */
+    subscribeTracks(roomId: RoomId, subscriberPeerId: PeerId, tracks: TrackId[]): Promise<void>;
     /**
      * Refresh the peer token for an already existing peer.
      * If an already created peer has not been connected to the room for more than 24 hours, the token will become invalid. This method can be used to generate a new peer token for the existing peer.

package/dist/index.d.ts

@@ -27,10 +27,16 @@ interface Peer$1 {
     'status': PeerStatus;
     /**
      *
-     * @type {SubscribeOptions}
+     * @type {SubscribeMode}
      * @memberof Peer
      */
-    'subscribe': SubscribeOptions | null;
+    'subscribeMode': SubscribeMode;
+    /**
+     * Describes peer\'s subscriptions in manual mode
+     * @type {Array<string>}
+     * @memberof Peer
+     */
+    'subscriptions': Array<string>;
     /**
      * List of all peer\'s tracks
      * @type {Array<Track>}
@@ -49,7 +55,59 @@ interface Peer$1 {
  * Peer-specific options
  * @export
  */
-type PeerOptions = PeerOptionsWebRTC | object;
+type PeerOptions = PeerOptionsAgent | PeerOptionsWebRTC;
+/**
+ * Options specific to the Agent peer
+ * @export
+ * @interface PeerOptionsAgent
+ */
+interface PeerOptionsAgent {
+    /**
+     *
+     * @type {PeerOptionsAgentOutput}
+     * @memberof PeerOptionsAgent
+     */
+    'output'?: PeerOptionsAgentOutput;
+    /**
+     * Configuration of peer\'s subscribing policy
+     * @type {string}
+     * @memberof PeerOptionsAgent
+     */
+    'subscribeMode'?: PeerOptionsAgentSubscribeModeEnum;
+}
+declare const PeerOptionsAgentSubscribeModeEnum: {
+    readonly Auto: "auto";
+    readonly Manual: "manual";
+};
+type PeerOptionsAgentSubscribeModeEnum = typeof PeerOptionsAgentSubscribeModeEnum[keyof typeof PeerOptionsAgentSubscribeModeEnum];
+/**
+ * Output audio options
+ * @export
+ * @interface PeerOptionsAgentOutput
+ */
+interface PeerOptionsAgentOutput {
+    /**
+     * The format of the output audio
+     * @type {string}
+     * @memberof PeerOptionsAgentOutput
+     */
+    'audioFormat'?: PeerOptionsAgentOutputAudioFormatEnum;
+    /**
+     * The sample rate of the output audio
+     * @type {number}
+     * @memberof PeerOptionsAgentOutput
+     */
+    'audioSampleRate'?: PeerOptionsAgentOutputAudioSampleRateEnum;
+}
+declare const PeerOptionsAgentOutputAudioFormatEnum: {
+    readonly Pcm16: "pcm16";
+};
+type PeerOptionsAgentOutputAudioFormatEnum = typeof PeerOptionsAgentOutputAudioFormatEnum[keyof typeof PeerOptionsAgentOutputAudioFormatEnum];
+declare const PeerOptionsAgentOutputAudioSampleRateEnum: {
+    readonly NUMBER_16000: 16000;
+    readonly NUMBER_24000: 24000;
+};
+type PeerOptionsAgentOutputAudioSampleRateEnum = typeof PeerOptionsAgentOutputAudioSampleRateEnum[keyof typeof PeerOptionsAgentOutputAudioSampleRateEnum];
 /**
  * Options specific to the WebRTC peer
  * @export
@@ -71,12 +129,17 @@ interface PeerOptionsWebRTC {
         [key: string]: any;
     };
     /**
-     *
-     * @type {SubscribeOptions1}
+     * Configuration of peer\'s subscribing policy
+     * @type {string}
      * @memberof PeerOptionsWebRTC
      */
-    'subscribe'?: SubscribeOptions1 | null;
+    'subscribeMode'?: PeerOptionsWebRTCSubscribeModeEnum;
 }
+declare const PeerOptionsWebRTCSubscribeModeEnum: {
+    readonly Auto: "auto";
+    readonly Manual: "manual";
+};
+type PeerOptionsWebRTCSubscribeModeEnum = typeof PeerOptionsWebRTCSubscribeModeEnum[keyof typeof PeerOptionsWebRTCSubscribeModeEnum];
 /**
  * Informs about the peer status
  * @export
@@ -140,6 +203,7 @@ declare const RoomConfigRoomTypeEnum: {
     readonly Broadcaster: "broadcaster";
     readonly Livestream: "livestream";
     readonly Conference: "conference";
+    readonly AudioOnlyLivestream: "audio_only_livestream";
 };
 type RoomConfigRoomTypeEnum = typeof RoomConfigRoomTypeEnum[keyof typeof RoomConfigRoomTypeEnum];
 declare const RoomConfigVideoCodecEnum: {
@@ -161,69 +225,23 @@ interface StreamerToken {
     'token': string;
 }
 /**
- * Configuration of server-side subscriptions to the peer\'s tracks
- * @export
- * @interface SubscribeOptions
- */
-interface SubscribeOptions {
-    /**
-     * The format of the output audio
-     * @type {string}
-     * @memberof SubscribeOptions
-     */
-    'audioFormat'?: SubscribeOptionsAudioFormatEnum;
-    /**
-     * The sample rate of the output audio
-     * @type {number}
-     * @memberof SubscribeOptions
-     */
-    'audioSampleRate'?: SubscribeOptionsAudioSampleRateEnum;
-}
-declare const SubscribeOptionsAudioFormatEnum: {
-    readonly Pcm16: "pcm16";
-};
-type SubscribeOptionsAudioFormatEnum = typeof SubscribeOptionsAudioFormatEnum[keyof typeof SubscribeOptionsAudioFormatEnum];
-declare const SubscribeOptionsAudioSampleRateEnum: {
-    readonly NUMBER_16000: 16000;
-    readonly NUMBER_24000: 24000;
-};
-type SubscribeOptionsAudioSampleRateEnum = typeof SubscribeOptionsAudioSampleRateEnum[keyof typeof SubscribeOptionsAudioSampleRateEnum];
-/**
- * Configuration of server-side subscriptions to the peer\'s tracks
+ * Configuration of peer\'s subscribing policy
  * @export
- * @interface SubscribeOptions1
+ * @enum {string}
  */
-interface SubscribeOptions1 {
-    /**
-     * The format of the output audio
-     * @type {string}
-     * @memberof SubscribeOptions1
-     */
-    'audioFormat'?: SubscribeOptions1AudioFormatEnum;
-    /**
-     * The sample rate of the output audio
-     * @type {number}
-     * @memberof SubscribeOptions1
-     */
-    'audioSampleRate'?: SubscribeOptions1AudioSampleRateEnum;
-}
-declare const SubscribeOptions1AudioFormatEnum: {
-    readonly Pcm16: "pcm16";
-};
-type SubscribeOptions1AudioFormatEnum = typeof SubscribeOptions1AudioFormatEnum[keyof typeof SubscribeOptions1AudioFormatEnum];
-declare const SubscribeOptions1AudioSampleRateEnum: {
-    readonly NUMBER_16000: 16000;
-    readonly NUMBER_24000: 24000;
+declare const SubscribeMode: {
+    readonly Auto: "auto";
+    readonly Manual: "manual";
 };
-type SubscribeOptions1AudioSampleRateEnum = typeof SubscribeOptions1AudioSampleRateEnum[keyof typeof SubscribeOptions1AudioSampleRateEnum];
+type SubscribeMode = typeof SubscribeMode[keyof typeof SubscribeMode];
 /**
- * Describes media track of a Peer or Component
+ * Describes media track of a Peer
  * @export
  * @interface Track
  */
 interface Track$1 {
     /**
-     *
+     * Assigned track id
      * @type {string}
      * @memberof Track
      */
@@ -327,10 +345,14 @@ interface ServerMessage {
     trackMetadataUpdated?: ServerMessage_TrackMetadataUpdated | undefined;
     peerAdded?: ServerMessage_PeerAdded | undefined;
     peerDeleted?: ServerMessage_PeerDeleted | undefined;
+    /** @deprecated */
     streamConnected?: ServerMessage_StreamConnected | undefined;
+    /** @deprecated */
     streamDisconnected?: ServerMessage_StreamDisconnected | undefined;
     viewerConnected?: ServerMessage_ViewerConnected | undefined;
     viewerDisconnected?: ServerMessage_ViewerDisconnected | undefined;
+    streamerConnected?: ServerMessage_StreamerConnected | undefined;
+    streamerDisconnected?: ServerMessage_StreamerDisconnected | undefined;
 }
 declare const ServerMessage: MessageFns$1<ServerMessage>;
 /** Notification sent when a room crashes */
@@ -479,6 +501,16 @@ interface ServerMessage_ViewerDisconnected {
     viewerId: string;
 }
 declare const ServerMessage_ViewerDisconnected: MessageFns$1<ServerMessage_ViewerDisconnected>;
+interface ServerMessage_StreamerConnected {
+    streamId: string;
+    streamerId: string;
+}
+declare const ServerMessage_StreamerConnected: MessageFns$1<ServerMessage_StreamerConnected>;
+interface ServerMessage_StreamerDisconnected {
+    streamId: string;
+    streamerId: string;
+}
+declare const ServerMessage_StreamerDisconnected: MessageFns$1<ServerMessage_StreamerDisconnected>;
 type Builtin$1 = Date | Function | Uint8Array | string | number | boolean | undefined;
 type DeepPartial$1<T> = T extends Builtin$1 ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial$1<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial$1<U>> : T extends {} ? {
     [K in keyof T]?: DeepPartial$1<T[K]>;
@@ -606,8 +638,7 @@ type Room = {
     config: RoomConfig;
 };
 type FishjamConfig = {
-    fishjamId?: string;
-    fishjamUrl?: string;
+    fishjamId: string;
     managementToken: string;
 };
 type ErrorEventHandler = (msg: Event) => void;
@@ -721,7 +752,7 @@ declare class FishjamAgent extends FishjamAgent_base {
 
 /**
  * Client class that allows to manage Rooms and Peers for a Fishjam App.
- * It requires the Fishjam URL and management token that can be retrieved from the Fishjam Dashboard.
+ * It requires the Fishjam ID and management token that can be retrieved from the Fishjam Dashboard.
  * @category Client
  */
 declare class FishjamClient {
@@ -735,7 +766,7 @@ declare class FishjamClient {
      * Example usage:
      * ```
      * const fishjamClient = new FishjamClient({
-     *   fishjamUrl: fastify.config.FISHJAM_URL,
+     *   fishjamId: fastify.config.FISHJAM_ID,
      *   managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN,
      * });
      * ```
@@ -775,6 +806,16 @@ declare class FishjamClient {
      * Delete a peer - this will also disconnect the peer from the room.
      */
     deletePeer(roomId: RoomId, peerId: PeerId): Promise<void>;
+    /**
+     * Subscribe a peer to another peer - this will make all tracks from the publisher available to the subscriber.
+     * Using this function only makes sense if subscribeMode is set to manual
+     */
+    subscribePeer(roomId: RoomId, subscriberPeerId: PeerId, publisherPeerId: PeerId): Promise<void>;
+    /**
+     * Subscribe a peer to specific tracks from another peer - this will make only the specified tracks from the publisher available to the subscriber.
+     * Using this function only makes sense if subscribeMode is set to manual
+     */
+    subscribeTracks(roomId: RoomId, subscriberPeerId: PeerId, tracks: TrackId[]): Promise<void>;
     /**
      * Refresh the peer token for an already existing peer.
      * If an already created peer has not been connected to the room for more than 24 hours, the token will become invalid. This method can be used to generate a new peer token for the existing peer.