diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useCallKit.md b/versioned_docs/version-0.27.0/api/mobile/functions/useCallKit.md deleted file mode 100644 index 9a05ee75..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/functions/useCallKit.md +++ /dev/null @@ -1,9 +0,0 @@ -# Function: useCallKit() - -> **useCallKit**(): `object` - -Defined in: [packages/mobile-client/src/overrides/hooks.ts:100](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L100) - -## Returns - -`object` diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useCallKitEvent.md b/versioned_docs/version-0.27.0/api/mobile/functions/useCallKitEvent.md deleted file mode 100644 index 9677f458..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/functions/useCallKitEvent.md +++ /dev/null @@ -1,22 +0,0 @@ -# Function: useCallKitEvent() - -> **useCallKitEvent**\<`T`\>(`action`, `callback`): `void` - -Defined in: [packages/mobile-client/src/overrides/hooks.ts:109](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L109) - -## Type Parameters - -| Type Parameter | -| ------ | -| `T` *extends* keyof `CallKitAction` | - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `action` | `T` | -| `callback` | (`event`) => `void` | - -## Returns - -`void` diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useCallKitService.md b/versioned_docs/version-0.27.0/api/mobile/functions/useCallKitService.md deleted file mode 100644 index d4651b27..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/functions/useCallKitService.md +++ /dev/null @@ -1,15 +0,0 @@ -# Function: useCallKitService() - -> **useCallKitService**(`config`): `void` - -Defined in: [packages/mobile-client/src/overrides/hooks.ts:105](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L105) - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | `CallKitConfig` | - -## Returns - -`void` diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useCamera.md b/versioned_docs/version-0.27.0/api/mobile/functions/useCamera.md deleted file mode 100644 index ef615ec7..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/functions/useCamera.md +++ /dev/null @@ -1,118 +0,0 @@ -# Function: useCamera() - -> **useCamera**(): `object` - -Defined in: [packages/mobile-client/src/overrides/hooks.ts:28](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L28) - -## Returns - -### ~~activeCamera~~ - -> **activeCamera**: `null` \| [`DeviceItem`](../type-aliases/DeviceItem.md) - -#### Deprecated - -Use `currentCamera` and `isCameraOn` instead -Indicates which camera is now turned on and streaming - -### cameraDeviceError - -> **cameraDeviceError**: `null` \| [`DeviceError`](../type-aliases/DeviceError.md) - -Possible error thrown while setting up the camera - -### cameraDevices - -> **cameraDevices**: [`DeviceItem`](../type-aliases/DeviceItem.md)[] - -List of available camera devices - -### cameraStream - -> **cameraStream**: `null` \| `MediaStream` - -### currentCamera - -> **currentCamera**: `null` \| `MediaDeviceInfo` - -Indicates which camera is now selected - -### currentCameraMiddleware - -> **currentCameraMiddleware**: [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) - -The currently set camera middleware function - -### isCameraOn - -> **isCameraOn**: `boolean` - -Indicates whether the camera is streaming video - -### selectCamera() - -> **selectCamera**: (`deviceId`) => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> - -Selects the camera device - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `deviceId` | `string` | - -#### Returns - -`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> - -### setCameraTrackMiddleware() - -> **setCameraTrackMiddleware**: (`middleware`) => `Promise`\<`void`\> - -Sets the camera middleware - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `middleware` | [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) | - -#### Returns - -`Promise`\<`void`\> - -### startCamera() - -> **startCamera**: (`deviceId?`) => `Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> - -Starts the camera - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `deviceId?` | `null` \| `string` | - -#### Returns - -`Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> - -### stopCamera() - -> **stopCamera**: () => `void` - -Stops the camera - -#### Returns - -`void` - -### toggleCamera() - -> **toggleCamera**: () => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> - -Toggles current camera on/off - -#### Returns - -`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useMicrophone.md b/versioned_docs/version-0.27.0/api/mobile/functions/useMicrophone.md deleted file mode 100644 index 00c5b134..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/functions/useMicrophone.md +++ /dev/null @@ -1,124 +0,0 @@ -# Function: useMicrophone() - -> **useMicrophone**(): `object` - -Defined in: [packages/mobile-client/src/overrides/hooks.ts:36](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L36) - -## Returns - -### ~~activeMicrophone~~ - -> **activeMicrophone**: `null` \| [`DeviceItem`](../type-aliases/DeviceItem.md) - -#### Deprecated - -Use `currentMicrophone` and `isMicrophoneOn` instead -Indicates which microphone is now turned on and streaming audio - -### currentMicrophone - -> **currentMicrophone**: `null` \| `MediaDeviceInfo` - -Indicates which microphone is now selected - -### currentMicrophoneMiddleware - -> **currentMicrophoneMiddleware**: [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) - -The currently set microphone middleware function - -### isMicrophoneMuted - -> **isMicrophoneMuted**: `boolean` - -Indicates whether the microphone is muted - -### isMicrophoneOn - -> **isMicrophoneOn**: `boolean` - -Indicates whether the microphone is streaming audio - -### microphoneDeviceError - -> **microphoneDeviceError**: `null` \| [`DeviceError`](../type-aliases/DeviceError.md) - -Possible error thrown while setting up the microphone - -### microphoneDevices - -> **microphoneDevices**: [`DeviceItem`](../type-aliases/DeviceItem.md)[] - -List of available microphone devices - -### microphoneStream - -> **microphoneStream**: `null` \| `MediaStream` - -### selectMicrophone() - -> **selectMicrophone**: (`deviceId`) => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> - -Selects the microphone device - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `deviceId` | `string` | - -#### Returns - -`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> - -### setMicrophoneTrackMiddleware() - -> **setMicrophoneTrackMiddleware**: (`middleware`) => `Promise`\<`void`\> - -Sets the microphone middleware - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `middleware` | [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) | - -#### Returns - -`Promise`\<`void`\> - -### startMicrophone() - -> **startMicrophone**: (`deviceId?`) => `Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> - -Starts the microphone - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `deviceId?` | `null` \| `string` | - -#### Returns - -`Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> - -### stopMicrophone() - -> **stopMicrophone**: () => `void` - -Stops the microphone - -#### Returns - -`void` - -### toggleMicrophone() - -> **toggleMicrophone**: () => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> - -Toggles current microphone on/off - -#### Returns - -`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useScreenShare.md b/versioned_docs/version-0.27.0/api/mobile/functions/useScreenShare.md deleted file mode 100644 index a506f089..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/functions/useScreenShare.md +++ /dev/null @@ -1,77 +0,0 @@ -# Function: useScreenShare() - -> **useScreenShare**(): `object` - -Defined in: [packages/mobile-client/src/overrides/hooks.ts:44](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L44) - -## Returns - -### audioTrack - -> **audioTrack**: `null` \| `MediaStreamTrack` - -The separate audio MediaStreamTrack. - -### currentTracksMiddleware - -> **currentTracksMiddleware**: `null` \| [`TracksMiddleware`](../type-aliases/TracksMiddleware.md) - -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`\> - -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`\> - -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`\> - -Stops the stream and cancels browser screen sharing. - -#### Returns - -`Promise`\<`void`\> - -### stream - -> **stream**: `null` \| `MediaStream` - -### videoTrack - -> **videoTrack**: `null` \| `MediaStreamTrack` - -The separate video MediaStreamTrack. diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/ConnectStreamerConfig.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/ConnectStreamerConfig.md deleted file mode 100644 index d907d189..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/ConnectStreamerConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ConnectStreamerConfig - -> **ConnectStreamerConfig** = `object` - -Defined in: [packages/mobile-client/src/overrides/types.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L21) - -## Properties - -### inputs - -> **inputs**: [`StreamerInputs`](StreamerInputs.md) - -Defined in: [packages/mobile-client/src/overrides/types.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L22) - -*** - -### token - -> **token**: `string` - -Defined in: [packages/mobile-client/src/overrides/types.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L23) diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/CustomSource.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/CustomSource.md deleted file mode 100644 index 738a0ef6..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/CustomSource.md +++ /dev/null @@ -1,17 +0,0 @@ -# Type Alias: CustomSource\ - -> **CustomSource**\<`T`\> = `Omit`\<`ReactClientCustomSource`\<`T`\>, `"stream"`\> & `object` - -Defined in: [packages/mobile-client/src/overrides/types.ts:64](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L64) - -## Type declaration - -### stream? - -> `optional` **stream**: `RNMediaStream` - -## Type Parameters - -| Type Parameter | -| ------ | -| `T` *extends* `string` | diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/DeviceItem.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/DeviceItem.md deleted file mode 100644 index 4c55e211..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/DeviceItem.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: DeviceItem - -> **DeviceItem** = `object` - -Defined in: packages/react-client/dist/types/public.d.ts:43 - -## Properties - -### deviceId - -> **deviceId**: `string` - -Defined in: packages/react-client/dist/types/public.d.ts:44 - -*** - -### label - -> **label**: `string` - -Defined in: packages/react-client/dist/types/public.d.ts:45 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/FishjamProviderProps.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/FishjamProviderProps.md deleted file mode 100644 index fafa5471..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/FishjamProviderProps.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: FishjamProviderProps - -> **FishjamProviderProps** = `Omit`\<`ReactClientFishjamProviderProps`, `"persistLastDevice"` \| `"fishjamClient"`\> - -Defined in: [packages/mobile-client/src/index.ts:117](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/index.ts#L117) diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/ForegroundServiceConfig.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/ForegroundServiceConfig.md deleted file mode 100644 index 66857656..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/ForegroundServiceConfig.md +++ /dev/null @@ -1,79 +0,0 @@ -# Type Alias: ForegroundServiceConfig - -> **ForegroundServiceConfig** = `object` - -Defined in: [packages/mobile-client/src/useForegroundService.ts:8](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L8) - -Configuration options for foreground service permissions. - -A type representing the configuration for foreground service permissions. - -## Properties - -### channelId? - -> `optional` **channelId**: `string` - -Defined in: [packages/mobile-client/src/useForegroundService.ts:24](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L24) - -The id of the channel. Must be unique per package. - -*** - -### channelName? - -> `optional` **channelName**: `string` - -Defined in: [packages/mobile-client/src/useForegroundService.ts:28](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L28) - -The user visible name of the channel. - -*** - -### enableCamera? - -> `optional` **enableCamera**: `boolean` - -Defined in: [packages/mobile-client/src/useForegroundService.ts:12](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L12) - -Indicates whether the camera is enabled for the foreground service. - -*** - -### enableMicrophone? - -> `optional` **enableMicrophone**: `boolean` - -Defined in: [packages/mobile-client/src/useForegroundService.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L16) - -Indicates whether the microphone is enabled for the foreground service. - -*** - -### enableScreenSharing? - -> `optional` **enableScreenSharing**: `boolean` - -Defined in: [packages/mobile-client/src/useForegroundService.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L20) - -Indicates whether screen sharing is enabled for the foreground service. - -*** - -### notificationContent? - -> `optional` **notificationContent**: `string` - -Defined in: [packages/mobile-client/src/useForegroundService.ts:36](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L36) - -The text (second row) of the notification, in a standard notification. - -*** - -### notificationTitle? - -> `optional` **notificationTitle**: `string` - -Defined in: [packages/mobile-client/src/useForegroundService.ts:32](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L32) - -The title (first row) of the notification, in a standard notification. diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesResult.md deleted file mode 100644 index da3eee2d..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: InitializeDevicesResult - -> **InitializeDevicesResult** = `Omit`\<`ReactClientInitializeDevicesResult`, `"stream"`\> & `object` - -Defined in: [packages/mobile-client/src/overrides/types.ts:66](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L66) - -## Type declaration - -### stream - -> **stream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesSettings.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesSettings.md deleted file mode 100644 index f85d28a2..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesSettings.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: InitializeDevicesSettings - -> **InitializeDevicesSettings** = `object` - -Defined in: packages/react-client/dist/hooks/internal/devices/useMediaDevices.d.ts:9 - -## Properties - -### enableAudio? - -> `optional` **enableAudio**: `boolean` - -Defined in: packages/react-client/dist/hooks/internal/devices/useMediaDevices.d.ts:11 - -*** - -### enableVideo? - -> `optional` **enableVideo**: `boolean` - -Defined in: packages/react-client/dist/hooks/internal/devices/useMediaDevices.d.ts:10 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/MiddlewareResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/MiddlewareResult.md deleted file mode 100644 index 34d3c29a..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/MiddlewareResult.md +++ /dev/null @@ -1,25 +0,0 @@ -# Type Alias: MiddlewareResult - -> **MiddlewareResult** = `object` - -Defined in: packages/react-client/dist/types/public.d.ts:23 - -## Properties - -### onClear()? - -> `optional` **onClear**: () => `void` - -Defined in: packages/react-client/dist/types/public.d.ts:25 - -#### Returns - -`void` - -*** - -### track - -> **track**: `MediaStreamTrack` - -Defined in: packages/react-client/dist/types/public.d.ts:24 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCPIPViewProps.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCPIPViewProps.md deleted file mode 100644 index 8fcf33c5..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCPIPViewProps.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: RTCPIPViewProps - -> **RTCPIPViewProps** = `Omit`\<`React.ComponentPropsWithRef`\<*typeof* `OriginalRTCPIPView`\>, `"streamURL"`\> & `object` - -Defined in: [packages/mobile-client/src/overrides/RTCView.tsx:10](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/RTCView.tsx#L10) - -## Type declaration - -### mediaStream - -> **mediaStream**: `RNMediaStream` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCVideoViewProps.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCVideoViewProps.md deleted file mode 100644 index c4f490b1..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCVideoViewProps.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: RTCVideoViewProps - -> **RTCVideoViewProps** = `Omit`\<`React.ComponentPropsWithRef`\<*typeof* `OriginalRTCView`\>, `"streamURL"`\> & `object` - -Defined in: [packages/mobile-client/src/overrides/RTCView.tsx:6](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/RTCView.tsx#L6) - -## Type declaration - -### mediaStream - -> **mediaStream**: `RNMediaStream` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/RemoteTrack.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/RemoteTrack.md deleted file mode 100644 index 07218564..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/RemoteTrack.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: RemoteTrack - -> **RemoteTrack** = `Omit`\<`ReactClientRemoteTrack`, `"stream"`\> & `object` - -Defined in: [packages/mobile-client/src/overrides/types.ts:62](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L62) - -## Type declaration - -### stream - -> **stream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/SimulcastBandwidthLimits.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/SimulcastBandwidthLimits.md deleted file mode 100644 index 5209ee64..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/SimulcastBandwidthLimits.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: SimulcastBandwidthLimits - -> **SimulcastBandwidthLimits** = `object` - -Defined in: packages/react-client/dist/types/public.d.ts:51 - -## Properties - -### 1 - -> **1**: `number` - -Defined in: packages/react-client/dist/types/public.d.ts:52 - -*** - -### 2 - -> **2**: `number` - -Defined in: packages/react-client/dist/types/public.d.ts:53 - -*** - -### 3 - -> **3**: `number` - -Defined in: packages/react-client/dist/types/public.d.ts:54 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/StreamerInputs.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/StreamerInputs.md deleted file mode 100644 index 7b5b087f..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/StreamerInputs.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: StreamerInputs - -> **StreamerInputs** = \{ `audio?`: `RNMediaStream` \| `null`; `video`: `RNMediaStream`; \} \| \{ `audio`: `RNMediaStream`; `video?`: `null`; \} - -Defined in: [packages/mobile-client/src/overrides/types.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L17) diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/Track.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/Track.md deleted file mode 100644 index 52ed9928..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/Track.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: Track - -> **Track** = `Omit`\<`ReactClientTrack`, `"stream"`\> & `object` - -Defined in: [packages/mobile-client/src/overrides/types.ts:60](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L60) - -## Type declaration - -### stream - -> **stream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackMiddleware.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackMiddleware.md deleted file mode 100644 index e6fec9f2..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/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/dist/types/public.d.ts:27 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/TracksMiddlewareResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TracksMiddlewareResult.md deleted file mode 100644 index fd95b8bb..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/TracksMiddlewareResult.md +++ /dev/null @@ -1,33 +0,0 @@ -# Type Alias: TracksMiddlewareResult - -> **TracksMiddlewareResult** = `object` - -Defined in: packages/react-client/dist/types/public.d.ts:28 - -## Properties - -### audioTrack - -> **audioTrack**: `MediaStreamTrack` \| `null` - -Defined in: packages/react-client/dist/types/public.d.ts:30 - -*** - -### onClear() - -> **onClear**: () => `void` - -Defined in: packages/react-client/dist/types/public.d.ts:31 - -#### Returns - -`void` - -*** - -### videoTrack - -> **videoTrack**: `MediaStreamTrack` - -Defined in: packages/react-client/dist/types/public.d.ts:29 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseCameraResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseCameraResult.md deleted file mode 100644 index 8c67e8bd..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseCameraResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: UseCameraResult - -> **UseCameraResult** = `Omit`\<`ReturnType`\<*typeof* `useCameraReactClient`\>, `"cameraStream"`\> & `object` - -Defined in: [packages/mobile-client/src/overrides/types.ts:34](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L34) - -## Type declaration - -### cameraStream - -> **cameraStream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseInitializeDevicesParams.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseInitializeDevicesParams.md deleted file mode 100644 index 7243935b..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseInitializeDevicesParams.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: UseInitializeDevicesParams - -> **UseInitializeDevicesParams** = `object` - -Defined in: packages/react-client/dist/hooks/devices/useInitializeDevices.d.ts:1 - -## Properties - -### enableAudio? - -> `optional` **enableAudio**: `boolean` - -Defined in: packages/react-client/dist/hooks/devices/useInitializeDevices.d.ts:3 - -*** - -### enableVideo? - -> `optional` **enableVideo**: `boolean` - -Defined in: packages/react-client/dist/hooks/devices/useInitializeDevices.d.ts:2 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseLivestreamViewerResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseLivestreamViewerResult.md deleted file mode 100644 index fca6e679..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseLivestreamViewerResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: UseLivestreamViewerResult - -> **UseLivestreamViewerResult** = `Omit`\<`ReactClientUseLivestreamViewerResult`, `"stream"`\> & `object` - -Defined in: [packages/mobile-client/src/overrides/types.ts:30](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L30) - -## Type declaration - -### stream - -> **stream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseMicrophoneResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseMicrophoneResult.md deleted file mode 100644 index ac869b81..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseMicrophoneResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: UseMicrophoneResult - -> **UseMicrophoneResult** = `Omit`\<`ReturnType`\<*typeof* `useMicrophoneReactClient`\>, `"toggleMicrophoneMute"` \| `"microphoneStream"`\> & `object` - -Defined in: [packages/mobile-client/src/overrides/types.ts:38](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L38) - -## Type declaration - -### microphoneStream - -> **microphoneStream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseScreenShareResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseScreenShareResult.md deleted file mode 100644 index 788f204a..00000000 --- a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseScreenShareResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: UseScreenShareResult - -> **UseScreenShareResult** = `Omit`\<`ReturnType`\<*typeof* `useScreenShareReactClient`\>, `"stream"`\> & `object` - -Defined in: [packages/mobile-client/src/overrides/types.ts:45](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L45) - -## Type declaration - -### stream - -> **stream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/typedoc-sidebar.cjs b/versioned_docs/version-0.27.0/api/mobile/typedoc-sidebar.cjs deleted file mode 100644 index 262c3655..00000000 --- a/versioned_docs/version-0.27.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/useDataChannel",label:"useDataChannel"},{type:"doc",id:"api/mobile/type-aliases/Metadata",label:"Metadata"},{type:"doc",id:"api/mobile/variables/useUpdatePeerMetadata",label:"useUpdatePeerMetadata"},{type:"doc",id:"api/mobile/variables/useVAD",label:"useVAD"}]},{type:"category",label:"Other",items:[{type:"doc",id:"api/mobile/functions/FishjamProvider",label:"FishjamProvider"},{type:"doc",id:"api/mobile/functions/RTCPIPView",label:"RTCPIPView"},{type:"doc",id:"api/mobile/functions/RTCView",label:"RTCView"},{type:"doc",id:"api/mobile/functions/useCallKit",label:"useCallKit"},{type:"doc",id:"api/mobile/functions/useCallKitEvent",label:"useCallKitEvent"},{type:"doc",id:"api/mobile/functions/useCallKitService",label:"useCallKitService"},{type:"doc",id:"api/mobile/functions/useCamera",label:"useCamera"},{type:"doc",id:"api/mobile/functions/useCameraPermissions",label:"useCameraPermissions"},{type:"doc",id:"api/mobile/functions/useCustomSource",label:"useCustomSource"},{type:"doc",id:"api/mobile/functions/useInitializeDevices",label:"useInitializeDevices"},{type:"doc",id:"api/mobile/functions/useLivestreamStreamer",label:"useLivestreamStreamer"},{type:"doc",id:"api/mobile/functions/useLivestreamViewer",label:"useLivestreamViewer"},{type:"doc",id:"api/mobile/functions/useMicrophone",label:"useMicrophone"},{type:"doc",id:"api/mobile/functions/useMicrophonePermissions",label:"useMicrophonePermissions"},{type:"doc",id:"api/mobile/functions/usePeers",label:"usePeers"},{type:"doc",id:"api/mobile/functions/useScreenShare",label:"useScreenShare"},{type:"doc",id:"api/mobile/enumerations/Variant",label:"Variant"},{type:"doc",id:"api/mobile/interfaces/DataChannelOptions",label:"DataChannelOptions"},{type:"doc",id:"api/mobile/interfaces/JoinRoomConfig",label:"JoinRoomConfig"},{type:"doc",id:"api/mobile/interfaces/SimulcastConfig",label:"SimulcastConfig"},{type:"doc",id:"api/mobile/type-aliases/AuthErrorReason",label:"AuthErrorReason"},{type:"doc",id:"api/mobile/type-aliases/BandwidthLimits",label:"BandwidthLimits"},{type:"doc",id:"api/mobile/type-aliases/Brand",label:"Brand"},{type:"doc",id:"api/mobile/type-aliases/ConnectStreamerConfig",label:"ConnectStreamerConfig"},{type:"doc",id:"api/mobile/type-aliases/ConnectViewerConfig",label:"ConnectViewerConfig"},{type:"doc",id:"api/mobile/type-aliases/CustomSource",label:"CustomSource"},{type:"doc",id:"api/mobile/type-aliases/DataCallback",label:"DataCallback"},{type:"doc",id:"api/mobile/type-aliases/DeviceError",label:"DeviceError"},{type:"doc",id:"api/mobile/type-aliases/DeviceItem",label:"DeviceItem"},{type:"doc",id:"api/mobile/type-aliases/FishjamProviderProps",label:"FishjamProviderProps"},{type:"doc",id:"api/mobile/type-aliases/ForegroundServiceConfig",label:"ForegroundServiceConfig"},{type:"doc",id:"api/mobile/type-aliases/InitializeDevicesResult",label:"InitializeDevicesResult"},{type:"doc",id:"api/mobile/type-aliases/InitializeDevicesSettings",label:"InitializeDevicesSettings"},{type:"doc",id:"api/mobile/type-aliases/InitializeDevicesStatus",label:"InitializeDevicesStatus"},{type:"doc",id:"api/mobile/type-aliases/JoinErrorReason",label:"JoinErrorReason"},{type:"doc",id:"api/mobile/type-aliases/MiddlewareResult",label:"MiddlewareResult"},{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/PeerWithTracks",label:"PeerWithTracks"},{type:"doc",id:"api/mobile/type-aliases/PermissionStatus",label:"PermissionStatus"},{type:"doc",id:"api/mobile/type-aliases/PersistLastDeviceHandlers",label:"PersistLastDeviceHandlers"},{type:"doc",id:"api/mobile/type-aliases/ReconnectConfig",label:"ReconnectConfig"},{type:"doc",id:"api/mobile/type-aliases/ReconnectionStatus",label:"ReconnectionStatus"},{type:"doc",id:"api/mobile/type-aliases/RemoteTrack",label:"RemoteTrack"},{type:"doc",id:"api/mobile/type-aliases/RoomType",label:"RoomType"},{type:"doc",id:"api/mobile/type-aliases/RTCPIPViewProps",label:"RTCPIPViewProps"},{type:"doc",id:"api/mobile/type-aliases/RTCVideoViewProps",label:"RTCVideoViewProps"},{type:"doc",id:"api/mobile/type-aliases/SimulcastBandwidthLimit",label:"SimulcastBandwidthLimit"},{type:"doc",id:"api/mobile/type-aliases/SimulcastBandwidthLimits",label:"SimulcastBandwidthLimits"},{type:"doc",id:"api/mobile/type-aliases/StreamConfig",label:"StreamConfig"},{type:"doc",id:"api/mobile/type-aliases/StreamerInputs",label:"StreamerInputs"},{type:"doc",id:"api/mobile/type-aliases/Track",label:"Track"},{type:"doc",id:"api/mobile/type-aliases/TrackBandwidthLimit",label:"TrackBandwidthLimit"},{type:"doc",id:"api/mobile/type-aliases/TrackFields",label:"TrackFields"},{type:"doc",id:"api/mobile/type-aliases/TrackId",label:"TrackId"},{type:"doc",id:"api/mobile/type-aliases/TrackMiddleware",label:"TrackMiddleware"},{type:"doc",id:"api/mobile/type-aliases/TracksMiddleware",label:"TracksMiddleware"},{type:"doc",id:"api/mobile/type-aliases/TracksMiddlewareResult",label:"TracksMiddlewareResult"},{type:"doc",id:"api/mobile/type-aliases/UseCameraResult",label:"UseCameraResult"},{type:"doc",id:"api/mobile/type-aliases/UseCustomSourceResult",label:"UseCustomSourceResult"},{type:"doc",id:"api/mobile/type-aliases/UseDataChannelResult",label:"UseDataChannelResult"},{type:"doc",id:"api/mobile/type-aliases/UseInitializeDevicesParams",label:"UseInitializeDevicesParams"},{type:"doc",id:"api/mobile/type-aliases/UseInitializeDevicesReturn",label:"UseInitializeDevicesReturn"},{type:"doc",id:"api/mobile/type-aliases/UseLivestreamStreamerResult",label:"UseLivestreamStreamerResult"},{type:"doc",id:"api/mobile/type-aliases/UseLivestreamViewerResult",label:"UseLivestreamViewerResult"},{type:"doc",id:"api/mobile/type-aliases/UseMicrophoneResult",label:"UseMicrophoneResult"},{type:"doc",id:"api/mobile/type-aliases/UseSandboxProps",label:"UseSandboxProps"},{type:"doc",id:"api/mobile/type-aliases/UseScreenShareResult",label:"UseScreenShareResult"},{type:"doc",id:"api/mobile/variables/SimulcastConfig",label:"SimulcastConfig"},{type:"doc",id:"api/mobile/variables/useForegroundService",label:"useForegroundService"},{type:"doc",id:"api/mobile/variables/useSandbox",label:"useSandbox"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/versioned_docs/version-0.27.0/api/reference.md b/versioned_docs/version-0.27.0/api/reference.md deleted file mode 100644 index a9ea6f47..00000000 --- a/versioned_docs/version-0.27.0/api/reference.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -type: reference ---- - -# Reference - -Describes APIs for direct interaction with Fishjam. - -Fishjam publishes documentation for the Sandbox API and Fishjam Server APIs. - -## Sandbox API - -[Sandbox API OpenAPI](https://github.com/fishjam-cloud/documentation/tree/main/static/api/room-manager-openapi.yaml) - -See also: [What is the Sandbox API?](../explanation/sandbox-api-concept) - -## Server - -Fishjam Server provides a REST API for managing rooms and peers, and -[Protobufs](https://protobuf.dev) for -receiving structured live updates from the server. -The notifications can be configured using Webhook or Websocket. - -### REST API - -[Server REST API Reference](/api/rest) - -### Protobufs - -- [Server Notification Protobufs](https://github.com/fishjam-cloud/documentation/tree/main/static/api/protobuf/server_notifications.proto) -- [Agent Message Protobufs](https://github.com/fishjam-cloud/documentation/tree/main/static/api/protobuf/agent_notifications.proto) - -#### Webhook - -When using webhooks for receiving notifications, the `webhookUrl` must be passed -in the `RoomConfig` options when creating a room. - -The HTTP POST to the `webhookUrl` uses "application/x-protobuf" content type. -The body is binary data, that represents encoded `ServerMessage`. - -For more information see also [server setup documentation](../how-to/backend/server-setup#webhooks) - -#### Websocket - -After opening the Websocket connection to -`https://fishjam.io/api/v1/connect/{fishjamId}/socket/server/websocket`, -the first message that must be sent is an `AuthRequest`, -with a valid Management Token. - -Next, you can should subscribe to notifications by sending `SubscribeRequest` event with `SERVER_NOTIFICATION` event type. diff --git a/versioned_docs/version-0.27.0/api/server-python/fishjam/errors/index.md b/versioned_docs/version-0.27.0/api/server-python/fishjam/errors/index.md deleted file mode 100644 index d64a628c..00000000 --- a/versioned_docs/version-0.27.0/api/server-python/fishjam/errors/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: errors -sidebar_label: errors -custom_edit_url: null ---- - -# fishjam.errors - - - -## HTTPError -```python -class HTTPError(Exception): -``` - - ---- -## BadRequestError -```python -class BadRequestError(HTTPError): -``` - - ---- -## UnauthorizedError -```python -class UnauthorizedError(HTTPError): -``` - - ---- -## NotFoundError -```python -class NotFoundError(HTTPError): -``` - - ---- -## ServiceUnavailableError -```python -class ServiceUnavailableError(HTTPError): -``` - - ---- -## InternalServerError -```python -class InternalServerError(HTTPError): -``` - - ---- -## ConflictError -```python -class ConflictError(HTTPError): -``` - - ---- diff --git a/versioned_docs/version-0.27.0/api/server-python/fishjam/index.md b/versioned_docs/version-0.27.0/api/server-python/fishjam/index.md deleted file mode 100644 index 9e52ea28..00000000 --- a/versioned_docs/version-0.27.0/api/server-python/fishjam/index.md +++ /dev/null @@ -1,682 +0,0 @@ ---- -title: fishjam -sidebar_label: fishjam -custom_edit_url: null ---- - -# fishjam - - -## Submodules -- [events](fishjam/events) -- [errors](fishjam/errors) -- [room](fishjam/room) -- [peer](fishjam/peer) -- [agent](fishjam/agent) -- [integrations](fishjam/integrations) - -## FishjamClient -```python -class FishjamClient(Client): -``` -Allows for managing rooms. - -### __init__ -```python -def __init__(fishjam_id: str, management_token: str) -``` -Create a FishjamClient instance. - -Args: -- fishjam_id: The unique identifier for the Fishjam instance. -- management_token: The token used for authenticating management operations. - -### create_peer -```python -def create_peer( - self, - room_id: str, - options: PeerOptions | None = None -) -> tuple[Peer, str] -``` -Creates a peer in the room. - -Args: -- room_id: The ID of the room where the peer will be created. -- options: Configuration options for the peer. Defaults to None. - -Returns: -- A tuple containing: - - Peer: The created peer object. - - str: The peer token needed to authenticate to Fishjam. - -### create_agent -```python -def create_agent( - self, - room_id: str, - options: AgentOptions | None = None -) -``` -Creates an agent in the room. - -Args: -- room_id: The ID of the room where the agent will be created. -- options: Configuration options for the agent. Defaults to None. - -Returns: -- Agent: The created agent instance initialized with peer ID, room ID, token, - and Fishjam URL. - -### create_vapi_agent -```python -def create_vapi_agent( - self, - room_id: str, - options: PeerOptionsVapi -) -> Peer -``` -Creates a vapi agent in the room. - -Args: -- room_id: The ID of the room where the vapi agent will be created. -- options: Configuration options for the vapi peer. - -Returns: -- - Peer: The created peer object. - -### create_room -```python -def create_room( - self, - options: RoomOptions | None = None -) -> Room -``` -Creates a new room. - -Args: -- options: Configuration options for the room. Defaults to None. - -Returns: -- Room: The created Room object. - -### get_all_rooms -```python -def get_all_rooms(self) -> list[Room] -``` -Returns list of all rooms. - -Returns: -- list[Room]: A list of all available Room objects. - -### get_room -```python -def get_room(self, room_id: str) -> Room -``` -Returns room with the given id. - -Args: -- room_id: The ID of the room to retrieve. - -Returns: -- Room: The Room object corresponding to the given ID. - -### delete_peer -```python -def delete_peer(self, room_id: str, peer_id: str) -> None -``` -Deletes a peer from a room. - -Args: -- room_id: The ID of the room the peer belongs to. -- peer_id: The ID of the peer to delete. - -### delete_room -```python -def delete_room(self, room_id: str) -> None -``` -Deletes a room. - -Args: -- room_id: The ID of the room to delete. - -### refresh_peer_token -```python -def refresh_peer_token(self, room_id: str, peer_id: str) -> str -``` -Refreshes a peer token. - -Args: -- room_id: The ID of the room. -- peer_id: The ID of the peer whose token needs refreshing. - -Returns: -- str: The new peer token. - -### create_livestream_viewer_token -```python -def create_livestream_viewer_token(self, room_id: str) -> str -``` -Generates a viewer token for livestream rooms. - -Args: -- room_id: The ID of the livestream room. - -Returns: -- str: The generated viewer token. - -### create_livestream_streamer_token -```python -def create_livestream_streamer_token(self, room_id: str) -> str -``` -Generates a streamer token for livestream rooms. - -Args: -- room_id: The ID of the livestream room. - -Returns: -- str: The generated streamer token. - -### create_moq_token -```python -def create_moq_token( - self, - publish_path: str | None = None, - subscribe_path: str | None = None -) -> str -``` -Generates a MoQ token. - -Args: -- publish_path: Path the token grants publish access to. -- subscribe_path: Path the token grants subscribe access to. - -Returns: -- str: The generated token. - -### subscribe_peer -```python -def subscribe_peer(self, room_id: str, peer_id: str, target_peer_id: str) -``` -Subscribes a peer to all tracks of another peer. - -Args: -- room_id: The ID of the room. -- peer_id: The ID of the subscribing peer. -- target_peer_id: The ID of the peer to subscribe to. - -### subscribe_tracks -```python -def subscribe_tracks(self, room_id: str, peer_id: str, track_ids: list[str]) -``` -Subscribes a peer to specific tracks of another peer. - -Args: -- room_id: The ID of the room. -- peer_id: The ID of the subscribing peer. -- track_ids: A list of track IDs to subscribe to. - -#### Inherited Members -* **Client**: - * `client` - * `warnings_shown` ---- -## FishjamNotifier -```python -class FishjamNotifier: -``` -Allows for receiving WebSocket messages from Fishjam. - -### __init__ -```python -def __init__(fishjam_id: str, management_token: str) -``` -Create a FishjamNotifier instance with an ID and management token. - -### on_server_notification -```python -def on_server_notification( - self, - handler: Union[Callable[[Union[ServerMessageRoomCreated, ServerMessageRoomDeleted, ServerMessageRoomCrashed, ServerMessagePeerAdded, ServerMessagePeerDeleted, ServerMessagePeerConnected, ServerMessagePeerDisconnected, ServerMessagePeerMetadataUpdated, ServerMessagePeerCrashed, ServerMessageStreamerConnected, ServerMessageStreamerDisconnected, ServerMessageChannelAdded, ServerMessageChannelRemoved, ServerMessageViewerConnected, ServerMessageViewerDisconnected, ServerMessageTrackAdded, ServerMessageTrackRemoved, ServerMessageTrackMetadataUpdated]], NoneType], Callable[[Union[ServerMessageRoomCreated, ServerMessageRoomDeleted, ServerMessageRoomCrashed, ServerMessagePeerAdded, ServerMessagePeerDeleted, ServerMessagePeerConnected, ServerMessagePeerDisconnected, ServerMessagePeerMetadataUpdated, ServerMessagePeerCrashed, ServerMessageStreamerConnected, ServerMessageStreamerDisconnected, ServerMessageChannelAdded, ServerMessageChannelRemoved, ServerMessageViewerConnected, ServerMessageViewerDisconnected, ServerMessageTrackAdded, ServerMessageTrackRemoved, ServerMessageTrackMetadataUpdated]], Coroutine[Any, Any, None]]] -) -``` -Decorator for defining a handler for Fishjam notifications. - -Args: -- handler: The function to be registered as the notification handler. - -Returns: -- NotificationHandler: The original handler function (unmodified). - -### connect -```python -def connect(self) -``` -Connects to Fishjam and listens for all incoming messages. - -It runs until the connection isn't closed. - -The incoming messages are handled by the functions defined using the -`on_server_notification` decorator. - -The handler have to be defined before calling `connect`, -otherwise the messages won't be received. - -### wait_ready -```python -def wait_ready(self) -> None -``` -Waits until the notifier is connected and authenticated to Fishjam. - -If already connected, returns immediately. - ---- -## receive_binary -```python -def receive_binary( - binary: bytes -) -> Union[ServerMessageRoomCreated, ServerMessageRoomDeleted, ServerMessageRoomCrashed, ServerMessagePeerAdded, ServerMessagePeerDeleted, ServerMessagePeerConnected, ServerMessagePeerDisconnected, ServerMessagePeerMetadataUpdated, ServerMessagePeerCrashed, ServerMessageStreamerConnected, ServerMessageStreamerDisconnected, ServerMessageChannelAdded, ServerMessageChannelRemoved, ServerMessageViewerConnected, ServerMessageViewerDisconnected, ServerMessageTrackAdded, ServerMessageTrackRemoved, ServerMessageTrackMetadataUpdated, NoneType] -``` -Transforms a received protobuf notification into a notification instance. - -The available notifications are listed in `fishjam.events` module. - -Args: -- binary: The raw binary data received from the webhook. - -Returns: -- AllowedNotification | None: The parsed notification object, or None if - the message type is not supported. - ---- -## PeerMetadata -```python -class PeerMetadata: -``` -Custom metadata set by the peer - -Example: -- \{'name': 'FishjamUser'\} - -### __init__ -```python -def __init__() -``` -Method generated by attrs for class PeerMetadata. - -### additional_properties -```python -additional_properties: dict[str, typing.Any] -``` - - -### to_dict -```python -def to_dict(self) -> dict[str, typing.Any] -``` - - -### from_dict -```python -def from_dict(cls: type[~T], src_dict: Mapping[str, typing.Any]) -> ~T -``` - - -### additional_keys -```python -additional_keys: list[str] -``` - - ---- -## PeerOptions -```python -class PeerOptions: -``` -Options specific to a WebRTC Peer. - -Attributes: -- metadata: Peer metadata. -- subscribe_mode: Configuration of peer's subscribing policy. - -### __init__ -```python -def __init__( - metadata: dict[str, typing.Any] | None = None, - subscribe_mode: Literal['auto', 'manual'] = 'auto' -) -``` - - -### metadata -```python -metadata: dict[str, typing.Any] | None = None - -``` -Peer metadata - -### subscribe_mode -```python -subscribe_mode: Literal['auto', 'manual'] = 'auto' - -``` -Configuration of peer's subscribing policy - ---- -## PeerOptionsVapi -```python -class PeerOptionsVapi: -``` -Options specific to the VAPI peer - -Attributes: -- api_key (str): VAPI API key -- call_id (str): VAPI call ID -- subscribe_mode (SubscribeMode | Unset): Configuration of peer's subscribing policy - -### __init__ -```python -def __init__( - api_key: str, - call_id: str, - subscribe_mode: SubscribeMode | Unset = -) -``` -Method generated by attrs for class PeerOptionsVapi. - -### api_key -```python -api_key: str -``` - - -### call_id -```python -call_id: str -``` - - -### subscribe_mode -```python -subscribe_mode: SubscribeMode | Unset -``` - - -### to_dict -```python -def to_dict(self) -> dict[str, typing.Any] -``` - - -### from_dict -```python -def from_dict(cls: type[~T], src_dict: Mapping[str, typing.Any]) -> ~T -``` - - ---- -## RoomOptions -```python -class RoomOptions: -``` -Description of a room options. - -Attributes: -- max_peers: Maximum amount of peers allowed into the room. -- video_codec: Enforces video codec for each peer in the room. -- webhook_url: URL where Fishjam notifications will be sent. -- room_type: The use-case of the room. If not provided, this defaults - to conference. -- public: True if livestream viewers can omit specifying a token. - -### __init__ -```python -def __init__( - max_peers: int | None = None, - video_codec: Optional[Literal['h264', 'vp8']] = None, - webhook_url: str | None = None, - room_type: Literal['conference', 'audio_only', 'livestream', 'full_feature', 'broadcaster', 'audio_only_livestream'] = 'conference', - public: bool = False -) -``` - - -### max_peers -```python -max_peers: int | None = None - -``` -Maximum amount of peers allowed into the room - -### video_codec -```python -video_codec: Optional[Literal['h264', 'vp8']] = None - -``` -Enforces video codec for each peer in the room - -### webhook_url -```python -webhook_url: str | None = None - -``` -URL where Fishjam notifications will be sent - -### room_type -```python -room_type: Literal['conference', 'audio_only', 'livestream', 'full_feature', 'broadcaster', 'audio_only_livestream'] = 'conference' - -``` -The use-case of the room. If not provided, this defaults to conference. - -### public -```python -public: bool = False - -``` -True if livestream viewers can omit specifying a token. - ---- -## AgentOptions -```python -class AgentOptions: -``` -Options specific to an Agent Peer. - -Attributes: -- output: Configuration for the agent's output options. -- subscribe_mode: Configuration of peer's subscribing policy. - -### __init__ -```python -def __init__( - output: AgentOutputOptions = , - subscribe_mode: Literal['auto', 'manual'] = 'auto' -) -``` - - -### output -```python -output: AgentOutputOptions -``` - - -### subscribe_mode -```python -subscribe_mode: Literal['auto', 'manual'] = 'auto' - -``` - - ---- -## AgentOutputOptions -```python -class AgentOutputOptions: -``` -Options of the desired format of audio tracks going from Fishjam to the agent. - -Attributes: -- audio_format: The format of the audio stream (e.g., 'pcm16'). -- audio_sample_rate: The sample rate of the audio stream. - -### __init__ -```python -def __init__( - audio_format: Literal['pcm16'] = 'pcm16', - audio_sample_rate: Literal[16000, 24000] = 16000 -) -``` - - -### audio_format -```python -audio_format: Literal['pcm16'] = 'pcm16' - -``` - - -### audio_sample_rate -```python -audio_sample_rate: Literal[16000, 24000] = 16000 - -``` - - ---- -## Room -```python -class Room: -``` -Description of the room state. - -Attributes: -- config: Room configuration. -- id: Room ID. -- peers: List of all peers. - -### __init__ -```python -def __init__( - config: RoomConfig, - id: str, - peers: list[Peer] -) -``` - - -### config -```python -config: RoomConfig -``` -Room configuration - -### id -```python -id: str -``` -Room ID - -### peers -```python -peers: list[Peer] -``` -List of all peers - ---- -## Peer -```python -class Peer: -``` -Describes peer status - -Attributes: -- id (str): Assigned peer id Example: 4a1c1164-5fb7-425d-89d7-24cdb8fff1cf. -- metadata (None | PeerMetadata): Custom metadata set by the peer Example: \{'name': 'FishjamUser'\}. -- status (PeerStatus): Informs about the peer status Example: disconnected. -- subscribe_mode (SubscribeMode): Configuration of peer's subscribing policy -- subscriptions (Subscriptions): Describes peer's subscriptions in manual mode -- tracks (list[Track]): List of all peer's tracks -- type_ (PeerType): Peer type Example: webrtc. - -### __init__ -```python -def __init__( - id: str, - metadata: None | PeerMetadata, - status: PeerStatus, - subscribe_mode: SubscribeMode, - subscriptions: Subscriptions, - tracks: list[Track], - type_: PeerType -) -``` -Method generated by attrs for class Peer. - -### id -```python -id: str -``` - - -### metadata -```python -metadata: None | PeerMetadata -``` - - -### status -```python -status: PeerStatus -``` - - -### subscribe_mode -```python -subscribe_mode: SubscribeMode -``` - - -### subscriptions -```python -subscriptions: Subscriptions -``` - - -### tracks -```python -tracks: list[Track] -``` - - -### type_ -```python -type_: PeerType -``` - - -### additional_properties -```python -additional_properties: dict[str, typing.Any] -``` - - -### to_dict -```python -def to_dict(self) -> dict[str, typing.Any] -``` - - -### from_dict -```python -def from_dict(cls: type[~T], src_dict: Mapping[str, typing.Any]) -> ~T -``` - - -### additional_keys -```python -additional_keys: list[str] -``` - - ---- diff --git a/versioned_docs/version-0.27.0/api/server/classes/BadRequestException.md b/versioned_docs/version-0.27.0/api/server/classes/BadRequestException.md deleted file mode 100644 index de9f6ed7..00000000 --- a/versioned_docs/version-0.27.0/api/server/classes/BadRequestException.md +++ /dev/null @@ -1,65 +0,0 @@ -# Class: BadRequestException - -Defined in: [js-server-sdk/src/exceptions/index.ts:21](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L21) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new BadRequestException**(`error`): `BadRequestException` - -Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/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: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/FishjamBaseException.md b/versioned_docs/version-0.27.0/api/server/classes/FishjamBaseException.md deleted file mode 100644 index 1bcebbb5..00000000 --- a/versioned_docs/version-0.27.0/api/server/classes/FishjamBaseException.md +++ /dev/null @@ -1,64 +0,0 @@ -# Class: FishjamBaseException - -Defined in: [js-server-sdk/src/exceptions/index.ts:9](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/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: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/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: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) diff --git a/versioned_docs/version-0.27.0/api/server/classes/FishjamClient.md b/versioned_docs/version-0.27.0/api/server/classes/FishjamClient.md deleted file mode 100644 index a046142a..00000000 --- a/versioned_docs/version-0.27.0/api/server/classes/FishjamClient.md +++ /dev/null @@ -1,329 +0,0 @@ -# Class: FishjamClient - -Defined in: [js-server-sdk/src/client.ts:24](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L24) - -Client class that allows to manage Rooms and Peers for a Fishjam App. -It requires the Fishjam ID and management token that can be retrieved from the Fishjam Dashboard. - -## Constructors - -### Constructor - -> **new FishjamClient**(`config`): `FishjamClient` - -Defined in: [js-server-sdk/src/client.ts:43](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L43) - -Create new instance of Fishjam Client. - -Example usage: -``` -const fishjamClient = new FishjamClient({ - fishjamId: fastify.config.FISHJAM_ID, - managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN, -}); -``` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`FishjamConfig`](../type-aliases/FishjamConfig.md) | - -#### Returns - -`FishjamClient` - -## Methods - -### createAgent() - -> **createAgent**(`roomId`, `options`, `callbacks?`): `Promise`\<\{ `agent`: [`FishjamAgent`](FishjamAgent.md); `peer`: [`Peer`](../type-aliases/Peer.md); \}\> - -Defined in: [js-server-sdk/src/client.ts:147](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L147) - -Create a new agent assigned to a room. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | -| `options` | [`PeerOptionsAgent`](../interfaces/PeerOptionsAgent.md) | -| `callbacks?` | [`AgentCallbacks`](../type-aliases/AgentCallbacks.md) | - -#### Returns - -`Promise`\<\{ `agent`: [`FishjamAgent`](FishjamAgent.md); `peer`: [`Peer`](../type-aliases/Peer.md); \}\> - -*** - -### createLivestreamStreamerToken() - -> **createLivestreamStreamerToken**(`roomId`): `Promise`\<[`StreamerToken`](../interfaces/StreamerToken.md)\> - -Defined in: [js-server-sdk/src/client.ts:268](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L268) - -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: [js-server-sdk/src/client.ts:255](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L255) - -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 - -*** - -### createMoqToken() - -> **createMoqToken**(`config?`): `Promise`\<[`MoqToken`](../interfaces/MoqToken.md)\> - -Defined in: [js-server-sdk/src/client.ts:281](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L281) - -Creates a MoQ token. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config?` | [`MoqTokenConfig`](../interfaces/MoqTokenConfig.md) | - -#### Returns - -`Promise`\<[`MoqToken`](../interfaces/MoqToken.md)\> - -a MoQ token - -*** - -### createPeer() - -> **createPeer**(`roomId`, `options`): `Promise`\<\{ `peer`: [`Peer`](../type-aliases/Peer.md); `peerToken`: `string`; \}\> - -Defined in: [js-server-sdk/src/client.ts:127](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L127) - -Create a new peer assigned to a room. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | -| `options` | [`PeerOptionsWebRTC`](../interfaces/PeerOptionsWebRTC.md) | - -#### Returns - -`Promise`\<\{ `peer`: [`Peer`](../type-aliases/Peer.md); `peerToken`: `string`; \}\> - -*** - -### createRoom() - -> **createRoom**(`config`): `Promise`\<[`Room`](../type-aliases/Room.md)\> - -Defined in: [js-server-sdk/src/client.ts:85](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L85) - -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)\> - -*** - -### createVapiAgent() - -> **createVapiAgent**(`roomId`, `options`): `Promise`\<\{ `peer`: [`Peer`](../type-aliases/Peer.md); \}\> - -Defined in: [js-server-sdk/src/client.ts:173](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L173) - -Create a new VAPI agent assigned to a room. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | -| `options` | [`PeerOptionsVapi`](../interfaces/PeerOptionsVapi.md) | - -#### Returns - -`Promise`\<\{ `peer`: [`Peer`](../type-aliases/Peer.md); \}\> - -*** - -### deletePeer() - -> **deletePeer**(`roomId`, `peerId`): `Promise`\<`void`\> - -Defined in: [js-server-sdk/src/client.ts:205](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L205) - -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: [js-server-sdk/src/client.ts:104](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L104) - -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: [js-server-sdk/src/client.ts:115](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L115) - -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: [js-server-sdk/src/client.ts:193](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L193) - -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: [js-server-sdk/src/client.ts:242](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L242) - -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 - -*** - -### subscribePeer() - -> **subscribePeer**(`roomId`, `subscriberPeerId`, `publisherPeerId`): `Promise`\<`void`\> - -Defined in: [js-server-sdk/src/client.ts:217](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L217) - -Subscribe a peer to another peer - this will make all tracks from the publisher available to the subscriber. -Using this function only makes sense if subscribeMode is set to manual - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | -| `subscriberPeerId` | [`PeerId`](../type-aliases/PeerId.md) | -| `publisherPeerId` | [`PeerId`](../type-aliases/PeerId.md) | - -#### Returns - -`Promise`\<`void`\> - -*** - -### subscribeTracks() - -> **subscribeTracks**(`roomId`, `subscriberPeerId`, `tracks`): `Promise`\<`void`\> - -Defined in: [js-server-sdk/src/client.ts:229](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L229) - -Subscribe a peer to specific tracks from another peer - this will make only the specified tracks from the publisher available to the subscriber. -Using this function only makes sense if subscribeMode is set to manual - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | -| `subscriberPeerId` | [`PeerId`](../type-aliases/PeerId.md) | -| `tracks` | [`TrackId`](../type-aliases/TrackId.md)[] | - -#### Returns - -`Promise`\<`void`\> diff --git a/versioned_docs/version-0.27.0/api/server/classes/FishjamNotFoundException.md b/versioned_docs/version-0.27.0/api/server/classes/FishjamNotFoundException.md deleted file mode 100644 index 71677daa..00000000 --- a/versioned_docs/version-0.27.0/api/server/classes/FishjamNotFoundException.md +++ /dev/null @@ -1,65 +0,0 @@ -# Class: FishjamNotFoundException - -Defined in: [js-server-sdk/src/exceptions/index.ts:29](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L29) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new FishjamNotFoundException**(`error`): `FishjamNotFoundException` - -Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/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: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/ForbiddenException.md b/versioned_docs/version-0.27.0/api/server/classes/ForbiddenException.md deleted file mode 100644 index df69275a..00000000 --- a/versioned_docs/version-0.27.0/api/server/classes/ForbiddenException.md +++ /dev/null @@ -1,65 +0,0 @@ -# Class: ForbiddenException - -Defined in: [js-server-sdk/src/exceptions/index.ts:25](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L25) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new ForbiddenException**(`error`): `ForbiddenException` - -Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/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: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/MissingFishjamIdException.md b/versioned_docs/version-0.27.0/api/server/classes/MissingFishjamIdException.md deleted file mode 100644 index 00f759be..00000000 --- a/versioned_docs/version-0.27.0/api/server/classes/MissingFishjamIdException.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: MissingFishjamIdException - -Defined in: [js-server-sdk/src/exceptions/index.ts:3](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L3) - -## Extends - -- `Error` - -## Constructors - -### Constructor - -> **new MissingFishjamIdException**(): `MissingFishjamIdException` - -Defined in: [js-server-sdk/src/exceptions/index.ts:4](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L4) - -#### Returns - -`MissingFishjamIdException` - -#### Overrides - -`Error.constructor` diff --git a/versioned_docs/version-0.27.0/api/server/classes/PeerNotFoundException.md b/versioned_docs/version-0.27.0/api/server/classes/PeerNotFoundException.md deleted file mode 100644 index 9c49bd2c..00000000 --- a/versioned_docs/version-0.27.0/api/server/classes/PeerNotFoundException.md +++ /dev/null @@ -1,65 +0,0 @@ -# Class: PeerNotFoundException - -Defined in: [js-server-sdk/src/exceptions/index.ts:31](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L31) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new PeerNotFoundException**(`error`): `PeerNotFoundException` - -Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/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: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/RoomNotFoundException.md b/versioned_docs/version-0.27.0/api/server/classes/RoomNotFoundException.md deleted file mode 100644 index e81dfdd2..00000000 --- a/versioned_docs/version-0.27.0/api/server/classes/RoomNotFoundException.md +++ /dev/null @@ -1,65 +0,0 @@ -# Class: RoomNotFoundException - -Defined in: [js-server-sdk/src/exceptions/index.ts:27](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L27) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new RoomNotFoundException**(`error`): `RoomNotFoundException` - -Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/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: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/ServiceUnavailableException.md b/versioned_docs/version-0.27.0/api/server/classes/ServiceUnavailableException.md deleted file mode 100644 index 1f397b24..00000000 --- a/versioned_docs/version-0.27.0/api/server/classes/ServiceUnavailableException.md +++ /dev/null @@ -1,65 +0,0 @@ -# Class: ServiceUnavailableException - -Defined in: [js-server-sdk/src/exceptions/index.ts:33](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L33) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new ServiceUnavailableException**(`error`): `ServiceUnavailableException` - -Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/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: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/UnauthorizedException.md b/versioned_docs/version-0.27.0/api/server/classes/UnauthorizedException.md deleted file mode 100644 index 63849a9a..00000000 --- a/versioned_docs/version-0.27.0/api/server/classes/UnauthorizedException.md +++ /dev/null @@ -1,65 +0,0 @@ -# Class: UnauthorizedException - -Defined in: [js-server-sdk/src/exceptions/index.ts:23](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L23) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new UnauthorizedException**(`error`): `UnauthorizedException` - -Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/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: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/UnknownException.md b/versioned_docs/version-0.27.0/api/server/classes/UnknownException.md deleted file mode 100644 index 41a35917..00000000 --- a/versioned_docs/version-0.27.0/api/server/classes/UnknownException.md +++ /dev/null @@ -1,65 +0,0 @@ -# Class: UnknownException - -Defined in: [js-server-sdk/src/exceptions/index.ts:35](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L35) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new UnknownException**(`error`): `UnknownException` - -Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/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: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/enumerations/PeerStatus.md b/versioned_docs/version-0.27.0/api/server/enumerations/PeerStatus.md deleted file mode 100644 index b65c395e..00000000 --- a/versioned_docs/version-0.27.0/api/server/enumerations/PeerStatus.md +++ /dev/null @@ -1,23 +0,0 @@ -# Enumeration: PeerStatus - -Defined in: fishjam-openapi/dist/index.d.ts:439 - -Informs about the peer status - -## Export - -## Enumeration Members - -### Connected - -> **Connected**: `"connected"` - -Defined in: fishjam-openapi/dist/index.d.ts:440 - -*** - -### Disconnected - -> **Disconnected**: `"disconnected"` - -Defined in: fishjam-openapi/dist/index.d.ts:441 diff --git a/versioned_docs/version-0.27.0/api/server/enumerations/RoomType.md b/versioned_docs/version-0.27.0/api/server/enumerations/RoomType.md deleted file mode 100644 index f922b904..00000000 --- a/versioned_docs/version-0.27.0/api/server/enumerations/RoomType.md +++ /dev/null @@ -1,55 +0,0 @@ -# Enumeration: RoomType - -Defined in: fishjam-openapi/dist/index.d.ts:573 - -The use-case of the room. If not provided, this defaults to conference. - -## Export - -## Enumeration Members - -### AudioOnly - -> **AudioOnly**: `"audio_only"` - -Defined in: fishjam-openapi/dist/index.d.ts:575 - -*** - -### AudioOnlyLivestream - -> **AudioOnlyLivestream**: `"audio_only_livestream"` - -Defined in: fishjam-openapi/dist/index.d.ts:579 - -*** - -### Broadcaster - -> **Broadcaster**: `"broadcaster"` - -Defined in: fishjam-openapi/dist/index.d.ts:576 - -*** - -### Conference - -> **Conference**: `"conference"` - -Defined in: fishjam-openapi/dist/index.d.ts:578 - -*** - -### FullFeature - -> **FullFeature**: `"full_feature"` - -Defined in: fishjam-openapi/dist/index.d.ts:574 - -*** - -### Livestream - -> **Livestream**: `"livestream"` - -Defined in: fishjam-openapi/dist/index.d.ts:577 diff --git a/versioned_docs/version-0.27.0/api/server/enumerations/VideoCodec.md b/versioned_docs/version-0.27.0/api/server/enumerations/VideoCodec.md deleted file mode 100644 index 450a4b5e..00000000 --- a/versioned_docs/version-0.27.0/api/server/enumerations/VideoCodec.md +++ /dev/null @@ -1,23 +0,0 @@ -# Enumeration: VideoCodec - -Defined in: fishjam-openapi/dist/index.d.ts:877 - -Enforces video codec for each peer in the room - -## Export - -## Enumeration Members - -### H264 - -> **H264**: `"h264"` - -Defined in: fishjam-openapi/dist/index.d.ts:878 - -*** - -### Vp8 - -> **Vp8**: `"vp8"` - -Defined in: fishjam-openapi/dist/index.d.ts:879 diff --git a/versioned_docs/version-0.27.0/api/server/index.md b/versioned_docs/version-0.27.0/api/server/index.md deleted file mode 100644 index 8c2c2065..00000000 --- a/versioned_docs/version-0.27.0/api/server/index.md +++ /dev/null @@ -1,77 +0,0 @@ -# @fishjam-cloud/js-server-sdk - -Server-side Node.js SDK for creating and managing Fishjam rooms, peers, agents, and receiving real-time server notifications. - -## Client - -- [FishjamClient](classes/FishjamClient.md) -- [FishjamWSNotifier](classes/FishjamWSNotifier.md) - -## Other - -- [PeerStatus](enumerations/PeerStatus.md) -- [RoomType](enumerations/RoomType.md) -- [VideoCodec](enumerations/VideoCodec.md) -- [BadRequestException](classes/BadRequestException.md) -- [FishjamAgent](classes/FishjamAgent.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) -- [MoqToken](interfaces/MoqToken.md) -- [MoqTokenConfig](interfaces/MoqTokenConfig.md) -- [PeerOptionsAgent](interfaces/PeerOptionsAgent.md) -- [PeerOptionsVapi](interfaces/PeerOptionsVapi.md) -- [PeerOptionsWebRTC](interfaces/PeerOptionsWebRTC.md) -- [RoomConfig](interfaces/RoomConfig.md) -- [ServerMessage](interfaces/ServerMessage.md) -- [StreamerToken](interfaces/StreamerToken.md) -- [ViewerToken](interfaces/ViewerToken.md) -- [AgentCallbacks](type-aliases/AgentCallbacks.md) -- [AgentEvents](type-aliases/AgentEvents.md) -- [AgentTrack](type-aliases/AgentTrack.md) -- [AudioCodecParameters](type-aliases/AudioCodecParameters.md) -- [Brand](type-aliases/Brand.md) -- [ChannelAdded](type-aliases/ChannelAdded.md) -- [ChannelRemoved](type-aliases/ChannelRemoved.md) -- [CloseEventHandler](type-aliases/CloseEventHandler.md) -- [ErrorEventHandler](type-aliases/ErrorEventHandler.md) -- [ExpectedAgentEvents](type-aliases/ExpectedAgentEvents.md) -- [ExpectedEvents](type-aliases/ExpectedEvents.md) -- [FishjamConfig](type-aliases/FishjamConfig.md) -- [IgnoredEvents](type-aliases/IgnoredEvents.md) -- [IncomingTrackData](type-aliases/IncomingTrackData.md) -- [IncomingTrackImage](type-aliases/IncomingTrackImage.md) -- [NotificationEvents](type-aliases/NotificationEvents.md) -- [OutgoingTrackData](type-aliases/OutgoingTrackData.md) -- [Peer](type-aliases/Peer.md) -- [PeerAdded](type-aliases/PeerAdded.md) -- [PeerConnected](type-aliases/PeerConnected.md) -- [PeerCrashed](type-aliases/PeerCrashed.md) -- [PeerDeleted](type-aliases/PeerDeleted.md) -- [PeerDisconnected](type-aliases/PeerDisconnected.md) -- [PeerId](type-aliases/PeerId.md) -- [PeerMetadataUpdated](type-aliases/PeerMetadataUpdated.md) -- [PeerOptions](type-aliases/PeerOptions.md) -- [PeerType](type-aliases/PeerType.md) -- [Room](type-aliases/Room.md) -- [RoomCrashed](type-aliases/RoomCrashed.md) -- [RoomCreated](type-aliases/RoomCreated.md) -- [RoomDeleted](type-aliases/RoomDeleted.md) -- [RoomId](type-aliases/RoomId.md) -- [StreamerConnected](type-aliases/StreamerConnected.md) -- [StreamerDisconnected](type-aliases/StreamerDisconnected.md) -- [Track](type-aliases/Track.md) -- [TrackAdded](type-aliases/TrackAdded.md) -- [TrackId](type-aliases/TrackId.md) -- [TrackMetadataUpdated](type-aliases/TrackMetadataUpdated.md) -- [TrackRemoved](type-aliases/TrackRemoved.md) -- [TrackType](type-aliases/TrackType.md) -- [ViewerConnected](type-aliases/ViewerConnected.md) -- [ViewerDisconnected](type-aliases/ViewerDisconnected.md) -- [ServerMessage](variables/ServerMessage.md) diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/MoqToken.md b/versioned_docs/version-0.27.0/api/server/interfaces/MoqToken.md deleted file mode 100644 index 68d38070..00000000 --- a/versioned_docs/version-0.27.0/api/server/interfaces/MoqToken.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: MoqToken - -Defined in: fishjam-openapi/dist/index.d.ts:204 - -Token for authorizing a MoQ relay connection - -## Export - -MoqToken - -## Properties - -### token - -> **token**: `string` - -Defined in: fishjam-openapi/dist/index.d.ts:210 - -JWT token for MoQ relay - -#### Memberof - -MoqToken diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/MoqTokenConfig.md b/versioned_docs/version-0.27.0/api/server/interfaces/MoqTokenConfig.md deleted file mode 100644 index e0f23431..00000000 --- a/versioned_docs/version-0.27.0/api/server/interfaces/MoqTokenConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: MoqTokenConfig - -Defined in: fishjam-openapi/dist/index.d.ts:217 - -MoQ token configuration - -## Export - -MoqTokenConfig - -## Properties - -### publishPath? - -> `optional` **publishPath**: `null` \| `string` - -Defined in: fishjam-openapi/dist/index.d.ts:223 - -Path under the root the token grants publish access to - -#### Memberof - -MoqTokenConfig - -*** - -### subscribePath? - -> `optional` **subscribePath**: `null` \| `string` - -Defined in: fishjam-openapi/dist/index.d.ts:229 - -Path under the root the token grants subscribe access to - -#### Memberof - -MoqTokenConfig diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsAgent.md b/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsAgent.md deleted file mode 100644 index 1fb3a246..00000000 --- a/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsAgent.md +++ /dev/null @@ -1,33 +0,0 @@ -# Interface: PeerOptionsAgent - -Defined in: fishjam-openapi/dist/index.d.ts:348 - -Options specific to the Agent peer - -## Export - -PeerOptionsAgent - -## Properties - -### output? - -> `optional` **output**: `AgentOutput` - -Defined in: fishjam-openapi/dist/index.d.ts:354 - -#### Memberof - -PeerOptionsAgent - -*** - -### subscribeMode? - -> `optional` **subscribeMode**: `SubscribeMode` - -Defined in: fishjam-openapi/dist/index.d.ts:360 - -#### Memberof - -PeerOptionsAgent diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsVapi.md b/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsVapi.md deleted file mode 100644 index de8f1622..00000000 --- a/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsVapi.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: PeerOptionsVapi - -Defined in: fishjam-openapi/dist/index.d.ts:367 - -Options specific to the VAPI peer - -## Export - -PeerOptionsVapi - -## Properties - -### apiKey - -> **apiKey**: `string` - -Defined in: fishjam-openapi/dist/index.d.ts:373 - -VAPI API key - -#### Memberof - -PeerOptionsVapi - -*** - -### callId - -> **callId**: `string` - -Defined in: fishjam-openapi/dist/index.d.ts:379 - -VAPI call ID - -#### Memberof - -PeerOptionsVapi - -*** - -### subscribeMode? - -> `optional` **subscribeMode**: `SubscribeMode` - -Defined in: fishjam-openapi/dist/index.d.ts:385 - -#### Memberof - -PeerOptionsVapi diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/AgentCallbacks.md b/versioned_docs/version-0.27.0/api/server/type-aliases/AgentCallbacks.md deleted file mode 100644 index 4d265047..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/AgentCallbacks.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: AgentCallbacks - -> **AgentCallbacks** = `object` - -Defined in: [js-server-sdk/src/types.ts:63](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L63) - -## Properties - -### onClose? - -> `optional` **onClose**: [`CloseEventHandler`](CloseEventHandler.md) - -Defined in: [js-server-sdk/src/types.ts:65](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L65) - -*** - -### onError? - -> `optional` **onError**: [`ErrorEventHandler`](ErrorEventHandler.md) - -Defined in: [js-server-sdk/src/types.ts:64](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L64) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/AgentEvents.md b/versioned_docs/version-0.27.0/api/server/type-aliases/AgentEvents.md deleted file mode 100644 index 4b863efd..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/AgentEvents.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: AgentEvents - -> **AgentEvents** = `{ [K in ExpectedAgentEvents]: (message: NonNullable<{ authenticated?: AgentResponse_Authenticated; trackData?: Omit & { peerId: PeerId }; trackImage?: AgentResponse_TrackImage }[K]>) => void }` - -Defined in: [js-server-sdk/src/agent.ts:47](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L47) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/AgentTrack.md b/versioned_docs/version-0.27.0/api/server/type-aliases/AgentTrack.md deleted file mode 100644 index c2183594..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/AgentTrack.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: AgentTrack - -> **AgentTrack** = `Omit`\<`ProtoTrack`, `"id"`\> & `object` - -Defined in: [js-server-sdk/src/agent.ts:28](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L28) - -## Type declaration - -### id - -> **id**: [`TrackId`](TrackId.md) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ChannelAdded.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ChannelAdded.md deleted file mode 100644 index 351afa70..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/ChannelAdded.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ChannelAdded - -> **ChannelAdded** = `object`\[`"channelAdded"`\] - -Defined in: [js-server-sdk/src/notifications.ts:136](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L136) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ChannelRemoved.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ChannelRemoved.md deleted file mode 100644 index 43f5d51f..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/ChannelRemoved.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ChannelRemoved - -> **ChannelRemoved** = `object`\[`"channelRemoved"`\] - -Defined in: [js-server-sdk/src/notifications.ts:137](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L137) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ErrorEventHandler.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ErrorEventHandler.md deleted file mode 100644 index aa74a7d4..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/ErrorEventHandler.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: ErrorEventHandler() - -> **ErrorEventHandler** = (`msg`) => `void` - -Defined in: [js-server-sdk/src/types.ts:60](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L60) - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `msg` | `Event` | - -## Returns - -`void` diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ExpectedEvents.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ExpectedEvents.md deleted file mode 100644 index 1adca6db..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/ExpectedEvents.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ExpectedEvents - -> **ExpectedEvents** = *typeof* `expectedEventsList`\[`number`\] - -Defined in: [js-server-sdk/src/notifications.ts:55](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L55) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/FishjamConfig.md b/versioned_docs/version-0.27.0/api/server/type-aliases/FishjamConfig.md deleted file mode 100644 index bc213ac2..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/FishjamConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: FishjamConfig - -> **FishjamConfig** = `object` - -Defined in: [js-server-sdk/src/types.ts:45](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L45) - -## Properties - -### fishjamId - -> **fishjamId**: `string` - -Defined in: [js-server-sdk/src/types.ts:50](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L50) - -*** - -### managementToken - -> **managementToken**: `string` - -Defined in: [js-server-sdk/src/types.ts:56](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L56) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/IgnoredEvents.md b/versioned_docs/version-0.27.0/api/server/type-aliases/IgnoredEvents.md deleted file mode 100644 index 956f2157..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/IgnoredEvents.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: IgnoredEvents - -> **IgnoredEvents** = *typeof* `ignoredEventsList`\[`number`\] - -Defined in: [js-server-sdk/src/notifications.ts:83](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L83) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/IncomingTrackData.md b/versioned_docs/version-0.27.0/api/server/type-aliases/IncomingTrackData.md deleted file mode 100644 index b4ce6802..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/IncomingTrackData.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: IncomingTrackData - -> **IncomingTrackData** = `Omit`\<`NonNullable`\<`AgentResponse_TrackData`\>, `"peerId"`\> & `object` - -Defined in: [js-server-sdk/src/agent.ts:24](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L24) - -## Type declaration - -### peerId - -> **peerId**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/NotificationEvents.md b/versioned_docs/version-0.27.0/api/server/type-aliases/NotificationEvents.md deleted file mode 100644 index d0bafc30..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/NotificationEvents.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: NotificationEvents - -> **NotificationEvents** = \{ \[K in ExpectedEvents\]: (message: \{ channelAdded: Omit\ & \{ roomId: RoomId \}; channelRemoved: Omit\ & \{ roomId: RoomId \}; peerAdded: Omit\ & \{ roomId: RoomId \}, "peerId"\> & \{ peerId: PeerId \}, "peerType"\> & \{ peerType: PeerType \}; peerConnected: Omit\ & \{ roomId: RoomId \}, "peerId"\> & \{ peerId: PeerId \}, "peerType"\> & \{ peerType: PeerType \}; peerCrashed: Omit\ & \{ roomId: RoomId \}, "peerId"\> & \{ peerId: PeerId \}, "peerType"\> & \{ peerType: PeerType \}; peerDeleted: Omit\ & \{ roomId: RoomId \}, "peerId"\> & \{ peerId: PeerId \}, "peerType"\> & \{ peerType: PeerType \}; peerDisconnected: Omit\ & \{ roomId: RoomId \}, "peerId"\> & \{ peerId: PeerId \}, "peerType"\> & \{ peerType: PeerType \}; peerMetadataUpdated: Omit\ & \{ roomId: RoomId \}, "peerId"\> & \{ peerId: PeerId \}, "peerType"\> & \{ peerType: PeerType \}; roomCrashed: Omit\ & \{ roomId: RoomId \}; roomCreated: Omit\ & \{ roomId: RoomId \}; roomDeleted: Omit\ & \{ roomId: RoomId \}; streamerConnected: ServerMessage\_StreamerConnected; streamerDisconnected: ServerMessage\_StreamerDisconnected; trackAdded: Omit\ & \{ roomId: RoomId \}, "track"\> & \{ track: undefined \| Track \}; trackMetadataUpdated: Omit\ & \{ roomId: RoomId \}, "track"\> & \{ track: undefined \| Track \}; trackRemoved: Omit\ & \{ roomId: RoomId \}, "track"\> & \{ track: undefined \| Track \}; viewerConnected: ServerMessage\_ViewerConnected; viewerDisconnected: ServerMessage\_ViewerDisconnected \}\[K\]) =\> void \} - -Defined in: [js-server-sdk/src/notifications.ts:165](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L165) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/OutgoingTrackData.md b/versioned_docs/version-0.27.0/api/server/type-aliases/OutgoingTrackData.md deleted file mode 100644 index e777539a..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/OutgoingTrackData.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: OutgoingTrackData - -> **OutgoingTrackData** = `Omit`\<`NonNullable`\<`AgentRequest_TrackData`\>, `"peerId"`\> & `object` - -Defined in: [js-server-sdk/src/agent.ts:26](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L26) - -## Type declaration - -### peerId - -> **peerId**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/Peer.md b/versioned_docs/version-0.27.0/api/server/type-aliases/Peer.md deleted file mode 100644 index a3a441c3..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/Peer.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: Peer - -> **Peer** = `Omit`\<`OpenApiPeer`, `"id"`\> & `object` - -Defined in: [js-server-sdk/src/types.ts:25](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L25) - -## Type declaration - -### id - -> **id**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerAdded.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerAdded.md deleted file mode 100644 index f5b2e198..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerAdded.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerAdded - -> **PeerAdded** = `object`\[`"peerAdded"`\] - -Defined in: [js-server-sdk/src/notifications.ts:123](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L123) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerConnected.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerConnected.md deleted file mode 100644 index d4b5c4c7..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerConnected.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerConnected - -> **PeerConnected** = `object`\[`"peerConnected"`\] - -Defined in: [js-server-sdk/src/notifications.ts:125](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L125) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerCrashed.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerCrashed.md deleted file mode 100644 index 9962c489..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerCrashed.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerCrashed - -> **PeerCrashed** = `object`\[`"peerCrashed"`\] - -Defined in: [js-server-sdk/src/notifications.ts:128](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L128) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerDeleted.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerDeleted.md deleted file mode 100644 index 2a20ac48..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerDeleted.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerDeleted - -> **PeerDeleted** = `object`\[`"peerDeleted"`\] - -Defined in: [js-server-sdk/src/notifications.ts:124](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L124) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerDisconnected.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerDisconnected.md deleted file mode 100644 index 48a8a1bc..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerDisconnected.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerDisconnected - -> **PeerDisconnected** = `object`\[`"peerDisconnected"`\] - -Defined in: [js-server-sdk/src/notifications.ts:126](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L126) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerMetadataUpdated.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerMetadataUpdated.md deleted file mode 100644 index 87fe78c6..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerMetadataUpdated.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerMetadataUpdated - -> **PeerMetadataUpdated** = `object`\[`"peerMetadataUpdated"`\] - -Defined in: [js-server-sdk/src/notifications.ts:127](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L127) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerOptions.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerOptions.md deleted file mode 100644 index e3477862..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerOptions.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: PeerOptions - -> **PeerOptions** = [`PeerOptionsAgent`](../interfaces/PeerOptionsAgent.md) \| [`PeerOptionsVapi`](../interfaces/PeerOptionsVapi.md) \| [`PeerOptionsWebRTC`](../interfaces/PeerOptionsWebRTC.md) - -Defined in: fishjam-openapi/dist/index.d.ts:342 - -## Export diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/Room.md b/versioned_docs/version-0.27.0/api/server/type-aliases/Room.md deleted file mode 100644 index 936ffcb5..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/Room.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: Room - -> **Room** = `object` - -Defined in: [js-server-sdk/src/types.ts:39](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L39) - -## Properties - -### config - -> **config**: [`RoomConfig`](../interfaces/RoomConfig.md) - -Defined in: [js-server-sdk/src/types.ts:42](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L42) - -*** - -### id - -> **id**: [`RoomId`](RoomId.md) - -Defined in: [js-server-sdk/src/types.ts:40](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L40) - -*** - -### peers - -> **peers**: [`Peer`](Peer.md)[] - -Defined in: [js-server-sdk/src/types.ts:41](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L41) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/RoomCrashed.md b/versioned_docs/version-0.27.0/api/server/type-aliases/RoomCrashed.md deleted file mode 100644 index c9275f6d..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/RoomCrashed.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomCrashed - -> **RoomCrashed** = `object`\[`"roomCrashed"`\] - -Defined in: [js-server-sdk/src/notifications.ts:122](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L122) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/RoomCreated.md b/versioned_docs/version-0.27.0/api/server/type-aliases/RoomCreated.md deleted file mode 100644 index 8f6fc25a..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/RoomCreated.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomCreated - -> **RoomCreated** = `object`\[`"roomCreated"`\] - -Defined in: [js-server-sdk/src/notifications.ts:120](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L120) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/RoomDeleted.md b/versioned_docs/version-0.27.0/api/server/type-aliases/RoomDeleted.md deleted file mode 100644 index 05f17729..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/RoomDeleted.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomDeleted - -> **RoomDeleted** = `object`\[`"roomDeleted"`\] - -Defined in: [js-server-sdk/src/notifications.ts:121](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L121) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/StreamerConnected.md b/versioned_docs/version-0.27.0/api/server/type-aliases/StreamerConnected.md deleted file mode 100644 index 2b741922..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/StreamerConnected.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: StreamerConnected - -> **StreamerConnected** = `object`\[`"streamerConnected"`\] - -Defined in: [js-server-sdk/src/notifications.ts:129](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L129) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/StreamerDisconnected.md b/versioned_docs/version-0.27.0/api/server/type-aliases/StreamerDisconnected.md deleted file mode 100644 index 4a7fdaa7..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/StreamerDisconnected.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: StreamerDisconnected - -> **StreamerDisconnected** = `object`\[`"streamerDisconnected"`\] - -Defined in: [js-server-sdk/src/notifications.ts:130](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L130) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/Track.md b/versioned_docs/version-0.27.0/api/server/type-aliases/Track.md deleted file mode 100644 index daec4c76..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/Track.md +++ /dev/null @@ -1,31 +0,0 @@ -# Type Alias: Track - -> **Track** = `object` - -Defined in: [js-server-sdk/src/notifications.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L13) - -Track payload embedded in [TrackAdded](TrackAdded.md), [TrackRemoved](TrackRemoved.md), [TrackMetadataUpdated](TrackMetadataUpdated.md). - -## Properties - -### id - -> **id**: `string` - -Defined in: [js-server-sdk/src/notifications.ts:14](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L14) - -*** - -### metadata - -> **metadata**: `string` - -Defined in: [js-server-sdk/src/notifications.ts:16](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L16) - -*** - -### type - -> **type**: [`TrackType`](TrackType.md) - -Defined in: [js-server-sdk/src/notifications.ts:15](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L15) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/TrackAdded.md b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackAdded.md deleted file mode 100644 index 0468b2d3..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/TrackAdded.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackAdded - -> **TrackAdded** = `object`\[`"trackAdded"`\] - -Defined in: [js-server-sdk/src/notifications.ts:133](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L133) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/TrackMetadataUpdated.md b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackMetadataUpdated.md deleted file mode 100644 index 7892b08c..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/TrackMetadataUpdated.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackMetadataUpdated - -> **TrackMetadataUpdated** = `object`\[`"trackMetadataUpdated"`\] - -Defined in: [js-server-sdk/src/notifications.ts:135](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L135) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/TrackRemoved.md b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackRemoved.md deleted file mode 100644 index a46a12ea..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/TrackRemoved.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackRemoved - -> **TrackRemoved** = `object`\[`"trackRemoved"`\] - -Defined in: [js-server-sdk/src/notifications.ts:134](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L134) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ViewerConnected.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ViewerConnected.md deleted file mode 100644 index c6998489..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/ViewerConnected.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ViewerConnected - -> **ViewerConnected** = `object`\[`"viewerConnected"`\] - -Defined in: [js-server-sdk/src/notifications.ts:131](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L131) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ViewerDisconnected.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ViewerDisconnected.md deleted file mode 100644 index 9787af9a..00000000 --- a/versioned_docs/version-0.27.0/api/server/type-aliases/ViewerDisconnected.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ViewerDisconnected - -> **ViewerDisconnected** = `object`\[`"viewerDisconnected"`\] - -Defined in: [js-server-sdk/src/notifications.ts:132](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L132) diff --git a/versioned_docs/version-0.27.0/api/server/typedoc-sidebar.cjs b/versioned_docs/version-0.27.0/api/server/typedoc-sidebar.cjs deleted file mode 100644 index b258ce4a..00000000 --- a/versioned_docs/version-0.27.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/enumerations/RoomType",label:"RoomType"},{type:"doc",id:"api/server/enumerations/VideoCodec",label:"VideoCodec"},{type:"doc",id:"api/server/classes/BadRequestException",label:"BadRequestException"},{type:"doc",id:"api/server/classes/FishjamAgent",label:"FishjamAgent"},{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/MoqToken",label:"MoqToken"},{type:"doc",id:"api/server/interfaces/MoqTokenConfig",label:"MoqTokenConfig"},{type:"doc",id:"api/server/interfaces/PeerOptionsAgent",label:"PeerOptionsAgent"},{type:"doc",id:"api/server/interfaces/PeerOptionsVapi",label:"PeerOptionsVapi"},{type:"doc",id:"api/server/interfaces/PeerOptionsWebRTC",label:"PeerOptionsWebRTC"},{type:"doc",id:"api/server/interfaces/RoomConfig",label:"RoomConfig"},{type:"doc",id:"api/server/interfaces/ServerMessage",label:"ServerMessage"},{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/AgentCallbacks",label:"AgentCallbacks"},{type:"doc",id:"api/server/type-aliases/AgentEvents",label:"AgentEvents"},{type:"doc",id:"api/server/type-aliases/AgentTrack",label:"AgentTrack"},{type:"doc",id:"api/server/type-aliases/AudioCodecParameters",label:"AudioCodecParameters"},{type:"doc",id:"api/server/type-aliases/Brand",label:"Brand"},{type:"doc",id:"api/server/type-aliases/ChannelAdded",label:"ChannelAdded"},{type:"doc",id:"api/server/type-aliases/ChannelRemoved",label:"ChannelRemoved"},{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/ExpectedAgentEvents",label:"ExpectedAgentEvents"},{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/IgnoredEvents",label:"IgnoredEvents"},{type:"doc",id:"api/server/type-aliases/IncomingTrackData",label:"IncomingTrackData"},{type:"doc",id:"api/server/type-aliases/IncomingTrackImage",label:"IncomingTrackImage"},{type:"doc",id:"api/server/type-aliases/NotificationEvents",label:"NotificationEvents"},{type:"doc",id:"api/server/type-aliases/OutgoingTrackData",label:"OutgoingTrackData"},{type:"doc",id:"api/server/type-aliases/Peer",label:"Peer"},{type:"doc",id:"api/server/type-aliases/PeerAdded",label:"PeerAdded"},{type:"doc",id:"api/server/type-aliases/PeerConnected",label:"PeerConnected"},{type:"doc",id:"api/server/type-aliases/PeerCrashed",label:"PeerCrashed"},{type:"doc",id:"api/server/type-aliases/PeerDeleted",label:"PeerDeleted"},{type:"doc",id:"api/server/type-aliases/PeerDisconnected",label:"PeerDisconnected"},{type:"doc",id:"api/server/type-aliases/PeerId",label:"PeerId"},{type:"doc",id:"api/server/type-aliases/PeerMetadataUpdated",label:"PeerMetadataUpdated"},{type:"doc",id:"api/server/type-aliases/PeerOptions",label:"PeerOptions"},{type:"doc",id:"api/server/type-aliases/PeerType",label:"PeerType"},{type:"doc",id:"api/server/type-aliases/Room",label:"Room"},{type:"doc",id:"api/server/type-aliases/RoomCrashed",label:"RoomCrashed"},{type:"doc",id:"api/server/type-aliases/RoomCreated",label:"RoomCreated"},{type:"doc",id:"api/server/type-aliases/RoomDeleted",label:"RoomDeleted"},{type:"doc",id:"api/server/type-aliases/RoomId",label:"RoomId"},{type:"doc",id:"api/server/type-aliases/StreamerConnected",label:"StreamerConnected"},{type:"doc",id:"api/server/type-aliases/StreamerDisconnected",label:"StreamerDisconnected"},{type:"doc",id:"api/server/type-aliases/Track",label:"Track"},{type:"doc",id:"api/server/type-aliases/TrackAdded",label:"TrackAdded"},{type:"doc",id:"api/server/type-aliases/TrackId",label:"TrackId"},{type:"doc",id:"api/server/type-aliases/TrackMetadataUpdated",label:"TrackMetadataUpdated"},{type:"doc",id:"api/server/type-aliases/TrackRemoved",label:"TrackRemoved"},{type:"doc",id:"api/server/type-aliases/TrackType",label:"TrackType"},{type:"doc",id:"api/server/type-aliases/ViewerConnected",label:"ViewerConnected"},{type:"doc",id:"api/server/type-aliases/ViewerDisconnected",label:"ViewerDisconnected"},{type:"doc",id:"api/server/variables/ServerMessage",label:"ServerMessage"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/versioned_docs/version-0.27.0/api/web/functions/useSandbox.md b/versioned_docs/version-0.27.0/api/web/functions/useSandbox.md deleted file mode 100644 index 5312c3b6..00000000 --- a/versioned_docs/version-0.27.0/api/web/functions/useSandbox.md +++ /dev/null @@ -1,60 +0,0 @@ -# Function: useSandbox() - -> **useSandbox**(`props`): `object` - -Defined in: [react-client/src/hooks/useSandbox.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useSandbox.ts#L19) - -## 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.27.0/api/web/type-aliases/BandwidthLimits.md b/versioned_docs/version-0.27.0/api/web/type-aliases/BandwidthLimits.md deleted file mode 100644 index 3a0b77cd..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/BandwidthLimits.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: BandwidthLimits - -> **BandwidthLimits** = `object` - -Defined in: [react-client/src/types/public.ts:70](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L70) - -## Properties - -### simulcast - -> **simulcast**: [`SimulcastBandwidthLimits`](SimulcastBandwidthLimits.md) - -Defined in: [react-client/src/types/public.ts:70](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L70) - -*** - -### singleStream - -> **singleStream**: `number` - -Defined in: [react-client/src/types/public.ts:70](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L70) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/CustomSource.md b/versioned_docs/version-0.27.0/api/web/type-aliases/CustomSource.md deleted file mode 100644 index 7f96610d..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/CustomSource.md +++ /dev/null @@ -1,40 +0,0 @@ -# Type Alias: CustomSource\ - -> **CustomSource**\<`T`\> = `object` - -Defined in: [react-client/src/types/public.ts:83](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L83) - -## Type Parameters - -| Type Parameter | -| ------ | -| `T` *extends* `string` | - -## Properties - -### id - -> **id**: `T` - -Defined in: [react-client/src/types/public.ts:84](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L84) - -*** - -### stream? - -> `optional` **stream**: `MediaStream` - -Defined in: [react-client/src/types/public.ts:86](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L86) - -*** - -### trackIds? - -> `optional` **trackIds**: `object` - -Defined in: [react-client/src/types/public.ts:85](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L85) - -| Name | Type | -| ------ | ------ | -| `audioId?` | `string` | -| `videoId?` | `string` | diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/DeviceItem.md b/versioned_docs/version-0.27.0/api/web/type-aliases/DeviceItem.md deleted file mode 100644 index 31dc61f6..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/DeviceItem.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: DeviceItem - -> **DeviceItem** = `object` - -Defined in: [react-client/src/types/public.ts:55](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L55) - -## Properties - -### deviceId - -> **deviceId**: `string` - -Defined in: [react-client/src/types/public.ts:55](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L55) - -*** - -### label - -> **label**: `string` - -Defined in: [react-client/src/types/public.ts:55](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L55) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesStatus.md b/versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesStatus.md deleted file mode 100644 index b40e1125..00000000 --- a/versioned_docs/version-0.27.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: [react-client/src/types/public.ts:9](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L9) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/MiddlewareResult.md b/versioned_docs/version-0.27.0/api/web/type-aliases/MiddlewareResult.md deleted file mode 100644 index ca0294f4..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/MiddlewareResult.md +++ /dev/null @@ -1,25 +0,0 @@ -# Type Alias: MiddlewareResult - -> **MiddlewareResult** = `object` - -Defined in: [react-client/src/types/public.ts:32](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L32) - -## Properties - -### onClear()? - -> `optional` **onClear**: () => `void` - -Defined in: [react-client/src/types/public.ts:32](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L32) - -#### Returns - -`void` - -*** - -### track - -> **track**: `MediaStreamTrack` - -Defined in: [react-client/src/types/public.ts:32](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L32) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/PeerId.md b/versioned_docs/version-0.27.0/api/web/type-aliases/PeerId.md deleted file mode 100644 index 527f04c7..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/PeerId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerId - -> **PeerId** = [`Brand`](Brand.md)\<`string`, `"PeerId"`\> - -Defined in: [react-client/src/types/public.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L18) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/PeerWithTracks.md b/versioned_docs/version-0.27.0/api/web/type-aliases/PeerWithTracks.md deleted file mode 100644 index c85d7c5a..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/PeerWithTracks.md +++ /dev/null @@ -1,85 +0,0 @@ -# Type Alias: PeerWithTracks\ - -> **PeerWithTracks**\<`PeerMetadata`, `ServerMetadata`, `T`\> = `object` - -Defined in: [react-client/src/hooks/usePeers.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L14) - -## Type Parameters - -| Type Parameter | Default type | 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. | -| `T` *extends* [`Track`](Track.md) | [`Track`](Track.md) | - | - -## Properties - -### cameraTrack? - -> `optional` **cameraTrack**: `T` - -Defined in: [react-client/src/hooks/usePeers.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L18) - -*** - -### customAudioTracks - -> **customAudioTracks**: `T`[] - -Defined in: [react-client/src/hooks/usePeers.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L23) - -*** - -### customVideoTracks - -> **customVideoTracks**: `T`[] - -Defined in: [react-client/src/hooks/usePeers.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L22) - -*** - -### id - -> **id**: [`PeerId`](PeerId.md) - -Defined in: [react-client/src/hooks/usePeers.ts:15](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L15) - -*** - -### metadata? - -> `optional` **metadata**: [`Metadata`](Metadata.md)\<`PeerMetadata`, `ServerMetadata`\> - -Defined in: [react-client/src/hooks/usePeers.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L16) - -*** - -### microphoneTrack? - -> `optional` **microphoneTrack**: `T` - -Defined in: [react-client/src/hooks/usePeers.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L19) - -*** - -### screenShareAudioTrack? - -> `optional` **screenShareAudioTrack**: `T` - -Defined in: [react-client/src/hooks/usePeers.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L21) - -*** - -### screenShareVideoTrack? - -> `optional` **screenShareVideoTrack**: `T` - -Defined in: [react-client/src/hooks/usePeers.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L20) - -*** - -### tracks - -> **tracks**: `T`[] - -Defined in: [react-client/src/hooks/usePeers.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L17) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/PersistLastDeviceHandlers.md b/versioned_docs/version-0.27.0/api/web/type-aliases/PersistLastDeviceHandlers.md deleted file mode 100644 index 1082c622..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/PersistLastDeviceHandlers.md +++ /dev/null @@ -1,42 +0,0 @@ -# Type Alias: PersistLastDeviceHandlers - -> **PersistLastDeviceHandlers** = `object` - -Defined in: [react-client/src/types/public.ts:57](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L57) - -## Properties - -### getLastDevice() - -> **getLastDevice**: (`deviceType`) => `MediaDeviceInfo` \| `null` - -Defined in: [react-client/src/types/public.ts:58](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L58) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `deviceType` | `"audio"` \| `"video"` | - -#### Returns - -`MediaDeviceInfo` \| `null` - -*** - -### saveLastDevice() - -> **saveLastDevice**: (`info`, `deviceType`) => `void` - -Defined in: [react-client/src/types/public.ts:59](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L59) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `info` | `MediaDeviceInfo` | -| `deviceType` | `"audio"` \| `"video"` | - -#### Returns - -`void` diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/RemoteTrack.md b/versioned_docs/version-0.27.0/api/web/type-aliases/RemoteTrack.md deleted file mode 100644 index e235fe2d..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/RemoteTrack.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: RemoteTrack - -> **RemoteTrack** = [`Track`](Track.md) & `object` - -Defined in: [react-client/src/types/public.ts:28](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L28) - -## Type declaration - -### setReceivedQuality() - -> **setReceivedQuality**: (`quality`) => `void` - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `quality` | [`Variant`](../enumerations/Variant.md) | - -#### Returns - -`void` diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/RoomType.md b/versioned_docs/version-0.27.0/api/web/type-aliases/RoomType.md deleted file mode 100644 index e429483e..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/RoomType.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomType - -> **RoomType** = `"conference"` \| `"livestream"` \| `"audio_only"` - -Defined in: [react-client/src/hooks/useSandbox.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useSandbox.ts#L17) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/SimulcastBandwidthLimits.md b/versioned_docs/version-0.27.0/api/web/type-aliases/SimulcastBandwidthLimits.md deleted file mode 100644 index 026cfb51..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/SimulcastBandwidthLimits.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: SimulcastBandwidthLimits - -> **SimulcastBandwidthLimits** = `object` - -Defined in: [react-client/src/types/public.ts:62](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L62) - -## Properties - -### 1 - -> **1**: `number` - -Defined in: [react-client/src/types/public.ts:63](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L63) - -*** - -### 2 - -> **2**: `number` - -Defined in: [react-client/src/types/public.ts:64](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L64) - -*** - -### 3 - -> **3**: `number` - -Defined in: [react-client/src/types/public.ts:65](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L65) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/StreamConfig.md b/versioned_docs/version-0.27.0/api/web/type-aliases/StreamConfig.md deleted file mode 100644 index 45164c3e..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/StreamConfig.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: StreamConfig - -> **StreamConfig** = `object` - -Defined in: [react-client/src/types/public.ts:68](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L68) - -## Properties - -### sentQualities? - -> `optional` **sentQualities**: [`Variant`](../enumerations/Variant.md)[] \| `false` - -Defined in: [react-client/src/types/public.ts:68](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L68) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/Track.md b/versioned_docs/version-0.27.0/api/web/type-aliases/Track.md deleted file mode 100644 index c7a10ad4..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/Track.md +++ /dev/null @@ -1,45 +0,0 @@ -# Type Alias: Track - -> **Track** = `object` - -Defined in: [react-client/src/types/public.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L20) - -## Properties - -### metadata? - -> `optional` **metadata**: `TrackMetadata` - -Defined in: [react-client/src/types/public.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L23) - -*** - -### simulcastConfig - -> **simulcastConfig**: [`SimulcastConfig`](../interfaces/SimulcastConfig.md) \| `null` - -Defined in: [react-client/src/types/public.ts:24](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L24) - -*** - -### stream - -> **stream**: `MediaStream` \| `null` - -Defined in: [react-client/src/types/public.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L21) - -*** - -### track - -> **track**: `MediaStreamTrack` \| `null` - -Defined in: [react-client/src/types/public.ts:25](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L25) - -*** - -### trackId - -> **trackId**: [`TrackId`](TrackId.md) - -Defined in: [react-client/src/types/public.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L22) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/TrackId.md b/versioned_docs/version-0.27.0/api/web/type-aliases/TrackId.md deleted file mode 100644 index 5053a276..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/TrackId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackId - -> **TrackId** = [`Brand`](Brand.md)\<`string`, `"TrackId"`\> - -Defined in: [react-client/src/types/public.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L17) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/TrackMiddleware.md b/versioned_docs/version-0.27.0/api/web/type-aliases/TrackMiddleware.md deleted file mode 100644 index 2bca6ee3..00000000 --- a/versioned_docs/version-0.27.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: [react-client/src/types/public.ts:33](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L33) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/TracksMiddlewareResult.md b/versioned_docs/version-0.27.0/api/web/type-aliases/TracksMiddlewareResult.md deleted file mode 100644 index 06f353cc..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/TracksMiddlewareResult.md +++ /dev/null @@ -1,33 +0,0 @@ -# Type Alias: TracksMiddlewareResult - -> **TracksMiddlewareResult** = `object` - -Defined in: [react-client/src/types/public.ts:35](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L35) - -## Properties - -### audioTrack - -> **audioTrack**: `MediaStreamTrack` \| `null` - -Defined in: [react-client/src/types/public.ts:37](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L37) - -*** - -### onClear() - -> **onClear**: () => `void` - -Defined in: [react-client/src/types/public.ts:38](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L38) - -#### Returns - -`void` - -*** - -### videoTrack - -> **videoTrack**: `MediaStreamTrack` - -Defined in: [react-client/src/types/public.ts:36](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L36) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/UseSandboxProps.md b/versioned_docs/version-0.27.0/api/web/type-aliases/UseSandboxProps.md deleted file mode 100644 index 9b1e3061..00000000 --- a/versioned_docs/version-0.27.0/api/web/type-aliases/UseSandboxProps.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: UseSandboxProps - -> **UseSandboxProps** = `object` - -Defined in: [react-client/src/hooks/useSandbox.ts:13](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useSandbox.ts#L13) - -## Properties - -### sandboxApiUrl - -> **sandboxApiUrl**: `string` - -Defined in: [react-client/src/hooks/useSandbox.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useSandbox.ts#L14) diff --git a/versioned_docs/version-0.27.0/how-to/backend/production-deployment.mdx b/versioned_docs/version-0.27.0/how-to/backend/production-deployment.mdx deleted file mode 100644 index 645aff77..00000000 --- a/versioned_docs/version-0.27.0/how-to/backend/production-deployment.mdx +++ /dev/null @@ -1,301 +0,0 @@ ---- -type: how-to -description: Deploy your Fishjam backend safely to production, moving from sandbox to a production-ready setup. ---- - -import TabItem from "@theme/TabItem"; -import Tabs from "@theme/Tabs"; - -# 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)) -- A Fishjam account on the **Standard Jar** plan (recommended for production deployments) -- Domain and SSL certificates for your backend -- Production database and infrastructure - -## Step 1: Get your Fishjam credentials - -### Get credentials from the dashboard - -1. Log in to [Fishjam Dashboard](https://fishjam.io/app) -2. Copy your **Fishjam ID** and **Management Token** from the dashboard - -:::tip -The **Standard Jar** plan is recommended for production deployments. With the **Mini Jar** plan, you can still develop and test using the Sandbox API, but production deployments should use the Standard Jar plan to get full access and reliability guarantees. -::: - -### Environment variables setup - -Create your environment variables: - -```bash -# Fishjam credentials -FISHJAM_ID="your-fishjam-id" -FISHJAM_MANAGEMENT_TOKEN="your-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: Replace Sandbox API with 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 sandboxApiUrl = "your-sandbox-api-url-here"; -const { getSandboxPeerToken } = useSandbox({ sandboxApiUrl }); - -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_ID = ""; -process.env.FISHJAM_MANAGEMENT_TOKEN = ""; -process.env.JWT_SECRET = ""; - -// ---cut--- -const fishjamClient = new FishjamClient({ - fishjamId: process.env.FISHJAM_ID!, - 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 }); - } 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({ - fishjamId: "", - 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.27.0/how-to/client/stream-middleware.mdx b/versioned_docs/version-0.27.0/how-to/client/stream-middleware.mdx deleted file mode 100644 index 714ab90c..00000000 --- a/versioned_docs/version-0.27.0/how-to/client/stream-middleware.mdx +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: "Stream middleware" -sidebar_position: 7 -sidebar_label: "Stream middleware 🌐" -description: Intercept and transform media tracks before sending them to Fishjam, enabling effects and custom encodings. ---- - -# Stream middleware Web - -:::note -This guide is exclusively for **Web** (React) applications. -::: - -Stream middleware in Fishjam allows you to intercept and manipulate media tracks before they are sent to the Fishjam server. -This feature is powerful for applying effects, custom encodings, or any other transformations to the media stream. - -## Overview - -Define a [`TrackMiddleware`](../../api/web/type-aliases/TrackMiddleware) function which takes a `MediaStreamTrack` and returns an object containing the modified `MediaStreamTrack` -and an optional `onClear` function, which is called when the middleware needs to be removed or reapplied when a device changes. - -### Type definition - -```typescript -export type TrackMiddleware = ( - track: MediaStreamTrack, -) => { track: MediaStreamTrack; onClear?: () => void } | null; -``` - -### Setting middleware - -You can set the middleware for your media tracks using [`setTrackMiddleware`](../../api/web/functions/useCamera) method. This method accepts a `TrackMiddleware` or `null` for removing previously set middleware. - -### Example: Applying a blur effect - -The following example demonstrates how to apply a custom blur effect to the camera track using the [`useCamera`](../../api/web/functions/useCamera) hook and middleware. - -```tsx -class BlurProcessor { - track: MediaStreamTrack; - - constructor(stream: MediaStream) { - this.track = this.applyBlurEffect(stream); - } - - private applyBlurEffect(stream: MediaStream): MediaStreamTrack { - return stream.getVideoTracks()[0]; - } - - destroy() {} -} - -// ---cut--- -import React, { useCallback, useEffect, useRef } from "react"; -import type { TrackMiddleware } from "@fishjam-cloud/react-client"; -import { useCamera } from "@fishjam-cloud/react-client"; - -export function CameraWithBlurEffect() { - const videoRef = useRef(null); - // [!code highlight:2] - const { cameraStream, currentCameraMiddleware, setCameraTrackMiddleware } = - useCamera(); - - useEffect(() => { - if (!videoRef.current) return; - videoRef.current.srcObject = cameraStream ?? null; - }, [cameraStream]); - - // Define blur middleware - const blurMiddleware: TrackMiddleware = useCallback( - (track: MediaStreamTrack) => { - const streamToBlur = new MediaStream([track]); - // BlurProcessor is just an example, - // process the stream however you need - const blurProcessor = new BlurProcessor(streamToBlur); - - return { - track: blurProcessor.track, - onClear: () => blurProcessor.destroy(), - }; - }, - [], - ); - - // Check if the current middleware is blur - const isBlurEnabled = currentCameraMiddleware === blurMiddleware; - - // Toggle blur effect - const toggleBlur = () => { - setCameraTrackMiddleware(isBlurEnabled ? null : blurMiddleware); // [!code highlight] - }; - - return ( - <> - - - {cameraStream &&