diff --git a/api/fishjam-server b/api/fishjam-server index 391609c0..65b3b4cb 160000 --- a/api/fishjam-server +++ b/api/fishjam-server @@ -1 +1 @@ -Subproject commit 391609c073581df6301cc8bddd877ac5a7c1a03d +Subproject commit 65b3b4cbbb5b26e21c6650bb62082668983f43e6 diff --git a/api/room-manager b/api/room-manager index d3a6056a..ac1122a5 160000 --- a/api/room-manager +++ b/api/room-manager @@ -1 +1 @@ -Subproject commit d3a6056afc54ff4f7f38ddd9afa2fe704e9c8569 +Subproject commit ac1122a55f70c7f06872e4106b6452a9f199480b diff --git a/docs/explanation/sandbox-api-concept.mdx b/docs/explanation/sandbox-api-concept.mdx index 460afcfe..6595b42f 100644 --- a/docs/explanation/sandbox-api-concept.mdx +++ b/docs/explanation/sandbox-api-concept.mdx @@ -35,10 +35,7 @@ The Sandbox API mitigates this issue and allows you to start frontend developmen The Sandbox API is essentially a simplified application built using the Fishjam Server SDKs: ```typescript -import { - FishjamClient, - RoomConfigRoomTypeEnum, -} from "@fishjam-cloud/js-server-sdk"; +import { FishjamClient, RoomType } from "@fishjam-cloud/js-server-sdk"; import express from "express"; const fishjamId = ""; const managementToken = ""; @@ -53,7 +50,7 @@ app.get("/", async (req: express.Request, res: express.Response) => { // Create or get room const room = await fishjamClient.createRoom({ - roomType: roomType as RoomConfigRoomTypeEnum, + roomType: roomType as RoomType, }); // Create or get peer diff --git a/docs/how-to/react/debug-logging.mdx b/docs/how-to/react/debug-logging.mdx new file mode 100644 index 00000000..6f62159f --- /dev/null +++ b/docs/how-to/react/debug-logging.mdx @@ -0,0 +1,66 @@ +--- +sidebar_position: 9 +--- + +# Debug logging + +The Fishjam SDK includes a built-in debugging mode to help developers troubleshoot connectivity and media issues during development. This feature controls the verbosity of the SDK's internal logging mechanisms. + +## Overview + +By default, the SDK suppresses internal logs to keep your browser console clean in production environments. Enabling `debug` mode allows the SDK to output warnings and errors to the console, prefixed with `[FISHJAM]`. + +## Usage + +To enable debugging in a React application, pass the `debug` prop to the `FishjamProvider`. + +```tsx +import React from "react"; +const App = () => null; +// ---cut--- +import { FishjamProvider } from "@fishjam-cloud/react-client"; + +function Root() { + return ( + + + + ); +} +``` + +We recommend toggling this based on your environment variables: + +```tsx +import React from "react"; +import { FishjamProvider } from "@fishjam-cloud/react-client"; +const process = { + env: { NODE_ENV: "development", FISHJAM_ID: "your-fishjam-id" }, +}; +const App = () => null; +// ---cut--- + + +; +``` + +## Behavior + +- **Enabled (`true`):** The SDK will log internal warnings (e.g., permission errors, socket closures, signaling issues) and errors to the browser console. All logs are prefixed with `[FISHJAM]` for easy filtering. +- **Disabled (`false` or `undefined`):** The SDK operates silently, suppressing internal `console.warn` and `console.error` calls to prevent console pollution. + +### Example Output + +When enabled, you may see logs similar to: + +```text +[FISHJAM] Socket closed with reason: ... +[FISHJAM] Couldn't get camera permission: NotAllowedError ... +[FISHJAM] ICE connection: disconnected +``` diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 77d47c84..9c1aead3 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -65,7 +65,7 @@ function injectTypeDocSidebar( version: SidebarItemsGeneratorVersion, items: NormalizedSidebar, ): NormalizedSidebar { - const docs_without_python_reference = ["0.20.0", "0.21.0", "0.22.0"]; + const docs_without_python_reference = ["0.22.0"]; const exclude_python = docs_without_python_reference.includes( version.versionName, @@ -107,18 +107,8 @@ function injectTypeDocSidebar( label: "Server SDK for Python", items: [ { - type: "category", - label: "fishjam", - link: { - type: "doc", - id: "api/server-python/fishjam", - }, - items: [ - { - type: "autogenerated", - dirName: "api/server-python/fishjam", - }, - ], + type: "autogenerated", + dirName: "api/server-python", }, ], }); diff --git a/packages/js-server-sdk b/packages/js-server-sdk index f79b8c1c..22932e9e 160000 --- a/packages/js-server-sdk +++ b/packages/js-server-sdk @@ -1 +1 @@ -Subproject commit f79b8c1c657855e44538c07962daf3135f32beae +Subproject commit 22932e9e40d6685e876f3295d34a2dc463114ca8 diff --git a/packages/mobile-client-sdk b/packages/mobile-client-sdk index 47936f2f..efa62a83 160000 --- a/packages/mobile-client-sdk +++ b/packages/mobile-client-sdk @@ -1 +1 @@ -Subproject commit 47936f2f7cc7d0d6100314ad92f0ac25bd097980 +Subproject commit efa62a8334bae1f0b89394bc9b884c47f9be9b37 diff --git a/packages/python-server-sdk b/packages/python-server-sdk index 9c8775c6..8136187b 160000 --- a/packages/python-server-sdk +++ b/packages/python-server-sdk @@ -1 +1 @@ -Subproject commit 9c8775c6a3e52c9410ebdcda45289e05c814f739 +Subproject commit 8136187b8912b35f6ff730144e69dc46c38939d7 diff --git a/packages/web-client-sdk b/packages/web-client-sdk index feb9a11b..a1e4bfe8 160000 --- a/packages/web-client-sdk +++ b/packages/web-client-sdk @@ -1 +1 @@ -Subproject commit feb9a11b001acdfc4e5e798c64ae9f8ae0b1a6b8 +Subproject commit a1e4bfe8ef582d1924accb8053fa0de389380124 diff --git a/versioned_docs/version-0.20.0/api/_category_.json b/versioned_docs/version-0.20.0/api/_category_.json deleted file mode 100644 index 24fd9392..00000000 --- a/versioned_docs/version-0.20.0/api/_category_.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "label": "API", - "position": 6, - "link": { - "type": "generated-index", - "description": "API documentation for Client and Server SDKs.", - "slug": "/api" - }, - "customProps": { - "id": "generated-api" - } -} diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/FishjamRoom.md b/versioned_docs/version-0.20.0/api/mobile/functions/FishjamRoom.md deleted file mode 100644 index 335dd2f5..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/FishjamRoom.md +++ /dev/null @@ -1,31 +0,0 @@ -# Function: FishjamRoom() - -> **FishjamRoom**(`props`): `Element` - -Defined in: [packages/react-native-client/src/components/FishjamRoom/index.tsx:39](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/FishjamRoom/index.tsx#L39) - -Simple component that enables your camera and show all tracks - -Example usage: -```tsx -import { FishjamRoom } from '@fishjam-cloud/react-native-client'; -import React from 'react'; - -const FISHJAM_URL = 'https://fishjam.io/your_fishjam'; -const PEER_TOKEN = 'your-peer-token'; - - -``` - -## Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `props` | [`FishjamRoomProps`](../type-aliases/FishjamRoomProps.md) | | - -## Returns - -`Element` diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/LivestreamStreamer.md b/versioned_docs/version-0.20.0/api/mobile/functions/LivestreamStreamer.md deleted file mode 100644 index 9a972ae3..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/LivestreamStreamer.md +++ /dev/null @@ -1,17 +0,0 @@ -# Function: LivestreamStreamer() - -> **LivestreamStreamer**(`props`): `Element` - -Defined in: [packages/react-native-client/src/components/LivestreamStreamer.tsx:22](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamStreamer.tsx#L22) - -Renders a video player playing the livestream set up with [useLivestreamStreamer](useLivestreamStreamer.md) hook. - -## Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `props` | [`LivestreamStreamerProps`](../type-aliases/LivestreamStreamerProps.md) | | - -## Returns - -`Element` diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/LivestreamViewer.md b/versioned_docs/version-0.20.0/api/mobile/functions/LivestreamViewer.md deleted file mode 100644 index a9ed3e04..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/LivestreamViewer.md +++ /dev/null @@ -1,17 +0,0 @@ -# Function: LivestreamViewer() - -> **LivestreamViewer**(`props`): `Element` - -Defined in: [packages/react-native-client/src/components/LivestreamViewer.tsx:54](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamViewer.tsx#L54) - -Renders a video player playing the livestream set up with [useLivestreamViewer](useLivestreamViewer.md) hook. - -## Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `props` | [`LivestreamViewerProps`](../type-aliases/LivestreamViewerProps.md) | | - -## Returns - -`Element` diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/useAudioSettings.md b/versioned_docs/version-0.20.0/api/mobile/functions/useAudioSettings.md deleted file mode 100644 index 5452070d..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/useAudioSettings.md +++ /dev/null @@ -1,66 +0,0 @@ -# Function: useAudioSettings() - -> **useAudioSettings**(): `object` - -Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:32](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useAudioSettings.ts#L32) - -This hook manages audio settings. - -## Returns - -### availableDevices - -> **availableDevices**: [`AudioOutputDevice`](../type-aliases/AudioOutputDevice.md)[] - -[Android only] available audio output devices to be set - -### selectAudioSessionMode() - -> **selectAudioSessionMode**: (`audioSessionMode`) => `Promise`\<`void`\> - -[iOS only] selects audio session mode. For more information refer to Apple's documentation: - https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/ - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `audioSessionMode` | [`AudioSessionMode`](../type-aliases/AudioSessionMode.md) | - -#### Returns - -`Promise`\<`void`\> - -### selectedAudioOutputDevice - -> **selectedAudioOutputDevice**: `null` \| [`AudioOutputDevice`](../type-aliases/AudioOutputDevice.md) - -currently selected output audio device - -### selectOutputAudioDevice() - -> **selectOutputAudioDevice**: (`device`) => `Promise`\<`void`\> - -[Android only] selects output audio device. -For detecting and selecting bluetooth devices make sure you have the BLUETOOTH_CONNECT permission. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `device` | [`AudioOutputDeviceType`](../type-aliases/AudioOutputDeviceType.md) | - -#### Returns - -`Promise`\<`void`\> - -### showAudioRoutePicker() - -> **showAudioRoutePicker**: () => `Promise`\<`void`\> - -[iOS only] Shows a picker modal that allows user to select output audio device. For more -information refer to Apple's documentation: https://developer.apple.com/documentation/avkit/avroutepickerview - -#### Returns - -`Promise`\<`void`\> diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/useBandwidthEstimation.md b/versioned_docs/version-0.20.0/api/mobile/functions/useBandwidthEstimation.md deleted file mode 100644 index fea296e4..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/useBandwidthEstimation.md +++ /dev/null @@ -1,17 +0,0 @@ -# Function: useBandwidthEstimation() - -> **useBandwidthEstimation**(): `object` - -Defined in: [packages/react-native-client/src/hooks/useBandwidthEstimation.ts:11](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useBandwidthEstimation.ts#L11) - -This hook provides current bandwidth estimation -estimation - client's available incoming bitrate estimated -by the server. It's measured in bits per second. - -## Returns - -### estimation - -> **estimation**: `null` \| `number` - -Bandwidth estimation, measured in bits per second diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/useCamera.md b/versioned_docs/version-0.20.0/api/mobile/functions/useCamera.md deleted file mode 100644 index 4f4bfef6..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/useCamera.md +++ /dev/null @@ -1,90 +0,0 @@ -# Function: useCamera() - -> **useCamera**(): `object` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:121](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L121) - -This hook can toggle camera on/off and provides current camera state. - -## Returns - -### cameras - -> **cameras**: readonly [`Camera`](../type-aliases/Camera.md)[] - -Property that lists cameras available on device. - -#### Returns - -A promise that resolves to the list of available cameras. - -### currentCamera - -> **currentCamera**: `null` \| [`Camera`](../type-aliases/Camera.md) - -Which camera is now used for streaming (or will be used as default when camera will be enabled) - -### isCameraOn - -> **isCameraOn**: `boolean` - -Informs if user camera is streaming video - -### isInitialized - -> **isInitialized**: `boolean` = `isCameraInitialized` - -A value indicating if camera was already initialized (if `prepareCamera` was called). - -### prepareCamera() - -> **prepareCamera**: (`config`) => `Promise`\<`boolean`\> - -Prepares camera and starts local video track - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `config` | `Readonly`\<[`CameraConfig`](../type-aliases/CameraConfig.md)\> | configuration of the camera capture | - -#### Returns - -`Promise`\<`boolean`\> - -A promise that resolves when camera is started. - -### simulcastConfig - -> **simulcastConfig**: [`SimulcastConfig`](../type-aliases/SimulcastConfig.md) - -Simulcast configuration - -### switchCamera() - -> **switchCamera**: (`cameraId`) => `Promise`\<`void`\> - -Switches to the specified camera. -List of available devices can be retrieved from `cameras` variable - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `cameraId` | [`CameraId`](../type-aliases/CameraId.md) | - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when camera is switched. - -### toggleCamera() - -> **toggleCamera**: () => `Promise`\<`void`\> - -Enable/disable current camera - -#### Returns - -`Promise`\<`void`\> diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/useConnection.md b/versioned_docs/version-0.20.0/api/mobile/functions/useConnection.md deleted file mode 100644 index 684e7a70..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/useConnection.md +++ /dev/null @@ -1,51 +0,0 @@ -# Function: useConnection() - -> **useConnection**(): `object` - -Defined in: [packages/react-native-client/src/hooks/useConnection.ts:87](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useConnection.ts#L87) - -Connect/leave room. And get connection status. - -## Returns - -### joinRoom() - -> **joinRoom**: \<`PeerMetadata`\>(`__namedParameters`) => `Promise`\<`void`\> - -Join room and start streaming camera and microphone - -See [JoinRoomConfig](../type-aliases/JoinRoomConfig.md) for parameter list - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `PeerMetadata` *extends* [`GenericMetadata`](../type-aliases/GenericMetadata.md) | [`GenericMetadata`](../type-aliases/GenericMetadata.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `__namedParameters` | [`JoinRoomConfig`](../type-aliases/JoinRoomConfig.md)\<`PeerMetadata`\> | - -#### Returns - -`Promise`\<`void`\> - -### leaveRoom() - -> **leaveRoom**: () => `void` - -Leave room and stop streaming - -#### Returns - -`void` - -### peerStatus - -> **peerStatus**: [`PeerStatus`](../type-aliases/PeerStatus.md) - -### reconnectionStatus - -> **reconnectionStatus**: [`ReconnectionStatus`](../type-aliases/ReconnectionStatus.md) diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/useLivestreamStreamer.md b/versioned_docs/version-0.20.0/api/mobile/functions/useLivestreamStreamer.md deleted file mode 100644 index 88cf5428..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/useLivestreamStreamer.md +++ /dev/null @@ -1,18 +0,0 @@ -# Function: useLivestreamStreamer() - -> **useLivestreamStreamer**(`__namedParameters`): [`useLivestreamStreamerResult`](../interfaces/useLivestreamStreamerResult.md) - -Defined in: [packages/react-native-client/src/hooks/useLivestreamStreamer.ts:31](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useLivestreamStreamer.ts#L31) - -Hook for publishing a livestream, which can be then received with [useLivestreamViewer](useLivestreamViewer.md) - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `__namedParameters` | \{ `camera?`: `Camera`; \} | -| `__namedParameters.camera?` | `Camera` | - -## Returns - -[`useLivestreamStreamerResult`](../interfaces/useLivestreamStreamerResult.md) diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/useLivestreamViewer.md b/versioned_docs/version-0.20.0/api/mobile/functions/useLivestreamViewer.md deleted file mode 100644 index 9e325ab4..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/useLivestreamViewer.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: useLivestreamViewer() - -> **useLivestreamViewer**(): [`useLivestreamViewerResult`](../interfaces/useLivestreamViewerResult.md) - -Defined in: [packages/react-native-client/src/hooks/useLivestreamViewer.ts:37](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useLivestreamViewer.ts#L37) - -Hook for receiving a published livestream. - -## Returns - -[`useLivestreamViewerResult`](../interfaces/useLivestreamViewerResult.md) diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/useMicrophone.md b/versioned_docs/version-0.20.0/api/mobile/functions/useMicrophone.md deleted file mode 100644 index 3ddbbe59..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/useMicrophone.md +++ /dev/null @@ -1,45 +0,0 @@ -# Function: useMicrophone() - -> **useMicrophone**(): `object` - -Defined in: [packages/react-native-client/src/hooks/useMicrophone.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useMicrophone.ts#L12) - -This hook can toggle microphone on/off and provides current microphone state. - -## Returns - -### isMicrophoneOn - -> **isMicrophoneOn**: `boolean` - -Informs if microphone audio track is active - -### startMicrophone() - -> **startMicrophone**: () => `Promise`\<`void`\> - -Starts microphone and requests permission if needed - -#### Returns - -`Promise`\<`void`\> - -### stopMicrophone() - -> **stopMicrophone**: () => `Promise`\<`void`\> - -Stops microphone (mutes the track without removing it) - -#### Returns - -`Promise`\<`void`\> - -### toggleMicrophone() - -> **toggleMicrophone**: () => `Promise`\<`void`\> - -Toggles microphone on/off based on the value of `isMicrophoneOn` - -#### Returns - -`Promise`\<`void`\> diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/usePeers.md b/versioned_docs/version-0.20.0/api/mobile/functions/usePeers.md deleted file mode 100644 index 127b7ef2..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/usePeers.md +++ /dev/null @@ -1,39 +0,0 @@ -# Function: usePeers() - -> **usePeers**\<`PeerMetadata`, `ServerMetadata`\>(): `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:186](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L186) - -Hook that provides live updates of room peers. - -## Type Parameters - -| Type Parameter | Default type | Description | -| ------ | ------ | ------ | -| `PeerMetadata` *extends* [`GenericMetadata`](../type-aliases/GenericMetadata.md) | [`GenericMetadata`](../type-aliases/GenericMetadata.md) | Type for peer-specific metadata | -| `ServerMetadata` *extends* [`GenericMetadata`](../type-aliases/GenericMetadata.md) | [`GenericMetadata`](../type-aliases/GenericMetadata.md) | Type for server-specific metadata | - -## Returns - -### localPeer - -> **localPeer**: `null` \| [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\> - -The local peer with distinguished tracks (camera, microphone, screen share). -Will be null if the local peer is not found. - -### ~~peers~~ - -> **peers**: [`Peer`](../type-aliases/Peer.md)\<`PeerMetadata`, `ServerMetadata`\>[] - -#### Deprecated - -Use localPeer and remotePeers instead -Legacy array containing all peers (both local and remote) without distinguished tracks. -This property will be removed in future versions. - -### remotePeers - -> **remotePeers**: [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\>[] - -Array of remote peers with distinguished tracks (camera, microphone, screen share). diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/useSandbox.md b/versioned_docs/version-0.20.0/api/mobile/functions/useSandbox.md deleted file mode 100644 index 5b13508a..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/useSandbox.md +++ /dev/null @@ -1,60 +0,0 @@ -# Function: useSandbox() - -> **useSandbox**(`__namedParameters`): `object` - -Defined in: [packages/react-native-client/src/hooks/useSandbox.ts:16](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useSandbox.ts#L16) - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `__namedParameters` | [`UseSandboxProps`](../type-aliases/UseSandboxProps.md) | - -## Returns - -`object` - -### getSandboxLivestream() - -> **getSandboxLivestream**: (`roomName`, `isPublic`) => `Promise`\<\{ `room`: \{ `id`: `string`; `name`: `string`; \}; `streamerToken`: `string`; \}\> - -#### Parameters - -| Parameter | Type | Default value | -| ------ | ------ | ------ | -| `roomName` | `string` | `undefined` | -| `isPublic` | `boolean` | `false` | - -#### Returns - -`Promise`\<\{ `room`: \{ `id`: `string`; `name`: `string`; \}; `streamerToken`: `string`; \}\> - -### getSandboxPeerToken() - -> **getSandboxPeerToken**: (`roomName`, `peerName`, `roomType`) => `Promise`\<`string`\> - -#### Parameters - -| Parameter | Type | Default value | -| ------ | ------ | ------ | -| `roomName` | `string` | `undefined` | -| `peerName` | `string` | `undefined` | -| `roomType` | [`RoomType`](../type-aliases/RoomType.md) | `'conference'` | - -#### Returns - -`Promise`\<`string`\> - -### getSandboxViewerToken() - -> **getSandboxViewerToken**: (`roomName`) => `Promise`\<`string`\> - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomName` | `string` | - -#### Returns - -`Promise`\<`string`\> diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/useScreenShare.md b/versioned_docs/version-0.20.0/api/mobile/functions/useScreenShare.md deleted file mode 100644 index b001642b..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/useScreenShare.md +++ /dev/null @@ -1,44 +0,0 @@ -# Function: useScreenShare() - -> **useScreenShare**(): `object` - -Defined in: [packages/react-native-client/src/hooks/useScreenShare.ts:42](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useScreenShare.ts#L42) - -This hook can toggle screen sharing on/off and provides current screen share state. - -## Returns - -An object with functions to manage screen share. - -### handleScreenSharePermission() - -> **handleScreenSharePermission**: () => `Promise`\<`"granted"` \| `"denied"`\> - -#### Returns - -`Promise`\<`"granted"` \| `"denied"`\> - -### isScreenShareOn - -> **isScreenShareOn**: `boolean` - -### simulcastConfig - -> **simulcastConfig**: [`SimulcastConfig`](../type-aliases/SimulcastConfig.md) - -### toggleScreenShare() - -> **toggleScreenShare**: (`screenShareOptions`) => `Promise`\<`void`\> - -Toggles the screen share on/off -Emits warning on ios when user is screensharing app screen. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `screenShareOptions` | `Partial`\<[`ScreenShareOptions`](../type-aliases/ScreenShareOptions.md)\> | - -#### Returns - -`Promise`\<`void`\> diff --git a/versioned_docs/version-0.20.0/api/mobile/functions/useUpdatePeerMetadata.md b/versioned_docs/version-0.20.0/api/mobile/functions/useUpdatePeerMetadata.md deleted file mode 100644 index ffe06a5f..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/functions/useUpdatePeerMetadata.md +++ /dev/null @@ -1,31 +0,0 @@ -# Function: useUpdatePeerMetadata() - -> **useUpdatePeerMetadata**\<`PeerMetadata`\>(): `object` - -Defined in: [packages/react-native-client/src/hooks/useUpdatePeerMetadata.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useUpdatePeerMetadata.ts#L10) - -This hook provides method to update peer metadata - -## Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `PeerMetadata` *extends* [`GenericMetadata`](../type-aliases/GenericMetadata.md) | [`GenericMetadata`](../type-aliases/GenericMetadata.md) | - -## Returns - -### updatePeerMetadata() - -> **updatePeerMetadata**: (`peerMetadata`) => `Promise`\<`void`\> - -Updates metadata send to other peers - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `peerMetadata` | `PeerMetadata` | string indexed record with metadata, that will be available to all other peers | - -#### Returns - -`Promise`\<`void`\> diff --git a/versioned_docs/version-0.20.0/api/mobile/index.md b/versioned_docs/version-0.20.0/api/mobile/index.md deleted file mode 100644 index b4673dcb..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/index.md +++ /dev/null @@ -1,87 +0,0 @@ -# @fishjam-cloud/react-native-client - -## Connection - -- [useConnection](functions/useConnection.md) -- [usePeers](functions/usePeers.md) -- [useScreenShare](functions/useScreenShare.md) -- [useUpdatePeerMetadata](functions/useUpdatePeerMetadata.md) -- [useAppScreenShare](variables/useAppScreenShare.md) -- [useForegroundService](variables/useForegroundService.md) - -## Devices - -- [useAudioSettings](functions/useAudioSettings.md) -- [useCamera](functions/useCamera.md) -- [useMicrophone](functions/useMicrophone.md) - -## Components - -- [FishjamRoom](functions/FishjamRoom.md) -- [LivestreamStreamer](functions/LivestreamStreamer.md) -- [LivestreamViewer](functions/LivestreamViewer.md) -- [VideoPreviewView](variables/VideoPreviewView.md) -- [VideoRendererView](variables/VideoRendererView.md) - -## Livestream - -- [useLivestreamStreamer](functions/useLivestreamStreamer.md) -- [useLivestreamViewer](functions/useLivestreamViewer.md) -- [useLivestreamStreamerResult](interfaces/useLivestreamStreamerResult.md) -- [useLivestreamViewerResult](interfaces/useLivestreamViewerResult.md) - -## Other - -- [useSandbox](functions/useSandbox.md) -- [AppScreenShareData](type-aliases/AppScreenShareData.md) -- [AudioOutputDevice](type-aliases/AudioOutputDevice.md) -- [AudioOutputDeviceType](type-aliases/AudioOutputDeviceType.md) -- [AudioSessionMode](type-aliases/AudioSessionMode.md) -- [AudioTrack](type-aliases/AudioTrack.md) -- [Brand](type-aliases/Brand.md) -- [Camera](type-aliases/Camera.md) -- [CameraConfig](type-aliases/CameraConfig.md) -- [CameraConfigBase](type-aliases/CameraConfigBase.md) -- [CameraFacingDirection](type-aliases/CameraFacingDirection.md) -- [CameraId](type-aliases/CameraId.md) -- [ConnectionConfig](type-aliases/ConnectionConfig.md) -- [ConnectViewerConfig](type-aliases/ConnectViewerConfig.md) -- [DistinguishedTracks](type-aliases/DistinguishedTracks.md) -- [EncodingReason](type-aliases/EncodingReason.md) -- [FishjamRoomProps](type-aliases/FishjamRoomProps.md) -- [ForegroundServiceConfig](type-aliases/ForegroundServiceConfig.md) -- [GenericMetadata](type-aliases/GenericMetadata.md) -- [JoinRoomConfig](type-aliases/JoinRoomConfig.md) -- [LivestreamStreamerProps](type-aliases/LivestreamStreamerProps.md) -- [LivestreamViewerProps](type-aliases/LivestreamViewerProps.md) -- [LivestreamViewerRef](type-aliases/LivestreamViewerRef.md) -- [Peer](type-aliases/Peer.md) -- [PeerId](type-aliases/PeerId.md) -- [PeerStatus](type-aliases/PeerStatus.md) -- [PeerTrackMetadata](type-aliases/PeerTrackMetadata.md) -- [PeerWithTracks](type-aliases/PeerWithTracks.md) -- [ReconnectionStatus](type-aliases/ReconnectionStatus.md) -- [RoomType](type-aliases/RoomType.md) -- [ScreenShareOptions](type-aliases/ScreenShareOptions.md) -- [ScreenShareQuality](type-aliases/ScreenShareQuality.md) -- [SimulcastConfig](type-aliases/SimulcastConfig.md) -- [Track](type-aliases/Track.md) -- [TrackBase](type-aliases/TrackBase.md) -- [TrackId](type-aliases/TrackId.md) -- [TrackMetadata](type-aliases/TrackMetadata.md) -- [TrackType](type-aliases/TrackType.md) -- [UsePeersResult](type-aliases/UsePeersResult.md) -- [UseSandboxProps](type-aliases/UseSandboxProps.md) -- [VadStatus](type-aliases/VadStatus.md) -- [VideoLayout](type-aliases/VideoLayout.md) -- [VideoPreviewViewProps](type-aliases/VideoPreviewViewProps.md) -- [VideoQuality](type-aliases/VideoQuality.md) -- [VideoRendererProps](type-aliases/VideoRendererProps.md) -- [VideoTrack](type-aliases/VideoTrack.md) -- [cameras](variables/cameras.md) -- [useCameraPermissions](variables/useCameraPermissions.md) -- [useMicrophonePermissions](variables/useMicrophonePermissions.md) - -## Debugging - -- [useBandwidthEstimation](functions/useBandwidthEstimation.md) diff --git a/versioned_docs/version-0.20.0/api/mobile/interfaces/useLivestreamStreamerResult.md b/versioned_docs/version-0.20.0/api/mobile/interfaces/useLivestreamStreamerResult.md deleted file mode 100644 index 3b74f288..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/interfaces/useLivestreamStreamerResult.md +++ /dev/null @@ -1,42 +0,0 @@ -# Interface: useLivestreamStreamerResult - -Defined in: [packages/react-native-client/src/hooks/useLivestreamStreamer.ts:14](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useLivestreamStreamer.ts#L14) - -## Properties - -### connect() - -> **connect**: (`token`, `urlOverride?`) => `Promise`\<`void`\> - -Defined in: [packages/react-native-client/src/hooks/useLivestreamStreamer.ts:21](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useLivestreamStreamer.ts#L21) - -Callback used to start publishing the selected audio and video media streams. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `token` | `string` | -| `urlOverride?` | `string` | - -#### Returns - -`Promise`\<`void`\> - -#### Remarks - -Calling [connect](#connect) multiple times will have the effect of only publishing the **last** specified inputs. - -*** - -### disconnect() - -> **disconnect**: () => `void` - -Defined in: [packages/react-native-client/src/hooks/useLivestreamStreamer.ts:23](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useLivestreamStreamer.ts#L23) - -Callback to stop publishing anything previously published with [connect](#connect) - -#### Returns - -`void` diff --git a/versioned_docs/version-0.20.0/api/mobile/interfaces/useLivestreamViewerResult.md b/versioned_docs/version-0.20.0/api/mobile/interfaces/useLivestreamViewerResult.md deleted file mode 100644 index 3f7551a6..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/interfaces/useLivestreamViewerResult.md +++ /dev/null @@ -1,40 +0,0 @@ -# Interface: useLivestreamViewerResult - -Defined in: [packages/react-native-client/src/hooks/useLivestreamViewer.ts:21](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useLivestreamViewer.ts#L21) - -## Properties - -### connect() - -> **connect**: (`config`, `url?`) => `Promise`\<`void`\> - -Defined in: [packages/react-native-client/src/hooks/useLivestreamViewer.ts:27](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useLivestreamViewer.ts#L27) - -Callback to start receiving a livestream. -If the livestream is private, provide `token`. -If the livestream is public, provide `streamId`. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`ConnectViewerConfig`](../type-aliases/ConnectViewerConfig.md) | -| `url?` | `string` | - -#### Returns - -`Promise`\<`void`\> - -*** - -### disconnect() - -> **disconnect**: () => `void` - -Defined in: [packages/react-native-client/src/hooks/useLivestreamViewer.ts:29](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useLivestreamViewer.ts#L29) - -Disconnect from a stream previously connected to with [connect](#connect) - -#### Returns - -`void` diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/AppScreenShareData.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/AppScreenShareData.md deleted file mode 100644 index 645f20e4..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/AppScreenShareData.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type Alias: AppScreenShareData - -> **AppScreenShareData** = `object` - -Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:17](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useAppScreenShare.ts#L17) - -## Properties - -### isAppScreenShareOn - -> **isAppScreenShareOn**: `boolean` - -Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:18](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useAppScreenShare.ts#L18) - -*** - -### simulcastConfig - -> **simulcastConfig**: [`SimulcastConfig`](SimulcastConfig.md) - -Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:19](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useAppScreenShare.ts#L19) - -*** - -### toggleAppScreenShare() - -> **toggleAppScreenShare**: (`screenShareOptions?`) => `Promise`\<`void`\> - -Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:20](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useAppScreenShare.ts#L20) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `screenShareOptions?` | `Partial`\<[`ScreenShareOptions`](ScreenShareOptions.md)\> | - -#### Returns - -`Promise`\<`void`\> diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/AudioOutputDevice.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/AudioOutputDevice.md deleted file mode 100644 index e221593c..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/AudioOutputDevice.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: AudioOutputDevice - -> **AudioOutputDevice** = `object` - -Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:17](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useAudioSettings.ts#L17) - -## Properties - -### name - -> **name**: `string` - -Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:19](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useAudioSettings.ts#L19) - -*** - -### type - -> **type**: [`AudioOutputDeviceType`](AudioOutputDeviceType.md) - -Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:18](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useAudioSettings.ts#L18) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/AudioOutputDeviceType.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/AudioOutputDeviceType.md deleted file mode 100644 index 31ac6fdd..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/AudioOutputDeviceType.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: AudioOutputDeviceType - -> **AudioOutputDeviceType** = `"bluetooth"` \| `"headset"` \| `"speaker"` \| `"earpiece"` - -Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useAudioSettings.ts#L9) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/AudioSessionMode.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/AudioSessionMode.md deleted file mode 100644 index dbd10996..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/AudioSessionMode.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: AudioSessionMode - -> **AudioSessionMode** = `"voiceChat"` \| `"videoChat"` - -Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useAudioSettings.ts#L15) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/AudioTrack.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/AudioTrack.md deleted file mode 100644 index 7bf17899..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/AudioTrack.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: AudioTrack - -> **AudioTrack** = [`TrackBase`](TrackBase.md) & `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:34](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L34) - -## Type declaration - -### type - -> **type**: `"Audio"` - -### vadStatus - -> **vadStatus**: [`VadStatus`](VadStatus.md) \| `undefined` diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/Brand.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/Brand.md deleted file mode 100644 index 2ed64dfb..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/Brand.md +++ /dev/null @@ -1,20 +0,0 @@ -# Type Alias: Brand\ - -> **Brand**\<`T`, `TBrand`\> = `T` & `object` - -Defined in: [packages/react-native-client/src/types.ts:34](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/types.ts#L34) - -Branded type - -## Type declaration - -### \[brand\] - -> **\[brand\]**: `TBrand` - -## Type Parameters - -| Type Parameter | -| ------ | -| `T` | -| `TBrand` *extends* `string` | diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/Camera.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/Camera.md deleted file mode 100644 index 80f4c4b3..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/Camera.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: Camera - -> **Camera** = `object` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L12) - -## Properties - -### facingDirection - -> **facingDirection**: [`CameraFacingDirection`](CameraFacingDirection.md) - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L15) - -*** - -### id - -> **id**: [`CameraId`](CameraId.md) - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:13](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L13) - -*** - -### name - -> **name**: `string` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:14](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L14) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/CameraConfig.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/CameraConfig.md deleted file mode 100644 index 52c4f95b..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/CameraConfig.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: CameraConfig - -> **CameraConfig** = [`CameraConfigBase`](CameraConfigBase.md) & `object` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:74](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L74) - -## Type declaration - -### simulcastEnabled? - -> `optional` **simulcastEnabled**: `boolean` - -whether video track uses simulcast. By default simulcast is disabled. diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/CameraConfigBase.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/CameraConfigBase.md deleted file mode 100644 index 83205c25..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/CameraConfigBase.md +++ /dev/null @@ -1,78 +0,0 @@ -# Type Alias: CameraConfigBase - -> **CameraConfigBase** = `object` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:36](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L36) - -## Properties - -### cameraEnabled? - -> `optional` **cameraEnabled**: `boolean` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:65](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L65) - -whether the camera track is initially enabled, you can toggle it on/off later with toggleCamera method - -#### Default - -`true` - -*** - -### cameraId? - -> `optional` **cameraId**: [`CameraId`](CameraId.md) - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:71](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L71) - -id of the camera to start capture with. Get available cameras with `cameras`. -You can switch the cameras later with `switchCamera` functions. - -#### Default - -`the first front camera` - -*** - -### flipDimensions? - -> `optional` **flipDimensions**: `boolean` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:60](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L60) - -whether to flip the dimensions of the video, that is whether to film in vertical orientation. -This basically switches width with height and is only used to select closes capture format. - -To record horizontal video your phone orientation must be in landscape and your app must support this orientation. - -Platform specific capture formats: - -#### See - - - [iOS](https://developer.apple.com/documentation/avfoundation/avcapturedevice/format) - - [Android](https://github.com/webrtc-sdk/webrtc/blob/cdc3bba5aa38910a55428b919ba45aceac1ad9ad/sdk/android/api/org/webrtc/CameraEnumerationAndroid.java#L50) - -WebRTC device orientation handling: - - [iOS](https://github.com/webrtc-sdk/webrtc/blob/cdc3bba5aa38910a55428b919ba45aceac1ad9ad/sdk/objc/components/capturer/RTCCameraVideoCapturer.m#L285) - - [Android](https://github.com/pristineio/webrtc-mirror/blob/7a5bcdffaab90a05bc1146b2b1ea71c004e54d71/webrtc/sdk/android/src/java/org/webrtc/Camera2Session.java#L347) - -#### Default - -`true` - -*** - -### quality? - -> `optional` **quality**: [`VideoQuality`](VideoQuality.md) - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:43](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L43) - -resolution + aspect ratio of local video track, one of: `QVGA_169`, `VGA_169`, `QHD_169`, `HD_169`, -`FHD_169`, `QVGA_43`, `VGA_43`, `QHD_43`, `HD_43`, `FHD_43`. Note that quality might be worse than -specified due to device capabilities, internet connection etc. - -#### Default - -`VGA_169` diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/CameraFacingDirection.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/CameraFacingDirection.md deleted file mode 100644 index 203ac17e..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/CameraFacingDirection.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: CameraFacingDirection - -> **CameraFacingDirection** = `"front"` \| `"back"` \| `"unspecified"` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L10) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/CameraId.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/CameraId.md deleted file mode 100644 index 4498cd17..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/CameraId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: CameraId - -> **CameraId** = [`Brand`](Brand.md)\<`string`, `"CameraId"`\> - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:8](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L8) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/ConnectViewerConfig.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/ConnectViewerConfig.md deleted file mode 100644 index 6b82b99d..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/ConnectViewerConfig.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ConnectViewerConfig - -> **ConnectViewerConfig** = \{ `streamId?`: `never`; `token`: `string`; \} \| \{ `streamId`: `string`; `token?`: `never`; \} - -Defined in: [packages/react-native-client/src/hooks/useLivestreamViewer.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useLivestreamViewer.ts#L9) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/ConnectionConfig.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/ConnectionConfig.md deleted file mode 100644 index a2a7d5d0..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/ConnectionConfig.md +++ /dev/null @@ -1,26 +0,0 @@ -# Type Alias: ConnectionConfig - -> **ConnectionConfig** = `object` - -Defined in: [packages/react-native-client/src/common/client.ts:4](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/common/client.ts#L4) - -## Properties - -### reconnectConfig? - -> `optional` **reconnectConfig**: `object` - -Defined in: [packages/react-native-client/src/common/client.ts:13](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/common/client.ts#L13) - -Configuration for automatic reconnection -sdk uses a linear backoff algorithm, that is the formula -for the delay of the nth attempt is -n * delayMs + initialDelayMs - -Pass 0 for maxAttempts to disable automatic reconnection - -| Name | Type | -| ------ | ------ | -| `delayMs?` | `number` | -| `initialDelayMs?` | `number` | -| `maxAttempts?` | `number` | diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/DistinguishedTracks.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/DistinguishedTracks.md deleted file mode 100644 index 20794d66..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/DistinguishedTracks.md +++ /dev/null @@ -1,37 +0,0 @@ -# Type Alias: DistinguishedTracks - -> **DistinguishedTracks** = `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:54](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L54) - -## Properties - -### cameraTrack? - -> `optional` **cameraTrack**: [`VideoTrack`](VideoTrack.md) - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:55](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L55) - -*** - -### microphoneTrack? - -> `optional` **microphoneTrack**: [`AudioTrack`](AudioTrack.md) - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:56](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L56) - -*** - -### screenShareAudioTrack? - -> `optional` **screenShareAudioTrack**: [`AudioTrack`](AudioTrack.md) - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:58](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L58) - -*** - -### screenShareVideoTrack? - -> `optional` **screenShareVideoTrack**: [`VideoTrack`](VideoTrack.md) - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:57](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L57) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/EncodingReason.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/EncodingReason.md deleted file mode 100644 index b1e667c8..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/EncodingReason.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: EncodingReason - -> **EncodingReason** = `"other"` \| `"encoding_inactive"` \| `"low_bandwidth"` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:52](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L52) - -Type describing possible reasons of currently selected encoding. - -- other - the exact reason couldn't be determined -- encoding_inactive - previously selected encoding became inactive -- low_bandwidth - there is no longer enough bandwidth to maintain previously selected encoding diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/FishjamRoomProps.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/FishjamRoomProps.md deleted file mode 100644 index 6c05bc9c..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/FishjamRoomProps.md +++ /dev/null @@ -1,25 +0,0 @@ -# Type Alias: FishjamRoomProps - -> **FishjamRoomProps** = `object` - -Defined in: [packages/react-native-client/src/components/FishjamRoom/index.tsx:7](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/FishjamRoom/index.tsx#L7) - -## Properties - -### fishjamUrl - -> **fishjamUrl**: `string` - -Defined in: [packages/react-native-client/src/components/FishjamRoom/index.tsx:11](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/FishjamRoom/index.tsx#L11) - -URL to your fishjam instance - -*** - -### peerToken - -> **peerToken**: `string` - -Defined in: [packages/react-native-client/src/components/FishjamRoom/index.tsx:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/FishjamRoom/index.tsx#L15) - -Peer Token diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/ForegroundServiceConfig.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/ForegroundServiceConfig.md deleted file mode 100644 index 1eca6631..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/ForegroundServiceConfig.md +++ /dev/null @@ -1,67 +0,0 @@ -# Type Alias: ForegroundServiceConfig - -> **ForegroundServiceConfig** = `object` - -Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useForegroundService.ts#L9) - -A type representing the configuration for foreground service permissions. - -## Properties - -### channelId? - -> `optional` **channelId**: `string` - -Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:21](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useForegroundService.ts#L21) - -The id of the channel. Must be unique per package. - -*** - -### channelName? - -> `optional` **channelName**: `string` - -Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:25](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useForegroundService.ts#L25) - -The user visible name of the channel. - -*** - -### enableCamera? - -> `optional` **enableCamera**: `boolean` - -Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:13](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useForegroundService.ts#L13) - -Indicates whether the camera is enabled for the foreground service. - -*** - -### enableMicrophone? - -> `optional` **enableMicrophone**: `boolean` - -Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:17](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useForegroundService.ts#L17) - -Indicates whether the microphone is enabled for the foreground service. - -*** - -### notificationContent? - -> `optional` **notificationContent**: `string` - -Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:33](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useForegroundService.ts#L33) - -The text (second row) of the notification, in a standard notification. - -*** - -### notificationTitle? - -> `optional` **notificationTitle**: `string` - -Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:29](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useForegroundService.ts#L29) - -The title (first row) of the notification, in a standard notification. diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/GenericMetadata.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/GenericMetadata.md deleted file mode 100644 index e85d3ffd..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/GenericMetadata.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: GenericMetadata - -> **GenericMetadata** = `Record`\<`string`, `unknown`\> - -Defined in: [packages/react-native-client/src/types.ts:27](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/types.ts#L27) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/JoinRoomConfig.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/JoinRoomConfig.md deleted file mode 100644 index 366410a7..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/JoinRoomConfig.md +++ /dev/null @@ -1,31 +0,0 @@ -# Type Alias: JoinRoomConfig\ - -> **JoinRoomConfig**\<`PeerMetadata`\> = `object` & \{ `fishjamId`: `string`; `url?`: `never`; \} \| \{ `fishjamId?`: `never`; `url`: `string`; \} - -Defined in: [packages/react-native-client/src/hooks/useConnection.ts:47](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useConnection.ts#L47) - -## Type declaration - -### config? - -> `optional` **config**: [`ConnectionConfig`](ConnectionConfig.md) - -Additional connection configuration - -### peerMetadata? - -> `optional` **peerMetadata**: `PeerMetadata` - -String indexed record with metadata, that will be available to all other peers - -### peerToken - -> **peerToken**: `string` - -Token received from server (or Room Manager) - -## Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `PeerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/LivestreamStreamerProps.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/LivestreamStreamerProps.md deleted file mode 100644 index 588c6225..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/LivestreamStreamerProps.md +++ /dev/null @@ -1,17 +0,0 @@ -# Type Alias: LivestreamStreamerProps - -> **LivestreamStreamerProps** = `object` - -Defined in: [packages/react-native-client/src/components/LivestreamStreamer.tsx:8](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamStreamer.tsx#L8) - -Props of the LivestreamView component - -## Properties - -### style? - -> `optional` **style**: `StyleProp`\<`ViewStyle`\> - -Defined in: [packages/react-native-client/src/components/LivestreamStreamer.tsx:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamStreamer.tsx#L12) - -Styles of the LivestreamView component diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/LivestreamViewerProps.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/LivestreamViewerProps.md deleted file mode 100644 index a3f4e383..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/LivestreamViewerProps.md +++ /dev/null @@ -1,85 +0,0 @@ -# Type Alias: LivestreamViewerProps - -> **LivestreamViewerProps** = `object` - -Defined in: [packages/react-native-client/src/components/LivestreamViewer.tsx:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamViewer.tsx#L10) - -Props of the LivestreamView component - -## Properties - -### autoStartPip? - -> `optional` **autoStartPip**: `boolean` - -Defined in: [packages/react-native-client/src/components/LivestreamViewer.tsx:29](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamViewer.tsx#L29) - -A variable deciding whether the Picture-in-Picture mode should be started automatically after the app is backgrounded. -Defaults to false. - -*** - -### autoStopPip? - -> `optional` **autoStopPip**: `boolean` - -Defined in: [packages/react-native-client/src/components/LivestreamViewer.tsx:35](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamViewer.tsx#L35) - -A variable deciding whether the Picture-in-Picture mode should be stopped automatically on iOS after the app is foregrounded. -Always enabled on Android as PiP is not supported in foreground. -Defaults to false. - -*** - -### orientation? - -> `optional` **orientation**: `"landscape"` \| `"portrait"` - -Defined in: [packages/react-native-client/src/components/LivestreamViewer.tsx:19](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamViewer.tsx#L19) - -Used to override the orientation of the video (from metadata). -Defaults to "portrait". - -*** - -### pipEnabled? - -> `optional` **pipEnabled**: `boolean` - -Defined in: [packages/react-native-client/src/components/LivestreamViewer.tsx:24](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamViewer.tsx#L24) - -A variable deciding whether the Picture-in-Picture is enabled. -Defaults to true. - -*** - -### pipSize? - -> `optional` **pipSize**: `object` - -Defined in: [packages/react-native-client/src/components/LivestreamViewer.tsx:39](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamViewer.tsx#L39) - -A variable deciding the size of the Picture-in-Picture mode. - -| Name | Type | -| ------ | ------ | -| `height` | `number` | -| `width` | `number` | - -*** - -### ref? - -> `optional` **ref**: `Ref`\<[`LivestreamViewerRef`](LivestreamViewerRef.md)\> - -Defined in: [packages/react-native-client/src/components/LivestreamViewer.tsx:44](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamViewer.tsx#L44) - -*** - -### style? - -> `optional` **style**: `StyleProp`\<`ViewStyle`\> - -Defined in: [packages/react-native-client/src/components/LivestreamViewer.tsx:14](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamViewer.tsx#L14) - -Styles of the LivestreamView component diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/LivestreamViewerRef.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/LivestreamViewerRef.md deleted file mode 100644 index 57da907e..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/LivestreamViewerRef.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: LivestreamViewerRef - -> **LivestreamViewerRef** = `WhepClientViewRef` - -Defined in: [packages/react-native-client/src/components/LivestreamViewer.tsx:5](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/LivestreamViewer.tsx#L5) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/Peer.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/Peer.md deleted file mode 100644 index b8544405..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/Peer.md +++ /dev/null @@ -1,52 +0,0 @@ -# Type Alias: Peer\ - -> **Peer**\<`PeerMetadata`, `ServerMetadata`\> = `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:66](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L66) - -## Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `PeerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | -| `ServerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | - -## Properties - -### id - -> **id**: [`PeerId`](PeerId.md) - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:73](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L73) - -id used to identify a peer - -*** - -### isLocal - -> **isLocal**: `boolean` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:77](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L77) - -whether the peer is local or remote - -*** - -### metadata - -> **metadata**: [`PeerTrackMetadata`](PeerTrackMetadata.md)\<`PeerMetadata`, `ServerMetadata`\> - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:81](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L81) - -a type containing peer and server metadata - -*** - -### tracks - -> **tracks**: [`Track`](Track.md)[] - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:85](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L85) - -a list of peer's video and audio tracks diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/PeerId.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/PeerId.md deleted file mode 100644 index 7d91f146..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/PeerId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerId - -> **PeerId** = [`Brand`](Brand.md)\<`string`, `"PeerId"`\> - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L9) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/PeerStatus.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/PeerStatus.md deleted file mode 100644 index 2a7570a7..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/PeerStatus.md +++ /dev/null @@ -1,12 +0,0 @@ -# Type Alias: PeerStatus - -> **PeerStatus** = `"connecting"` \| `"connected"` \| `"error"` \| `"idle"` - -Defined in: [packages/react-native-client/src/hooks/useConnection.ts:32](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useConnection.ts#L32) - -Represents the possible statuses of a peer connection to a room (websocket state). - -- `idle` - Peer is not connected, either never connected or successfully disconnected. -- `connecting` - Peer is in the process of connecting. -- `connected` - Peer has successfully connected. -- `error` - There was an error in the connection process. diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/PeerTrackMetadata.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/PeerTrackMetadata.md deleted file mode 100644 index efa1bb11..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/PeerTrackMetadata.md +++ /dev/null @@ -1,28 +0,0 @@ -# Type Alias: PeerTrackMetadata\ - -> **PeerTrackMetadata**\<`PeerMetadata`, `ServerMetadata`\> = `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:22](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L22) - -## Type Parameters - -| Type Parameter | -| ------ | -| `PeerMetadata` | -| `ServerMetadata` | - -## Properties - -### peer - -> **peer**: `PeerMetadata` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:23](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L23) - -*** - -### server - -> **server**: `ServerMetadata` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:24](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L24) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/PeerWithTracks.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/PeerWithTracks.md deleted file mode 100644 index ed45cb5a..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/PeerWithTracks.md +++ /dev/null @@ -1,12 +0,0 @@ -# Type Alias: PeerWithTracks\ - -> **PeerWithTracks**\<`PeerMetadata`, `ServerMetadata`\> = [`Peer`](Peer.md)\<`PeerMetadata`, `ServerMetadata`\> & [`DistinguishedTracks`](DistinguishedTracks.md) - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:61](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L61) - -## Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `PeerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | -| `ServerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/ReconnectionStatus.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/ReconnectionStatus.md deleted file mode 100644 index 78419cba..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/ReconnectionStatus.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: ReconnectionStatus - -> **ReconnectionStatus** = `"idle"` \| `"reconnecting"` \| `"error"` - -Defined in: [packages/react-native-client/src/hooks/useConnection.ts:22](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useConnection.ts#L22) - -Represents the possible statuses of a peer while reconnecting to room - -- `idle` - No reconnection in progress. See [PeerStatus](PeerStatus.md) for more details -- `reconnecting` - Peer is in the process of reconnecting. -- `error` - There was an error in the reconnection process. diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/RoomType.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/RoomType.md deleted file mode 100644 index 12445374..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/RoomType.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomType - -> **RoomType** = `"conference"` \| `"audio-only"` \| `"livestream"` - -Defined in: [packages/react-native-client/src/types.ts:36](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/types.ts#L36) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/ScreenShareOptions.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/ScreenShareOptions.md deleted file mode 100644 index 6f830586..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/ScreenShareOptions.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ScreenShareOptions - -> **ScreenShareOptions** = `object` - -Defined in: [packages/react-native-client/src/hooks/useScreenShare.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useScreenShare.ts#L12) - -## Properties - -### quality - -> **quality**: [`ScreenShareQuality`](ScreenShareQuality.md) - -Defined in: [packages/react-native-client/src/hooks/useScreenShare.ts:19](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useScreenShare.ts#L19) - -Resolution + fps of screen share track, one of: `VGA`, `HD5`, `HD15`, `FHD15`, `FHD30`. -Note that quality might be worse than specified due to device capabilities, internet -connection etc. - -#### Default - -`HD15` diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/ScreenShareQuality.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/ScreenShareQuality.md deleted file mode 100644 index e590fb5a..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/ScreenShareQuality.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ScreenShareQuality - -> **ScreenShareQuality** = `"VGA"` \| `"HD5"` \| `"HD15"` \| `"FHD15"` \| `"FHD30"` - -Defined in: [packages/react-native-client/src/hooks/useScreenShare.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useScreenShare.ts#L10) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/SimulcastConfig.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/SimulcastConfig.md deleted file mode 100644 index 59f69c46..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/SimulcastConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: SimulcastConfig - -> **SimulcastConfig** = `object` - -Defined in: [packages/react-native-client/src/types.ts:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/types.ts#L15) - -A type describing simulcast configuration. - -At the moment, simulcast track is initialized in three versions - low, medium and high. -High resolution is the original track resolution, while medium and low resolutions are -the original track resolution scaled down by 2 and 4 respectively. - -## Properties - -### enabled - -> **enabled**: `boolean` - -Defined in: [packages/react-native-client/src/types.ts:19](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/types.ts#L19) - -whether to simulcast track or not. By default simulcast is disabled. diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/Track.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/Track.md deleted file mode 100644 index 22e14151..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/Track.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: Track - -> **Track** = [`VideoTrack`](VideoTrack.md) \| [`AudioTrack`](AudioTrack.md) - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:44](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L44) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/TrackBase.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/TrackBase.md deleted file mode 100644 index 06fcd2af..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/TrackBase.md +++ /dev/null @@ -1,37 +0,0 @@ -# Type Alias: TrackBase - -> **TrackBase** = `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:27](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L27) - -## Properties - -### id - -> **id**: [`TrackId`](TrackId.md) - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:28](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L28) - -*** - -### isActive - -> **isActive**: `boolean` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:30](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L30) - -*** - -### metadata? - -> `optional` **metadata**: [`TrackMetadata`](TrackMetadata.md) - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:31](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L31) - -*** - -### type - -> **type**: [`TrackType`](TrackType.md) - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:29](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L29) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/TrackId.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/TrackId.md deleted file mode 100644 index 479aa6a8..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/TrackId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackId - -> **TrackId** = [`Brand`](Brand.md)\<`string`, `"TrackId"`\> - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L10) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/TrackMetadata.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/TrackMetadata.md deleted file mode 100644 index a2b6214c..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/TrackMetadata.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: TrackMetadata - -> **TrackMetadata** = `object` - -Defined in: [packages/react-native-client/src/types.ts:22](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/types.ts#L22) - -## Properties - -### active - -> **active**: `boolean` - -Defined in: [packages/react-native-client/src/types.ts:23](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/types.ts#L23) - -*** - -### type - -> **type**: `"microphone"` \| `"camera"` \| `"screenShareVideo"` \| `"screenShareAudio"` - -Defined in: [packages/react-native-client/src/types.ts:24](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/types.ts#L24) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/TrackType.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/TrackType.md deleted file mode 100644 index a9bbb16a..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/TrackType.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackType - -> **TrackType** = `"Audio"` \| `"Video"` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L12) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/UsePeersResult.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/UsePeersResult.md deleted file mode 100644 index cccfe53b..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/UsePeersResult.md +++ /dev/null @@ -1,38 +0,0 @@ -# Type Alias: UsePeersResult\ - -> **UsePeersResult**\<`PeerMetadata`, `ServerMetadata`\> = `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:168](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L168) - -Result type for the usePeers hook. - -## Type Parameters - -| Type Parameter | Default type | Description | -| ------ | ------ | ------ | -| `PeerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | Type for peer-specific metadata | -| `ServerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | Type for server-specific metadata | - -## Properties - -### localPeer - -> **localPeer**: [`PeerWithTracks`](PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\> \| `null` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:172](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L172) - -*** - -### peers - -> **peers**: [`Peer`](Peer.md)\<`PeerMetadata`, `ServerMetadata`\>[] - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:176](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L176) - -*** - -### remotePeers - -> **remotePeers**: [`PeerWithTracks`](PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\>[] - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:174](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L174) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/UseSandboxProps.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/UseSandboxProps.md deleted file mode 100644 index 59c72ca9..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/UseSandboxProps.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: UseSandboxProps - -> **UseSandboxProps** = \{ `fishjamId`: `string`; `fishjamUrl?`: `never`; \} \| \{ `fishjamId?`: `never`; `fishjamUrl`: `string`; \} - -Defined in: [packages/react-native-client/src/hooks/useSandbox.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useSandbox.ts#L12) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/VadStatus.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/VadStatus.md deleted file mode 100644 index 97c3636f..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/VadStatus.md +++ /dev/null @@ -1,10 +0,0 @@ -# Type Alias: VadStatus - -> **VadStatus** = `"silence"` \| `"speech"` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:20](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L20) - -Type describing Voice Activity Detection statuses. - -- `speech` voice activity has been detected -- `silence` - lack of voice activity has been detected diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoLayout.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoLayout.md deleted file mode 100644 index 2b7bb6ad..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoLayout.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: VideoLayout - -> **VideoLayout** = `"FILL"` \| `"FIT"` - -Defined in: [packages/react-native-client/src/types.ts:6](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/types.ts#L6) - -`FILL` or `FIT` - it works just like RN Image component. `FILL` fills the whole view -with video and it may cut some parts of the video. `FIT` scales the video so the whole -video is visible, but it may leave some empty space in the view. diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoPreviewViewProps.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoPreviewViewProps.md deleted file mode 100644 index 515c9891..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoPreviewViewProps.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: VideoPreviewViewProps - -> **VideoPreviewViewProps** = `object` - -Defined in: [packages/react-native-client/src/components/VideoPreviewView.tsx:8](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/VideoPreviewView.tsx#L8) - -## Properties - -### cameraId? - -> `optional` **cameraId**: [`CameraId`](CameraId.md) - -Defined in: [packages/react-native-client/src/components/VideoPreviewView.tsx:20](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/VideoPreviewView.tsx#L20) - -Id of the camera used for preview. Get available cameras with `cameras` property. - -#### Default - -`the first front camera` - -*** - -### style? - -> `optional` **style**: `StyleProp`\<`ViewStyle`\> - -Defined in: [packages/react-native-client/src/components/VideoPreviewView.tsx:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/VideoPreviewView.tsx#L15) - -*** - -### videoLayout? - -> `optional` **videoLayout**: [`VideoLayout`](VideoLayout.md) - -Defined in: [packages/react-native-client/src/components/VideoPreviewView.tsx:13](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/VideoPreviewView.tsx#L13) - -Video layout inside of the component - -#### Default - -`FILL` diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoQuality.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoQuality.md deleted file mode 100644 index 7452ff92..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoQuality.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: VideoQuality - -> **VideoQuality** = `"QVGA169"` \| `"VGA169"` \| `"QHD169"` \| `"HD169"` \| `"FHD169"` \| `"QVGA43"` \| `"VGA43"` \| `"QHD43"` \| `"HD43"` \| `"FHD43"` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:24](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useCamera.ts#L24) diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoRendererProps.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoRendererProps.md deleted file mode 100644 index 8c77b3f8..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoRendererProps.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: VideoRendererProps - -> **VideoRendererProps** = `object` - -Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:8](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/VideoRendererView.tsx#L8) - -## Properties - -### skipRenderOutsideVisibleArea? - -> `optional` **skipRenderOutsideVisibleArea**: `boolean` - -Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:21](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/VideoRendererView.tsx#L21) - -Whether the video should be rendered if it's off screen or hidden. - -*** - -### style? - -> `optional` **style**: `StyleProp`\<`ViewStyle`\> - -Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:22](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/VideoRendererView.tsx#L22) - -*** - -### trackId - -> **trackId**: [`TrackId`](TrackId.md) - -Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/VideoRendererView.tsx#L12) - -id of the video track which you want to render. - -*** - -### videoLayout? - -> `optional` **videoLayout**: [`VideoLayout`](VideoLayout.md) - -Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:17](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/VideoRendererView.tsx#L17) - -Video layout inside of the component - -#### Default - -`FILL` diff --git a/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoTrack.md b/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoTrack.md deleted file mode 100644 index deba2577..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/type-aliases/VideoTrack.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: VideoTrack - -> **VideoTrack** = [`TrackBase`](TrackBase.md) & `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:39](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePeers.ts#L39) - -## Type declaration - -### aspectRatio - -> **aspectRatio**: `number` - -### type - -> **type**: `"Video"` diff --git a/versioned_docs/version-0.20.0/api/mobile/typedoc-sidebar.cjs b/versioned_docs/version-0.20.0/api/mobile/typedoc-sidebar.cjs deleted file mode 100644 index 641d3fa8..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ -const typedocSidebar = {items:[{type:"category",label:"Connection",items:[{type:"doc",id:"api/mobile/functions/useConnection",label:"useConnection"},{type:"doc",id:"api/mobile/functions/usePeers",label:"usePeers"},{type:"doc",id:"api/mobile/functions/useScreenShare",label:"useScreenShare"},{type:"doc",id:"api/mobile/functions/useUpdatePeerMetadata",label:"useUpdatePeerMetadata"},{type:"doc",id:"api/mobile/variables/useAppScreenShare",label:"useAppScreenShare"},{type:"doc",id:"api/mobile/variables/useForegroundService",label:"useForegroundService"}]},{type:"category",label:"Devices",items:[{type:"doc",id:"api/mobile/functions/useAudioSettings",label:"useAudioSettings"},{type:"doc",id:"api/mobile/functions/useCamera",label:"useCamera"},{type:"doc",id:"api/mobile/functions/useMicrophone",label:"useMicrophone"}]},{type:"category",label:"Components",items:[{type:"doc",id:"api/mobile/functions/FishjamRoom",label:"FishjamRoom"},{type:"doc",id:"api/mobile/functions/LivestreamStreamer",label:"LivestreamStreamer"},{type:"doc",id:"api/mobile/functions/LivestreamViewer",label:"LivestreamViewer"},{type:"doc",id:"api/mobile/variables/VideoPreviewView",label:"VideoPreviewView"},{type:"doc",id:"api/mobile/variables/VideoRendererView",label:"VideoRendererView"}]},{type:"category",label:"Livestream",items:[{type:"doc",id:"api/mobile/functions/useLivestreamStreamer",label:"useLivestreamStreamer"},{type:"doc",id:"api/mobile/functions/useLivestreamViewer",label:"useLivestreamViewer"},{type:"doc",id:"api/mobile/interfaces/useLivestreamStreamerResult",label:"useLivestreamStreamerResult"},{type:"doc",id:"api/mobile/interfaces/useLivestreamViewerResult",label:"useLivestreamViewerResult"}]},{type:"category",label:"Other",items:[{type:"doc",id:"api/mobile/functions/useSandbox",label:"useSandbox"},{type:"doc",id:"api/mobile/type-aliases/AppScreenShareData",label:"AppScreenShareData"},{type:"doc",id:"api/mobile/type-aliases/AudioOutputDevice",label:"AudioOutputDevice"},{type:"doc",id:"api/mobile/type-aliases/AudioOutputDeviceType",label:"AudioOutputDeviceType"},{type:"doc",id:"api/mobile/type-aliases/AudioSessionMode",label:"AudioSessionMode"},{type:"doc",id:"api/mobile/type-aliases/AudioTrack",label:"AudioTrack"},{type:"doc",id:"api/mobile/type-aliases/Brand",label:"Brand"},{type:"doc",id:"api/mobile/type-aliases/Camera",label:"Camera"},{type:"doc",id:"api/mobile/type-aliases/CameraConfig",label:"CameraConfig"},{type:"doc",id:"api/mobile/type-aliases/CameraConfigBase",label:"CameraConfigBase"},{type:"doc",id:"api/mobile/type-aliases/CameraFacingDirection",label:"CameraFacingDirection"},{type:"doc",id:"api/mobile/type-aliases/CameraId",label:"CameraId"},{type:"doc",id:"api/mobile/type-aliases/ConnectionConfig",label:"ConnectionConfig"},{type:"doc",id:"api/mobile/type-aliases/ConnectViewerConfig",label:"ConnectViewerConfig"},{type:"doc",id:"api/mobile/type-aliases/DistinguishedTracks",label:"DistinguishedTracks"},{type:"doc",id:"api/mobile/type-aliases/EncodingReason",label:"EncodingReason"},{type:"doc",id:"api/mobile/type-aliases/FishjamRoomProps",label:"FishjamRoomProps"},{type:"doc",id:"api/mobile/type-aliases/ForegroundServiceConfig",label:"ForegroundServiceConfig"},{type:"doc",id:"api/mobile/type-aliases/GenericMetadata",label:"GenericMetadata"},{type:"doc",id:"api/mobile/type-aliases/JoinRoomConfig",label:"JoinRoomConfig"},{type:"doc",id:"api/mobile/type-aliases/LivestreamStreamerProps",label:"LivestreamStreamerProps"},{type:"doc",id:"api/mobile/type-aliases/LivestreamViewerProps",label:"LivestreamViewerProps"},{type:"doc",id:"api/mobile/type-aliases/LivestreamViewerRef",label:"LivestreamViewerRef"},{type:"doc",id:"api/mobile/type-aliases/Peer",label:"Peer"},{type:"doc",id:"api/mobile/type-aliases/PeerId",label:"PeerId"},{type:"doc",id:"api/mobile/type-aliases/PeerStatus",label:"PeerStatus"},{type:"doc",id:"api/mobile/type-aliases/PeerTrackMetadata",label:"PeerTrackMetadata"},{type:"doc",id:"api/mobile/type-aliases/PeerWithTracks",label:"PeerWithTracks"},{type:"doc",id:"api/mobile/type-aliases/ReconnectionStatus",label:"ReconnectionStatus"},{type:"doc",id:"api/mobile/type-aliases/RoomType",label:"RoomType"},{type:"doc",id:"api/mobile/type-aliases/ScreenShareOptions",label:"ScreenShareOptions"},{type:"doc",id:"api/mobile/type-aliases/ScreenShareQuality",label:"ScreenShareQuality"},{type:"doc",id:"api/mobile/type-aliases/SimulcastConfig",label:"SimulcastConfig"},{type:"doc",id:"api/mobile/type-aliases/Track",label:"Track"},{type:"doc",id:"api/mobile/type-aliases/TrackBase",label:"TrackBase"},{type:"doc",id:"api/mobile/type-aliases/TrackId",label:"TrackId"},{type:"doc",id:"api/mobile/type-aliases/TrackMetadata",label:"TrackMetadata"},{type:"doc",id:"api/mobile/type-aliases/TrackType",label:"TrackType"},{type:"doc",id:"api/mobile/type-aliases/UsePeersResult",label:"UsePeersResult"},{type:"doc",id:"api/mobile/type-aliases/UseSandboxProps",label:"UseSandboxProps"},{type:"doc",id:"api/mobile/type-aliases/VadStatus",label:"VadStatus"},{type:"doc",id:"api/mobile/type-aliases/VideoLayout",label:"VideoLayout"},{type:"doc",id:"api/mobile/type-aliases/VideoPreviewViewProps",label:"VideoPreviewViewProps"},{type:"doc",id:"api/mobile/type-aliases/VideoQuality",label:"VideoQuality"},{type:"doc",id:"api/mobile/type-aliases/VideoRendererProps",label:"VideoRendererProps"},{type:"doc",id:"api/mobile/type-aliases/VideoTrack",label:"VideoTrack"},{type:"doc",id:"api/mobile/variables/cameras",label:"cameras"},{type:"doc",id:"api/mobile/variables/useCameraPermissions",label:"useCameraPermissions"},{type:"doc",id:"api/mobile/variables/useMicrophonePermissions",label:"useMicrophonePermissions"}]},{type:"category",label:"Debugging",items:[{type:"doc",id:"api/mobile/functions/useBandwidthEstimation",label:"useBandwidthEstimation"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/versioned_docs/version-0.20.0/api/mobile/variables/VideoPreviewView.md b/versioned_docs/version-0.20.0/api/mobile/variables/VideoPreviewView.md deleted file mode 100644 index f3a850bc..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/variables/VideoPreviewView.md +++ /dev/null @@ -1,12 +0,0 @@ -# Variable: VideoPreviewView - -> `const` **VideoPreviewView**: `ForwardRefExoticComponent`\<[`VideoPreviewViewProps`](../type-aliases/VideoPreviewViewProps.md) & `RefAttributes`\<`ComponentType`\<[`VideoPreviewViewProps`](../type-aliases/VideoPreviewViewProps.md)\>\>\> - -Defined in: [packages/react-native-client/src/components/VideoPreviewView.tsx:35](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/VideoPreviewView.tsx#L35) - -Render camera preview. -Allows to display camera preview before streaming is started - -## Param - -## Param diff --git a/versioned_docs/version-0.20.0/api/mobile/variables/VideoRendererView.md b/versioned_docs/version-0.20.0/api/mobile/variables/VideoRendererView.md deleted file mode 100644 index f5638089..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/variables/VideoRendererView.md +++ /dev/null @@ -1,20 +0,0 @@ -# Variable: VideoRendererView - -> `const` **VideoRendererView**: `ForwardRefExoticComponent`\<[`VideoRendererProps`](../type-aliases/VideoRendererProps.md) & `RefAttributes`\<`ComponentType`\<[`VideoRendererProps`](../type-aliases/VideoRendererProps.md)\>\>\> - -Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:45](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/components/VideoRendererView.tsx#L45) - -Render video track received from [usePeers](../functions/usePeers.md) hook - -Example usage: -```js - - ``` - -## Param - -## Param diff --git a/versioned_docs/version-0.20.0/api/mobile/variables/cameras.md b/versioned_docs/version-0.20.0/api/mobile/variables/cameras.md deleted file mode 100644 index 898ac345..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/variables/cameras.md +++ /dev/null @@ -1,7 +0,0 @@ -# Variable: cameras - -> `const` **cameras**: readonly `Camera`[] - -Defined in: node\_modules/react-native-whip-whep/build/ReactNativeMobileWhepClientModule.d.ts:74 - -Gives access to the cameras available on the device. diff --git a/versioned_docs/version-0.20.0/api/mobile/variables/useAppScreenShare.md b/versioned_docs/version-0.20.0/api/mobile/variables/useAppScreenShare.md deleted file mode 100644 index 6b4b9cc2..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/variables/useAppScreenShare.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: useAppScreenShare() - -> `const` **useAppScreenShare**: () => [`AppScreenShareData`](../type-aliases/AppScreenShareData.md) - -Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:80](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useAppScreenShare.ts#L80) - -This hook can toggle client app screen sharing on/off and provides current screen share state. - -It works only on iOS. - -## Returns - -[`AppScreenShareData`](../type-aliases/AppScreenShareData.md) - -An object with functions to manage app screen share on iOS and null on android. diff --git a/versioned_docs/version-0.20.0/api/mobile/variables/useCameraPermissions.md b/versioned_docs/version-0.20.0/api/mobile/variables/useCameraPermissions.md deleted file mode 100644 index 85461913..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/variables/useCameraPermissions.md +++ /dev/null @@ -1,25 +0,0 @@ -# Variable: useCameraPermissions() - -> `const` **useCameraPermissions**: (`options?`) => \[`null` \| `PermissionResponse`, `RequestPermissionMethod`\<`PermissionResponse`\>, `GetPermissionMethod`\<`PermissionResponse`\>\] - -Defined in: [packages/react-native-client/src/hooks/usePermissions.ts:31](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePermissions.ts#L31) - -Check or request permissions to access the camera. -This uses both `requestCameraPermissionsAsync` and `getCameraPermissionsAsync` to interact with the permissions. - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `options?` | `PermissionHookOptions`\<`object`\> | - -## Returns - -\[`null` \| `PermissionResponse`, `RequestPermissionMethod`\<`PermissionResponse`\>, `GetPermissionMethod`\<`PermissionResponse`\>\] - -## Example - -```ts -import { useCameraPermissions } from '@fishjam-cloud/react-native-client'; -const [status, requestPermission] = useCameraPermissions(); -``` diff --git a/versioned_docs/version-0.20.0/api/mobile/variables/useForegroundService.md b/versioned_docs/version-0.20.0/api/mobile/variables/useForegroundService.md deleted file mode 100644 index 6e7d61c2..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/variables/useForegroundService.md +++ /dev/null @@ -1,18 +0,0 @@ -# Variable: useForegroundService() - -> `const` **useForegroundService**: (`config`) => `void` - -Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:109](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/useForegroundService.ts#L109) - -A hook for managing a foreground service on Android. Does nothing on other platforms. -You can use this hook to keep your app running in the background. You're also required to run a foreground service when screen sharing. - -## Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `config` | [`ForegroundServiceConfig`](../type-aliases/ForegroundServiceConfig.md) | Configuration options for the foreground service. | - -## Returns - -`void` diff --git a/versioned_docs/version-0.20.0/api/mobile/variables/useMicrophonePermissions.md b/versioned_docs/version-0.20.0/api/mobile/variables/useMicrophonePermissions.md deleted file mode 100644 index 1694d912..00000000 --- a/versioned_docs/version-0.20.0/api/mobile/variables/useMicrophonePermissions.md +++ /dev/null @@ -1,25 +0,0 @@ -# Variable: useMicrophonePermissions() - -> `const` **useMicrophonePermissions**: (`options?`) => \[`null` \| `PermissionResponse`, `RequestPermissionMethod`\<`PermissionResponse`\>, `GetPermissionMethod`\<`PermissionResponse`\>\] - -Defined in: [packages/react-native-client/src/hooks/usePermissions.ts:63](https://github.com/fishjam-cloud/mobile-client-sdk/blob/a60616b68cd043388665165d49f98ce759f80517/packages/react-native-client/src/hooks/usePermissions.ts#L63) - -Check or request permissions to access the microphone. -This uses both `requestMicrophonePermissionsAsync` and `getMicrophonePermissionsAsync` to interact with the permissions. - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `options?` | `PermissionHookOptions`\<`object`\> | - -## Returns - -\[`null` \| `PermissionResponse`, `RequestPermissionMethod`\<`PermissionResponse`\>, `GetPermissionMethod`\<`PermissionResponse`\>\] - -## Example - -```ts -import { useMicrophonePermissions } from '@fishjam-cloud/react-native-client'; -const [status, requestPermission] = useMicrophonePermissions(); -``` diff --git a/versioned_docs/version-0.20.0/api/server/classes/BadRequestException.md b/versioned_docs/version-0.20.0/api/server/classes/BadRequestException.md deleted file mode 100644 index addcb1eb..00000000 --- a/versioned_docs/version-0.20.0/api/server/classes/BadRequestException.md +++ /dev/null @@ -1,179 +0,0 @@ -# Class: BadRequestException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:21](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L21) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new BadRequestException**(`error`): `BadRequestException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`BadRequestException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:145 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) diff --git a/versioned_docs/version-0.20.0/api/server/classes/FishjamBaseException.md b/versioned_docs/version-0.20.0/api/server/classes/FishjamBaseException.md deleted file mode 100644 index f837cbf7..00000000 --- a/versioned_docs/version-0.20.0/api/server/classes/FishjamBaseException.md +++ /dev/null @@ -1,178 +0,0 @@ -# Class: FishjamBaseException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:9](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L9) - -## Extends - -- `Error` - -## Extended by - -- [`BadRequestException`](BadRequestException.md) -- [`UnauthorizedException`](UnauthorizedException.md) -- [`ForbiddenException`](ForbiddenException.md) -- [`RoomNotFoundException`](RoomNotFoundException.md) -- [`FishjamNotFoundException`](FishjamNotFoundException.md) -- [`PeerNotFoundException`](PeerNotFoundException.md) -- [`ServiceUnavailableException`](ServiceUnavailableException.md) -- [`UnknownException`](UnknownException.md) - -## Constructors - -### Constructor - -> **new FishjamBaseException**(`error`): `FishjamBaseException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`FishjamBaseException` - -#### Overrides - -`Error.constructor` - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L11) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -#### Inherited from - -`Error.cause` - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L12) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -`Error.message` - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -`Error.name` - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -`Error.prepareStackTrace` - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -`Error.stack` - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:145 - -#### Inherited from - -`Error.stackTraceLimit` - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L10) - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -`Error.captureStackTrace` diff --git a/versioned_docs/version-0.20.0/api/server/classes/FishjamClient.md b/versioned_docs/version-0.20.0/api/server/classes/FishjamClient.md deleted file mode 100644 index b487c0cc..00000000 --- a/versioned_docs/version-0.20.0/api/server/classes/FishjamClient.md +++ /dev/null @@ -1,218 +0,0 @@ -# Class: FishjamClient - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/client.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/client.ts#L12) - -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. - -## Constructors - -### Constructor - -> **new FishjamClient**(`config`): `FishjamClient` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/client.ts:28](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/client.ts#L28) - -Create new instance of Fishjam Client. - -Example usage: -``` -const fishjamClient = new FishjamClient({ - fishjamUrl: fastify.config.FISHJAM_URL, - managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN, -}); -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`FishjamConfig`](../type-aliases/FishjamConfig.md) | - -#### Returns - -`FishjamClient` - -## Methods - -### createLivestreamStreamerToken() - -> **createLivestreamStreamerToken**(`roomId`): `Promise`\<[`StreamerToken`](../interfaces/StreamerToken.md)\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/client.ts:161](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/client.ts#L161) - -Creates a livestream streamer token for the given room. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | - -#### Returns - -`Promise`\<[`StreamerToken`](../interfaces/StreamerToken.md)\> - -a livestream streamer token - -*** - -### createLivestreamViewerToken() - -> **createLivestreamViewerToken**(`roomId`): `Promise`\<[`ViewerToken`](../interfaces/ViewerToken.md)\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/client.ts:148](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/client.ts#L148) - -Creates a livestream viewer token for the given room. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | - -#### Returns - -`Promise`\<[`ViewerToken`](../interfaces/ViewerToken.md)\> - -a livestream viewer token - -*** - -### createPeer() - -> **createPeer**(`roomId`, `options`): `Promise`\<\{ `peer`: [`Peer`](../type-aliases/Peer.md); `peerToken`: `string`; \}\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/client.ts:89](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/client.ts#L89) - -Create a new peer assigned to a room. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | -| `options` | `PeerOptionsWebRTC` | - -#### Returns - -`Promise`\<\{ `peer`: [`Peer`](../type-aliases/Peer.md); `peerToken`: `string`; \}\> - -*** - -### createRoom() - -> **createRoom**(`config`): `Promise`\<[`Room`](../type-aliases/Room.md)\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/client.ts:45](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/client.ts#L45) - -Create a new room. All peers connected to the same room will be able to send/receive streams to each other. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`RoomConfig`](../interfaces/RoomConfig.md) | - -#### Returns - -`Promise`\<[`Room`](../type-aliases/Room.md)\> - -*** - -### deletePeer() - -> **deletePeer**(`roomId`, `peerId`): `Promise`\<`void`\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/client.ts:122](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/client.ts#L122) - -Delete a peer - this will also disconnect the peer from the room. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | -| `peerId` | [`PeerId`](../type-aliases/PeerId.md) | - -#### Returns - -`Promise`\<`void`\> - -*** - -### deleteRoom() - -> **deleteRoom**(`roomId`): `Promise`\<`void`\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/client.ts:66](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/client.ts#L66) - -Delete an existing room. All peers connected to this room will be disconnected and removed. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | - -#### Returns - -`Promise`\<`void`\> - -*** - -### getAllRooms() - -> **getAllRooms**(): `Promise`\<[`Room`](../type-aliases/Room.md)[]\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/client.ts:77](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/client.ts#L77) - -Get a list of all existing rooms. - -#### Returns - -`Promise`\<[`Room`](../type-aliases/Room.md)[]\> - -*** - -### getRoom() - -> **getRoom**(`roomId`): `Promise`\<[`Room`](../type-aliases/Room.md)\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/client.ts:109](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/client.ts#L109) - -Get details about a given room. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | - -#### Returns - -`Promise`\<[`Room`](../type-aliases/Room.md)\> - -*** - -### refreshPeerToken() - -> **refreshPeerToken**(`roomId`, `peerId`): `Promise`\<`string`\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/client.ts:135](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/client.ts#L135) - -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. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | -| `peerId` | [`PeerId`](../type-aliases/PeerId.md) | - -#### Returns - -`Promise`\<`string`\> - -refreshed peer token diff --git a/versioned_docs/version-0.20.0/api/server/classes/FishjamNotFoundException.md b/versioned_docs/version-0.20.0/api/server/classes/FishjamNotFoundException.md deleted file mode 100644 index 0344c33d..00000000 --- a/versioned_docs/version-0.20.0/api/server/classes/FishjamNotFoundException.md +++ /dev/null @@ -1,179 +0,0 @@ -# Class: FishjamNotFoundException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:29](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L29) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new FishjamNotFoundException**(`error`): `FishjamNotFoundException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`FishjamNotFoundException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:145 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) diff --git a/versioned_docs/version-0.20.0/api/server/classes/FishjamWSNotifier.md b/versioned_docs/version-0.20.0/api/server/classes/FishjamWSNotifier.md deleted file mode 100644 index 8bb2552e..00000000 --- a/versioned_docs/version-0.20.0/api/server/classes/FishjamWSNotifier.md +++ /dev/null @@ -1,432 +0,0 @@ -# Class: FishjamWSNotifier - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:45](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/ws_notifier.ts#L45) - -Notifier object that can be used to get notified about various events related to the Fishjam App. - -## Extends - -- `TypedEventEmitter`\<[`NotificationEvents`](../type-aliases/NotificationEvents.md), `this`\> - -## Constructors - -### Constructor - -> **new FishjamWSNotifier**(`config`, `onError`, `onClose`, `onConnectionFailed`): `FishjamWSNotifier` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:48](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/ws_notifier.ts#L48) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`FishjamConfig`](../type-aliases/FishjamConfig.md) | -| `onError` | [`ErrorEventHandler`](../type-aliases/ErrorEventHandler.md) | -| `onClose` | [`CloseEventHandler`](../type-aliases/CloseEventHandler.md) | -| `onConnectionFailed` | [`ErrorEventHandler`](../type-aliases/ErrorEventHandler.md) | - -#### Returns - -`FishjamWSNotifier` - -#### Overrides - -`(EventEmitter as new () => TypedEmitter).constructor` - -## Methods - -### addListener() - -> **addListener**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:22 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).addListener` - -*** - -### emit() - -> **emit**\<`E`\>(`event`, ...`args`): `boolean` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:32 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| ...`args` | `Parameters`\<[`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\]\> | - -#### Returns - -`boolean` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).emit` - -*** - -### eventNames() - -> **eventNames**(): (`string` \| `symbol`)[] - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:34 - -#### Returns - -(`string` \| `symbol`)[] - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).eventNames` - -*** - -### getMaxListeners() - -> **getMaxListeners**(): `number` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:39 - -#### Returns - -`number` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).getMaxListeners` - -*** - -### listenerCount() - -> **listenerCount**\<`E`\>(`event`): `number` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:37 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | - -#### Returns - -`number` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).listenerCount` - -*** - -### listeners() - -> **listeners**\<`E`\>(`event`): [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\][] - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:36 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | - -#### Returns - -[`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\][] - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).listeners` - -*** - -### off() - -> **off**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:28 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).off` - -*** - -### on() - -> **on**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:23 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).on` - -*** - -### once() - -> **once**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:24 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).once` - -*** - -### prependListener() - -> **prependListener**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:25 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).prependListener` - -*** - -### prependOnceListener() - -> **prependOnceListener**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:26 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).prependOnceListener` - -*** - -### rawListeners() - -> **rawListeners**\<`E`\>(`event`): [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\][] - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:35 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | - -#### Returns - -[`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\][] - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).rawListeners` - -*** - -### removeAllListeners() - -> **removeAllListeners**\<`E`\>(`event?`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:29 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event?` | `E` | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).removeAllListeners` - -*** - -### removeListener() - -> **removeListener**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:30 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).removeListener` - -*** - -### setMaxListeners() - -> **setMaxListeners**(`maxListeners`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:40 - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `maxListeners` | `number` | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).setMaxListeners` diff --git a/versioned_docs/version-0.20.0/api/server/classes/ForbiddenException.md b/versioned_docs/version-0.20.0/api/server/classes/ForbiddenException.md deleted file mode 100644 index aa09c82a..00000000 --- a/versioned_docs/version-0.20.0/api/server/classes/ForbiddenException.md +++ /dev/null @@ -1,179 +0,0 @@ -# Class: ForbiddenException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:25](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L25) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new ForbiddenException**(`error`): `ForbiddenException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`ForbiddenException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:145 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) diff --git a/versioned_docs/version-0.20.0/api/server/classes/MissingFishjamIdException.md b/versioned_docs/version-0.20.0/api/server/classes/MissingFishjamIdException.md deleted file mode 100644 index 24ee4fe3..00000000 --- a/versioned_docs/version-0.20.0/api/server/classes/MissingFishjamIdException.md +++ /dev/null @@ -1,137 +0,0 @@ -# Class: MissingFishjamIdException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:3](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L3) - -## Extends - -- `Error` - -## Constructors - -### Constructor - -> **new MissingFishjamIdException**(): `MissingFishjamIdException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:4](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L4) - -#### Returns - -`MissingFishjamIdException` - -#### Overrides - -`Error.constructor` - -## Properties - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -#### Inherited from - -`Error.cause` - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -`Error.message` - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -`Error.name` - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -`Error.prepareStackTrace` - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -`Error.stack` - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:145 - -#### Inherited from - -`Error.stackTraceLimit` - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -`Error.captureStackTrace` diff --git a/versioned_docs/version-0.20.0/api/server/classes/PeerNotFoundException.md b/versioned_docs/version-0.20.0/api/server/classes/PeerNotFoundException.md deleted file mode 100644 index c691d89c..00000000 --- a/versioned_docs/version-0.20.0/api/server/classes/PeerNotFoundException.md +++ /dev/null @@ -1,179 +0,0 @@ -# Class: PeerNotFoundException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:31](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L31) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new PeerNotFoundException**(`error`): `PeerNotFoundException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`PeerNotFoundException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:145 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) diff --git a/versioned_docs/version-0.20.0/api/server/classes/RoomNotFoundException.md b/versioned_docs/version-0.20.0/api/server/classes/RoomNotFoundException.md deleted file mode 100644 index 38f71280..00000000 --- a/versioned_docs/version-0.20.0/api/server/classes/RoomNotFoundException.md +++ /dev/null @@ -1,179 +0,0 @@ -# Class: RoomNotFoundException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:27](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L27) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new RoomNotFoundException**(`error`): `RoomNotFoundException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`RoomNotFoundException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:145 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) diff --git a/versioned_docs/version-0.20.0/api/server/classes/ServiceUnavailableException.md b/versioned_docs/version-0.20.0/api/server/classes/ServiceUnavailableException.md deleted file mode 100644 index fa42c9be..00000000 --- a/versioned_docs/version-0.20.0/api/server/classes/ServiceUnavailableException.md +++ /dev/null @@ -1,179 +0,0 @@ -# Class: ServiceUnavailableException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:33](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L33) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new ServiceUnavailableException**(`error`): `ServiceUnavailableException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`ServiceUnavailableException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:145 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) diff --git a/versioned_docs/version-0.20.0/api/server/classes/UnauthorizedException.md b/versioned_docs/version-0.20.0/api/server/classes/UnauthorizedException.md deleted file mode 100644 index b0b3917b..00000000 --- a/versioned_docs/version-0.20.0/api/server/classes/UnauthorizedException.md +++ /dev/null @@ -1,179 +0,0 @@ -# Class: UnauthorizedException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:23](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L23) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new UnauthorizedException**(`error`): `UnauthorizedException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`UnauthorizedException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:145 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) diff --git a/versioned_docs/version-0.20.0/api/server/classes/UnknownException.md b/versioned_docs/version-0.20.0/api/server/classes/UnknownException.md deleted file mode 100644 index f3249902..00000000 --- a/versioned_docs/version-0.20.0/api/server/classes/UnknownException.md +++ /dev/null @@ -1,179 +0,0 @@ -# Class: UnknownException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:35](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L35) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new UnknownException**(`error`): `UnknownException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`UnknownException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:145 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) diff --git a/versioned_docs/version-0.20.0/api/server/enumerations/PeerStatus.md b/versioned_docs/version-0.20.0/api/server/enumerations/PeerStatus.md deleted file mode 100644 index 8e8a702b..00000000 --- a/versioned_docs/version-0.20.0/api/server/enumerations/PeerStatus.md +++ /dev/null @@ -1,23 +0,0 @@ -# Enumeration: PeerStatus - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:904 - -Informs about the peer status - -## Export - -## Enumeration Members - -### Connected - -> **Connected**: `"connected"` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:905 - -*** - -### Disconnected - -> **Disconnected**: `"disconnected"` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:906 diff --git a/versioned_docs/version-0.20.0/api/server/index.md b/versioned_docs/version-0.20.0/api/server/index.md deleted file mode 100644 index 994ac6be..00000000 --- a/versioned_docs/version-0.20.0/api/server/index.md +++ /dev/null @@ -1,38 +0,0 @@ -# @fishjam-cloud/js-server-sdk - -## Client - -- [FishjamClient](classes/FishjamClient.md) -- [FishjamWSNotifier](classes/FishjamWSNotifier.md) - -## Other - -- [PeerStatus](enumerations/PeerStatus.md) -- [BadRequestException](classes/BadRequestException.md) -- [FishjamBaseException](classes/FishjamBaseException.md) -- [FishjamNotFoundException](classes/FishjamNotFoundException.md) -- [ForbiddenException](classes/ForbiddenException.md) -- [MissingFishjamIdException](classes/MissingFishjamIdException.md) -- [PeerNotFoundException](classes/PeerNotFoundException.md) -- [RoomNotFoundException](classes/RoomNotFoundException.md) -- [ServiceUnavailableException](classes/ServiceUnavailableException.md) -- [UnauthorizedException](classes/UnauthorizedException.md) -- [UnknownException](classes/UnknownException.md) -- [RoomConfig](interfaces/RoomConfig.md) -- [StreamerToken](interfaces/StreamerToken.md) -- [ViewerToken](interfaces/ViewerToken.md) -- [Brand](type-aliases/Brand.md) -- [CloseEventHandler](type-aliases/CloseEventHandler.md) -- [ErrorEventHandler](type-aliases/ErrorEventHandler.md) -- [ExpectedEvents](type-aliases/ExpectedEvents.md) -- [FishjamConfig](type-aliases/FishjamConfig.md) -- [NotificationEvents](type-aliases/NotificationEvents.md) -- [Peer](type-aliases/Peer.md) -- [PeerId](type-aliases/PeerId.md) -- [PeerOptions](type-aliases/PeerOptions.md) -- [Room](type-aliases/Room.md) -- [RoomConfigRoomTypeEnum](type-aliases/RoomConfigRoomTypeEnum.md) -- [RoomConfigVideoCodecEnum](type-aliases/RoomConfigVideoCodecEnum.md) -- [RoomId](type-aliases/RoomId.md) -- [RoomConfigRoomTypeEnum](variables/RoomConfigRoomTypeEnum.md) -- [RoomConfigVideoCodecEnum](variables/RoomConfigVideoCodecEnum.md) diff --git a/versioned_docs/version-0.20.0/api/server/interfaces/RoomConfig.md b/versioned_docs/version-0.20.0/api/server/interfaces/RoomConfig.md deleted file mode 100644 index 0c197888..00000000 --- a/versioned_docs/version-0.20.0/api/server/interfaces/RoomConfig.md +++ /dev/null @@ -1,79 +0,0 @@ -# Interface: RoomConfig - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:958 - -Room configuration - -## Export - -RoomConfig - -## Properties - -### maxPeers? - -> `optional` **maxPeers**: `null` \| `number` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:964 - -Maximum amount of peers allowed into the room - -#### Memberof - -RoomConfig - -*** - -### public? - -> `optional` **public**: `boolean` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:970 - -True if livestream viewers can omit specifying a token. - -#### Memberof - -RoomConfig - -*** - -### roomType? - -> `optional` **roomType**: [`RoomConfigRoomTypeEnum`](../type-aliases/RoomConfigRoomTypeEnum.md) - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:976 - -The use-case of the room. If not provided, this defaults to conference. - -#### Memberof - -RoomConfig - -*** - -### videoCodec? - -> `optional` **videoCodec**: `null` \| [`RoomConfigVideoCodecEnum`](../type-aliases/RoomConfigVideoCodecEnum.md) - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:982 - -Enforces video codec for each peer in the room - -#### Memberof - -RoomConfig - -*** - -### webhookUrl? - -> `optional` **webhookUrl**: `null` \| `string` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:988 - -URL where Fishjam notifications will be sent - -#### Memberof - -RoomConfig diff --git a/versioned_docs/version-0.20.0/api/server/interfaces/StreamerToken.md b/versioned_docs/version-0.20.0/api/server/interfaces/StreamerToken.md deleted file mode 100644 index dc52e21f..00000000 --- a/versioned_docs/version-0.20.0/api/server/interfaces/StreamerToken.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: StreamerToken - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:1204 - -Token for authorizing broadcaster streamer connection - -## Export - -StreamerToken - -## Properties - -### token - -> **token**: `string` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:1210 - -#### Memberof - -StreamerToken diff --git a/versioned_docs/version-0.20.0/api/server/interfaces/ViewerToken.md b/versioned_docs/version-0.20.0/api/server/interfaces/ViewerToken.md deleted file mode 100644 index 0c9a023b..00000000 --- a/versioned_docs/version-0.20.0/api/server/interfaces/ViewerToken.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: ViewerToken - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:1292 - -Token for authorizing broadcaster viewer connection - -## Export - -ViewerToken - -## Properties - -### token - -> **token**: `string` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:1298 - -#### Memberof - -ViewerToken diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/Brand.md b/versioned_docs/version-0.20.0/api/server/type-aliases/Brand.md deleted file mode 100644 index 8c09dd8d..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/Brand.md +++ /dev/null @@ -1,20 +0,0 @@ -# Type Alias: Brand\ - -> **Brand**\<`T`, `TBrand`\> = `T` & `object` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:8](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/types.ts#L8) - -Branded type helper - -## Type declaration - -### \[brand\] - -> **\[brand\]**: `TBrand` - -## Type Parameters - -| Type Parameter | -| ------ | -| `T` | -| `TBrand` *extends* `string` | diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/CloseEventHandler.md b/versioned_docs/version-0.20.0/api/server/type-aliases/CloseEventHandler.md deleted file mode 100644 index 9594e9a8..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/CloseEventHandler.md +++ /dev/null @@ -1,16 +0,0 @@ -# Type Alias: CloseEventHandler() - -> **CloseEventHandler** = (`code`, `reason`) => `void` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:38](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/ws_notifier.ts#L38) - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `code` | `number` | -| `reason` | `string` | - -## Returns - -`void` diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/ErrorEventHandler.md b/versioned_docs/version-0.20.0/api/server/type-aliases/ErrorEventHandler.md deleted file mode 100644 index 0c4e1b45..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/ErrorEventHandler.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: ErrorEventHandler() - -> **ErrorEventHandler** = (`msg`) => `void` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:37](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/ws_notifier.ts#L37) - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `msg` | `Error` | - -## Returns - -`void` diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/ExpectedEvents.md b/versioned_docs/version-0.20.0/api/server/type-aliases/ExpectedEvents.md deleted file mode 100644 index c9f4da10..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/ExpectedEvents.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ExpectedEvents - -> **ExpectedEvents** = `"roomCreated"` \| `"roomDeleted"` \| `"roomCrashed"` \| `"peerAdded"` \| `"peerDeleted"` \| `"peerConnected"` \| `"peerDisconnected"` \| `"peerMetadataUpdated"` \| `"peerCrashed"` \| `"trackAdded"` \| `"trackRemoved"` \| `"trackMetadataUpdated"` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:8](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/ws_notifier.ts#L8) diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/FishjamConfig.md b/versioned_docs/version-0.20.0/api/server/type-aliases/FishjamConfig.md deleted file mode 100644 index 1be5323e..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/FishjamConfig.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: FishjamConfig - -> **FishjamConfig** = `object` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:28](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/types.ts#L28) - -## Properties - -### fishjamId? - -> `optional` **fishjamId**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:33](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/types.ts#L33) - -*** - -### fishjamUrl? - -> `optional` **fishjamUrl**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:37](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/types.ts#L37) - -*** - -### managementToken - -> **managementToken**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:43](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/types.ts#L43) diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/NotificationEvents.md b/versioned_docs/version-0.20.0/api/server/type-aliases/NotificationEvents.md deleted file mode 100644 index 353a00d1..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/NotificationEvents.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: NotificationEvents - -> **NotificationEvents** = `Record`\<[`ExpectedEvents`](ExpectedEvents.md), (`message`) => `void`\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:39](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/ws_notifier.ts#L39) diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/Peer.md b/versioned_docs/version-0.20.0/api/server/type-aliases/Peer.md deleted file mode 100644 index a70fef51..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/Peer.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: Peer - -> **Peer** = `Omit`\<`OpenApiPeer`, `"id"`\> & `object` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:20](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/types.ts#L20) - -## Type declaration - -### id - -> **id**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/PeerId.md b/versioned_docs/version-0.20.0/api/server/type-aliases/PeerId.md deleted file mode 100644 index 2be94124..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/PeerId.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: PeerId - -> **PeerId** = [`Brand`](Brand.md)\<`string`, `"PeerId"`\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:18](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/types.ts#L18) - -ID of Peer. Peer is associated with Room and can be created with [FishjamClient.createPeer](../classes/FishjamClient.md#createpeer). diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/PeerOptions.md b/versioned_docs/version-0.20.0/api/server/type-aliases/PeerOptions.md deleted file mode 100644 index bf16f5ee..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/PeerOptions.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: PeerOptions - -> **PeerOptions** = `PeerOptionsWebRTC` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:851 - -## Export diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/Room.md b/versioned_docs/version-0.20.0/api/server/type-aliases/Room.md deleted file mode 100644 index 4781f2d1..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/Room.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: Room - -> **Room** = `object` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:22](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/types.ts#L22) - -## Properties - -### config - -> **config**: [`RoomConfig`](../interfaces/RoomConfig.md) - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:25](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/types.ts#L25) - -*** - -### id - -> **id**: [`RoomId`](RoomId.md) - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:23](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/types.ts#L23) - -*** - -### peers - -> **peers**: [`Peer`](Peer.md)[] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:24](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/types.ts#L24) diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/RoomConfigRoomTypeEnum.md b/versioned_docs/version-0.20.0/api/server/type-aliases/RoomConfigRoomTypeEnum.md deleted file mode 100644 index 6d7026dd..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/RoomConfigRoomTypeEnum.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomConfigRoomTypeEnum - -> **RoomConfigRoomTypeEnum** = *typeof* [`RoomConfigRoomTypeEnum`](../variables/RoomConfigRoomTypeEnum.md)\[keyof *typeof* [`RoomConfigRoomTypeEnum`](../variables/RoomConfigRoomTypeEnum.md)\] - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:990 diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/RoomConfigVideoCodecEnum.md b/versioned_docs/version-0.20.0/api/server/type-aliases/RoomConfigVideoCodecEnum.md deleted file mode 100644 index 80e1e34e..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/RoomConfigVideoCodecEnum.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomConfigVideoCodecEnum - -> **RoomConfigVideoCodecEnum** = *typeof* [`RoomConfigVideoCodecEnum`](../variables/RoomConfigVideoCodecEnum.md)\[keyof *typeof* [`RoomConfigVideoCodecEnum`](../variables/RoomConfigVideoCodecEnum.md)\] - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:998 diff --git a/versioned_docs/version-0.20.0/api/server/type-aliases/RoomId.md b/versioned_docs/version-0.20.0/api/server/type-aliases/RoomId.md deleted file mode 100644 index 6058cdde..00000000 --- a/versioned_docs/version-0.20.0/api/server/type-aliases/RoomId.md +++ /dev/null @@ -1,8 +0,0 @@ -# Type Alias: RoomId - -> **RoomId** = [`Brand`](Brand.md)\<`string`, `"RoomId"`\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:14](https://github.com/fishjam-cloud/js-server-sdk/blob/891a2e978ee650dde85956b1c7d697c5ffa577dc/packages/js-server-sdk/src/types.ts#L14) - -ID of the Room. -Room can be created with [FishjamClient.createRoom](../classes/FishjamClient.md#createroom). diff --git a/versioned_docs/version-0.20.0/api/server/typedoc-sidebar.cjs b/versioned_docs/version-0.20.0/api/server/typedoc-sidebar.cjs deleted file mode 100644 index a96910ca..00000000 --- a/versioned_docs/version-0.20.0/api/server/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ -const typedocSidebar = {items:[{type:"category",label:"Client",items:[{type:"doc",id:"api/server/classes/FishjamClient",label:"FishjamClient"},{type:"doc",id:"api/server/classes/FishjamWSNotifier",label:"FishjamWSNotifier"}]},{type:"category",label:"Other",items:[{type:"doc",id:"api/server/enumerations/PeerStatus",label:"PeerStatus"},{type:"doc",id:"api/server/classes/BadRequestException",label:"BadRequestException"},{type:"doc",id:"api/server/classes/FishjamBaseException",label:"FishjamBaseException"},{type:"doc",id:"api/server/classes/FishjamNotFoundException",label:"FishjamNotFoundException"},{type:"doc",id:"api/server/classes/ForbiddenException",label:"ForbiddenException"},{type:"doc",id:"api/server/classes/MissingFishjamIdException",label:"MissingFishjamIdException"},{type:"doc",id:"api/server/classes/PeerNotFoundException",label:"PeerNotFoundException"},{type:"doc",id:"api/server/classes/RoomNotFoundException",label:"RoomNotFoundException"},{type:"doc",id:"api/server/classes/ServiceUnavailableException",label:"ServiceUnavailableException"},{type:"doc",id:"api/server/classes/UnauthorizedException",label:"UnauthorizedException"},{type:"doc",id:"api/server/classes/UnknownException",label:"UnknownException"},{type:"doc",id:"api/server/interfaces/RoomConfig",label:"RoomConfig"},{type:"doc",id:"api/server/interfaces/StreamerToken",label:"StreamerToken"},{type:"doc",id:"api/server/interfaces/ViewerToken",label:"ViewerToken"},{type:"doc",id:"api/server/type-aliases/Brand",label:"Brand"},{type:"doc",id:"api/server/type-aliases/CloseEventHandler",label:"CloseEventHandler"},{type:"doc",id:"api/server/type-aliases/ErrorEventHandler",label:"ErrorEventHandler"},{type:"doc",id:"api/server/type-aliases/ExpectedEvents",label:"ExpectedEvents"},{type:"doc",id:"api/server/type-aliases/FishjamConfig",label:"FishjamConfig"},{type:"doc",id:"api/server/type-aliases/NotificationEvents",label:"NotificationEvents"},{type:"doc",id:"api/server/type-aliases/Peer",label:"Peer"},{type:"doc",id:"api/server/type-aliases/PeerId",label:"PeerId"},{type:"doc",id:"api/server/type-aliases/PeerOptions",label:"PeerOptions"},{type:"doc",id:"api/server/type-aliases/Room",label:"Room"},{type:"doc",id:"api/server/type-aliases/RoomConfigRoomTypeEnum",label:"RoomConfigRoomTypeEnum"},{type:"doc",id:"api/server/type-aliases/RoomConfigVideoCodecEnum",label:"RoomConfigVideoCodecEnum"},{type:"doc",id:"api/server/type-aliases/RoomId",label:"RoomId"},{type:"doc",id:"api/server/variables/RoomConfigRoomTypeEnum",label:"RoomConfigRoomTypeEnum"},{type:"doc",id:"api/server/variables/RoomConfigVideoCodecEnum",label:"RoomConfigVideoCodecEnum"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/versioned_docs/version-0.20.0/api/server/variables/RoomConfigRoomTypeEnum.md b/versioned_docs/version-0.20.0/api/server/variables/RoomConfigRoomTypeEnum.md deleted file mode 100644 index a0867f7e..00000000 --- a/versioned_docs/version-0.20.0/api/server/variables/RoomConfigRoomTypeEnum.md +++ /dev/null @@ -1,27 +0,0 @@ -# Variable: RoomConfigRoomTypeEnum - -> `const` **RoomConfigRoomTypeEnum**: `object` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:990 - -## Type declaration - -### AudioOnly - -> `readonly` **AudioOnly**: `"audio_only"` - -### Broadcaster - -> `readonly` **Broadcaster**: `"broadcaster"` - -### Conference - -> `readonly` **Conference**: `"conference"` - -### FullFeature - -> `readonly` **FullFeature**: `"full_feature"` - -### Livestream - -> `readonly` **Livestream**: `"livestream"` diff --git a/versioned_docs/version-0.20.0/api/server/variables/RoomConfigVideoCodecEnum.md b/versioned_docs/version-0.20.0/api/server/variables/RoomConfigVideoCodecEnum.md deleted file mode 100644 index d17314f7..00000000 --- a/versioned_docs/version-0.20.0/api/server/variables/RoomConfigVideoCodecEnum.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: RoomConfigVideoCodecEnum - -> `const` **RoomConfigVideoCodecEnum**: `object` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:998 - -## Type declaration - -### H264 - -> `readonly` **H264**: `"h264"` - -### Vp8 - -> `readonly` **Vp8**: `"vp8"` diff --git a/versioned_docs/version-0.20.0/api/web/enumerations/Variant.md b/versioned_docs/version-0.20.0/api/web/enumerations/Variant.md deleted file mode 100644 index 737899e9..00000000 --- a/versioned_docs/version-0.20.0/api/web/enumerations/Variant.md +++ /dev/null @@ -1,43 +0,0 @@ -# Enumeration: Variant - -Defined in: packages/ts-client/dist/index.d.mts:12 - -## Enumeration Members - -### UNRECOGNIZED - -> **UNRECOGNIZED**: `-1` - -Defined in: packages/ts-client/dist/index.d.mts:17 - -*** - -### VARIANT\_HIGH - -> **VARIANT\_HIGH**: `3` - -Defined in: packages/ts-client/dist/index.d.mts:16 - -*** - -### VARIANT\_LOW - -> **VARIANT\_LOW**: `1` - -Defined in: packages/ts-client/dist/index.d.mts:14 - -*** - -### VARIANT\_MEDIUM - -> **VARIANT\_MEDIUM**: `2` - -Defined in: packages/ts-client/dist/index.d.mts:15 - -*** - -### VARIANT\_UNSPECIFIED - -> **VARIANT\_UNSPECIFIED**: `0` - -Defined in: packages/ts-client/dist/index.d.mts:13 diff --git a/versioned_docs/version-0.20.0/api/web/functions/FishjamProvider.md b/versioned_docs/version-0.20.0/api/web/functions/FishjamProvider.md deleted file mode 100644 index bc98f28c..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/FishjamProvider.md +++ /dev/null @@ -1,17 +0,0 @@ -# Function: FishjamProvider() - -> **FishjamProvider**(`props`): `Element` - -Defined in: [packages/react-client/src/FishjamProvider.tsx:67](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/FishjamProvider.tsx#L67) - -Provides the Fishjam Context - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `props` | [`FishjamProviderProps`](../interfaces/FishjamProviderProps.md) | - -## Returns - -`Element` diff --git a/versioned_docs/version-0.20.0/api/web/functions/useCamera.md b/versioned_docs/version-0.20.0/api/web/functions/useCamera.md deleted file mode 100644 index fa289336..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/useCamera.md +++ /dev/null @@ -1,96 +0,0 @@ -# Function: useCamera() - -> **useCamera**(): `object` - -Defined in: [packages/react-client/src/hooks/devices/useCamera.ts:9](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/devices/useCamera.ts#L9) - -This hook can toggle camera on/off, change camera, provides current camera and other. - -## Returns - -### ~~activeCamera~~ - -> **activeCamera**: `null` \| [`DeviceItem`](../type-aliases/DeviceItem.md) = `cameraManager.activeDevice` - -#### Deprecated - -Use `currentCamera` and `isCameraOn` instead -Indicates which camera is now turned on and streaming - -### cameraDeviceError - -> **cameraDeviceError**: `null` \| [`DeviceError`](../type-aliases/DeviceError.md) = `cameraManager.deviceError` - -Possible error thrown while setting up the camera - -### cameraDevices - -> **cameraDevices**: [`DeviceItem`](../type-aliases/DeviceItem.md)[] = `cameraManager.deviceList` - -List of available camera devices - -### cameraStream - -> **cameraStream**: `null` \| `MediaStream` - -The MediaStream object containing the current stream - -### currentCamera - -> **currentCamera**: `null` \| `MediaDeviceInfo` = `cameraManager.selectedDevice` - -Indicates which camera is now selected - -### currentCameraMiddleware - -> **currentCameraMiddleware**: [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) = `videoTrackManager.currentMiddleware` - -The currently set camera middleware function - -### isCameraOn - -> **isCameraOn**: `boolean` = `!!cameraStream` - -Indicates whether the camera is streaming video - -### selectCamera() - -> **selectCamera**: (`deviceId`) => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> = `videoTrackManager.selectDevice` - -Selects the camera device - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `deviceId` | `string` | - -#### Returns - -`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> - -### setCameraTrackMiddleware() - -> **setCameraTrackMiddleware**: (`middleware`) => `Promise`\<`void`\> = `videoTrackManager.setTrackMiddleware` - -Sets the camera middleware - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `middleware` | [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) | - -#### Returns - -`Promise`\<`void`\> - -### toggleCamera() - -> **toggleCamera**: () => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> = `videoTrackManager.toggleDevice` - -Toggles current camera on/off - -#### Returns - -`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> diff --git a/versioned_docs/version-0.20.0/api/web/functions/useConnection.md b/versioned_docs/version-0.20.0/api/web/functions/useConnection.md deleted file mode 100644 index 11045f88..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/useConnection.md +++ /dev/null @@ -1,53 +0,0 @@ -# Function: useConnection() - -> **useConnection**(): `object` - -Defined in: [packages/react-client/src/hooks/useConnection.ts:30](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useConnection.ts#L30) - -Hook allows to join or leave a room and check the current connection status. - -## Returns - -### joinRoom() - -> **joinRoom**: \<`PeerMetadata`\>(`__namedParameters`) => `Promise`\<`void`\> - -Join room and start streaming camera and microphone - -#### Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `__namedParameters` | [`JoinRoomConfig`](../interfaces/JoinRoomConfig.md)\<`PeerMetadata`\> | - -#### Returns - -`Promise`\<`void`\> - -### leaveRoom() - -> **leaveRoom**: () => `void` - -Leave room and stop streaming - -#### Returns - -`void` - -### peerStatus - -> **peerStatus**: [`PeerStatus`](../type-aliases/PeerStatus.md) - -Current peer connection status - -### reconnectionStatus - -> **reconnectionStatus**: [`ReconnectionStatus`](../type-aliases/ReconnectionStatus.md) - -Current reconnection status diff --git a/versioned_docs/version-0.20.0/api/web/functions/useCustomSource.md b/versioned_docs/version-0.20.0/api/web/functions/useCustomSource.md deleted file mode 100644 index bc3c34c9..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/useCustomSource.md +++ /dev/null @@ -1,44 +0,0 @@ -# Function: useCustomSource() - -> **useCustomSource**\<`T`\>(`sourceId`): `object` - -Defined in: [packages/react-client/src/hooks/useCustomSource.ts:9](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useCustomSource.ts#L9) - -This hook can register/deregister a custom MediaStream with Fishjam. - -## Type Parameters - -| Type Parameter | -| ------ | -| `T` *extends* `string` | - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `sourceId` | `T` | - -## Returns - -### setStream() - -> **setStream**: (`newStream`) => `Promise`\<`void`\> - -Associates the given stream with the custom source. -This stream will be sent to Fishjam after startStreaming has been called. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `newStream` | `null` \| `MediaStream` | - -#### Returns - -`Promise`\<`void`\> - -### stream - -> **stream**: `undefined` \| `MediaStream` - -The MediaStream currently associated with the custom source diff --git a/versioned_docs/version-0.20.0/api/web/functions/useInitializeDevices.md b/versioned_docs/version-0.20.0/api/web/functions/useInitializeDevices.md deleted file mode 100644 index 20e8e918..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/useInitializeDevices.md +++ /dev/null @@ -1,25 +0,0 @@ -# Function: useInitializeDevices() - -> **useInitializeDevices**(): `object` - -Defined in: [packages/react-client/src/hooks/devices/useInitializeDevices.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L14) - -Hook allows you to initialize access to the devices before joining the room. - -## Returns - -### initializeDevices() - -> **initializeDevices**: (`settings?`) => `Promise`\<[`InitializeDevicesResult`](../type-aliases/InitializeDevicesResult.md)\> - -Initialize access to the devices before joining the room - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `settings?` | [`InitializeDevicesSettings`](../type-aliases/InitializeDevicesSettings.md) | - -#### Returns - -`Promise`\<[`InitializeDevicesResult`](../type-aliases/InitializeDevicesResult.md)\> diff --git a/versioned_docs/version-0.20.0/api/web/functions/useLivestreamStreamer.md b/versioned_docs/version-0.20.0/api/web/functions/useLivestreamStreamer.md deleted file mode 100644 index be512f17..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/useLivestreamStreamer.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: useLivestreamStreamer() - -> **useLivestreamStreamer**(): [`UseLivestreamStreamerResult`](../interfaces/UseLivestreamStreamerResult.md) - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:51](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamStreamer.ts#L51) - -Hook for publishing a livestream, which can be then received with [useLivestreamViewer](useLivestreamViewer.md) - -## Returns - -[`UseLivestreamStreamerResult`](../interfaces/UseLivestreamStreamerResult.md) diff --git a/versioned_docs/version-0.20.0/api/web/functions/useLivestreamViewer.md b/versioned_docs/version-0.20.0/api/web/functions/useLivestreamViewer.md deleted file mode 100644 index 0f5a9063..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/useLivestreamViewer.md +++ /dev/null @@ -1,11 +0,0 @@ -# Function: useLivestreamViewer() - -> **useLivestreamViewer**(): [`UseLivestreamViewerResult`](../interfaces/UseLivestreamViewerResult.md) - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:41](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamViewer.ts#L41) - -Hook for receiving a published livestream. - -## Returns - -[`UseLivestreamViewerResult`](../interfaces/UseLivestreamViewerResult.md) diff --git a/versioned_docs/version-0.20.0/api/web/functions/useMicrophone.md b/versioned_docs/version-0.20.0/api/web/functions/useMicrophone.md deleted file mode 100644 index 127f9257..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/useMicrophone.md +++ /dev/null @@ -1,112 +0,0 @@ -# Function: useMicrophone() - -> **useMicrophone**(): `object` - -Defined in: [packages/react-client/src/hooks/devices/useMicrophone.ts:9](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/devices/useMicrophone.ts#L9) - -Manage microphone - -## Returns - -### ~~activeMicrophone~~ - -> **activeMicrophone**: `null` \| [`DeviceItem`](../type-aliases/DeviceItem.md) = `microphoneManager.activeDevice` - -#### Deprecated - -Use `currentMicrophone` and `isMicrophoneOn` instead -Indicates which microphone is now turned on and streaming audio - -### currentMicrophone - -> **currentMicrophone**: `null` \| `MediaDeviceInfo` = `microphoneManager.selectedDevice` - -Indicates which microphone is now selected - -### currentMicrophoneMiddleware - -> **currentMicrophoneMiddleware**: [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) = `audioTrackManager.currentMiddleware` - -The currently set microphone middleware function - -### isMicrophoneMuted - -> **isMicrophoneMuted**: `boolean` = `!microphoneManager.deviceEnabled` - -Indicates whether the microphone is muted - -### isMicrophoneOn - -> **isMicrophoneOn**: `boolean` = `!!microphoneStream` - -Indicates whether the microphone is streaming audio - -### microphoneDeviceError - -> **microphoneDeviceError**: `null` \| [`DeviceError`](../type-aliases/DeviceError.md) = `microphoneManager.deviceError` - -Possible error thrown while setting up the microphone - -### microphoneDevices - -> **microphoneDevices**: [`DeviceItem`](../type-aliases/DeviceItem.md)[] = `microphoneManager.deviceList` - -List of available microphone devices - -### microphoneStream - -> **microphoneStream**: `null` \| `MediaStream` - -The MediaStream object containing the current audio stream - -### selectMicrophone() - -> **selectMicrophone**: (`deviceId`) => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> = `audioTrackManager.selectDevice` - -Selects the microphone device - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `deviceId` | `string` | - -#### Returns - -`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> - -### setMicrophoneTrackMiddleware() - -> **setMicrophoneTrackMiddleware**: (`middleware`) => `Promise`\<`void`\> = `audioTrackManager.setTrackMiddleware` - -Sets the microphone middleware - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `middleware` | [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) | - -#### Returns - -`Promise`\<`void`\> - -### toggleMicrophone() - -> **toggleMicrophone**: () => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> = `audioTrackManager.toggleDevice` - -Toggles current microphone on/off - -#### Returns - -`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> - -### toggleMicrophoneMute() - -> **toggleMicrophoneMute**: () => `Promise`\<`void`\> = `audioTrackManager.toggleMute` - -Mutes/unmutes the microphone - -#### Returns - -`Promise`\<`void`\> diff --git a/versioned_docs/version-0.20.0/api/web/functions/usePeers.md b/versioned_docs/version-0.20.0/api/web/functions/usePeers.md deleted file mode 100644 index f8f99b44..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/usePeers.md +++ /dev/null @@ -1,39 +0,0 @@ -# Function: usePeers() - -> **usePeers**\<`PeerMetadata`, `ServerMetadata`\>(): `object` - -Defined in: [packages/react-client/src/hooks/usePeers.ts:67](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/usePeers.ts#L67) - -Hook allows to access id, tracks and metadata of the local and remote peers. - -## Type Parameters - -| Type Parameter | Default type | Description | -| ------ | ------ | ------ | -| `PeerMetadata` | `Record`\<`string`, `unknown`\> | Type of metadata set by peer while connecting to a room. | -| `ServerMetadata` | `Record`\<`string`, `unknown`\> | Type of metadata set by the server while creating a peer. | - -## Returns - -### localPeer - -> **localPeer**: `null` \| [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\> - -The local peer with distinguished tracks (camera, microphone, screen share). -Will be null if the local peer is not found. - -### ~~peers~~ - -> **peers**: [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\>[] = `remotePeers` - -#### Deprecated - -Use remotePeers instead -Legacy array containing remote peers. -This property will be removed in future versions. - -### remotePeers - -> **remotePeers**: [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\>[] - -Array of remote peers with distinguished tracks (camera, microphone, screen share). diff --git a/versioned_docs/version-0.20.0/api/web/functions/useSandbox.md b/versioned_docs/version-0.20.0/api/web/functions/useSandbox.md deleted file mode 100644 index e12a013f..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/useSandbox.md +++ /dev/null @@ -1,60 +0,0 @@ -# Function: useSandbox() - -> **useSandbox**(`props?`): `object` - -Defined in: [packages/react-client/src/hooks/useSandbox.ts:27](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useSandbox.ts#L27) - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `props?` | [`UseSandboxProps`](../type-aliases/UseSandboxProps.md) | - -## Returns - -`object` - -### getSandboxLivestream() - -> **getSandboxLivestream**: (`roomName`, `isPublic`) => `Promise`\<\{ `room`: \{ `id`: `string`; `name`: `string`; \}; `streamerToken`: `string`; \}\> - -#### Parameters - -| Parameter | Type | Default value | -| ------ | ------ | ------ | -| `roomName` | `string` | `undefined` | -| `isPublic` | `boolean` | `false` | - -#### Returns - -`Promise`\<\{ `room`: \{ `id`: `string`; `name`: `string`; \}; `streamerToken`: `string`; \}\> - -### getSandboxPeerToken() - -> **getSandboxPeerToken**: (`roomName`, `peerName`, `roomType`) => `Promise`\<`string`\> - -#### Parameters - -| Parameter | Type | Default value | -| ------ | ------ | ------ | -| `roomName` | `string` | `undefined` | -| `peerName` | `string` | `undefined` | -| `roomType` | [`RoomType`](../type-aliases/RoomType.md) | `"conference"` | - -#### Returns - -`Promise`\<`string`\> - -### getSandboxViewerToken() - -> **getSandboxViewerToken**: (`roomName`) => `Promise`\<`string`\> - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomName` | `string` | - -#### Returns - -`Promise`\<`string`\> diff --git a/versioned_docs/version-0.20.0/api/web/functions/useScreenShare.md b/versioned_docs/version-0.20.0/api/web/functions/useScreenShare.md deleted file mode 100644 index 9232960b..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/useScreenShare.md +++ /dev/null @@ -1,81 +0,0 @@ -# Function: useScreenShare() - -> **useScreenShare**(): `object` - -Defined in: [packages/react-client/src/hooks/useScreenShare.ts:10](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useScreenShare.ts#L10) - -Hook to enable screen sharing within a room and manage the existing stream. - -## Returns - -### audioTrack - -> **audioTrack**: `null` \| `MediaStreamTrack` = `screenShareManager.audioTrack` - -The separate audio MediaStreamTrack. - -### currentTracksMiddleware - -> **currentTracksMiddleware**: `null` \| [`TracksMiddleware`](../type-aliases/TracksMiddleware.md) = `screenShareManager.currentTracksMiddleware` - -The middleware currently assigned to process the tracks. -A screenshare may include both audio and video tracks, and this middleware is capable of processing -each track type. - -### setTracksMiddleware() - -> **setTracksMiddleware**: (`middleware`) => `Promise`\<`void`\> = `screenShareManager.setTracksMiddleware` - -Sets the middleware responsible for processing the tracks. - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `middleware` | `null` \| [`TracksMiddleware`](../type-aliases/TracksMiddleware.md) | The middleware to set, which can be a TracksMiddleware instance or null to remove the middleware. | - -#### Returns - -`Promise`\<`void`\> - -A Promise that resolves once the middleware is successfully set. - -### startStreaming() - -> **startStreaming**: (`props?`) => `Promise`\<`void`\> = `screenShareManager.startStreaming` - -Invokes the screen sharing prompt in the user's browser and starts streaming upon approval. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `props?` | \{ `audioConstraints?`: `boolean` \| `MediaTrackConstraints`; `videoConstraints?`: `boolean` \| `MediaTrackConstraints`; \} | -| `props.audioConstraints?` | `boolean` \| `MediaTrackConstraints` | -| `props.videoConstraints?` | `boolean` \| `MediaTrackConstraints` | - -#### Returns - -`Promise`\<`void`\> - -### stopStreaming() - -> **stopStreaming**: () => `Promise`\<`void`\> = `screenShareManager.stopStreaming` - -Stops the stream and cancels browser screen sharing. - -#### Returns - -`Promise`\<`void`\> - -### stream - -> **stream**: `null` \| `MediaStream` = `screenShareManager.stream` - -The MediaStream object containing both tracks. - -### videoTrack - -> **videoTrack**: `null` \| `MediaStreamTrack` = `screenShareManager.videoTrack` - -The separate video MediaStreamTrack. diff --git a/versioned_docs/version-0.20.0/api/web/functions/useUpdatePeerMetadata.md b/versioned_docs/version-0.20.0/api/web/functions/useUpdatePeerMetadata.md deleted file mode 100644 index de765d9c..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/useUpdatePeerMetadata.md +++ /dev/null @@ -1,31 +0,0 @@ -# Function: useUpdatePeerMetadata() - -> **useUpdatePeerMetadata**\<`PeerMetadata`\>(): `object` - -Defined in: [packages/react-client/src/hooks/useUpdatePeerMetadata.ts:12](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useUpdatePeerMetadata.ts#L12) - -Hook provides a method to update the metadata of the local peer. - -## Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | - -## Returns - -### updatePeerMetadata() - -> **updatePeerMetadata**: (`peerMetadata`) => `void` - -Updates metadata visible to other peers - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `peerMetadata` | `PeerMetadata` | - -#### Returns - -`void` diff --git a/versioned_docs/version-0.20.0/api/web/functions/useVAD.md b/versioned_docs/version-0.20.0/api/web/functions/useVAD.md deleted file mode 100644 index 3ae45283..00000000 --- a/versioned_docs/version-0.20.0/api/web/functions/useVAD.md +++ /dev/null @@ -1,31 +0,0 @@ -# Function: useVAD() - -> **useVAD**(`peerIds`): `Record`\<[`PeerId`](../type-aliases/PeerId.md), `boolean`\> - -Defined in: [packages/react-client/src/hooks/useVAD.ts:25](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useVAD.ts#L25) - -Voice activity detection. Use this hook to check if voice is detected in audio track for given peer(s). - -Example usage: -```tsx -import { useVAD, type PeerId } from "@fishjam-cloud/react-client"; -function WhoIsTalkingComponent({ peerIds }: { peerIds: PeerId[] }) { - const peersInfo = useVAD({peerIds}); - const activePeers = (Object.keys(peersInfo) as PeerId[]).filter((peerId) => peersInfo[peerId]); - - return `Now talking: ${activePeers.join(", ")}`; -} -``` - -## Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `peerIds` | \{ `peerIds`: readonly [`PeerId`](../type-aliases/PeerId.md)[]; \} | List of ids of peers to subscribe to for voice activity detection notifications. | -| `peerIds.peerIds` | readonly [`PeerId`](../type-aliases/PeerId.md)[] | - | - -## Returns - -`Record`\<[`PeerId`](../type-aliases/PeerId.md), `boolean`\> - -Each key is a peerId and the boolean value indicates if voice activity is currently detected for that peer. diff --git a/versioned_docs/version-0.20.0/api/web/index.md b/versioned_docs/version-0.20.0/api/web/index.md deleted file mode 100644 index 01c4eb79..00000000 --- a/versioned_docs/version-0.20.0/api/web/index.md +++ /dev/null @@ -1,69 +0,0 @@ -# @fishjam-cloud/react-client - -## Connection - -- [useConnection](functions/useConnection.md) -- [usePeers](functions/usePeers.md) -- [useUpdatePeerMetadata](functions/useUpdatePeerMetadata.md) -- [useVAD](functions/useVAD.md) -- [Metadata](type-aliases/Metadata.md) - -## Devices - -- [useCamera](functions/useCamera.md) -- [useInitializeDevices](functions/useInitializeDevices.md) -- [useMicrophone](functions/useMicrophone.md) -- [useScreenShare](functions/useScreenShare.md) - -## Components - -- [FishjamProvider](functions/FishjamProvider.md) -- [FishjamProviderProps](interfaces/FishjamProviderProps.md) - -## Livestream - -- [useLivestreamStreamer](functions/useLivestreamStreamer.md) -- [useLivestreamViewer](functions/useLivestreamViewer.md) -- [UseLivestreamStreamerResult](interfaces/UseLivestreamStreamerResult.md) -- [UseLivestreamViewerResult](interfaces/UseLivestreamViewerResult.md) -- [ConnectStreamerConfig](type-aliases/ConnectStreamerConfig.md) -- [StreamerInputs](type-aliases/StreamerInputs.md) - -## Other - -- [useCustomSource](functions/useCustomSource.md) -- [useSandbox](functions/useSandbox.md) -- [Variant](enumerations/Variant.md) -- [JoinRoomConfig](interfaces/JoinRoomConfig.md) -- [SimulcastConfig](interfaces/SimulcastConfig.md) -- [AuthErrorReason](type-aliases/AuthErrorReason.md) -- [BandwidthLimits](type-aliases/BandwidthLimits.md) -- [Brand](type-aliases/Brand.md) -- [ConnectViewerConfig](type-aliases/ConnectViewerConfig.md) -- [CustomSource](type-aliases/CustomSource.md) -- [DeviceError](type-aliases/DeviceError.md) -- [DeviceItem](type-aliases/DeviceItem.md) -- [InitializeDevicesResult](type-aliases/InitializeDevicesResult.md) -- [InitializeDevicesSettings](type-aliases/InitializeDevicesSettings.md) -- [InitializeDevicesStatus](type-aliases/InitializeDevicesStatus.md) -- [JoinErrorReason](type-aliases/JoinErrorReason.md) -- [MiddlewareResult](type-aliases/MiddlewareResult.md) -- [PeerId](type-aliases/PeerId.md) -- [PeerStatus](type-aliases/PeerStatus.md) -- [PeerWithTracks](type-aliases/PeerWithTracks.md) -- [PersistLastDeviceHandlers](type-aliases/PersistLastDeviceHandlers.md) -- [ReconnectConfig](type-aliases/ReconnectConfig.md) -- [ReconnectionStatus](type-aliases/ReconnectionStatus.md) -- [RoomType](type-aliases/RoomType.md) -- [SimulcastBandwidthLimit](type-aliases/SimulcastBandwidthLimit.md) -- [SimulcastBandwidthLimits](type-aliases/SimulcastBandwidthLimits.md) -- [StreamConfig](type-aliases/StreamConfig.md) -- [Track](type-aliases/Track.md) -- [TrackBandwidthLimit](type-aliases/TrackBandwidthLimit.md) -- [TrackId](type-aliases/TrackId.md) -- [TrackMiddleware](type-aliases/TrackMiddleware.md) -- [TracksMiddleware](type-aliases/TracksMiddleware.md) -- [TracksMiddlewareResult](type-aliases/TracksMiddlewareResult.md) -- [UseInitializeDevicesParams](type-aliases/UseInitializeDevicesParams.md) -- [UseSandboxProps](type-aliases/UseSandboxProps.md) -- [SimulcastConfig](variables/SimulcastConfig.md) diff --git a/versioned_docs/version-0.20.0/api/web/interfaces/FishjamProviderProps.md b/versioned_docs/version-0.20.0/api/web/interfaces/FishjamProviderProps.md deleted file mode 100644 index bbad028d..00000000 --- a/versioned_docs/version-0.20.0/api/web/interfaces/FishjamProviderProps.md +++ /dev/null @@ -1,97 +0,0 @@ -# Interface: FishjamProviderProps - -Defined in: [packages/react-client/src/FishjamProvider.tsx:27](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/FishjamProvider.tsx#L27) - -## Extends - -- `PropsWithChildren` - -## Properties - -### audioConfig? - -> `optional` **audioConfig**: [`StreamConfig`](../type-aliases/StreamConfig.md) - -Defined in: [packages/react-client/src/FishjamProvider.tsx:55](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/FishjamProvider.tsx#L55) - -Configure whether to use audio simulcast and which layers to send if so. - -*** - -### bandwidthLimits? - -> `optional` **bandwidthLimits**: `Partial`\<[`BandwidthLimits`](../type-aliases/BandwidthLimits.md)\> - -Defined in: [packages/react-client/src/FishjamProvider.tsx:47](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/FishjamProvider.tsx#L47) - -Adjust max bandwidth limit for a single stream and simulcast. - -*** - -### children? - -> `optional` **children**: `ReactNode` - -Defined in: node\_modules/@types/react/index.d.ts:1398 - -#### Inherited from - -`PropsWithChildren.children` - -*** - -### constraints? - -> `optional` **constraints**: `Pick`\<`MediaStreamConstraints`, `"audio"` \| `"video"`\> - -Defined in: [packages/react-client/src/FishjamProvider.tsx:38](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/FishjamProvider.tsx#L38) - -Set preferred constraints. - -#### Param - -The media stream constraints as defined by the Web API. - -#### See - -[MediaStreamConstraints](https://udn.realityripple.com/docs/Web/API/MediaStreamConstraints) - -*** - -### fishjamId? - -> `optional` **fishjamId**: `string` - -Defined in: [packages/react-client/src/FishjamProvider.tsx:60](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/FishjamProvider.tsx#L60) - -*** - -### persistLastDevice? - -> `optional` **persistLastDevice**: `boolean` \| [`PersistLastDeviceHandlers`](../type-aliases/PersistLastDeviceHandlers.md) - -Defined in: [packages/react-client/src/FishjamProvider.tsx:43](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/FishjamProvider.tsx#L43) - -Decide if you want Fishjam SDK to persist last used device in the local storage. -You can also provide your getter and setter by using the [PersistLastDeviceHandlers](../type-aliases/PersistLastDeviceHandlers.md) interface. - -*** - -### reconnect? - -> `optional` **reconnect**: `boolean` \| [`ReconnectConfig`](../type-aliases/ReconnectConfig.md) - -Defined in: [packages/react-client/src/FishjamProvider.tsx:32](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/FishjamProvider.tsx#L32) - -Use [ReconnectConfig](../type-aliases/ReconnectConfig.md) to adjust reconnection policy to your needs or set false it. -Set to true by default. - -*** - -### videoConfig? - -> `optional` **videoConfig**: [`StreamConfig`](../type-aliases/StreamConfig.md) - -Defined in: [packages/react-client/src/FishjamProvider.tsx:51](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/FishjamProvider.tsx#L51) - -Configure whether to use video simulcast and which layers to send if so. diff --git a/versioned_docs/version-0.20.0/api/web/interfaces/JoinRoomConfig.md b/versioned_docs/version-0.20.0/api/web/interfaces/JoinRoomConfig.md deleted file mode 100644 index b23bb196..00000000 --- a/versioned_docs/version-0.20.0/api/web/interfaces/JoinRoomConfig.md +++ /dev/null @@ -1,39 +0,0 @@ -# Interface: JoinRoomConfig\ - -Defined in: [packages/react-client/src/hooks/useConnection.ts:10](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useConnection.ts#L10) - -## Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | - -## Properties - -### peerMetadata? - -> `optional` **peerMetadata**: `PeerMetadata` - -Defined in: [packages/react-client/src/hooks/useConnection.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useConnection.ts#L22) - -String indexed record with metadata, that will be available to all other peers - -*** - -### peerToken - -> **peerToken**: `string` - -Defined in: [packages/react-client/src/hooks/useConnection.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useConnection.ts#L18) - -Token received from server (or Room Manager) - -*** - -### url? - -> `optional` **url**: `string` - -Defined in: [packages/react-client/src/hooks/useConnection.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useConnection.ts#L14) - -Overrides the default url derived from the Fishjam ID passed to FishjamProvider diff --git a/versioned_docs/version-0.20.0/api/web/interfaces/SimulcastConfig.md b/versioned_docs/version-0.20.0/api/web/interfaces/SimulcastConfig.md deleted file mode 100644 index ffef1264..00000000 --- a/versioned_docs/version-0.20.0/api/web/interfaces/SimulcastConfig.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: SimulcastConfig - -Defined in: packages/ts-client/dist/index.d.mts:158 - -## Properties - -### disabledVariants - -> **disabledVariants**: [`Variant`](../enumerations/Variant.md)[] - -Defined in: packages/ts-client/dist/index.d.mts:161 - -*** - -### enabled - -> **enabled**: `boolean` - -Defined in: packages/ts-client/dist/index.d.mts:159 - -*** - -### enabledVariants - -> **enabledVariants**: [`Variant`](../enumerations/Variant.md)[] - -Defined in: packages/ts-client/dist/index.d.mts:160 diff --git a/versioned_docs/version-0.20.0/api/web/interfaces/UseLivestreamStreamerResult.md b/versioned_docs/version-0.20.0/api/web/interfaces/UseLivestreamStreamerResult.md deleted file mode 100644 index 009c23ad..00000000 --- a/versioned_docs/version-0.20.0/api/web/interfaces/UseLivestreamStreamerResult.md +++ /dev/null @@ -1,62 +0,0 @@ -# Interface: UseLivestreamStreamerResult - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:27](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamStreamer.ts#L27) - -## Properties - -### connect() - -> **connect**: (`inputs`, `urlOverride?`) => `Promise`\<`void`\> - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:34](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamStreamer.ts#L34) - -Callback used to start publishing the selected audio and video media streams. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `inputs` | [`ConnectStreamerConfig`](../type-aliases/ConnectStreamerConfig.md) | -| `urlOverride?` | `string` | - -#### Returns - -`Promise`\<`void`\> - -#### Remarks - -Calling [connect](#connect) multiple times will have the effect of only publishing the **last** specified inputs. - -*** - -### disconnect() - -> **disconnect**: () => `void` - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:36](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamStreamer.ts#L36) - -Callback to stop publishing anything previously published with [connect](#connect) - -#### Returns - -`void` - -*** - -### error - -> **error**: `null` \| `LivestreamError` - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:38](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamStreamer.ts#L38) - -Any errors encountered in [connect](#connect) will populate this field - -*** - -### isConnected - -> **isConnected**: `boolean` - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:40](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamStreamer.ts#L40) - -Utility flag which indicates the current connection status diff --git a/versioned_docs/version-0.20.0/api/web/interfaces/UseLivestreamViewerResult.md b/versioned_docs/version-0.20.0/api/web/interfaces/UseLivestreamViewerResult.md deleted file mode 100644 index 225ffada..00000000 --- a/versioned_docs/version-0.20.0/api/web/interfaces/UseLivestreamViewerResult.md +++ /dev/null @@ -1,70 +0,0 @@ -# Interface: UseLivestreamViewerResult - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:11](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamViewer.ts#L11) - -## Properties - -### connect() - -> **connect**: (`config`, `url?`) => `Promise`\<`void`\> - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamViewer.ts#L19) - -Callback to start receiving a livestream. -If the livestream is private, provide `token`. -If the livestream is public, provide `streamId`. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`ConnectViewerConfig`](../type-aliases/ConnectViewerConfig.md) | -| `url?` | `string` | - -#### Returns - -`Promise`\<`void`\> - -*** - -### disconnect() - -> **disconnect**: () => `void` - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamViewer.ts#L21) - -Callback used to disconnect from a stream previously connected to with [connect](#connect) - -#### Returns - -`void` - -*** - -### error - -> **error**: `null` \| `LivestreamError` - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamViewer.ts#L23) - -Any errors encountered in [connect](#connect) will be present in this field. - -*** - -### isConnected - -> **isConnected**: `boolean` - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:25](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamViewer.ts#L25) - -Utility flag which indicates the current connection status - -*** - -### stream - -> **stream**: `null` \| `MediaStream` - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:13](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamViewer.ts#L13) - -The received livestream media diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/AuthErrorReason.md b/versioned_docs/version-0.20.0/api/web/type-aliases/AuthErrorReason.md deleted file mode 100644 index 5d7ef8f5..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/AuthErrorReason.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: AuthErrorReason - -> **AuthErrorReason** = *typeof* `AUTH_ERROR_REASONS`\[`number`\] - -Defined in: packages/ts-client/dist/index.d.mts:5 diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/BandwidthLimits.md b/versioned_docs/version-0.20.0/api/web/type-aliases/BandwidthLimits.md deleted file mode 100644 index b38a65f6..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/BandwidthLimits.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: BandwidthLimits - -> **BandwidthLimits** = `object` - -Defined in: [packages/react-client/src/types/public.ts:61](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L61) - -## Properties - -### simulcast - -> **simulcast**: [`SimulcastBandwidthLimits`](SimulcastBandwidthLimits.md) - -Defined in: [packages/react-client/src/types/public.ts:61](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L61) - -*** - -### singleStream - -> **singleStream**: `number` - -Defined in: [packages/react-client/src/types/public.ts:61](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L61) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/Brand.md b/versioned_docs/version-0.20.0/api/web/type-aliases/Brand.md deleted file mode 100644 index 8432e1a5..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/Brand.md +++ /dev/null @@ -1,18 +0,0 @@ -# Type Alias: Brand\ - -> **Brand**\<`T`, `TBrand`\> = `T` & `object` - -Defined in: [packages/react-client/src/types/public.ts:72](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L72) - -## Type declaration - -### \[brand\] - -> **\[brand\]**: `TBrand` - -## Type Parameters - -| Type Parameter | -| ------ | -| `T` | -| `TBrand` *extends* `string` | diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/ConnectStreamerConfig.md b/versioned_docs/version-0.20.0/api/web/type-aliases/ConnectStreamerConfig.md deleted file mode 100644 index a169d15c..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/ConnectStreamerConfig.md +++ /dev/null @@ -1,23 +0,0 @@ -# Type Alias: ConnectStreamerConfig - -> **ConnectStreamerConfig** = `object` - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamStreamer.ts#L20) - -## Properties - -### inputs - -> **inputs**: [`StreamerInputs`](StreamerInputs.md) - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamStreamer.ts#L21) - -*** - -### token - -> **token**: `string` - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamStreamer.ts#L23) - -Streamer token used to authenticate with Fishjam diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/ConnectViewerConfig.md b/versioned_docs/version-0.20.0/api/web/type-aliases/ConnectViewerConfig.md deleted file mode 100644 index 7534805e..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/ConnectViewerConfig.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ConnectViewerConfig - -> **ConnectViewerConfig** = \{ `streamId?`: `never`; `token`: `string`; \} \| \{ `streamId`: `string`; `token?`: `never`; \} - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:6](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamViewer.ts#L6) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/CustomSource.md b/versioned_docs/version-0.20.0/api/web/type-aliases/CustomSource.md deleted file mode 100644 index 771beb93..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/CustomSource.md +++ /dev/null @@ -1,40 +0,0 @@ -# Type Alias: CustomSource\ - -> **CustomSource**\<`T`\> = `object` - -Defined in: [packages/react-client/src/types/public.ts:74](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L74) - -## Type Parameters - -| Type Parameter | -| ------ | -| `T` *extends* `string` | - -## Properties - -### id - -> **id**: `T` - -Defined in: [packages/react-client/src/types/public.ts:75](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L75) - -*** - -### stream? - -> `optional` **stream**: `MediaStream` - -Defined in: [packages/react-client/src/types/public.ts:77](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L77) - -*** - -### trackIds? - -> `optional` **trackIds**: `object` - -Defined in: [packages/react-client/src/types/public.ts:76](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L76) - -| Name | Type | -| ------ | ------ | -| `audioId?` | `string` | -| `videoId?` | `string` | diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/DeviceError.md b/versioned_docs/version-0.20.0/api/web/type-aliases/DeviceError.md deleted file mode 100644 index 4dae1f78..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/DeviceError.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: DeviceError - -> **DeviceError** = \{ `name`: `"OverconstrainedError"`; \} \| \{ `name`: `"NotAllowedError"`; \} \| \{ `name`: `"NotFoundError"`; \} \| \{ `name`: `"UNHANDLED_ERROR"`; \} - -Defined in: [packages/react-client/src/types/public.ts:65](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L65) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/DeviceItem.md b/versioned_docs/version-0.20.0/api/web/type-aliases/DeviceItem.md deleted file mode 100644 index f11b52f1..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/DeviceItem.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: DeviceItem - -> **DeviceItem** = `object` - -Defined in: [packages/react-client/src/types/public.ts:46](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L46) - -## Properties - -### deviceId - -> **deviceId**: `string` - -Defined in: [packages/react-client/src/types/public.ts:46](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L46) - -*** - -### label - -> **label**: `string` - -Defined in: [packages/react-client/src/types/public.ts:46](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L46) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/InitializeDevicesResult.md b/versioned_docs/version-0.20.0/api/web/type-aliases/InitializeDevicesResult.md deleted file mode 100644 index d5e39041..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/InitializeDevicesResult.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: InitializeDevicesResult - -> **InitializeDevicesResult** = `object` - -Defined in: [packages/react-client/src/types/public.ts:5](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L5) - -## Properties - -### errors - -> **errors**: \{ `audio`: [`DeviceError`](DeviceError.md) \| `null`; `video`: [`DeviceError`](DeviceError.md) \| `null`; \} \| `null` - -Defined in: [packages/react-client/src/types/public.ts:8](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L8) - -*** - -### status - -> **status**: [`InitializeDevicesStatus`](InitializeDevicesStatus.md) - -Defined in: [packages/react-client/src/types/public.ts:6](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L6) - -*** - -### stream - -> **stream**: `MediaStream` \| `null` - -Defined in: [packages/react-client/src/types/public.ts:7](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L7) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/InitializeDevicesSettings.md b/versioned_docs/version-0.20.0/api/web/type-aliases/InitializeDevicesSettings.md deleted file mode 100644 index 668609d1..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/InitializeDevicesSettings.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: InitializeDevicesSettings - -> **InitializeDevicesSettings** = `object` - -Defined in: [packages/react-client/src/hooks/internal/devices/useMediaDevices.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/internal/devices/useMediaDevices.ts#L14) - -## Properties - -### enableAudio? - -> `optional` **enableAudio**: `boolean` - -Defined in: [packages/react-client/src/hooks/internal/devices/useMediaDevices.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/internal/devices/useMediaDevices.ts#L14) - -*** - -### enableVideo? - -> `optional` **enableVideo**: `boolean` - -Defined in: [packages/react-client/src/hooks/internal/devices/useMediaDevices.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/internal/devices/useMediaDevices.ts#L14) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/InitializeDevicesStatus.md b/versioned_docs/version-0.20.0/api/web/type-aliases/InitializeDevicesStatus.md deleted file mode 100644 index 58d334b5..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/InitializeDevicesStatus.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: InitializeDevicesStatus - -> **InitializeDevicesStatus** = `"initialized"` \| `"failed"` \| `"initialized_with_errors"` \| `"already_initialized"` - -Defined in: [packages/react-client/src/types/public.ts:3](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L3) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/JoinErrorReason.md b/versioned_docs/version-0.20.0/api/web/type-aliases/JoinErrorReason.md deleted file mode 100644 index 14763576..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/JoinErrorReason.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: JoinErrorReason - -> **JoinErrorReason** = *typeof* `JOIN_ERRORS`\[`number`\] - -Defined in: packages/ts-client/dist/index.d.mts:775 diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/Metadata.md b/versioned_docs/version-0.20.0/api/web/type-aliases/Metadata.md deleted file mode 100644 index 2bd4d2c4..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/Metadata.md +++ /dev/null @@ -1,28 +0,0 @@ -# Type Alias: Metadata\ - -> **Metadata**\<`PeerMetadata`, `ServerMetadata`\> = `object` - -Defined in: packages/ts-client/dist/index.d.mts:798 - -## Type Parameters - -| Type Parameter | Default type | Description | -| ------ | ------ | ------ | -| `PeerMetadata` | `GenericMetadata` | Type of metadata set by peer while connecting to a room. | -| `ServerMetadata` | `GenericMetadata` | Type of metadata set by the server while creating a peer. | - -## Properties - -### peer - -> **peer**: `PeerMetadata` - -Defined in: packages/ts-client/dist/index.d.mts:799 - -*** - -### server - -> **server**: `ServerMetadata` - -Defined in: packages/ts-client/dist/index.d.mts:800 diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/MiddlewareResult.md b/versioned_docs/version-0.20.0/api/web/type-aliases/MiddlewareResult.md deleted file mode 100644 index f132241a..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/MiddlewareResult.md +++ /dev/null @@ -1,25 +0,0 @@ -# Type Alias: MiddlewareResult - -> **MiddlewareResult** = `object` - -Defined in: [packages/react-client/src/types/public.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L23) - -## Properties - -### onClear()? - -> `optional` **onClear**: () => `void` - -Defined in: [packages/react-client/src/types/public.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L23) - -#### Returns - -`void` - -*** - -### track - -> **track**: `MediaStreamTrack` - -Defined in: [packages/react-client/src/types/public.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L23) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/PeerId.md b/versioned_docs/version-0.20.0/api/web/type-aliases/PeerId.md deleted file mode 100644 index 44865168..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/PeerId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerId - -> **PeerId** = [`Brand`](Brand.md)\<`string`, `"PeerId"`\> - -Defined in: [packages/react-client/src/types/public.ts:12](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L12) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/PeerStatus.md b/versioned_docs/version-0.20.0/api/web/type-aliases/PeerStatus.md deleted file mode 100644 index 80f7b2cf..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/PeerStatus.md +++ /dev/null @@ -1,12 +0,0 @@ -# Type Alias: PeerStatus - -> **PeerStatus** = `"connecting"` \| `"connected"` \| `"error"` \| `"idle"` - -Defined in: [packages/react-client/src/types/public.ts:44](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L44) - -Represents the possible statuses of a peer connection. - -- `idle` - Peer is not connected, either never connected or successfully disconnected. -- `connecting` - Peer is in the process of connecting. -- `connected` - Peer has successfully connected. -- `error` - There was an error in the connection process. diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/PeerWithTracks.md b/versioned_docs/version-0.20.0/api/web/type-aliases/PeerWithTracks.md deleted file mode 100644 index 72f4092c..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/PeerWithTracks.md +++ /dev/null @@ -1,84 +0,0 @@ -# Type Alias: PeerWithTracks\ - -> **PeerWithTracks**\<`PeerMetadata`, `ServerMetadata`\> = `object` - -Defined in: [packages/react-client/src/hooks/usePeers.ts:13](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/usePeers.ts#L13) - -## Type Parameters - -| Type Parameter | Description | -| ------ | ------ | -| `PeerMetadata` | Type of metadata set by peer while connecting to a room. | -| `ServerMetadata` | Type of metadata set by the server while creating a peer. | - -## Properties - -### cameraTrack? - -> `optional` **cameraTrack**: [`Track`](Track.md) - -Defined in: [packages/react-client/src/hooks/usePeers.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/usePeers.ts#L17) - -*** - -### customAudioTracks - -> **customAudioTracks**: [`Track`](Track.md)[] - -Defined in: [packages/react-client/src/hooks/usePeers.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/usePeers.ts#L22) - -*** - -### customVideoTracks - -> **customVideoTracks**: [`Track`](Track.md)[] - -Defined in: [packages/react-client/src/hooks/usePeers.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/usePeers.ts#L21) - -*** - -### id - -> **id**: [`PeerId`](PeerId.md) - -Defined in: [packages/react-client/src/hooks/usePeers.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/usePeers.ts#L14) - -*** - -### metadata? - -> `optional` **metadata**: [`Metadata`](Metadata.md)\<`PeerMetadata`, `ServerMetadata`\> - -Defined in: [packages/react-client/src/hooks/usePeers.ts:15](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/usePeers.ts#L15) - -*** - -### microphoneTrack? - -> `optional` **microphoneTrack**: [`Track`](Track.md) - -Defined in: [packages/react-client/src/hooks/usePeers.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/usePeers.ts#L18) - -*** - -### screenShareAudioTrack? - -> `optional` **screenShareAudioTrack**: [`Track`](Track.md) - -Defined in: [packages/react-client/src/hooks/usePeers.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/usePeers.ts#L20) - -*** - -### screenShareVideoTrack? - -> `optional` **screenShareVideoTrack**: [`Track`](Track.md) - -Defined in: [packages/react-client/src/hooks/usePeers.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/usePeers.ts#L19) - -*** - -### tracks - -> **tracks**: [`Track`](Track.md)[] - -Defined in: [packages/react-client/src/hooks/usePeers.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/usePeers.ts#L16) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/PersistLastDeviceHandlers.md b/versioned_docs/version-0.20.0/api/web/type-aliases/PersistLastDeviceHandlers.md deleted file mode 100644 index 8f07b481..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/PersistLastDeviceHandlers.md +++ /dev/null @@ -1,42 +0,0 @@ -# Type Alias: PersistLastDeviceHandlers - -> **PersistLastDeviceHandlers** = `object` - -Defined in: [packages/react-client/src/types/public.ts:48](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L48) - -## Properties - -### getLastDevice() - -> **getLastDevice**: (`deviceType`) => `MediaDeviceInfo` \| `null` - -Defined in: [packages/react-client/src/types/public.ts:49](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L49) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `deviceType` | `"audio"` \| `"video"` | - -#### Returns - -`MediaDeviceInfo` \| `null` - -*** - -### saveLastDevice() - -> **saveLastDevice**: (`info`, `deviceType`) => `void` - -Defined in: [packages/react-client/src/types/public.ts:50](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L50) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `info` | `MediaDeviceInfo` | -| `deviceType` | `"audio"` \| `"video"` | - -#### Returns - -`void` diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/ReconnectConfig.md b/versioned_docs/version-0.20.0/api/web/type-aliases/ReconnectConfig.md deleted file mode 100644 index 14361829..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/ReconnectConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -# Type Alias: ReconnectConfig - -> **ReconnectConfig** = `object` - -Defined in: packages/ts-client/dist/index.d.mts:779 - -## Properties - -### addTracksOnReconnect? - -> `optional` **addTracksOnReconnect**: `boolean` - -Defined in: packages/ts-client/dist/index.d.mts:783 - -*** - -### delay? - -> `optional` **delay**: `number` - -Defined in: packages/ts-client/dist/index.d.mts:782 - -*** - -### initialDelay? - -> `optional` **initialDelay**: `number` - -Defined in: packages/ts-client/dist/index.d.mts:781 - -*** - -### maxAttempts? - -> `optional` **maxAttempts**: `number` - -Defined in: packages/ts-client/dist/index.d.mts:780 diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/ReconnectionStatus.md b/versioned_docs/version-0.20.0/api/web/type-aliases/ReconnectionStatus.md deleted file mode 100644 index 95225742..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/ReconnectionStatus.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ReconnectionStatus - -> **ReconnectionStatus** = `"reconnecting"` \| `"idle"` \| `"error"` - -Defined in: packages/ts-client/dist/index.d.mts:778 diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/RoomType.md b/versioned_docs/version-0.20.0/api/web/type-aliases/RoomType.md deleted file mode 100644 index e8ead95f..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/RoomType.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomType - -> **RoomType** = `"conference"` \| `"livestream"` \| `"audio_only"` - -Defined in: [packages/react-client/src/hooks/useSandbox.ts:25](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useSandbox.ts#L25) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/SimulcastBandwidthLimit.md b/versioned_docs/version-0.20.0/api/web/type-aliases/SimulcastBandwidthLimit.md deleted file mode 100644 index acd7f0c7..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/SimulcastBandwidthLimit.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: SimulcastBandwidthLimit - -> **SimulcastBandwidthLimit** = `Map`\<[`Variant`](../enumerations/Variant.md), `BandwidthLimit`\> - -Defined in: packages/ts-client/dist/index.d.mts:213 - -Type describing bandwidth limit for simulcast track. -It is a mapping (encoding => BandwidthLimit). -If encoding isn't present in this mapping, it will be assumed that this particular encoding shouldn't have any bandwidth limit diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/SimulcastBandwidthLimits.md b/versioned_docs/version-0.20.0/api/web/type-aliases/SimulcastBandwidthLimits.md deleted file mode 100644 index 5d167750..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/SimulcastBandwidthLimits.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: SimulcastBandwidthLimits - -> **SimulcastBandwidthLimits** = `object` - -Defined in: [packages/react-client/src/types/public.ts:53](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L53) - -## Properties - -### 1 - -> **1**: `number` - -Defined in: [packages/react-client/src/types/public.ts:54](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L54) - -*** - -### 2 - -> **2**: `number` - -Defined in: [packages/react-client/src/types/public.ts:55](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L55) - -*** - -### 3 - -> **3**: `number` - -Defined in: [packages/react-client/src/types/public.ts:56](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L56) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/StreamConfig.md b/versioned_docs/version-0.20.0/api/web/type-aliases/StreamConfig.md deleted file mode 100644 index fa279a10..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/StreamConfig.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: StreamConfig - -> **StreamConfig** = `object` - -Defined in: [packages/react-client/src/types/public.ts:59](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L59) - -## Properties - -### simulcast? - -> `optional` **simulcast**: [`Variant`](../enumerations/Variant.md)[] \| `false` - -Defined in: [packages/react-client/src/types/public.ts:59](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L59) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/StreamerInputs.md b/versioned_docs/version-0.20.0/api/web/type-aliases/StreamerInputs.md deleted file mode 100644 index 6459239b..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/StreamerInputs.md +++ /dev/null @@ -1,31 +0,0 @@ -# Type Alias: StreamerInputs - -> **StreamerInputs** = \{ `audio?`: `MediaStream` \| `null`; `video`: `MediaStream`; \} \| \{ `audio`: `MediaStream`; `video?`: `null`; \} - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:7](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useLivestreamStreamer.ts#L7) - -## Type declaration - -\{ `audio?`: `MediaStream` \| `null`; `video`: `MediaStream`; \} - -### audio? - -> `optional` **audio**: `MediaStream` \| `null` - -The audio source to publish. e.g. `microphoneStream` from [useMicrophone](../functions/useMicrophone.md) or `stream` from [useScreenShare](../functions/useScreenShare.md) - -### video - -> **video**: `MediaStream` - -The video source to publish. e.g. `cameraStream` from [useCamera](../functions/useCamera.md) or `stream` from [useScreenShare](../functions/useScreenShare.md) - -\{ `audio`: `MediaStream`; `video?`: `null`; \} - -### audio - -> **audio**: `MediaStream` - -### video? - -> `optional` **video**: `null` diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/Track.md b/versioned_docs/version-0.20.0/api/web/type-aliases/Track.md deleted file mode 100644 index f39e8bcb..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/Track.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: Track - -> **Track** = `object` - -Defined in: [packages/react-client/src/types/public.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L14) - -## Properties - -### encoding - -> **encoding**: [`Variant`](../enumerations/Variant.md) \| `null` - -Defined in: [packages/react-client/src/types/public.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L16) - -*** - -### metadata? - -> `optional` **metadata**: `TrackMetadata` - -Defined in: [packages/react-client/src/types/public.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L18) - -*** - -### simulcastConfig - -> **simulcastConfig**: [`SimulcastConfig`](../interfaces/SimulcastConfig.md) \| `null` - -Defined in: [packages/react-client/src/types/public.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L19) - -*** - -### stream - -> **stream**: `MediaStream` \| `null` - -Defined in: [packages/react-client/src/types/public.ts:15](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L15) - -*** - -### track - -> **track**: `MediaStreamTrack` \| `null` - -Defined in: [packages/react-client/src/types/public.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L20) - -*** - -### trackId - -> **trackId**: [`TrackId`](TrackId.md) - -Defined in: [packages/react-client/src/types/public.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L17) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/TrackBandwidthLimit.md b/versioned_docs/version-0.20.0/api/web/type-aliases/TrackBandwidthLimit.md deleted file mode 100644 index 0831453a..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/TrackBandwidthLimit.md +++ /dev/null @@ -1,8 +0,0 @@ -# Type Alias: TrackBandwidthLimit - -> **TrackBandwidthLimit** = `BandwidthLimit` \| [`SimulcastBandwidthLimit`](SimulcastBandwidthLimit.md) - -Defined in: packages/ts-client/dist/index.d.mts:218 - -Type describing bandwidth limitation of a Track, including simulcast and non-simulcast tracks. -A sum type of `BandwidthLimit` and `SimulcastBandwidthLimit` diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/TrackId.md b/versioned_docs/version-0.20.0/api/web/type-aliases/TrackId.md deleted file mode 100644 index ee28427b..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/TrackId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackId - -> **TrackId** = [`Brand`](Brand.md)\<`string`, `"TrackId"`\> - -Defined in: [packages/react-client/src/types/public.ts:11](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L11) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/TrackMiddleware.md b/versioned_docs/version-0.20.0/api/web/type-aliases/TrackMiddleware.md deleted file mode 100644 index 210106a9..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/TrackMiddleware.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackMiddleware - -> **TrackMiddleware** = (`track`) => [`MiddlewareResult`](MiddlewareResult.md) \| `Promise`\<[`MiddlewareResult`](MiddlewareResult.md)\> \| `null` - -Defined in: [packages/react-client/src/types/public.ts:24](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L24) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/TracksMiddleware.md b/versioned_docs/version-0.20.0/api/web/type-aliases/TracksMiddleware.md deleted file mode 100644 index adb3caca..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/TracksMiddleware.md +++ /dev/null @@ -1,16 +0,0 @@ -# Type Alias: TracksMiddleware() - -> **TracksMiddleware** = (`videoTrack`, `audioTrack`) => [`TracksMiddlewareResult`](TracksMiddlewareResult.md) \| `Promise`\<[`TracksMiddlewareResult`](TracksMiddlewareResult.md)\> - -Defined in: [packages/react-client/src/types/public.ts:31](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L31) - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `videoTrack` | `MediaStreamTrack` | -| `audioTrack` | `MediaStreamTrack` \| `null` | - -## Returns - -[`TracksMiddlewareResult`](TracksMiddlewareResult.md) \| `Promise`\<[`TracksMiddlewareResult`](TracksMiddlewareResult.md)\> diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/TracksMiddlewareResult.md b/versioned_docs/version-0.20.0/api/web/type-aliases/TracksMiddlewareResult.md deleted file mode 100644 index 2133abc2..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/TracksMiddlewareResult.md +++ /dev/null @@ -1,33 +0,0 @@ -# Type Alias: TracksMiddlewareResult - -> **TracksMiddlewareResult** = `object` - -Defined in: [packages/react-client/src/types/public.ts:26](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L26) - -## Properties - -### audioTrack - -> **audioTrack**: `MediaStreamTrack` \| `null` - -Defined in: [packages/react-client/src/types/public.ts:28](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L28) - -*** - -### onClear() - -> **onClear**: () => `void` - -Defined in: [packages/react-client/src/types/public.ts:29](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L29) - -#### Returns - -`void` - -*** - -### videoTrack - -> **videoTrack**: `MediaStreamTrack` - -Defined in: [packages/react-client/src/types/public.ts:27](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/types/public.ts#L27) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/UseInitializeDevicesParams.md b/versioned_docs/version-0.20.0/api/web/type-aliases/UseInitializeDevicesParams.md deleted file mode 100644 index b8409e5a..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/UseInitializeDevicesParams.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: UseInitializeDevicesParams - -> **UseInitializeDevicesParams** = `object` - -Defined in: [packages/react-client/src/hooks/devices/useInitializeDevices.ts:5](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L5) - -## Properties - -### enableAudio? - -> `optional` **enableAudio**: `boolean` - -Defined in: [packages/react-client/src/hooks/devices/useInitializeDevices.ts:7](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L7) - -*** - -### enableVideo? - -> `optional` **enableVideo**: `boolean` - -Defined in: [packages/react-client/src/hooks/devices/useInitializeDevices.ts:6](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L6) diff --git a/versioned_docs/version-0.20.0/api/web/type-aliases/UseSandboxProps.md b/versioned_docs/version-0.20.0/api/web/type-aliases/UseSandboxProps.md deleted file mode 100644 index 663c4b95..00000000 --- a/versioned_docs/version-0.20.0/api/web/type-aliases/UseSandboxProps.md +++ /dev/null @@ -1,17 +0,0 @@ -# Type Alias: UseSandboxProps - -> **UseSandboxProps** = `object` - -Defined in: [packages/react-client/src/hooks/useSandbox.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useSandbox.ts#L20) - -## Properties - -### configOverride? - -> `optional` **configOverride**: `object` - -Defined in: [packages/react-client/src/hooks/useSandbox.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/00cc23b021c6e87a4a0f647ceccc9acb897b5a38/packages/react-client/src/hooks/useSandbox.ts#L22) - -| Name | Type | -| ------ | ------ | -| `fishjamUrl?` | `string` | diff --git a/versioned_docs/version-0.20.0/api/web/typedoc-sidebar.cjs b/versioned_docs/version-0.20.0/api/web/typedoc-sidebar.cjs deleted file mode 100644 index 3f4a788e..00000000 --- a/versioned_docs/version-0.20.0/api/web/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ -const typedocSidebar = {items:[{type:"category",label:"Connection",items:[{type:"doc",id:"api/web/functions/useConnection",label:"useConnection"},{type:"doc",id:"api/web/functions/usePeers",label:"usePeers"},{type:"doc",id:"api/web/functions/useUpdatePeerMetadata",label:"useUpdatePeerMetadata"},{type:"doc",id:"api/web/functions/useVAD",label:"useVAD"},{type:"doc",id:"api/web/type-aliases/Metadata",label:"Metadata"}]},{type:"category",label:"Devices",items:[{type:"doc",id:"api/web/functions/useCamera",label:"useCamera"},{type:"doc",id:"api/web/functions/useInitializeDevices",label:"useInitializeDevices"},{type:"doc",id:"api/web/functions/useMicrophone",label:"useMicrophone"},{type:"doc",id:"api/web/functions/useScreenShare",label:"useScreenShare"}]},{type:"category",label:"Components",items:[{type:"doc",id:"api/web/functions/FishjamProvider",label:"FishjamProvider"},{type:"doc",id:"api/web/interfaces/FishjamProviderProps",label:"FishjamProviderProps"}]},{type:"category",label:"Livestream",items:[{type:"doc",id:"api/web/functions/useLivestreamStreamer",label:"useLivestreamStreamer"},{type:"doc",id:"api/web/functions/useLivestreamViewer",label:"useLivestreamViewer"},{type:"doc",id:"api/web/interfaces/UseLivestreamStreamerResult",label:"UseLivestreamStreamerResult"},{type:"doc",id:"api/web/interfaces/UseLivestreamViewerResult",label:"UseLivestreamViewerResult"},{type:"doc",id:"api/web/type-aliases/ConnectStreamerConfig",label:"ConnectStreamerConfig"},{type:"doc",id:"api/web/type-aliases/StreamerInputs",label:"StreamerInputs"}]},{type:"category",label:"Other",items:[{type:"doc",id:"api/web/functions/useCustomSource",label:"useCustomSource"},{type:"doc",id:"api/web/functions/useSandbox",label:"useSandbox"},{type:"doc",id:"api/web/enumerations/Variant",label:"Variant"},{type:"doc",id:"api/web/interfaces/JoinRoomConfig",label:"JoinRoomConfig"},{type:"doc",id:"api/web/interfaces/SimulcastConfig",label:"SimulcastConfig"},{type:"doc",id:"api/web/type-aliases/AuthErrorReason",label:"AuthErrorReason"},{type:"doc",id:"api/web/type-aliases/BandwidthLimits",label:"BandwidthLimits"},{type:"doc",id:"api/web/type-aliases/Brand",label:"Brand"},{type:"doc",id:"api/web/type-aliases/ConnectViewerConfig",label:"ConnectViewerConfig"},{type:"doc",id:"api/web/type-aliases/CustomSource",label:"CustomSource"},{type:"doc",id:"api/web/type-aliases/DeviceError",label:"DeviceError"},{type:"doc",id:"api/web/type-aliases/DeviceItem",label:"DeviceItem"},{type:"doc",id:"api/web/type-aliases/InitializeDevicesResult",label:"InitializeDevicesResult"},{type:"doc",id:"api/web/type-aliases/InitializeDevicesSettings",label:"InitializeDevicesSettings"},{type:"doc",id:"api/web/type-aliases/InitializeDevicesStatus",label:"InitializeDevicesStatus"},{type:"doc",id:"api/web/type-aliases/JoinErrorReason",label:"JoinErrorReason"},{type:"doc",id:"api/web/type-aliases/MiddlewareResult",label:"MiddlewareResult"},{type:"doc",id:"api/web/type-aliases/PeerId",label:"PeerId"},{type:"doc",id:"api/web/type-aliases/PeerStatus",label:"PeerStatus"},{type:"doc",id:"api/web/type-aliases/PeerWithTracks",label:"PeerWithTracks"},{type:"doc",id:"api/web/type-aliases/PersistLastDeviceHandlers",label:"PersistLastDeviceHandlers"},{type:"doc",id:"api/web/type-aliases/ReconnectConfig",label:"ReconnectConfig"},{type:"doc",id:"api/web/type-aliases/ReconnectionStatus",label:"ReconnectionStatus"},{type:"doc",id:"api/web/type-aliases/RoomType",label:"RoomType"},{type:"doc",id:"api/web/type-aliases/SimulcastBandwidthLimit",label:"SimulcastBandwidthLimit"},{type:"doc",id:"api/web/type-aliases/SimulcastBandwidthLimits",label:"SimulcastBandwidthLimits"},{type:"doc",id:"api/web/type-aliases/StreamConfig",label:"StreamConfig"},{type:"doc",id:"api/web/type-aliases/Track",label:"Track"},{type:"doc",id:"api/web/type-aliases/TrackBandwidthLimit",label:"TrackBandwidthLimit"},{type:"doc",id:"api/web/type-aliases/TrackId",label:"TrackId"},{type:"doc",id:"api/web/type-aliases/TrackMiddleware",label:"TrackMiddleware"},{type:"doc",id:"api/web/type-aliases/TracksMiddleware",label:"TracksMiddleware"},{type:"doc",id:"api/web/type-aliases/TracksMiddlewareResult",label:"TracksMiddlewareResult"},{type:"doc",id:"api/web/type-aliases/UseInitializeDevicesParams",label:"UseInitializeDevicesParams"},{type:"doc",id:"api/web/type-aliases/UseSandboxProps",label:"UseSandboxProps"},{type:"doc",id:"api/web/variables/SimulcastConfig",label:"SimulcastConfig"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/versioned_docs/version-0.20.0/api/web/variables/SimulcastConfig.md b/versioned_docs/version-0.20.0/api/web/variables/SimulcastConfig.md deleted file mode 100644 index 180155b5..00000000 --- a/versioned_docs/version-0.20.0/api/web/variables/SimulcastConfig.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: SimulcastConfig - -> **SimulcastConfig**: `MessageFns`\<[`SimulcastConfig`](../interfaces/SimulcastConfig.md)\> - -Defined in: packages/ts-client/dist/index.d.mts:158 diff --git a/versioned_docs/version-0.20.0/explanation/_category_.json b/versioned_docs/version-0.20.0/explanation/_category_.json deleted file mode 100644 index d34d9b78..00000000 --- a/versioned_docs/version-0.20.0/explanation/_category_.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "label": "Explanation", - "position": 4, - "link": { - "type": "generated-index", - "title": "Explanation", - "description": "Big-picture explanations of higher-level Fishjam concepts. Most useful for building understanding of a particular topic.", - "slug": "/explanation" - }, - "collapsible": false -} diff --git a/versioned_docs/version-0.20.0/explanation/architecture.mdx b/versioned_docs/version-0.20.0/explanation/architecture.mdx deleted file mode 100644 index 6501ad92..00000000 --- a/versioned_docs/version-0.20.0/explanation/architecture.mdx +++ /dev/null @@ -1,91 +0,0 @@ ---- -type: explanation -sidebar_position: 2 ---- - -# Fishjam Architecture - -_Understanding how Fishjam works under the hood_ - -This document explains the technical architecture of Fishjam and how data flows through the system. - -## High-level Architecture - -Streaming with Fishjam is simple: you create a room, add peers to it, and start streaming. Below is a high-level overview of how Fishjam works. - -![Fishjam Data Flow](@site/static/img/architecture.svg) - -## Components Overview - -### 1. Your Backend Server - -Your application's backend server is responsible for: - -- Authenticating users -- Creating rooms using Fishjam Server SDKs -- Generating peer tokens for clients -- Managing room lifecycle and permissions - -### 2. Fishjam Media Server - -The Fishjam Media Server is the core infrastructure component that: - -- Routes audio and video streams between participants -- Handles WebRTC negotiations and connections -- Manages different room types (conference, audio-only, livestream) -- Processes and transcodes media when needed -- Enforces security policies and token validation - -### 3. Client Applications - -Client applications (React Native, React) use Fishjam Client SDKs to: - -- Connect to rooms using peer tokens -- Send and receive audio/video streams -- Handle device management (cameras, microphones) -- Manage connection state and reconnections - -## Data Flow - -### 1. Room Creation Flow - -```mermaid -sequenceDiagram - participant FM as Fishjam Media Server - participant BE as Your Backend - participant Client as Client App - - Client->>BE: Request to join room - BE->>FM: Create room (Server SDK) - FM->>BE: Return room ID - BE->>FM: Create peer (Server SDK) - FM->>BE: Return peer token - BE->>Client: Send peer token + Fishjam URL -``` - -### 2. Media Streaming Flow - -```mermaid -sequenceDiagram - participant C1 as Client 1 - participant FM as Fishjam Media Server - participant C2 as Client 2 - - C1->>FM: Connect with peer token - C2->>FM: Connect with peer token - C1->>FM: Send video/audio stream - FM->>C2: Route stream to other peers - C2->>FM: Send video/audio stream - FM->>C1: Route stream to other peers -``` - -## Next Steps - -To understand different room types in detail, see [Room Types Explained](../explanation/room-types). - -To learn about security and token management, see [Security & Token Model](../explanation/security-tokens). - -Ready to implement? Start with our tutorials: - -- [React Native Quick Start](../tutorials/react-native-quick-start) -- [Backend Quick Start](../tutorials/backend-quick-start) diff --git a/versioned_docs/version-0.20.0/explanation/glossary.md b/versioned_docs/version-0.20.0/explanation/glossary.md deleted file mode 100644 index dd92e57c..00000000 --- a/versioned_docs/version-0.20.0/explanation/glossary.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -type: reference ---- - -# Glossary - -A brief walk-through of the terms we use in the documentation. - -### Room - -A collection of peers that can send and receive video/audio to and from other peers. - -### Peer - -A user that is connected to a room. Each peer has some associated metadata and tracks. - -### Track - -A single stream of video or audio from a peer. It could be a camera view, shared screen, or microphone audio. Each peer can stream multiple tracks. - -### Management Token - -A secret token that should be stored on your backend. It allows you to create rooms and add peers. - -### Peer Token - -A token that your backend should pass to end clients to allow access to a specific room. - -### Fishjam ID - -The ID of your Fishjam instance. It is used by your backend server to add peers to rooms (and create rooms). It is also used by end client apps to join rooms. - -### Sandbox API - -A simple testing API allowing you to test Fishjam features without requiring you to add any functionalities to your backend. As the name suggests, it's available **only** in the Sandbox environment. You can find more details [here](/how-to/features/sandbox-api-testing). diff --git a/versioned_docs/version-0.20.0/explanation/public-livestreams.mdx b/versioned_docs/version-0.20.0/explanation/public-livestreams.mdx deleted file mode 100644 index 6dc1032c..00000000 --- a/versioned_docs/version-0.20.0/explanation/public-livestreams.mdx +++ /dev/null @@ -1,224 +0,0 @@ ---- -type: explanation -title: Private vs Public Livestreams -sidebar_position: 5 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# Private vs Public Livestreams - -:::info -This explanation only applies to Fishjam rooms with type `livestream`. -::: - -When livestreaming with Fishjam, you can chose to make your livestream `private` or `public`. -By default, created livestreams are `private`, to prevent possible bugs. - - - - - ```ts - const fishjamId = ''; - const managementToken = ''; - - // ---cut--- - import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; - - const fishjamClient = new FishjamClient({ - fishjamId, - managementToken, - }); - - const privateRoom = await fishjamClient.createRoom({ roomType: 'livestream' }); // [!code highlight] - const publicRoom = await fishjamClient.createRoom({ roomType: 'livestream', public: true }); // [!code highlight] - ``` - - - - - - ```python - from fishjam import FishjamClient - - fishjam_client = FishjamClient( - fishjam_id=fishjam_id, - management_token=management_token, - ); - - private_room = fishjam_client.create_room(room_type="livestream") # [!code highlight] - public_room = fishjam_client.create_room(room_type="livestream", public=True) # [!code highlight] - ``` - - - - -The choice you make affects how **viewers** connect to the livestream and has no effect on streamers. - -## Private livestreams - -When you create a private livestream, viewers are required to provide a viewer token when connecting to the livestream. - -This aims to provide control over who can view a livestream, but requires you to distribute tokens from your backend application to your frontend applications. - -### Creating a viewer token - -Below we show how you would create a livestream viewer token in a production scenario, with your own backend. -Note that for development purposes, you can [use the Sandbox API to generate a viewer token](../tutorials/livestreaming#obtaining-a-token-1). - - - - - ```ts - const fishjamId = ''; - const managementToken = ''; - - // ---cut--- - import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; - - const fishjamClient = new FishjamClient({ - fishjamId, - managementToken, - }); - - - const privateRoom = await fishjamClient.createRoom({ roomType: 'livestream' }); - const { token: viewerToken } = await fishjamClient.createLivestreamViewerToken(privateRoom.id); // [!code highlight] - ``` - - - - - - ```python - from fishjam import FishjamClient - - fishjam_client = FishjamClient( - fishjam_id=fishjam_id, - management_token=management_token, - ); - - private_room = fishjam_client.create_room(room_type="livestream") - viewer_token = fishjam_client.create_livestream_viewer_token(private_room.id) # [!code highlight] - ``` - - - - -### Connecting to a private room - -Once you've created a viewer token, you can connect to a room using the Fishjam client SDKs (examples below), or alternatively you can use [WHEP](../how-to/features/whip-whep#private-livestreams). - - - - - ```tsx - const viewerToken = ''; - - // ---cut--- - import { useLivestreamViewer } from '@fishjam-cloud/react-client'; - - // ... - - const { connect, stream } = useLivestreamViewer(); - - // ... - - await connect({ token: viewerToken }); - // after connecting stream will be available - ``` - - - - - - ```tsx - import React from 'react'; - - const viewerToken = ''; - - // ---cut--- - import { - LivestreamViewer, - useLivestreamViewer, - } from '@fishjam-cloud/react-native-client'; - - // ... - - const { connect } = useLivestreamViewer(); - - // ... - - await connect({ token: viewerToken }); - - // Use `LivestreamViewer` to render the stream - - ``` - - - - -## Public livestreams - -Public livestreams simplify the viewing process by omitting the viewer token. -All a viewer needs to view a public livestream is the ID of the room, so your backend doesn't need to manage the creation and distribution of viewer tokens. - -Note however, that public livestreams are _not suitable for all use-cases_. - -For example, if you are developing an app, which includes exclusive live content that requires a subscription to view, then you will want to authorize viewers before allowing them to view a livestream. -Failing to do so may result in extra costs, as livestreams are billed per-viewer. -Such an application will benefit from the token-based authorization in [private livestreams](#private-livestreams). - -### Connecting to a public room - -Once you've created a room of type `livestream` with the `public` flag enabled, you may start connecting viewers to the stream via the Fishjam client SDKs or [WHEP](../how-to/features/whip-whep#public-livestreams). - - - - - ```tsx - const roomId = ''; - - // ---cut--- - import { useLivestreamViewer } from '@fishjam-cloud/react-client'; - - // ... - - const { connect, stream } = useLivestreamViewer(); - - // ... - - await connect({ streamId: roomId }); - // after connecting `stream` will be available - ``` - - - - - - ```tsx - import React from 'react'; - - const roomId = ''; - - // ---cut--- - import { - LivestreamViewer, - useLivestreamViewer, - } from '@fishjam-cloud/react-native-client'; - - // ... - - const { connect } = useLivestreamViewer(); - - // ... - - await connect({ streamId: roomId }); - - // Use `LivestreamViewer` to render the stream - - ``` - - - diff --git a/versioned_docs/version-0.20.0/explanation/room-types.mdx b/versioned_docs/version-0.20.0/explanation/room-types.mdx deleted file mode 100644 index 2257dd72..00000000 --- a/versioned_docs/version-0.20.0/explanation/room-types.mdx +++ /dev/null @@ -1,130 +0,0 @@ ---- -type: explanation -sidebar_position: 3 ---- - -# Room Types Explained - -_Understanding different types of rooms and when to use them_ - -Fishjam provides three distinct room types, each optimized for different use cases and scenarios. -Understanding these room types helps you choose the right approach for your application. - -## Conference Rooms (Default) - -### What are Conference Rooms? - -Conference rooms are the default room type designed for multi-participant video conferencing scenarios. They support all Fishjam features and provide the most flexibility. - -### Key Characteristics - -- **Multi-participant**: Support for many participants simultaneously -- **Bidirectional media**: All participants can send and receive video/audio -- **Multiple sources**: Participants can share their camera, screen, microphone and more all at once -- **Flexible track management**: Participants can add/remove tracks dynamically - -### Best Use Cases - -- **Video conferencing applications** -- **Interactive webinars** with participant engagement - -### Cost Considerations - -Conference rooms are priced based on total connection time of all peers. - -## Audio-only Rooms - -### What are Audio-only Rooms? - -Audio-only rooms are optimized specifically for voice communication, removing video capabilities to improve performance and reduce costs. - -### Key Characteristics - -- **Voice-only communication**: No video tracks allowed -- **Cheap pricing**: Audio only rooms cost much less than other room types -- **Optimized network usage**: Works well in degraded network conditions - -### Best Use Cases - -- **Audio chat applications** -- **Podcast recording** with multiple participants -- **Large-scale audio events** (town halls, announcements) - -### Cost Benefits - -Audio-only rooms come at a **75% discount** compared to conference rooms: - -- 2 peers for 30 minutes = 60 minutes total time in conference room -- Same scenario in audio-only room = 15 minutes equivalent cost - -### Video Behavior in Audio-only Rooms - -If you attempt to add video to an audio-only room: - -- Video tracks are ignored (not transmitted) -- SDKs log warnings to help with debugging -- Only audio from screen sharing is transmitted -- No errors thrown, graceful degradation - -## Livestream Rooms - -### What are Livestream Rooms? - -Livestream rooms are designed for one-to-many livestreaming scenarios where a single streamer streams to multiple viewers. - -### Key Characteristics - -- **One sender**: Only one streamer can send media -- **Many receivers**: Unlimited viewers can watch -- **Optimized for scale**: Efficient distribution architecture - -### Livestreaming Limitations - -- **Single video track**: Only one video stream allowed -- **Single audio track**: Only one audio stream allowed -- **Additional tracks ignored**: Extra tracks are not forwarded to viewers - -### Viewer Experience - -- **Configurable access**: Livestreams can either be public, where anyone with the stream's ID can join, or private, where every viewer needs a token -- **Standard compatibility**: Any [WHEP](https://blog.swmansion.com/building-interactive-streaming-apps-webrtc-whip-whep-explained-d38f4825ec90)-compatible player works - -### Best Use Cases - -- **Live events** -- **Streaming platforms** and content distribution -- **Corporate livestreams** and announcements -- **Sports and entertainment** streaming - -### Cost Benefits - -Livestream rooms are **20% cheaper** than conference rooms for equivalent usage. - -## Choosing the Right Room Type - -### Decision Matrix - -| Use Case | Room Type | Why | -| ---------------------- | ---------- | ------------------------------------------- | -| Classic video meetings | Conference | Multiple video sources | -| Voice-only meetings | Audio-only | Cheapest and most performant option | -| Live Podcasts | Audio-only | Cheapest and most performant option | -| Sport streaming | Livestream | Highly scalable and cheaper than conference | -| Interactive workshop | Conference | Multiple video sources | - -## Next Steps - -To understand how to use each room type: - -- [How to implement livestreaming](../tutorials/livestreaming) -- [How to create audio-only calls](../how-to/features/audio-only-calls) - -To learn about the underlying architecture: - -- [Fishjam Architecture](../explanation/architecture) -- [Security & Token Model](../explanation/security-tokens) - -Ready to start building? Check our tutorials: - -- [React Native Quick Start](../tutorials/react-native-quick-start) -- [Backend Quick Start](../tutorials/backend-quick-start) diff --git a/versioned_docs/version-0.20.0/explanation/sandbox-api-concept.mdx b/versioned_docs/version-0.20.0/explanation/sandbox-api-concept.mdx deleted file mode 100644 index a54d5d85..00000000 --- a/versioned_docs/version-0.20.0/explanation/sandbox-api-concept.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -type: explanation -sidebar_position: 1 ---- - -# What is the Sandbox API? - -The Sandbox API is a development tool that simplifies getting started with Fishjam by providing a simple backend for testing, eliminating the need to build your own server initially. - -## What can the Sandbox API do? - -The Sandbox API is an HTTP server that comes with Fishjam's Sandbox environment. -It provides basic room creation and peer management functionality without requiring you to set up your own backend infrastructure. - -### Key Characteristics - -- **Development-purposed**: Designed for initial development and testing -- **No authentication**: Simplified access for quick prototyping -- **Sandbox-only**: Only available in the Sandbox environment - -## The Problem Sandbox API Solves - -When starting with videoconferencing or livestreaming development, you typically need: - -1. A **Backend server** to create rooms -2. An **Authentication system** to manage users -3. **Token management** for secure peer access -4. **API endpoints** for your frontend to call - -This creates a problem: to test your frontend, you need a backend, but during prototyping you want to focus on frontend development first. -The Sandbox API mitigates this issue and allows you to start frontend development ASAP. - -## Relationship to Server SDKs - -The Sandbox API is essentially a simplified application built using the Fishjam Server SDKs: - -```typescript -import { - FishjamClient, - RoomConfigRoomTypeEnum, -} from "@fishjam-cloud/js-server-sdk"; -import express from "express"; -const fishjamUrl = ""; -const managementToken = ""; -const app = express(); - -// ---cut--- -// What Sandbox API does internally (simplified) -const fishjamClient = new FishjamClient({ fishjamUrl, managementToken }); - -app.get("/", async (req: express.Request, res: express.Response) => { - const { roomName, peerName, roomType } = req.query; - - // Create or get room - const room = await fishjamClient.createRoom({ - roomType: roomType as RoomConfigRoomTypeEnum, - }); - - // Create or get peer - const { peer, peerToken } = await fishjamClient.createPeer(room.id); - - res.json({ peerToken, url: fishjamUrl }); -}); -``` - -This shows you exactly what your production backend needs to do, just with proper authentication and error handling. - -## See also - -To understand how to use The Sandbox API for development: - -- [How to use The Sandbox API for testing](../how-to/features/sandbox-api-testing) - -To learn about building your own backend: - -- [Backend Quick Start Tutorial](../tutorials/backend-quick-start) -- [How to set up your server](../how-to/backend/server-setup) - -To understand the security model: - -- [Security & Token Model](../explanation/security-tokens) diff --git a/versioned_docs/version-0.20.0/explanation/security-tokens.mdx b/versioned_docs/version-0.20.0/explanation/security-tokens.mdx deleted file mode 100644 index 42b628e9..00000000 --- a/versioned_docs/version-0.20.0/explanation/security-tokens.mdx +++ /dev/null @@ -1,122 +0,0 @@ ---- -type: explanation -sidebar_position: 4 ---- - -# Security & Token Model - -_Understanding Fishjam's security architecture and token system_ - -Fishjam uses a token-based security model to ensure secure access control while keeping the developer experience simple. - -## Security Architecture Overview - -Fishjam's security is built on a **two-tier token system**: - -1. **Management Tokens**: For backend-to-Fishjam server communication -2. **Peer Tokens**: For client-to-Fishjam server communication - -This separation ensures that sensitive operations remain on your backend while allowing clients secure, limited access to media streaming. - -## Management Tokens - -### Purpose - -Management tokens provide your backend server with administrative access to Fishjam resources. They allow creating, managing, and deleting rooms and peers. - -### Characteristics - -- **Long-lived**: Management tokens remain valid until manually regenerated -- **High privilege**: Management tokens allow performing administrative operations and should only be used in backend applications. -- **Backend-only**: Management tokens should never be sent to client applications. -- **Environment-specific**: There are different tokens for sandbox and production. - -### What Management Tokens Can Do - -Management tokens give permission to: - -- Create and manage rooms and peers -- Setup [webhooks](../how-to/backend/server-setup#webhooks) -- Set [immutable peer metadata](../how-to/backend/server-setup#metadata) - -## Peer Tokens - -### Purpose - -Peer tokens provide client applications with limited, time-bound access to join a specific room as a specific peer. - -### Characteristics - -- **Short-lived**: Peer tokens expire 24h after creation. -- **Scope-limited**: Peer tokens give access to one specific room as one specific peer only. -- **Client-safe**: Peer tokens are safe to send to frontend applications. - -### What Peer Tokens Can Do - -Peer tokens give permission to: - -- Connect to the specific room they were issued for -- Participate in room activities (audio/video/screen sharing) -- Access peer metadata and room state - -### What Peer Tokens Cannot Do - -- Create or delete rooms -- Access multiple rooms -- Add or remove peers - -### Generation Process - -```typescript -import { FishjamClient, RoomId } from "@fishjam-cloud/js-server-sdk"; -import express from "express"; -const res = {} as any; -const fishjamUrl = ""; -const managementToken = ""; -const roomId = "" as unknown as RoomId; -const fishjamClient = new FishjamClient({ fishjamUrl, managementToken }); - -// ---cut--- -// Backend generates peer token (using management token) -const { peer, peerToken } = await fishjamClient.createPeer(roomId, { - metadata: { name: "John Doe", userId: "user-123" }, -}); - -// Backend sends peer token to client -res.json({ - peerToken, // Client uses this to connect - fishjamUrl, // Fishjam server URL - roomId, // Room information -}); -``` - -### Client Usage - -```typescript -import { useConnection } from "@fishjam-cloud/react-client"; -const joinRoom = {} as any; -const fishjamUrl = ""; -const peerToken = ""; - -// ---cut--- -// Client uses peer token to connect (safe to use in frontend) -await joinRoom({ - url: fishjamUrl, - peerToken: peerToken, // This is safe in client code -}); -``` - -## Next Steps - -To implement secure authentication: - -- [Backend Quick Start Tutorial](../tutorials/backend-quick-start) -- [How to set up your server](../how-to/backend/server-setup) - -To understand the broader architecture: - -- [Fishjam Architecture](../explanation/architecture) - -To learn about the Sandbox API's security limitations: - -- [Understanding the Sandbox API](../explanation/sandbox-api-concept) diff --git a/versioned_docs/version-0.20.0/explanation/what-is-fishjam.mdx b/versioned_docs/version-0.20.0/explanation/what-is-fishjam.mdx deleted file mode 100644 index a2e80309..00000000 --- a/versioned_docs/version-0.20.0/explanation/what-is-fishjam.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -type: explanation -sidebar_position: 0 ---- - -# What is Fishjam? - -_Understanding the role and purpose of Fishjam_ - -Fishjam is a multimedia streaming toolkit that allows you to build real-time video and audio streaming applications. -It uses [WebRTC](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API) under the hood to ensure sub-second (in most cases **less than 300ms**) latency. -We provide the infrastructure, media server, and client SDKs so you can focus on building your apps. - -**No WebRTC knowledge is required!** - -## The Problem Fishjam Solves - -Building real-time video and audio applications is complex. Developers typically need to: - -- Set up and manage WebRTC infrastructure -- Handle complex peer-to-peer networking -- Manage media servers and scaling -- Deal with different devices and codec compatibility -- Implement secure token-based authentication - -Fishjam abstracts away this complexity, providing a simple API and managed infrastructure. - -## What Fishjam Provides - -Fishjam consists of several components that work together to provide a seamless multimedia streaming experience: - -| Component | Description | -| --------------------- | ------------------------------------------------------------------------------------------------------- | -| Developer panel | The place to access your credentials and manage your Fishjam usage. | -| Fishjam Media Servers | Media servers route your multimedia traffic. We host and manage them for you. | -| Fishjam Client SDKs | Toolkit used for multimedia integration on endpoint devices. | -| Fishjam Server SDKs | Toolkit for integrating your backend with Fishjam. We currently support Python and NodeJS. | -| Sandbox API | Simple backend for creating test rooms. You can test Fishjam without having to set up your own backend. | - -## Use Cases - -Fishjam is ideal for: - -### Video Conferencing - -Build videoconferencing applications with multiple participants in rooms, screen sharing, and audio/video. - -### Livestreaming - -Stream live content from one streamer to many viewers with low latency. -Perfect for live events or streaming platforms. - -### Audio-only Applications - -Create voice-only experiences like audio conferencing, podcasts, or voice chat applications. - -## Next Steps - -To understand how Fishjam works technically, see [Fishjam Architecture](../explanation/architecture). - -To learn about the different types of rooms available, see [Room Types Explained](../explanation/room-types). - -Ready to start building? Check out our tutorials: - -- [React Native Quick Start](../tutorials/react-native-quick-start) -- [React Quick Start](../tutorials/react-quick-start) -- [Backend Quick Start](../tutorials/backend-quick-start) diff --git a/versioned_docs/version-0.20.0/how-to/_category_.json b/versioned_docs/version-0.20.0/how-to/_category_.json deleted file mode 100644 index a932906d..00000000 --- a/versioned_docs/version-0.20.0/how-to/_category_.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "label": "How-to Guides", - "position": 3, - "link": { - "type": "generated-index", - "title": "How-to Guides", - "description": "Practical step-by-step guides to help you achieve a specific goal. Most useful when you're trying to get something done.", - "slug": "/how-to" - }, - "collapsible": false -} diff --git a/versioned_docs/version-0.20.0/how-to/_common/metadata/header.mdx b/versioned_docs/version-0.20.0/how-to/_common/metadata/header.mdx deleted file mode 100644 index 1602f006..00000000 --- a/versioned_docs/version-0.20.0/how-to/_common/metadata/header.mdx +++ /dev/null @@ -1,10 +0,0 @@ -Alongside audio and video, it is possible to send additional metadata with each peer. Metadata is just -JSON that can contain arbitrary information. Its most common use is sending a user name associated with a peer. -However, it can be also used to send the peer's camera type, application information etc. - -:::info - -You can also set metadata on [the server side, when adding user to the room](../backend/server-setup#metadata). This metadata is persistent throughout its lifetime and is useful for attaching information that -can't be overwritten by the peer, like information about real user names or basic permission info. - -::: diff --git a/versioned_docs/version-0.20.0/how-to/_common/metadata/joining_room.mdx b/versioned_docs/version-0.20.0/how-to/_common/metadata/joining_room.mdx deleted file mode 100644 index 517a5b30..00000000 --- a/versioned_docs/version-0.20.0/how-to/_common/metadata/joining_room.mdx +++ /dev/null @@ -1,5 +0,0 @@ -## Setting metadata when joining the room - -The `joinRoom` method from the `useConnection` hook has a `peerMetadata` parameter, that can be used for setting object metadata. - -{props.children} diff --git a/versioned_docs/version-0.20.0/how-to/_common/metadata/reading.mdx b/versioned_docs/version-0.20.0/how-to/_common/metadata/reading.mdx deleted file mode 100644 index b0516650..00000000 --- a/versioned_docs/version-0.20.0/how-to/_common/metadata/reading.mdx +++ /dev/null @@ -1,9 +0,0 @@ -## Reading metadata - -Peer metadata is available as the `metadata` property for each peer. Therefore, when you list your peers with the `usePeers` hook, you can read -the metadata associated with them. -Note that the `metadata.peer` property contains only the metadata set by the client SDK (as in the examples examples above). -The metadata set on the server side is available as `metadata.server`. -Learn more about server metadata [here](../backend/server-setup#metadata). - -{props.children} diff --git a/versioned_docs/version-0.20.0/how-to/_common/metadata/updating.mdx b/versioned_docs/version-0.20.0/how-to/_common/metadata/updating.mdx deleted file mode 100644 index 97bd1a1b..00000000 --- a/versioned_docs/version-0.20.0/how-to/_common/metadata/updating.mdx +++ /dev/null @@ -1,5 +0,0 @@ -## Updating metadata during connection - -Once you've joined the room, you can update your peer metadata with the `updatePeerMetadata` method of the `useUpdatePeerMetadata` hook: - -{props.children} diff --git a/versioned_docs/version-0.20.0/how-to/backend/_category_.json b/versioned_docs/version-0.20.0/how-to/backend/_category_.json deleted file mode 100644 index 2d5af2e1..00000000 --- a/versioned_docs/version-0.20.0/how-to/backend/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Backend", - "position": 4 -} diff --git a/versioned_docs/version-0.20.0/how-to/backend/fastapi-example.mdx b/versioned_docs/version-0.20.0/how-to/backend/fastapi-example.mdx deleted file mode 100644 index de091849..00000000 --- a/versioned_docs/version-0.20.0/how-to/backend/fastapi-example.mdx +++ /dev/null @@ -1,99 +0,0 @@ ---- -sidebar_position: 1 -title: FastAPI ---- - -# FastAPI example - -The example assumes you've already installed [**our SDK**](https://github.com/fishjam-cloud/python-server-sdk) and you're ready to go. -If you wish to see more general info, visit [**Set up your server**](../../how-to/backend/server-setup) article. - -## Minimal setup - -The same way as in the [**FastAPI docs**](https://fastapi.tiangolo.com/tutorial/first-steps/), the code below can be copied and run immediately. -Just make sure you set `FISHJAM_URL` and `FISHJAM_MANAGEMENT_TOKEN` environment variables. -The `Depends` function allows the `FishjamClient` to be provided to the route function as a dependency, which avoids code duplication and allows easy mocking. - -```python -import os -from typing import Annotated -from fastapi import Depends, FastAPI -from fishjam import FishjamClient - - -app = FastAPI() - -def fishjam_client(): - fishjam_url = os.environ["FISHJAM_URL"] - management_token = os.environ["FISHJAM_MANAGEMENT_TOKEN"] - return FishjamClient(fishjam_url=fishjam_url, management_token=management_token) - - -@app.get("/") -async def get_rooms(fishjam_client: Annotated[FishjamClient, Depends(fishjam_client)]): - rooms = fishjam_client.get_all_rooms() - return {"rooms": rooms} -``` - -## Listening to events - -Fishjam instance is a stateful server that is emitting messages upon certain events. -You can listen for those messages and react as you prefer. -There are two options for obtaining these. - -### Webhooks - -To receive and parse Fishjam protobuf messages, create a dependable function that parses the request body using the `receive_binary` function from the `fishjam` package. -Then, you will be able to use pattern matching to respond to different kinds of events. - -```python -from fastapi import Depends, FastAPI, HTTPException, Request -from fishjam import receive_binary -from fishjam.events import ServerMessagePeerAdded - -app = FastAPI() - -async def parse_fishjam_message(request: Request): - binary = await request.body() - if message := receive_binary(binary): - return message - raise HTTPException(status_code=400, detail="Invalid Fishjam message") - -@app.post("/fishjam-webhook") -async def fishjam_webhook(fishjam_message = Depends(parse_fishjam_message)): - match fishjam_message: - case ServerMessagePeerAdded(): - print(f"Peer added: {fishjam_message.peer_id}") - case _: - ... -``` - -### SDK Notifier - -Use the `asyncio` library to run the SDK notifier. -It doesn't interact with the FastAPI library per se, just start the event loop and it will run alongside the server. - -```python -import asyncio -from fishjam import FishjamNotifier - -notifier = FishjamNotifier(server_address=fishjam_url, server_api_token=management_token) - -@notifier.on_server_notification -def handle_notification(notification): - match notification: - case ServerMessagePeerAdded(): - print(f"Peer added: {notification.peer_id}") - case _: - ... - -async def run_notifier(): - notifier_task = asyncio.create_task(notifier.connect()) - - # Wait for the notifier to be ready to receive messages - await notifier.wait_ready() - - await notifier_task - -asyncio.run(run_notifier()) -``` diff --git a/versioned_docs/version-0.20.0/how-to/backend/fastify-example.mdx b/versioned_docs/version-0.20.0/how-to/backend/fastify-example.mdx deleted file mode 100644 index c9193f7e..00000000 --- a/versioned_docs/version-0.20.0/how-to/backend/fastify-example.mdx +++ /dev/null @@ -1,240 +0,0 @@ ---- -sidebar_position: 0 -title: Fastify ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# Fastify example - -The example assumes you've already installed [**our SDK**](https://www.npmjs.com/package/@fishjam-cloud/js-server-sdk) and you're ready to go. -If you wish to see more general info, visit [**set up your server**](../../how-to/backend/server-setup) article. - -## Load environment variables to Fastify - -Use [`@fastify/env` package](https://github.com/fastify/fastify-env) to load and set environment variables in your Fastify instance. - -```ts title='main.ts' -import Fastify from "fastify"; -import fastifyEnv from "@fastify/env"; - -const fastify = Fastify(); - -const envSchema = { - type: "object", - required: ["FISHJAM_URL", "FISHJAM_MANAGEMENT_TOKEN"], - properties: { - FISHJAM_URL: { - type: "string", - }, - FISHJAM_MANAGEMENT_TOKEN: { - type: "string", - }, - }, -}; - -await fastify.register(fastifyEnv, { schema: envSchema }); - -fastify.listen({ port: 3000 }); -``` - -## Setup Fishjam Fastify plugin - -Fastify allows you to create plugins to encapsulate functionality in scopes. -Check out [fastify documentation](https://fastify.dev/docs/latest/Reference/Plugins) for a deeper understanding of the concept. - -First, extend the `FastifyInstance` interface with `fishjam` entry. -This will provide types of FishjamClient wherever you access `fastify.fishjam` in the codebase. -Then, declare the plugin by invoking the `fp` function with the setup function with as an argument. - -```ts title='fishjamPlugin.ts' -import fastifyPlugin from "fastify-plugin"; -import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; - -declare module "fastify" { - interface FastifyInstance { - fishjam: FishjamClient; - config: { - FISHJAM_URL: string; - FISHJAM_MANAGEMENT_TOKEN: string; - }; - } -} - -export const fishjamPlugin = fastifyPlugin((fastify) => { - const fishjamClient = new FishjamClient({ - fishjamUrl: fastify.config.FISHJAM_URL, - managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN, - }); - - fastify.decorate("fishjam", fishjamClient); -}); -``` - -Now, after registering the plugin, we will be able to use Fishjam client by accessing the `fastify.fishjam` property. - -```ts title='main.ts' -import fastifyPlugin from "fastify-plugin"; -import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; -import Fastify from "fastify"; - -declare module "fastify" { - interface FastifyInstance { - fishjam: FishjamClient; - config: { - FISHJAM_URL: string; - FISHJAM_MANAGEMENT_TOKEN: string; - }; - } -} - -export const fishjamPlugin = fastifyPlugin((fastify) => { - const fishjamClient = new FishjamClient({ - fishjamUrl: fastify.config.FISHJAM_URL, - managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN, - }); - - fastify.decorate("fishjam", fishjamClient); -}); - -const fastify = Fastify(); - -// ---cut--- -await fastify.register(fishjamPlugin); - -fastify.get("/rooms", () => fastify.fishjam.getAllRooms()); - -fastify.listen({ port: 3000 }); -``` - -## Listening to events - -Fishjam instance is a stateful server that is emitting messages upon certain events. -You can listen for those messages and react as you prefer. -There are two options to obtain these. - -### Webhooks - -To receive and parse the Fishjam protobuf messages, add a content type parser to your global (or scoped) Fastify instance. -Then, you will be able to access the parsed message at `request.Body`. - -```ts title='main.ts' -import Fastify, { FastifyRequest } from "fastify"; -import { ServerMessage } from "@fishjam-cloud/js-server-sdk/proto"; - -const fastify = Fastify(); - -fastify.addContentTypeParser( - "application/x-protobuf", - { parseAs: "buffer" }, - async (_: FastifyRequest, body: Buffer) => - ServerMessage.decode(new Uint8Array(body)), -); - -fastify.post<{ Body: ServerMessage }>("/fishjam-webhook", (request) => { - // handle the message - console.log(request.body); -}); -``` - -### SDK Notifier - -You can also leverage the Fastify plugin mechanism to use websockets to receive messages from Fishjam. -Let's create another plugin in `fishjamNotifierPlugin.ts` file. - -In this case, we don't need to extend the Fastify instance type, because the plugin doesn't decorate the Fastify instance with any properties. It will work in the background. - -```ts title='fishjamNotifierPlugin.ts' -import fastifyPlugin from "fastify-plugin"; -import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; -import Fastify from "fastify"; - -declare module "fastify" { - interface FastifyInstance { - fishjam: FishjamClient; - config: { - FISHJAM_URL: string; - FISHJAM_MANAGEMENT_TOKEN: string; - }; - } -} - -export const fishjamPlugin = fastifyPlugin((fastify) => { - const fishjamClient = new FishjamClient({ - fishjamUrl: fastify.config.FISHJAM_URL, - managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN, - }); - - fastify.decorate("fishjam", fishjamClient); -}); - -const fastify = Fastify(); - -// ---cut--- -import { type FastifyInstance } from "fastify"; -import fp from "fastify-plugin"; -import { FishjamWSNotifier } from "@fishjam-cloud/js-server-sdk"; - -export const fishjamNotifierPlugin = fp((fastify) => { - const fishjamUrl = fastify.config.FISHJAM_URL; - const managementToken = fastify.config.FISHJAM_MANAGEMENT_TOKEN; - - const fishjamNotifier = new FishjamWSNotifier( - { fishjamUrl, managementToken }, - (err) => fastify.log.error(err), - () => fastify.log.info("Websocket connection to Fishjam closed"), - () => fastify.log.error("Failed to connect Fishjam notifier"), - ); - - // handle the messages - const handleRoomCreated = console.log; - const handlePeerAdded = console.log; - - fishjamNotifier.on("roomCreated", handleRoomCreated); - fishjamNotifier.on("peerAdded", handlePeerAdded); -}); -``` - -Don't forget to register your plugin. - -```ts title='main.ts' -import fastifyPlugin from "fastify-plugin"; -import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; -import Fastify from "fastify"; -import { FishjamWSNotifier } from "@fishjam-cloud/js-server-sdk"; - -declare module "fastify" { - interface FastifyInstance { - fishjam: FishjamClient; - config: { - FISHJAM_URL: string; - FISHJAM_MANAGEMENT_TOKEN: string; - }; - } -} - -export const fishjamPlugin = fastifyPlugin((fastify) => { - const fishjamClient = new FishjamClient({ - fishjamUrl: "aaa", - managementToken: "bbb", - }); - - fastify.decorate("fishjam", fishjamClient); -}); - -const fastify = Fastify(); - -const fishjamNotifierPlugin = fastifyPlugin((fastify) => { - const fishjamNotifier = new FishjamWSNotifier( - { fishjamUrl: "aaa", managementToken: "bbb" }, - (err) => fastify.log.error(err), - () => fastify.log.info("Websocket connection to Fishjam closed"), - () => fastify.log.error("Failed to connect Fishjam notifier"), - ); -}); - -// ---cut--- -await fastify.register(fishjamPlugin); -await fastify.register(fishjamNotifierPlugin); -``` diff --git a/versioned_docs/version-0.20.0/how-to/backend/production-deployment.mdx b/versioned_docs/version-0.20.0/how-to/backend/production-deployment.mdx deleted file mode 100644 index 4dc43dc2..00000000 --- a/versioned_docs/version-0.20.0/how-to/backend/production-deployment.mdx +++ /dev/null @@ -1,300 +0,0 @@ ---- -type: how-to ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# How to Deploy Fishjam to Production - -**How-to Guide** - _Deploy your Fishjam backend safely to production_ - -This guide covers the essential steps to move from development (using the Sandbox API) to a production-ready Fishjam backend deployment. - -## Prerequisites - -- Working Fishjam backend (see [Backend Quick Start](../../tutorials/backend-quick-start)) -- Production Fishjam environment (not Sandbox) -- Domain and SSL certificates for your backend -- Production database and infrastructure - -## Step 1: Set up production Fishjam environment - -### Get production credentials - -1. Log in to [Fishjam Dashboard](https://fishjam.io/app) -2. Create or select your **Production** environment (not Sandbox) -3. Copy your production **Fishjam URL** and **Management Token** -4. Note: These are different from your sandbox credentials - -### Environment variables setup - -Create production environment variables: - -```bash -# Production Fishjam credentials -FISHJAM_URL="your-production-fishjam-url" -FISHJAM_MANAGEMENT_TOKEN="your-production-management-token" - -# Your application settings -NODE_ENV="production" -PORT="3000" -DATABASE_URL="your-production-database-url" - -# Security settings -JWT_SECRET="your-secure-jwt-secret" -CORS_ORIGIN="https://yourdomain.com" -``` - -## Step 2: Implement proper authentication - -### Replace Sandbox API calls - -Remove any Sandbox API dependencies from your client code: - -```typescript -// @noErrors: 2451 -import { useSandbox } from "@fishjam-cloud/react-client"; -import express from "express"; - -const authenticateUser = {} as any; -const app = express(); - -const { getSandboxPeerToken } = useSandbox(); - -const userToken = ""; -const roomName = ""; -const userName = ""; - -// ---cut--- -// ❌ Remove: Sandbox API calls -const peerToken = await getSandboxPeerToken(roomName, userName); - -// ✅ Replace with: Your authenticated API -const response = await fetch("https://your-backend.com/api/join-room", { - method: "POST", - headers: { - "Content-Type": "application/json", - Authorization: `Bearer ${userToken}`, - }, - body: JSON.stringify({ roomName, userName }), -}); -``` - -### Implement user authentication - -```typescript -// @noErrors: 2339 -const jwt = {} as any; -import { FishjamClient, Room } from "@fishjam-cloud/js-server-sdk"; -import express from "express"; - -const app = express(); -const getUserById = async (userId: string) => ({ - id: userId, - name: "User", - avatar: "", - role: "user", -}); -const getOrCreateRoom = async (roomName: string) => - ({ id: "room-id" }) as unknown as Room; -const canUserJoinRoom = (user: any, room: any) => true; -process.env.FISHJAM_URL = ""; -process.env.FISHJAM_MANAGEMENT_TOKEN = ""; -process.env.JWT_SECRET = ""; - -// ---cut--- -const fishjamClient = new FishjamClient({ - fishjamUrl: process.env.FISHJAM_URL!, - managementToken: process.env.FISHJAM_MANAGEMENT_TOKEN!, -}); - -// Authentication middleware -const authenticateUser = async ( - req: express.Request, - res: express.Response, - next: express.NextFunction, -) => { - try { - const token = req.headers.authorization?.replace("Bearer ", ""); - if (!token) { - return res.status(401).json({ error: "Authentication required" }); - } - - const decoded = jwt.verify(token, process.env.JWT_SECRET); - req.user = await getUserById(decoded.userId); - next(); - } catch (error) { - res.status(401).json({ error: "Invalid token" }); - } -}; - -// Protected endpoint for joining rooms -app.post("/api/join-room", authenticateUser, async (req, res) => { - try { - const { roomName } = req.body; - const user = req.user; - - // Create or get room - const room = await getOrCreateRoom(roomName); - - // Verify user has permission to join this room - if (!canUserJoinRoom(user, room)) { - return res.status(403).json({ error: "Access denied" }); - } - - // Create peer with user metadata - const { peer, peerToken } = await fishjamClient.createPeer(room.id, { - metadata: { - userId: user.id, - name: user.name, - avatar: user.avatar, - role: user.role, - }, - }); - - res.json({ - peerToken, - fishjamUrl: process.env.FISHJAM_URL, - }); - } catch (error) { - console.error("Join room error:", error); - res.status(500).json({ error: "Failed to join room" }); - } -}); -``` - -## (Optional) Step 3: Handle webhooks and events - -You may wish to receive events from Fishjam regarding created rooms and peers. -All you need for this is a single api endpoint: - -### Webhook endpoint - -```typescript -import express from "express"; -const crypto = {} as any; -const app = express(); - -const handlePeerConnected = {} as any; -const handlePeerDisconnected = {} as any; -const handleRoomEmpty = {} as any; - -// ---cut--- -// Webhook signature verification -const verifyWebhookSignature = ( - req: express.Request, - res: express.Response, - next: express.NextFunction, -) => { - const signature = req.headers["x-fishjam-signature"]; - const payload = JSON.stringify(req.body); - - const expectedSignature = crypto - .createHmac("sha256", process.env.WEBHOOK_SECRET) - .update(payload, "utf8") - .digest("hex"); - - if (signature !== expectedSignature) { - return res.status(401).json({ error: "Invalid signature" }); - } - - next(); -}; - -// Webhook handler -app.post( - "/api/webhooks/fishjam", - express.raw({ type: "application/json" }), - verifyWebhookSignature, - (req: express.Request, res: express.Response) => { - const event = req.body; - - switch (event.type) { - case "peer_connected": - handlePeerConnected(event.data); - break; - case "peer_disconnected": - handlePeerDisconnected(event.data); - break; - case "room_empty": - handleRoomEmpty(event.data); - break; - default: - console.log("Unhandled event type:", event.type); - } - - res.status(200).json({ received: true }); - }, -); -``` - -### Enabling webhooks - -Now, with your endpoint setup, all you need to do is supply your webhook endpoint to Fishjam when creating a room: - -```typescript -import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; -const fishjamClient = {} as any; - -// ---cut--- -const createRoomWithWebhooks = async ( - roomName: string, - roomType = "conference", -) => { - const room = await fishjamClient.createRoom({ - roomType, - webhookUrl: `${process.env.BASE_URL}/api/webhooks/fishjam`, - }); - - return room; -}; -``` - -## Common production issues - -### Issue: Token expiration handling - -Peer tokens expire 24h after creation. -We encourage keeping room and peer lifetimes as short as possible -(typically a single room corresponds to a single video call or stream). -However, if you wish to reuse a single peer over multiple days, you can make use of token refreshing: - - - - - ```ts - import { FishjamClient, RoomId, PeerId } from "@fishjam-cloud/js-server-sdk"; - const fishjamClient = new FishjamClient({ - fishjamUrl: "", - managementToken: "", - }); - const roomId = "" as RoomId; - const peerId = "" as PeerId; - - // ---cut--- - const newToken = fishjamClient.refreshPeerToken(roomId, peerId); - ``` - - - - - - ```python - new_token = fishjam_client.refresh_peer_token(room_id, peer_id) - ``` - - - - -## See also - -For scaling considerations: - -- [Understanding Fishjam Architecture](../../explanation/architecture) -- [Security best practices](../../explanation/security-tokens) - -For specific backend frameworks: - -- [FastAPI example](../../how-to/backend/fastapi-example) -- [Fastify example](../../how-to/backend/fastify-example) diff --git a/versioned_docs/version-0.20.0/how-to/backend/server-setup.mdx b/versioned_docs/version-0.20.0/how-to/backend/server-setup.mdx deleted file mode 100644 index a188e8e2..00000000 --- a/versioned_docs/version-0.20.0/how-to/backend/server-setup.mdx +++ /dev/null @@ -1,295 +0,0 @@ ---- -sidebar_position: 0 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# Set up your server - -## Install the SDK - -Install the SDK for the language of your choice. We provide libraries for [**Node**](https://github.com/fishjam-cloud/js-server-sdk) and [**Python**](https://github.com/fishjam-cloud/python-server-sdk). -It's also possible to use the bare REST API, in this case you can skip this step. - - - - - ```bash - npm install @fishjam-cloud/js-server-sdk - ``` - - - - - - ```bash - yarn add @fishjam-cloud/js-server-sdk - ``` - - - - - - ```bash - pip install fishjam-server-sdk - ``` - - - - - - ```bash - poetry add fishjam-server-sdk - ``` - - - - -## Setup your client - -Let's setup everything you need to start communicating with a Fishjam instance. -First of all, view your app in the [**Fishjam developer panel**](https://fishjam.io/app) and copy your **Fishjam URL** and the **Management Token**. -They are required to proceed. Now, we are ready to dive into the code. - - - - - ```ts - process.env.FISHJAM_URL = "https://fishjam.io"; - process.env.FISHJAM_MANAGEMENT_TOKEN = "bbb"; - - // ---cut--- - import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; - - const fishjamUrl = process.env.FISHJAM_URL; - const managementToken = process.env.FISHJAM_MANAGEMENT_TOKEN; - - const fishjamClient = new FishjamClient({ fishjamUrl, managementToken }); - ``` - - - - - - ```python - import os - from fishjam import FishjamClient - - fishjam_url = os.environ["FISHJAM_URL"] - management_token = os.environ["FISHJAM_MANAGEMENT_TOKEN"] - - fishjam_client = FishjamClient(fishjam_url, management_token) - ``` - - - - -### Managing rooms - -Create a room to get the `roomId` and be able to start adding peers. - - - - - ```ts - import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; - const fishjamClient = new FishjamClient({ - - fishjamUrl: "https://fishjam.io", - managementToken: "bbb", - }); - // ---cut--- - const createdRoom = await fishjamClient.createRoom(); - - const theSameRoom = await fishjamClient.getRoom(createdRoom.id); - - await fishjamClient.deleteRoom(theSameRoom.id) - - // puff, it's gone! - ``` - - - - - - ```python - created_room = fishjam_client.create_room() - - the_same_room = fishjam_client.get_room(created_room.id) - - fishjam_client.delete_room(the_same_room.id) - - # puff, it's gone! - ``` - - - - - -### Managing peers - -Create a peer to obtain the peer token allowing your user to join the room. -At any time you can terminate user's access by deleting the peer. - - - - - ```ts - import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; - const fishjamClient = new FishjamClient({ - fishjamUrl: "https://fishjam.io", - managementToken: "bbb", - }); - const created_room = await fishjamClient.createRoom(); - // ---cut--- - const { peer, peerToken } = await fishjamClient.createPeer(created_room.id); - - await fishjamClient.deletePeer(created_room.id, peer.id); - ``` - - - - - - ```python - peer, token = fishjam_client.create_peer(room_id) - - fishjam_client.delete_peer(room_id, peer.id) - ``` - - - - - -#### Metadata - -When creating a peer, you can also assign metadata to that peer, which can be read later with the [mobile SDK](../../how-to/react-native/metadata-and-broadcasting) -or [web SDK](../../how-to/react/metadata). This metadata can be only set when creating the peer and can't be updated later. - - - - - ```ts - import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; - const fishjamClient = new FishjamClient({ - fishjamUrl: "https://fishjam.io", - managementToken: "bbb", - }); - const created_room = await fishjamClient.createRoom(); - // ---cut--- - const { peer, peerToken } = await fishjamClient.createPeer(created_room.id, { - metadata: { realName: 'Tom Reeves' }, - }); - ``` - - - - - - ```py - options = PeerOptions( - metadata={"realName": "Tom Reeves"}, - ) - peer, token = self.fishjam_client.create_peer(room_id, options=options) - ``` - - - - -## Listening to events - -Fishjam instance is a stateful server that is emitting messages upon certain events. -You can listen for those messages and react as you prefer. -There are two options to obtain these. - -### Webhooks - -Simply pass the your webhook url as a `webhookUrl` parameter when creating a room. - - - - - ```ts - import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; - - const fishjamClient = new FishjamClient({ - fishjamUrl: "https://fishjam.io", - managementToken: "bbb", - }); - // ---cut--- - const webhookUrl = "https://example.com/"; - await fishjamClient.createRoom({ webhookUrl }); - ``` - - - - - - ```python - from fishjam import RoomOptions - - options = RoomOptions(webhook_url="https://example.com/") - - fishjam_client.create_room(options) - ``` - - - - - -### SDK Notifier - -Our SDKs come equipped with a Notifier allowing you to subscribe for messages. -It sets up a websocket connection with a Fishjam instance and provides a simple interface allowing you to handle messages. - - - - - ```ts - const fishjamUrl = "https://fishjam.io"; - const managementToken = "bbb"; - // ---cut--- - import { FishjamWSNotifier } from '@fishjam-cloud/js-server-sdk'; - - const onClose = console.log; - const onError = console.error; - const onConnectionFailed = console.error; - - const fishjamNotifier = new FishjamWSNotifier({ fishjamUrl, managementToken }, onError, onClose, onConnectionFailed); - - fishjamNotifier.on('roomCreated', console.log); - ``` - - - - - - ```python - import asyncio - from fishjam import FishjamNotifier - - notifier = FishjamNotifier(server_address=fishjam_url, server_api_token=management_token) - - @notifier.on_server_notification - def handle_notification(notification): - match notification: - case ServerMessageRoomCreated(): - print(notification) - case _: - ... - - async def run_notifier(): - notifier_task = asyncio.create_task(notifier.connect()) - - # Wait for notifier to be ready to receive messages - await notifier.wait_ready() - - await notifier_task - - asyncio.run(run_notifier()) - ``` - - - - diff --git a/versioned_docs/version-0.20.0/how-to/features/_category_.json b/versioned_docs/version-0.20.0/how-to/features/_category_.json deleted file mode 100644 index 4aaeb074..00000000 --- a/versioned_docs/version-0.20.0/how-to/features/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Features", - "position": 3 -} diff --git a/versioned_docs/version-0.20.0/how-to/features/audio-only-calls.mdx b/versioned_docs/version-0.20.0/how-to/features/audio-only-calls.mdx deleted file mode 100644 index 7fb48a2d..00000000 --- a/versioned_docs/version-0.20.0/how-to/features/audio-only-calls.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -type: how-to ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# Audio-only Calls - -**How-to Guide** - _Set up voice-only communication with cost savings_ - -In many use cases, you only need real-time audio, without any video streaming. -If your use case falls into this category, then you can benefit greatly from using `audio_only` rooms in Fishjam. - -## Why Should I Care? - -Audio-only rooms are heavily discounted compared to normal rooms. -As described in more detail on the [pricing page](https://fishjam.io/#pricing), Fishjam rooms are priced based on the total connection time of peers in them. -Audio-only rooms come at a 75% discount. -For example, if you have a normal room with 2 peers connected for 30 minutes, then the total cost of the room will be equal to the cost of 60 minutes. -If the same room were audio-only, then the final cost of the room will only be equal to 15 minutes. - -## How Do I Use It? - -Using this feature is as easy as setting the `roomType` field to `audio_only` when creating a room using our [Server SDKs](../../how-to/backend/server-setup) - - - - - ```ts - import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; - const fishjamClient = new FishjamClient({ - fishjamUrl: "aaa", - managementToken: "bbb", - }); - // ---cut--- - const createdRoom = await fishjamClient.createRoom({ roomType: 'audio_only' }); - ``` - - - - - - ```python - options = RoomOptions(room_type="audio_only") - created_room = fishjam_client.create_room(options) - ``` - - - - -Now, you can connect peers normally to the room as described in our [React Native](../../how-to/react-native/connecting) and [React](../../how-to/react/connecting) docs. - -:::info -The React Native and React SDKs will log a warning in the console if any attempt to add video to an audio-only room is made. -This aims to assist in debugging, as adding video to an audio-only room does nothing and is most likely a mistake. -::: - -### Screen sharing - -If you attempt to screen share when connected to an `audio_only` room, then only the audio will actually be sent to the other peers. diff --git a/versioned_docs/version-0.20.0/how-to/features/sandbox-api-testing.mdx b/versioned_docs/version-0.20.0/how-to/features/sandbox-api-testing.mdx deleted file mode 100644 index 896b9413..00000000 --- a/versioned_docs/version-0.20.0/how-to/features/sandbox-api-testing.mdx +++ /dev/null @@ -1,323 +0,0 @@ ---- -type: how-to ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# Testing with the Sandbox API - -**How-to Guide** - _Use Sandbox API to test your Fishjam integration quickly without a backend_ - -The Sandbox API is a development tool that lets you create rooms and peers for testing without setting up your own backend server. This guide shows you how to use it effectively. - -## Prerequisites - -- Access to [Fishjam Dashboard](https://fishjam.io/app) -- A Sandbox environment set up - -## Step 1: Get your Fishjam ID - -1. Log in to [Fishjam Dashboard](https://fishjam.io/app) -2. Navigate to your [Sandbox Environment](https://fishjam.io/app/sandbox) -3. Copy your **Fishjam ID** - -:::note -`FISHJAM_ID` is your unique sandbox identifier. Anyone who knows this ID can join your rooms, so keep it secure during development. -::: - -## Step 2: Create a room and get peer tokens - -### With the `useSandbox` hook - - - - - ```ts - const FISHJAM_ID = "..."; - const roomName = "testRoom"; - const peerName = "testUser"; - // ---cut--- - import { useSandbox } from '@fishjam-cloud/react-native-client'; - - // ... - - const { getSandboxPeerToken } = useSandbox({ fishjamId: FISHJAM_ID }); - const peerToken = await getSandboxPeerToken(roomName, peerName); - ``` - - - - - - ```ts - const FISHJAM_ID = "..."; - const roomName = "testRoom"; - const peerName = "testUser"; - // ---cut--- - import { useSandbox } from '@fishjam-cloud/react-client'; - - // ... - - const { getSandboxPeerToken } = useSandbox(); - const peerToken = await getSandboxPeerToken(roomName, peerName); - ``` - - - - -### Required parameters - -- `roomName` - Name of the room to create/join -- `peerName` - Name for the peer joining the room - -### Optional parameters - -- `roomType` - Type of room to create (defaults to `conference`) - -### Room types available - -- `conference` - For video/audio conferencing (default) -- `audio-only` - For audio-only conferencing -- `livestream` - For one-to-many video/audio streaming - -## Step 3: Handle the response - -The Sandbox API returns a JSON response with connection details: - -```json -{ - "peerToken": "", - "url": "wss://fishjam.io/api/v1/connect/${YOUR_APP_UUID}", - "room": { - "id": "", - "name": "foo" - }, - "peer": { - "id": "", - "name": "bar" - } -} -``` - -## Step 4: Use the tokens in your client app - -Below are examples on how to use tokens from the Sandbox API in your frontend applications: - - - - - ```tsx - import React, { useEffect, useState } from "react"; - import { Text } from "react-native"; - - const roomName = "testRoom"; - const peerName = `user_${Date.now()}`; - const FISHJAM_ID = "..."; - - const RoomView = (props: {peerToken: string}) => null; - // ---cut--- - import { useSandbox } from "@fishjam-cloud/react-native-client"; - - export default function TestScreen() { - const [peerToken, setPeerToken] = useState(null); - const { getSandboxPeerToken } = useSandbox({ fishjamId: FISHJAM_ID }); - - useEffect(() => { - const fetchPeerToken = async () => { - try { - const token = await getSandboxPeerToken(roomName, peerName); - setPeerToken(token); - } catch (error) { - console.error("Failed to create room:", error); - } - }; - - fetchPeerToken(); - }, []); - - if (!peerToken) { - return Creating room...; - } - - return ( - - ); - } - ``` - - - - - - ```tsx - import React, { useState, useEffect } from "react"; - - const FISHJAM_ID = "your-app-uuid-here"; - // ---cut--- - import { FishjamProvider, useConnection, useSandbox } from "@fishjam-cloud/react-client"; - - function VideoCallComponent() { - const { joinRoom, peerStatus } = useConnection(); - const { getSandboxPeerToken } = useSandbox(); - - const handleJoinRoom = async () => { - const roomName = "testRoom"; - const peerName = `user_${Date.now()}`; - - try { - const peerToken = await getSandboxPeerToken(roomName, peerName) - await joinRoom({ peerToken }); - } catch (error) { - console.error("Failed to join room:", error); - } - }; - - const isConnected = peerStatus === "connected"; - - return ( -
- {isConnected ?

Connected to room!

: } -
- ); - } - - export default function App() { - return ( - - - - ); - } - ``` - - - - -## Step 5: Test different room types - -### Testing audio-only rooms - -```ts -import { useSandbox } from "@fishjam-cloud/react-client"; -const { getSandboxPeerToken } = useSandbox(); -// ---cut--- -const audioOnlyUrl = await getSandboxPeerToken( - "audioTest", - "user1", - "audio_only", -); -``` - -### Testing livestream rooms - -```ts -import { useSandbox } from "@fishjam-cloud/react-client"; -const { getSandboxLivestream, getSandboxViewerToken } = useSandbox(); -// ---cut--- - -const livestreamName = "livestream1"; -// For the streamer -const streamerUrl = await getSandboxLivestream(livestreamName); - -// For viewers, you need a viewer token (different endpoint) -const viewerTokenUrl = await getSandboxViewerToken(livestreamName); -``` - -## Step 6: Handle multiple peers - -To test with multiple participants, create multiple peer tokens with different peer names: - -```ts -import { useSandbox } from "@fishjam-cloud/react-client"; -const { getSandboxPeerToken } = useSandbox(); -// ---cut--- -// First peer -const peer1Response = await getSandboxPeerToken("multiTest", "alice"); - -// Second peer -const peer2Response = await getSandboxPeerToken("multiTest", "bob"); -``` - -Both peers will join the same room (`multiTest`) and can communicate with each other. - -## Common testing patterns - -### Pattern 1: Random room names for isolation - -```ts -const roomName = `test_${Math.random().toString(36).substring(7)}`; -const peerName = `user_${Date.now()}`; -``` - -### Pattern 2: Consistent naming for repeated tests - -```ts -// @noErrors: 2451 -const roomName = "development-room"; -const peerName = `developer_1`; -``` - -### Pattern 3: Feature-specific room names - -```ts -// @noErrors: 2451 -const roomName = `screenshare-test-${Date.now()}`; -const roomName = `audio-only-test`; -const roomName = `livestream-demo`; -``` - -## Troubleshooting - -### Issue: Room not found errors - -**Problem**: Rooms might not persist between requests. - -**Solution**: Always create rooms fresh for each test session. - -### Issue: Connection failures - -**Problem**: Invalid Fishjam ID or network issues. - -**Solution**: - -1. Verify your Fishjam ID in the Fishjam Dashboard -2. Check network connectivity -3. Ensure you're using the sandbox environment - -## Security reminder - -:::danger -**The Sandbox API is not safe for production!** - -- No authentication required -- Anyone with your Fishjam ID can join rooms -- Identical room/peer names get the same tokens -- No rate limiting or abuse protection - -Only use the Sandbox API for development and testing. -::: - -## Resetting your app - -If you need to reset your Sandbox API: - -1. Go to [Fishjam Dashboard](https://fishjam.io/app/sandbox) -2. Click **Settings** -3. Click **Reset App** -4. Get your new Fishjam ID - -This will invalidate all existing tokens (including the management token!) and give you a fresh sandbox environment. - -## Next steps - -Once you've tested your integration with the Sandbox API: - -- [Set up your own backend](../../tutorials/backend-quick-start) -- [Learn more about the Sandbox API](../../explanation/sandbox-api-concept) -- [Understand security implications](../../explanation/security-tokens) - -For production deployment: - -- [How to set up a production server](../../how-to/backend/server-setup) -- [How to implement proper authentication](../../explanation/security-tokens) diff --git a/versioned_docs/version-0.20.0/how-to/features/whip-whep.mdx b/versioned_docs/version-0.20.0/how-to/features/whip-whep.mdx deleted file mode 100644 index d7de8b01..00000000 --- a/versioned_docs/version-0.20.0/how-to/features/whip-whep.mdx +++ /dev/null @@ -1,228 +0,0 @@ ---- -type: how-to -title: WHIP/WHEP with Fishjam ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# Livestreaming using WHIP/WHEP - -:::tip -Make sure to read [Livestreaming with Fishjam](../../tutorials/livestreaming) before reading this guide. -This guide focuses on a low-level way to communicate with Fishjam. - -The majority of use-cases should prefer to use the methods described in [Livestreaming with Fishjam](../../tutorials/livestreaming). -::: - -If you've reading this guide, it is more than likely that you've already heard of **WHIP** (WebRTC HTTP Ingress Protocol) and **WHEP** (WebRTC HTTP Egress Protocol). -If not, then we recommend to read our [article about WHIP/WHEP](https://blog.swmansion.com/building-interactive-streaming-apps-webrtc-whip-whep-explained-d38f4825ec90). -In short, these are two protocols which standardize real-time livestreaming. -This prevents vendor lock-in and allows implementations and solutions to be reused in different scenarios. - -Fishjam supports both WHIP and WHEP, so you can choose how to publish and receive streams. -For example, you can use [OBS Studio](https://obsproject.com/) to publish a livestream with WHIP and then receive the stream using any public online WHEP player you like. - -## WHIP with Fishjam - -WHIP is the protocol used by streamers to start publishing. -To use WHIP you need two things: - -1. The URL of an HTTP endpoint implementing the WHIP specification. -2. A token, used by the endpoint to authorize the streamer. - -### Getting the URL - -Fishjam's WHIP endpoint is available at - -```sh -https://fishjam.io/api/v1/live/api/whip -``` - -You can paste this URL in your WHIP client of choice to start streaming. - -### Getting the token - -To authenticate a streamer, you need to first create a room of type `livestream` and a streamer token for that room. -You can read about this in detail in [Production Livestreaming with Server SDKs](../../tutorials/livestreaming#production-livestreaming-with-server-sdks), but the TL;DR is - - - - - ```ts - const fishjamId = ""; - const managementToken = ""; - - // ---cut--- - import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; - - const fishjamClient = new FishjamClient({ - fishjamId, - managementToken, - }); - - const room = await fishjamClient.createRoom({ roomType: 'livestream' }); - const { token: streamerToken } = await fishjamClient.createLivestreamStreamerToken(room.id); // [!code highlight] - ``` - - - - - - ```python - from fishjam import FishjamClient - - fishjam_client = FishjamClient( - fishjam_id=fishjam_id, - management_token=management_token, - ); - - room = fishjam_client.create_room(room_type="livestream") - streamer_token = fishjam_client.create_livestream_streamer_token(room.id) # [!code highlight] - ``` - - - - -The created streamer token must be supplied in the HTTP headers of the WHIP request: - -```sh -POST https://fishjam.io/api/v1/live/api/whip -Authorization: Bearer [STREAMER-TOKEN] -``` - -## WHEP with Fishjam - -WHEP is the protocol used by viewers to start receiving a published livestream. -The usage of WHEP is very similar to WHIP, as you need the following: - -1. The URL of an HTTP endpoint implementing the WHEP specification. -2. **(Optional)** A token, used by the endpoint to authorize the viewer. - -With Fishjam, if the livestream is private, then the **token is required**. -On the other hand, if the livestream is public, then the **token is omitted**. - -[Private vs Public Livestreams](../../explanation/public-livestreams) explains private and public livestreams in more detail. -In this guide we demonstrate how to view each livestream type using WHEP directly. - -### Private livestreams - -#### Getting the URL - -For private livestreams, Fishjam's WHEP endpoint is available at - -```sh -https://fishjam.io/api/v1/live/api/whep -``` - -You can paste this URL in your WHEP client of choice to start viewing. - -#### Getting the token - -To authenticate a viewer, you need to create a viewer token for a room of `livestream` type. -You can read about this in detail in [Production Livestreaming with Server SDKs](../../tutorials/livestreaming#production-livestreaming-with-server-sdks), but the TL;DR is - - - - - ```ts - const fishjamId = ""; - const managementToken = ""; - - // ---cut--- - import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; - - const fishjamClient = new FishjamClient({ - fishjamId, - managementToken, - }); - - const room = await fishjamClient.createRoom({ roomType: 'livestream', public: false }); - - // ... - - const { token: viewerToken } = await fishjamClient.createLivestreamViewerToken(room.id); // [!code highlight] - ``` - - - - - - ```python - from fishjam import FishjamClient - - fishjam_client = FishjamClient( - fishjam_id=fishjam_id, - management_token=management_token, - ); - - room = fishjam_client.create_room(room_type="livestream", public=False) - - # ... - - viewer_token = fishjam_client.create_livestream_viewer_token(room.id) # [!code highlight] - ``` - - - - -The created viewer token must be supplied in the HTTP headers of the WHEP request: - -```sh -POST https://fishjam.io/api/v1/live/api/whep -Authorization: Bearer [VIEWER-TOKEN] -``` - -### Public livestreams - -For public livestreams, you don't need a token, however you still need a room of `livestream` type with the `public` flag enabled. - - - - - ```ts - import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; - - const fishjamId = ""; - const managementToken = ""; - const fishjamClient = new FishjamClient({ - fishjamId, - managementToken, - }); - - // ---cut--- - const room = await fishjamClient.createRoom({ roomType: 'livestream', public: true }); - // now you can use room.id to start viewing - ``` - - - - - - ```python - room = fishjam_client.create_room(room_type="livestream", public=True) - # now you can use room.id to start viewing - ``` - - - - -Once you have such a room, you can view a stream published to that room by supplying the following URL: - -```sh -http://fishjam.io/api/v1/live/api/whep/[ROOM-ID] -``` - -## See also - -More on livestreaming: - -- [Livestreaming tutorial](../../tutorials/livestreaming) -- [Private vs Public livestreams](../../explanation/public-livestreams) - -If livestreaming doesn't fit your use case: - -- [Room types explained](../../explanation/room-types) -- [Videoconferencing in React Native](../../tutorials/react-native-quick-start) -- [Videoconferencing in React](../../tutorials/react-quick-start) -- [Audio-only calls](../../how-to/features/audio-only-calls) diff --git a/versioned_docs/version-0.20.0/how-to/react-native/_category_.json b/versioned_docs/version-0.20.0/how-to/react-native/_category_.json deleted file mode 100644 index 1fd79841..00000000 --- a/versioned_docs/version-0.20.0/how-to/react-native/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "React Native", - "position": 1 -} diff --git a/versioned_docs/version-0.20.0/how-to/react-native/_components/configure-permissions.mdx b/versioned_docs/version-0.20.0/how-to/react-native/_components/configure-permissions.mdx deleted file mode 100644 index bd5debcc..00000000 --- a/versioned_docs/version-0.20.0/how-to/react-native/_components/configure-permissions.mdx +++ /dev/null @@ -1,91 +0,0 @@ -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -Your app needs to have permissions configured in order to use the microphone and camera. - -### Android - -Permissions below are required to stream audio and video with Fishjam on Android. - -- `android.permission.CAMERA` -- `android.permission.RECORD_AUDIO` -- `android.permission.MODIFY_AUDIO_SETTINGS` - - - - - -Add required permissions to the `app.json` file. - -```json title='app.json' -{ - "expo": { - ... - "android": { - ... - "permissions": [ - "android.permission.CAMERA", - "android.permission.RECORD_AUDIO", - "android.permission.MODIFY_AUDIO_SETTINGS" - ] - } - } -} -``` - - - - -Add required permissions to the `AndroidManifest.xml` file. - -```xml title='AndroidManifest.xml' - - ... - - - - ... - -``` - - - - -### iOS - - - - - -You don't have to make any changes to run app on iOS. -To update default content of permission alert, you can add these settings to `app.json`: - -```json title='app.json' -{ - "expo": { - ... - "ios": { - ... - "infoPlist": { - "NSCameraUsageDescription": "Allow $(PRODUCT_NAME) to access your camera.", - "NSMicrophoneUsageDescription": "Allow $(PRODUCT_NAME) to access your microphone." - } - }, - } -} -``` - - - - -Ensure `Info.plist` contains camera and microphone usage description entries: - -```xml title='Info.plist' - NSCameraUsageDescription - Allow $(PRODUCT_NAME) to access your camera. - NSMicrophoneUsageDescription - Allow $(PRODUCT_NAME) to access your microphone. -``` - - - diff --git a/versioned_docs/version-0.20.0/how-to/react-native/_components/install-package.mdx b/versioned_docs/version-0.20.0/how-to/react-native/_components/install-package.mdx deleted file mode 100644 index 356da871..00000000 --- a/versioned_docs/version-0.20.0/how-to/react-native/_components/install-package.mdx +++ /dev/null @@ -1,27 +0,0 @@ -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - - - - -```bash npm2yarn -npm install @fishjam-cloud/react-native-client -``` - - - - - -### Install Expo dependencies - -Follow instructions from official [Expo documentation](https://docs.expo.dev/bare/installing-expo-modules/). - -### Install Fishjam - - ```sh - npx expo install @fishjam-cloud/react-native-client - ``` - - - - diff --git a/versioned_docs/version-0.20.0/how-to/react-native/assets/ios-new-folder.png b/versioned_docs/version-0.20.0/how-to/react-native/assets/ios-new-folder.png deleted file mode 100644 index 59299cf3..00000000 Binary files a/versioned_docs/version-0.20.0/how-to/react-native/assets/ios-new-folder.png and /dev/null differ diff --git a/versioned_docs/version-0.20.0/how-to/react-native/assets/ios-new-group.png b/versioned_docs/version-0.20.0/how-to/react-native/assets/ios-new-group.png deleted file mode 100644 index 8ec7c415..00000000 Binary files a/versioned_docs/version-0.20.0/how-to/react-native/assets/ios-new-group.png and /dev/null differ diff --git a/versioned_docs/version-0.20.0/how-to/react-native/assets/ios-new-target.png b/versioned_docs/version-0.20.0/how-to/react-native/assets/ios-new-target.png deleted file mode 100644 index 4ecff358..00000000 Binary files a/versioned_docs/version-0.20.0/how-to/react-native/assets/ios-new-target.png and /dev/null differ diff --git a/versioned_docs/version-0.20.0/how-to/react-native/background-streaming.mdx b/versioned_docs/version-0.20.0/how-to/react-native/background-streaming.mdx deleted file mode 100644 index d51054e3..00000000 --- a/versioned_docs/version-0.20.0/how-to/react-native/background-streaming.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -sidebar_position: 6 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# Streaming from background - -On Android, it is possible to continue streaming when app is in background. Unfortunately this functionality is not available on iOS (due to Apple limitations) - -Below is configuration required to make it work: - - - - - -You need to modify `app.json` file and add our plugin: - -```json -{ - "expo": { - ... - "plugins": { - ... - [ - "@fishjam-cloud/react-native-client", - { - "android": { - "enableForegroundService": true - } - } - ], - ... - } - } -} -``` - - - - -You need to modify `AndroidManifest.xml` file and add below service: - -```xml title='AndroidManifest.xml' - - ... - - ... - - - -``` - - - - -## Usage - - - - - -You can use [`useForegroundService`](../../api/mobile/variables/useForegroundService) hook to handle how foreground service behaves on Android. - -:::important[Permissions] - -If you want to use [`enableCamera`](../../api/mobile/type-aliases/ForegroundServiceConfig#enablecamera) or [`enableMicrophone`](../../api/mobile/type-aliases/ForegroundServiceConfig#enablemicrophone), -user must first grant permission for this resource. [`useForegroundService`](../../api/mobile/variables/useForegroundService) will check if permission is -granted and only then allow to start a service. - -::: - -```tsx -import { - useForegroundService, - useCamera, - useMicrophone, -} from "@fishjam-cloud/react-native-client"; - -const { isCameraOn } = useCamera(); -const { isMicrophoneOn } = useMicrophone(); - -useForegroundService({ - channelId: "io.fishjam.example.fishjamchat.foregroundservice.channel", - channelName: "Fishjam Chat Notifications", - notificationTitle: "Your video call is ongoing", - notificationContent: "Tap to return to the call.", - enableCamera: isCameraOn, - enableMicrophone: isMicrophoneOn, -}); -``` - - - -This feature is unavailable on iOS. - - diff --git a/versioned_docs/version-0.20.0/how-to/react-native/connecting.mdx b/versioned_docs/version-0.20.0/how-to/react-native/connecting.mdx deleted file mode 100644 index 42c6388f..00000000 --- a/versioned_docs/version-0.20.0/how-to/react-native/connecting.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -sidebar_position: 2 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# Connecting - -This article will guide you through the process of connecting to a Fishjam room. - -## Getting URL and token - -In order to connect, you need to obtain a **Peer Token** (the token that will authenticate the peer in -your Room). - - - - - -Once you create your account on [Fishjam](https://fishjam.io), you will have access to the Sandbox environment as part of the Mini Jar plan. -While using the Sandbox environment, [you can use the Sandbox API](../../how-to/features/sandbox-api-testing) to generate peer tokens for testing or development purposes. -This is basically a service that will create a Room, add your app as -the Room's Peer, and return the token required to use that Room. - -```ts -import { useSandbox } from "@fishjam-cloud/react-native-client"; -const SANDBOX_FISHJAM_ID = "..."; -const roomName = "room"; -const peerName = "user"; -// ---cut--- - -// The `useSandbox` hook will work ONLY with the FISHJAM_ID of the Sandbox environment -const { getSandboxPeerToken } = useSandbox({ fishjamId: SANDBOX_FISHJAM_ID }); -const peerToken = await getSandboxPeerToken(roomName, peerName); -``` - - - - -For the production app, you need to implement your own backend service that will provide the user with a **Peer Token**. To do that, -follow our [server setup instructions](../../how-to/backend/server-setup). - - - - -## Connecting - -In order to connect, call [`joinRoom`](../../api/mobile/functions/useConnection#joinroom) method with the `peerToken` and the fishjam ID: - -```tsx -import React, { useCallback } from "react"; -import { Button } from "react-native"; -import { useConnection, useSandbox } from "@fishjam-cloud/react-native-client"; - -// Check https://fishjam.io/app/ for your Fishjam ID -const FISHJAM_ID = "..."; - -export function JoinRoomButton() { - const { joinRoom } = useConnection(); // [!code highlight] - const { getSandboxPeerToken } = useSandbox({ fishjamId: FISHJAM_ID }); - - const onPressJoin = useCallback(async () => { - // in production environment, get the peerToken from your backend - const peerToken = await getSandboxPeerToken("Room", "User"); - - await joinRoom({ fishjamId: FISHJAM_ID, peerToken }); // [!code highlight] - }, [joinRoom]); - - return ; -} -``` - -## Disconnecting - -In order to close connection, use the [`leaveRoom`](../../api/web/functions/useConnection#leaveroom) method -from [`useConnection`](../../api/web/functions/useConnection) hook. - -```tsx -import { useConnection } from "@fishjam-cloud/react-client"; -import React, { useCallback } from "react"; - -export function LeaveRoomButton() { - const { leaveRoom } = useConnection(); // [!code highlight] - - return ; -} -``` diff --git a/versioned_docs/version-0.20.0/how-to/react/custom-sources.mdx b/versioned_docs/version-0.20.0/how-to/react/custom-sources.mdx deleted file mode 100644 index 14e7fde0..00000000 --- a/versioned_docs/version-0.20.0/how-to/react/custom-sources.mdx +++ /dev/null @@ -1,175 +0,0 @@ ---- -sidebar_position: 8 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# Custom sources - -:::important - -If you only wish to send camera, microphone or screen share output through Fishjam, then you most likely should refer to the documentation in [Streaming media](../../how-to/react/start-streaming) and [Managing devices](../../how-to/react/managing-devices) instead of this page. - -::: - -This section demonstrates how to stream non-standard video or audio to other peers in your web app. -The utilities in this section allow you to integrate Fishjam with powerful browser APIs such as [WebGL](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) and [WebGPU](https://developer.mozilla.org/en-US/docs/Web/API/WebGPU_API), -or higher level libraries, which leverage these APIs, such as [Three.js](https://threejs.org/), [Smelter](https://smelter.dev) or [PixiJS](https://pixijs.com/) - -## Creating a custom source - [`useCustomSource()`](../../api/web/functions/useCustomSource) - -To create a custom source, you only need to do two things: - -1. Call the `useCustomSource` hook. -2. Call the [`setStream`](../../api/web/functions/useCustomSource#setstream) callback provided by the `useCustomSource` hook with a [MediaStream](#how-to-get-a-mediastream-object) object. - -#### Usage Example - -```tsx -import React, { useEffect } from "react"; -import { useCustomSource } from "@fishjam-cloud/react-client"; - -const stream: MediaStream | null = null; // Replace with your MediaStream object -const { setStream } = useCustomSource("my-custom-source"); - -useEffect(() => { - setStream(stream); -}, [stream, setStream]); -``` - -### Using a created custom source - -Once you have called [`setStream`](../../api/web/functions/useCustomSource#setstream) for a given source ID (in the above example, `"my-custom-source"`), any subsequent calls to `useCustomSource` with the same ID will return the same state. -This enables multiple components to control and read a shared custom source. - -### Deleting a custom source - -If you wish to remove a custom source, then you should call the [`setStream`](../../api/web/functions/useCustomSource#setstream) callback with `null` as its argument. - -#### Usage Example - -```tsx -import { useCustomSource } from "@fishjam-cloud/react-client"; -// ---cut--- -const { setStream } = useCustomSource("my-custom-source"); -// ... -await setStream(null); -``` - -## How to get a MediaStream object? - -Depending on your use-case, the way you can obtain a [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream) will vary. -Below are some common examples of how to obtain one from an existing video or audio source. - -### Canvas - -If you have a `` HTML element, then you will need to call the [`captureStream`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/captureStream) method of the given canvas. -This is particularly useful if you are using [Three.js](https://threejs.org/) or [PixiJS](https://pixijs.com/) to render complex animations and more. - -#### Usage Example - -```tsx -import React, { useCallback, useState } from "react"; - -export function CanvasExample() { - const [canvasStream, setCanvasStream] = useState(); - - const streamFromCanvas = useCallback((canvas: HTMLCanvasElement | null) => { - if (!canvas) return; - setCanvasStream(canvas.captureStream()); - }, []); - - // use canvasStream as desired - - return ; -} -``` - -### Smelter - -If you are using [Smelter](https://smelter.dev), then all you need to do is register an output via [`registerOutput`](https://smelter.dev/ts-sdk/outputs/wasm-stream/). - -#### Usage Example - -:::tip - -If you want to see a full example React app which uses Fishjam with Smelter, then you can check out our [full example on GitHub](https://github.com/fishjam-cloud/web-client-sdk/tree/main/examples/react-client/minimal-smelter). - -::: - -```tsx -import React from "react"; -import Smelter, { setWasmBundleUrl } from "@swmansion/smelter-web-wasm"; -import { View } from "@swmansion/smelter"; - -setWasmBundleUrl("/assets/smelter.wasm"); - -async function run() { - const smelter = new Smelter({ framerate: 30 }); - const { stream } = await smelter.registerOutput("example-output", , { - type: "stream", - video: { - resolution: { width: 1920, height: 1080 }, - }, - }); - await smelter.init(); -} -``` - -### Video/Audio HTML tag - -If you have a `