Release v0.26.0

static/api/protobuf/server_notifications.proto

@@ -15,6 +15,7 @@ message ServerMessage {
     PEER_TYPE_UNSPECIFIED = 0;
     PEER_TYPE_WEBRTC = 1;
     PEER_TYPE_AGENT = 2;
+    PEER_TYPE_VAPI = 3;
   }
 
   // Notification sent when a peer is added
@@ -168,6 +169,38 @@ message ServerMessage {
     string channel_id = 4;
   }
 
+  // Sent when there is an upsert to track forwardings from Fishjam to Composition
+  message TrackForwarding {
+    string room_id = 1;
+    string peer_id = 2;
+    string composition_url = 3;
+    string input_id = 4;
+    optional notifications.Track audio_track = 5; // Track has id, type, and metadata
+    optional notifications.Track video_track = 6;
+  }
+
+  // Sent when track forwarding is removed
+  message TrackForwardingRemoved {
+    string room_id = 1;
+    string peer_id = 2;
+    string composition_url = 3;
+    string input_id = 4;
+  }
+
+  // Notification sent when voice activity changes on a track
+  message VadNotification {
+    enum Status {
+      STATUS_UNSPECIFIED = 0;
+      STATUS_SILENCE = 1;
+      STATUS_SPEECH = 2;
+    }
+
+    string room_id = 1;
+    string peer_id = 2;
+    string track_id = 3;
+    Status status = 4;
+  }
+
   // Notification sent when streamer successfully connects
   message StreamConnected {
     string stream_id = 1;
@@ -203,33 +236,50 @@ message ServerMessage {
   reserved 12;
 
   oneof content {
-    RoomCrashed room_crashed = 1;
-    PeerConnected peer_connected = 2;
-    PeerDisconnected peer_disconnected = 3;
-    PeerCrashed peer_crashed = 4;
-    ComponentCrashed component_crashed = 5;
+    // Auth
+
     Authenticated authenticated = 6;
     AuthRequest auth_request = 7;
     SubscribeRequest subscribe_request = 8;
     SubscribeResponse subscribe_response = 9;
+
+    // Common
+
     RoomCreated room_created = 10;
     RoomDeleted room_deleted = 11;
-    HlsPlayable hls_playable = 13;
-    HlsUploaded hls_uploaded = 14;
-    HlsUploadCrashed hls_upload_crashed = 15;
+    RoomCrashed room_crashed = 1;
+
+    // Conferencing
+
+    PeerConnected peer_connected = 2;
+    PeerDisconnected peer_disconnected = 3;
+    PeerCrashed peer_crashed = 4;
     PeerMetadataUpdated peer_metadata_updated = 16;
     TrackAdded track_added = 17;
     TrackRemoved track_removed = 18;
     TrackMetadataUpdated track_metadata_updated = 19;
     PeerAdded peer_added = 20;
     PeerDeleted peer_deleted = 21;
-    StreamConnected stream_connected = 22 [deprecated = true];
-    StreamDisconnected stream_disconnected = 23 [deprecated = true];
+    ChannelAdded channel_added = 28;
+    ChannelRemoved channel_removed = 29;
+    TrackForwarding track_forwarding = 30;
+    TrackForwardingRemoved track_forwarding_removed = 31;
+    VadNotification vad_notification = 32;
+
+    // Streaming
+
     ViewerConnected viewer_connected = 24;
     ViewerDisconnected viewer_disconnected = 25;
     StreamerConnected streamer_connected = 26;
     StreamerDisconnected streamer_disconnected = 27;
-    ChannelAdded channel_added = 28;
-    ChannelRemoved channel_removed = 29;
+
+    // Deprecated
+
+    StreamConnected stream_connected = 22 [deprecated = true];
+    StreamDisconnected stream_disconnected = 23 [deprecated = true];
+    HlsPlayable hls_playable = 13 [deprecated = true];
+    HlsUploaded hls_uploaded = 14 [deprecated = true];
+    HlsUploadCrashed hls_upload_crashed = 15 [deprecated = true];
+    ComponentCrashed component_crashed = 5 [deprecated = true];
   }
 }

versioned_docs/version-0.26.0/_common/agents/definition.mdx

@@ -0,0 +1,6 @@
+## What is an Agent?
+
+An agent is a piece of software that allows your backend server to participate in a Fishjam room, similar to how the Fishjam client SDKs allow your client-side application to participate in a Fishjam room.
+They can be used to implement features such as real-time audio transcription, real-time content moderation, conversations with AI agents and more.
+
+You can simply think of an agent as a peer running within your backend application.

versioned_docs/version-0.26.0/_common/agents/remember-to-disconnect.mdx

@@ -0,0 +1,3 @@
+:::danger Remember to disconnect your agents!
+It's important to disconnect agents, because **every connected agent generates usage** just as a normal peer.
+:::

versioned_docs/version-0.26.0/_common/agents/subscriptions.mdx

@@ -0,0 +1,4 @@
+By default, agents **won't** receive peers' audio streams.
+This is by design and aims to prevent unnecessary resource usage by the agents.
+
+For an agent to start receiving a peer's audio, the peer must be **created** with the **subscribe** option set.

versioned_docs/version-0.26.0/api/_category_.json

@@ -0,0 +1,12 @@
+{
+  "label": "API",
+  "position": 7,
+  "link": {
+    "type": "generated-index",
+    "description": "API documentation for Client and Server SDKs.",
+    "slug": "/api"
+  },
+  "customProps": {
+    "id": "generated-api"
+  }
+}

versioned_docs/version-0.26.0/api/mobile/enumerations/Variant.md

@@ -0,0 +1,43 @@
+# Enumeration: Variant
+
+Defined in: packages/ts-client/dist/index.d.mts:51
+
+## Enumeration Members
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`
+
+Defined in: packages/ts-client/dist/index.d.mts:56
+
+***
+
+### VARIANT\_HIGH
+
+> **VARIANT\_HIGH**: `3`
+
+Defined in: packages/ts-client/dist/index.d.mts:55
+
+***
+
+### VARIANT\_LOW
+
+> **VARIANT\_LOW**: `1`
+
+Defined in: packages/ts-client/dist/index.d.mts:53
+
+***
+
+### VARIANT\_MEDIUM
+
+> **VARIANT\_MEDIUM**: `2`
+
+Defined in: packages/ts-client/dist/index.d.mts:54
+
+***
+
+### VARIANT\_UNSPECIFIED
+
+> **VARIANT\_UNSPECIFIED**: `0`
+
+Defined in: packages/ts-client/dist/index.d.mts:52

versioned_docs/version-0.26.0/api/mobile/functions/FishjamProvider.md

@@ -0,0 +1,15 @@
+# Function: FishjamProvider()
+
+> **FishjamProvider**(`props`): `FunctionComponentElement`\<`FishjamProviderProps`\>
+
+Defined in: [packages/mobile-client/src/index.ts:118](https://github.com/fishjam-cloud/web-client-sdk/blob/f9c524fd1ea91e5bcd57ee915282fefeaed45b65/packages/mobile-client/src/index.ts#L118)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `props` | [`FishjamProviderProps`](../type-aliases/FishjamProviderProps.md) |
+
+## Returns
+
+`FunctionComponentElement`\<`FishjamProviderProps`\>

versioned_docs/version-0.26.0/api/mobile/functions/RTCPIPView.md

@@ -0,0 +1,15 @@
+# Function: RTCPIPView()
+
+> **RTCPIPView**(`__namedParameters`): `Element`
+
+Defined in: [packages/mobile-client/src/overrides/RTCView.tsx:31](https://github.com/fishjam-cloud/web-client-sdk/blob/f9c524fd1ea91e5bcd57ee915282fefeaed45b65/packages/mobile-client/src/overrides/RTCView.tsx#L31)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | [`RTCPIPViewProps`](../type-aliases/RTCPIPViewProps.md) |
+
+## Returns
+
+`Element`

versioned_docs/version-0.26.0/api/mobile/functions/RTCView.md

@@ -0,0 +1,15 @@
+# Function: RTCView()
+
+> **RTCView**(`__namedParameters`): `Element`
+
+Defined in: [packages/mobile-client/src/overrides/RTCView.tsx:26](https://github.com/fishjam-cloud/web-client-sdk/blob/f9c524fd1ea91e5bcd57ee915282fefeaed45b65/packages/mobile-client/src/overrides/RTCView.tsx#L26)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | [`RTCVideoViewProps`](../type-aliases/RTCVideoViewProps.md) |
+
+## Returns
+
+`Element`

versioned_docs/version-0.26.0/api/mobile/functions/useCallKit.md

@@ -0,0 +1,9 @@
+# Function: useCallKit()
+
+> **useCallKit**(): `object`
+
+Defined in: [packages/mobile-client/src/overrides/hooks.ts:100](https://github.com/fishjam-cloud/web-client-sdk/blob/f9c524fd1ea91e5bcd57ee915282fefeaed45b65/packages/mobile-client/src/overrides/hooks.ts#L100)
+
+## Returns
+
+`object`

versioned_docs/version-0.26.0/api/mobile/functions/useCallKitEvent.md

@@ -0,0 +1,22 @@
+# Function: useCallKitEvent()
+
+> **useCallKitEvent**\<`T`\>(`action`, `callback`): `void`
+
+Defined in: [packages/mobile-client/src/overrides/hooks.ts:109](https://github.com/fishjam-cloud/web-client-sdk/blob/f9c524fd1ea91e5bcd57ee915282fefeaed45b65/packages/mobile-client/src/overrides/hooks.ts#L109)
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* keyof `CallKitAction` |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `action` | `T` |
+| `callback` | (`event`) => `void` |
+
+## Returns
+
+`void`

versioned_docs/version-0.26.0/api/mobile/functions/useCallKitService.md

@@ -0,0 +1,15 @@
+# Function: useCallKitService()
+
+> **useCallKitService**(`config`): `void`
+
+Defined in: [packages/mobile-client/src/overrides/hooks.ts:105](https://github.com/fishjam-cloud/web-client-sdk/blob/f9c524fd1ea91e5bcd57ee915282fefeaed45b65/packages/mobile-client/src/overrides/hooks.ts#L105)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `config` | `CallKitConfig` |
+
+## Returns
+
+`void`