diff --git a/package.json b/package.json index 7853fb5e..a7f9fd10 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "fishjam-docs", - "version": "0.23.0", + "version": "0.24.0", "private": true, "scripts": { "docusaurus": "docusaurus", diff --git a/versioned_docs/version-0.24.0/_common/agents/definition.mdx b/versioned_docs/version-0.24.0/_common/agents/definition.mdx new file mode 100644 index 00000000..c6de7300 --- /dev/null +++ b/versioned_docs/version-0.24.0/_common/agents/definition.mdx @@ -0,0 +1,6 @@ +## What is an Agent? + +An agent is a piece of software that allows your backend server to participate in a Fishjam room, similar to how the Fishjam client SDKs allow your client-side application to participate in a Fishjam room. +They can be used to implement features such as real-time audio transcription, real-time content moderation, conversations with AI agents and more. + +You can simply think of an agent as a peer running within your backend application. diff --git a/versioned_docs/version-0.24.0/_common/agents/remember-to-disconnect.mdx b/versioned_docs/version-0.24.0/_common/agents/remember-to-disconnect.mdx new file mode 100644 index 00000000..4960eed1 --- /dev/null +++ b/versioned_docs/version-0.24.0/_common/agents/remember-to-disconnect.mdx @@ -0,0 +1,3 @@ +:::danger Remember to disconnect your agents! +It's important to disconnect agents, because **every connected agent generates usage** just as a normal peer. +::: diff --git a/versioned_docs/version-0.24.0/_common/agents/subscriptions.mdx b/versioned_docs/version-0.24.0/_common/agents/subscriptions.mdx new file mode 100644 index 00000000..f4aaa318 --- /dev/null +++ b/versioned_docs/version-0.24.0/_common/agents/subscriptions.mdx @@ -0,0 +1,4 @@ +By default, agents **won't** receive peers' audio streams. +This is by design and aims to prevent unnecessary resource usage by the agents. + +For an agent to start receiving a peer's audio, the peer must be **created** with the **subscribe** option set. diff --git a/versioned_docs/version-0.24.0/api/_category_.json b/versioned_docs/version-0.24.0/api/_category_.json new file mode 100644 index 00000000..24fd9392 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/_category_.json @@ -0,0 +1,12 @@ +{ + "label": "API", + "position": 6, + "link": { + "type": "generated-index", + "description": "API documentation for Client and Server SDKs.", + "slug": "/api" + }, + "customProps": { + "id": "generated-api" + } +} diff --git a/versioned_docs/version-0.24.0/api/mobile/functions/FishjamRoom.md b/versioned_docs/version-0.24.0/api/mobile/functions/FishjamRoom.md new file mode 100644 index 00000000..58202eea --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/functions/FishjamRoom.md @@ -0,0 +1,31 @@ +# Function: FishjamRoom() + +> **FishjamRoom**(`props`): `Element` + +Defined in: [packages/react-native-client/src/components/FishjamRoom/index.tsx:39](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/FishjamRoom/index.tsx#L39) + +Simple component that enables your camera and show all tracks + +Example usage: +```tsx +import { FishjamRoom } from '@fishjam-cloud/react-native-client'; +import React from 'react'; + +const FISHJAM_ID = 'your-fishjam_id'; +const PEER_TOKEN = 'your-peer-token'; + + +``` + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `props` | [`FishjamRoomProps`](../type-aliases/FishjamRoomProps.md) | | + +## Returns + +`Element` diff --git a/versioned_docs/version-0.24.0/api/mobile/functions/setOverwriteDebugConfig.md b/versioned_docs/version-0.24.0/api/mobile/functions/setOverwriteDebugConfig.md new file mode 100644 index 00000000..81b79865 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/functions/setOverwriteDebugConfig.md @@ -0,0 +1,15 @@ +# Function: setOverwriteDebugConfig() + +> **setOverwriteDebugConfig**(`partial`): `void` + +Defined in: [packages/react-native-client/src/utils/config.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/utils/config.ts#L9) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `partial` | `Partial`\<[`DebugConfig`](../type-aliases/DebugConfig.md)\> | + +## Returns + +`void` diff --git a/versioned_docs/version-0.24.0/api/mobile/functions/useAudioSettings.md b/versioned_docs/version-0.24.0/api/mobile/functions/useAudioSettings.md new file mode 100644 index 00000000..4c8a8a6b --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/functions/useAudioSettings.md @@ -0,0 +1,66 @@ +# Function: useAudioSettings() + +> **useAudioSettings**(): `object` + +Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:39](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useAudioSettings.ts#L39) + +This hook manages audio settings. + +## Returns + +### availableDevices + +> **availableDevices**: [`AudioOutputDevice`](../type-aliases/AudioOutputDevice.md)[] + +[Android only] available audio output devices to be set + +### selectAudioSessionMode() + +> **selectAudioSessionMode**: (`audioSessionMode`) => `Promise`\<`void`\> + +[iOS only] selects audio session mode. For more information refer to Apple's documentation: + https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/ + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `audioSessionMode` | [`AudioSessionMode`](../type-aliases/AudioSessionMode.md) | + +#### Returns + +`Promise`\<`void`\> + +### selectedAudioOutputDevice + +> **selectedAudioOutputDevice**: `null` \| [`AudioOutputDevice`](../type-aliases/AudioOutputDevice.md) + +currently selected output audio device + +### selectOutputAudioDevice() + +> **selectOutputAudioDevice**: (`device`) => `Promise`\<`void`\> + +[Android only] selects output audio device. +For detecting and selecting bluettoth devices make sure you have the BLUETOOTH_CONNECT permission. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `device` | [`AudioOutputDeviceType`](../type-aliases/AudioOutputDeviceType.md) | + +#### Returns + +`Promise`\<`void`\> + +### showAudioRoutePicker() + +> **showAudioRoutePicker**: () => `Promise`\<`void`\> + +[iOS only] Shows a picker modal that allows user to select output audio device. For more +information refer to Apple's documentation: https://developer.apple.com/documentation/avkit/avroutepickerview + +#### Returns + +`Promise`\<`void`\> diff --git a/versioned_docs/version-0.24.0/api/mobile/functions/useBandwidthEstimation.md b/versioned_docs/version-0.24.0/api/mobile/functions/useBandwidthEstimation.md new file mode 100644 index 00000000..59f216f0 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/functions/useBandwidthEstimation.md @@ -0,0 +1,17 @@ +# Function: useBandwidthEstimation() + +> **useBandwidthEstimation**(): `object` + +Defined in: [packages/react-native-client/src/hooks/useBandwidthEstimation.ts:11](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useBandwidthEstimation.ts#L11) + +This hook provides current bandwidth estimation +estimation - client's available incoming bitrate estimated +by the server. It's measured in bits per second. + +## Returns + +### estimation + +> **estimation**: `null` \| `number` + +Bandwidth estimation, measured in bits per second diff --git a/versioned_docs/version-0.24.0/api/mobile/functions/useCamera.md b/versioned_docs/version-0.24.0/api/mobile/functions/useCamera.md new file mode 100644 index 00000000..1e9bfd2a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/functions/useCamera.md @@ -0,0 +1,90 @@ +# Function: useCamera() + +> **useCamera**(): `object` + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:116](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L116) + +This hook can toggle camera on/off and provides current camera state. + +## Returns + +### cameras + +> **cameras**: readonly [`Camera`](../type-aliases/Camera.md)[] + +Property that lists cameras available on device. + +#### Returns + +A promise that resolves to the list of available cameras. + +### currentCamera + +> **currentCamera**: `null` \| [`Camera`](../type-aliases/Camera.md) + +Which camera is now used for streaming (or will be used as default when camera will be enabled) + +### isCameraOn + +> **isCameraOn**: `boolean` + +Informs if user camera is streaming video + +### isInitialized + +> **isInitialized**: `boolean` = `isCameraInitialized` + +A value indicating if camera was already initialized (if `prepareCamera` was called). + +### prepareCamera() + +> **prepareCamera**: (`config`) => `Promise`\<`boolean`\> + +Prepares camera and starts local video track + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `config` | `Readonly`\<[`CameraConfig`](../type-aliases/CameraConfig.md)\> | configuration of the camera capture | + +#### Returns + +`Promise`\<`boolean`\> + +A promise that resolves when camera is started. + +### simulcastConfig + +> **simulcastConfig**: [`SimulcastConfig`](../type-aliases/SimulcastConfig.md) + +Simulcast configuration + +### switchCamera() + +> **switchCamera**: (`cameraId`) => `Promise`\<`void`\> + +Switches to the specified camera. +List of available devices can be retrieved from `cameras` variable + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `cameraId` | [`CameraId`](../type-aliases/CameraId.md) | + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when camera is switched. + +### toggleCamera() + +> **toggleCamera**: () => `Promise`\<`void`\> + +Enable/disable current camera + +#### Returns + +`Promise`\<`void`\> diff --git a/versioned_docs/version-0.24.0/api/mobile/functions/useConnection.md b/versioned_docs/version-0.24.0/api/mobile/functions/useConnection.md new file mode 100644 index 00000000..9e8045f2 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/functions/useConnection.md @@ -0,0 +1,51 @@ +# Function: useConnection() + +> **useConnection**(): `object` + +Defined in: [packages/react-native-client/src/hooks/useConnection.ts:104](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useConnection.ts#L104) + +Connect/leave room. And get connection status. + +## Returns + +### joinRoom() + +> **joinRoom**: \<`PeerMetadata`\>(`__namedParameters`) => `Promise`\<`void`\> + +Join room and start streaming camera and microphone + +See [JoinRoomConfig](../type-aliases/JoinRoomConfig.md) for parameter list + +#### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* [`GenericMetadata`](../type-aliases/GenericMetadata.md) | [`GenericMetadata`](../type-aliases/GenericMetadata.md) | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | [`JoinRoomConfig`](../type-aliases/JoinRoomConfig.md)\<`PeerMetadata`\> | + +#### Returns + +`Promise`\<`void`\> + +### leaveRoom() + +> **leaveRoom**: () => `void` + +Leave room and stop streaming + +#### Returns + +`void` + +### peerStatus + +> **peerStatus**: [`PeerStatus`](../type-aliases/PeerStatus.md) + +### reconnectionStatus + +> **reconnectionStatus**: [`ReconnectionStatus`](../type-aliases/ReconnectionStatus.md) diff --git a/versioned_docs/version-0.24.0/api/mobile/functions/useMicrophone.md b/versioned_docs/version-0.24.0/api/mobile/functions/useMicrophone.md new file mode 100644 index 00000000..dddf98b5 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/functions/useMicrophone.md @@ -0,0 +1,45 @@ +# Function: useMicrophone() + +> **useMicrophone**(): `object` + +Defined in: [packages/react-native-client/src/hooks/useMicrophone.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useMicrophone.ts#L12) + +This hook can toggle microphone on/off and provides current microphone state. + +## Returns + +### isMicrophoneOn + +> **isMicrophoneOn**: `boolean` + +Informs if microphone audio track is active + +### startMicrophone() + +> **startMicrophone**: () => `Promise`\<`void`\> + +Starts microphone and requests permission if needed + +#### Returns + +`Promise`\<`void`\> + +### stopMicrophone() + +> **stopMicrophone**: () => `Promise`\<`void`\> + +Stops microphone (mutes the track without removing it) + +#### Returns + +`Promise`\<`void`\> + +### toggleMicrophone() + +> **toggleMicrophone**: () => `Promise`\<`void`\> + +Toggles microphone on/off based on the value of `isMicrophoneOn` + +#### Returns + +`Promise`\<`void`\> diff --git a/versioned_docs/version-0.24.0/api/mobile/functions/usePeers.md b/versioned_docs/version-0.24.0/api/mobile/functions/usePeers.md new file mode 100644 index 00000000..1441bd0a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/functions/usePeers.md @@ -0,0 +1,39 @@ +# Function: usePeers() + +> **usePeers**\<`PeerMetadata`, `ServerMetadata`\>(): `object` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:186](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L186) + +Hook that provides live updates of room peers. + +## Type Parameters + +| Type Parameter | Default type | Description | +| ------ | ------ | ------ | +| `PeerMetadata` *extends* [`GenericMetadata`](../type-aliases/GenericMetadata.md) | [`GenericMetadata`](../type-aliases/GenericMetadata.md) | Type for peer-specific metadata | +| `ServerMetadata` *extends* [`GenericMetadata`](../type-aliases/GenericMetadata.md) | [`GenericMetadata`](../type-aliases/GenericMetadata.md) | Type for server-specific metadata | + +## Returns + +### localPeer + +> **localPeer**: `null` \| [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\> + +The local peer with distinguished tracks (camera, microphone, screen share). +Will be null if the local peer is not found. + +### ~~peers~~ + +> **peers**: [`Peer`](../type-aliases/Peer.md)\<`PeerMetadata`, `ServerMetadata`\>[] + +#### Deprecated + +Use localPeer and remotePeers instead +Legacy array containing all peers (both local and remote) without distinguished tracks. +This property will be removed in future versions. + +### remotePeers + +> **remotePeers**: [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\>[] + +Array of remote peers with distinguished tracks (camera, microphone, screen share). diff --git a/versioned_docs/version-0.24.0/api/mobile/functions/useSandbox.md b/versioned_docs/version-0.24.0/api/mobile/functions/useSandbox.md new file mode 100644 index 00000000..627e4326 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/functions/useSandbox.md @@ -0,0 +1,60 @@ +# Function: useSandbox() + +> **useSandbox**(`__namedParameters`): `object` + +Defined in: [packages/react-native-client/src/hooks/useSandbox.ts:17](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useSandbox.ts#L17) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | [`UseSandboxProps`](../type-aliases/UseSandboxProps.md) | + +## Returns + +`object` + +### getSandboxLivestream() + +> **getSandboxLivestream**: (`roomName`, `isPublic`) => `Promise`\<\{ `room`: \{ `id`: `string`; `name`: `string`; \}; `streamerToken`: `string`; \}\> + +#### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `roomName` | `string` | `undefined` | +| `isPublic` | `boolean` | `false` | + +#### Returns + +`Promise`\<\{ `room`: \{ `id`: `string`; `name`: `string`; \}; `streamerToken`: `string`; \}\> + +### getSandboxPeerToken() + +> **getSandboxPeerToken**: (`roomName`, `peerName`, `roomType`) => `Promise`\<`string`\> + +#### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `roomName` | `string` | `undefined` | +| `peerName` | `string` | `undefined` | +| `roomType` | [`RoomType`](../type-aliases/RoomType.md) | `'conference'` | + +#### Returns + +`Promise`\<`string`\> + +### getSandboxViewerToken() + +> **getSandboxViewerToken**: (`roomName`) => `Promise`\<`string`\> + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomName` | `string` | + +#### Returns + +`Promise`\<`string`\> diff --git a/versioned_docs/version-0.24.0/api/mobile/functions/useScreenShare.md b/versioned_docs/version-0.24.0/api/mobile/functions/useScreenShare.md new file mode 100644 index 00000000..c0471461 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/functions/useScreenShare.md @@ -0,0 +1,40 @@ +# Function: useScreenShare() + +> **useScreenShare**(): `object` + +Defined in: [packages/react-native-client/src/hooks/useScreenShare.ts:35](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useScreenShare.ts#L35) + +This hook can toggle screen sharing on/off and provides current screen share state. + +## Returns + +An object with functions to manage screen share. + +### handleScreenSharePermission() + +> **handleScreenSharePermission**: () => `Promise`\<`"granted"` \| `"denied"`\> + +#### Returns + +`Promise`\<`"granted"` \| `"denied"`\> + +### isScreenShareOn + +> **isScreenShareOn**: `boolean` + +### toggleScreenShare() + +> **toggleScreenShare**: (`screenShareOptions`) => `Promise`\<`void`\> + +Toggles the screen share on/off +Emits warning on ios when user is screensharing app screen. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `screenShareOptions` | `Partial`\<[`ScreenShareOptions`](../type-aliases/ScreenShareOptions.md)\> | + +#### Returns + +`Promise`\<`void`\> diff --git a/versioned_docs/version-0.24.0/api/mobile/functions/useUpdatePeerMetadata.md b/versioned_docs/version-0.24.0/api/mobile/functions/useUpdatePeerMetadata.md new file mode 100644 index 00000000..6a7768ec --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/functions/useUpdatePeerMetadata.md @@ -0,0 +1,31 @@ +# Function: useUpdatePeerMetadata() + +> **useUpdatePeerMetadata**\<`PeerMetadata`\>(): `object` + +Defined in: [packages/react-native-client/src/hooks/useUpdatePeerMetadata.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useUpdatePeerMetadata.ts#L10) + +This hook provides method to update peer metadata + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* [`GenericMetadata`](../type-aliases/GenericMetadata.md) | [`GenericMetadata`](../type-aliases/GenericMetadata.md) | + +## Returns + +### updatePeerMetadata() + +> **updatePeerMetadata**: (`peerMetadata`) => `Promise`\<`void`\> + +Updates metadata send to other peers + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `peerMetadata` | `PeerMetadata` | string indexed record with metadata, that will be available to all other peers | + +#### Returns + +`Promise`\<`void`\> diff --git a/versioned_docs/version-0.24.0/api/mobile/index.md b/versioned_docs/version-0.24.0/api/mobile/index.md new file mode 100644 index 00000000..e31b652a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/index.md @@ -0,0 +1,85 @@ +# @fishjam-cloud/react-native-client + +## Connection + +- [useConnection](functions/useConnection.md) +- [usePeers](functions/usePeers.md) +- [useScreenShare](functions/useScreenShare.md) +- [useUpdatePeerMetadata](functions/useUpdatePeerMetadata.md) +- [useAppScreenShare](variables/useAppScreenShare.md) +- [useCallKit](variables/useCallKit.md) +- [useCallKitEvent](variables/useCallKitEvent.md) +- [useCallKitService](variables/useCallKitService.md) +- [useForegroundService](variables/useForegroundService.md) + +## Devices + +- [useAudioSettings](functions/useAudioSettings.md) +- [useCamera](functions/useCamera.md) +- [useMicrophone](functions/useMicrophone.md) + +## Components + +- [FishjamRoom](functions/FishjamRoom.md) +- [PipContainerView](variables/PipContainerView.md) +- [VideoPreviewView](variables/VideoPreviewView.md) +- [VideoRendererView](variables/VideoRendererView.md) + +## Other + +- [setOverwriteDebugConfig](functions/setOverwriteDebugConfig.md) +- [useSandbox](functions/useSandbox.md) +- [PipContainerViewProps](interfaces/PipContainerViewProps.md) +- [PipContainerViewRef](interfaces/PipContainerViewRef.md) +- [AppScreenShareData](type-aliases/AppScreenShareData.md) +- [AudioOutputDevice](type-aliases/AudioOutputDevice.md) +- [AudioOutputDeviceType](type-aliases/AudioOutputDeviceType.md) +- [AudioSessionMode](type-aliases/AudioSessionMode.md) +- [AudioTrack](type-aliases/AudioTrack.md) +- [Brand](type-aliases/Brand.md) +- [CallKitAction](type-aliases/CallKitAction.md) +- [CallKitConfig](type-aliases/CallKitConfig.md) +- [Camera](type-aliases/Camera.md) +- [CameraConfig](type-aliases/CameraConfig.md) +- [CameraConfigBase](type-aliases/CameraConfigBase.md) +- [CameraFacingDirection](type-aliases/CameraFacingDirection.md) +- [CameraId](type-aliases/CameraId.md) +- [ConnectionConfig](type-aliases/ConnectionConfig.md) +- [DebugConfig](type-aliases/DebugConfig.md) +- [DistinguishedTracks](type-aliases/DistinguishedTracks.md) +- [EncodingReason](type-aliases/EncodingReason.md) +- [FishjamRoomProps](type-aliases/FishjamRoomProps.md) +- [ForegroundServiceConfig](type-aliases/ForegroundServiceConfig.md) +- [GenericMetadata](type-aliases/GenericMetadata.md) +- [JoinRoomConfig](type-aliases/JoinRoomConfig.md) +- [Peer](type-aliases/Peer.md) +- [PeerId](type-aliases/PeerId.md) +- [PeerStatus](type-aliases/PeerStatus.md) +- [PeerTrackMetadata](type-aliases/PeerTrackMetadata.md) +- [PeerWithTracks](type-aliases/PeerWithTracks.md) +- [PictureInPictureConfig](type-aliases/PictureInPictureConfig.md) +- [ReconnectionStatus](type-aliases/ReconnectionStatus.md) +- [RoomType](type-aliases/RoomType.md) +- [ScreenShareOptions](type-aliases/ScreenShareOptions.md) +- [ScreenShareQuality](type-aliases/ScreenShareQuality.md) +- [SimulcastConfig](type-aliases/SimulcastConfig.md) +- [Track](type-aliases/Track.md) +- [TrackBase](type-aliases/TrackBase.md) +- [TrackId](type-aliases/TrackId.md) +- [TrackMetadata](type-aliases/TrackMetadata.md) +- [TrackType](type-aliases/TrackType.md) +- [UseCallKitResult](type-aliases/UseCallKitResult.md) +- [UsePeersResult](type-aliases/UsePeersResult.md) +- [UseSandboxProps](type-aliases/UseSandboxProps.md) +- [VadStatus](type-aliases/VadStatus.md) +- [VideoLayout](type-aliases/VideoLayout.md) +- [VideoPreviewViewProps](type-aliases/VideoPreviewViewProps.md) +- [VideoQuality](type-aliases/VideoQuality.md) +- [VideoRendererProps](type-aliases/VideoRendererProps.md) +- [VideoTrack](type-aliases/VideoTrack.md) +- [useCameraPermissions](variables/useCameraPermissions.md) +- [useMicrophonePermissions](variables/useMicrophonePermissions.md) + +## Debugging + +- [useBandwidthEstimation](functions/useBandwidthEstimation.md) diff --git a/versioned_docs/version-0.24.0/api/mobile/interfaces/PipContainerViewProps.md b/versioned_docs/version-0.24.0/api/mobile/interfaces/PipContainerViewProps.md new file mode 100644 index 00000000..264604a8 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/interfaces/PipContainerViewProps.md @@ -0,0 +1,47 @@ +# Interface: PipContainerViewProps + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:13](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L13) + +## Extends + +- `ViewProps` + +## Properties + +### allowsCameraInBackground? + +> `optional` **allowsCameraInBackground**: `boolean` + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:16](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L16) + +*** + +### primaryPlaceholderText? + +> `optional` **primaryPlaceholderText**: `string` + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:17](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L17) + +*** + +### secondaryPlaceholderText? + +> `optional` **secondaryPlaceholderText**: `string` + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:18](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L18) + +*** + +### startAutomatically? + +> `optional` **startAutomatically**: `boolean` + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:14](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L14) + +*** + +### stopAutomatically? + +> `optional` **stopAutomatically**: `boolean` + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L15) diff --git a/versioned_docs/version-0.24.0/api/mobile/interfaces/PipContainerViewRef.md b/versioned_docs/version-0.24.0/api/mobile/interfaces/PipContainerViewRef.md new file mode 100644 index 00000000..6cce94f2 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/interfaces/PipContainerViewRef.md @@ -0,0 +1,27 @@ +# Interface: PipContainerViewRef + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:21](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L21) + +## Methods + +### startPictureInPicture() + +> **startPictureInPicture**(): `Promise`\<`void`\> + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:22](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L22) + +#### Returns + +`Promise`\<`void`\> + +*** + +### stopPictureInPicture() + +> **stopPictureInPicture**(): `Promise`\<`void`\> + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:23](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L23) + +#### Returns + +`Promise`\<`void`\> diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/AppScreenShareData.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/AppScreenShareData.md new file mode 100644 index 00000000..dd582e88 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/AppScreenShareData.md @@ -0,0 +1,31 @@ +# Type Alias: AppScreenShareData + +> **AppScreenShareData** = `object` + +Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useAppScreenShare.ts#L9) + +## Properties + +### isAppScreenShareOn + +> **isAppScreenShareOn**: `boolean` + +Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useAppScreenShare.ts#L10) + +*** + +### toggleAppScreenShare() + +> **toggleAppScreenShare**: (`screenShareOptions?`) => `Promise`\<`void`\> + +Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:11](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useAppScreenShare.ts#L11) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `screenShareOptions?` | `Partial`\<[`ScreenShareOptions`](ScreenShareOptions.md)\> | + +#### Returns + +`Promise`\<`void`\> diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/AudioOutputDevice.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/AudioOutputDevice.md new file mode 100644 index 00000000..37166599 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/AudioOutputDevice.md @@ -0,0 +1,21 @@ +# Type Alias: AudioOutputDevice + +> **AudioOutputDevice** = `object` + +Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:17](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useAudioSettings.ts#L17) + +## Properties + +### name + +> **name**: `string` + +Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:19](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useAudioSettings.ts#L19) + +*** + +### type + +> **type**: [`AudioOutputDeviceType`](AudioOutputDeviceType.md) + +Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:18](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useAudioSettings.ts#L18) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/AudioOutputDeviceType.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/AudioOutputDeviceType.md new file mode 100644 index 00000000..95fe5f1d --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/AudioOutputDeviceType.md @@ -0,0 +1,5 @@ +# Type Alias: AudioOutputDeviceType + +> **AudioOutputDeviceType** = `"bluetooth"` \| `"headset"` \| `"speaker"` \| `"earpiece"` + +Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useAudioSettings.ts#L9) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/AudioSessionMode.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/AudioSessionMode.md new file mode 100644 index 00000000..f8cf491d --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/AudioSessionMode.md @@ -0,0 +1,5 @@ +# Type Alias: AudioSessionMode + +> **AudioSessionMode** = `"voiceChat"` \| `"videoChat"` + +Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useAudioSettings.ts#L15) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/AudioTrack.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/AudioTrack.md new file mode 100644 index 00000000..5e1fd70c --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/AudioTrack.md @@ -0,0 +1,15 @@ +# Type Alias: AudioTrack + +> **AudioTrack** = [`TrackBase`](TrackBase.md) & `object` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:34](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L34) + +## Type declaration + +### type + +> **type**: `"Audio"` + +### vadStatus + +> **vadStatus**: [`VadStatus`](VadStatus.md) \| `undefined` diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/Brand.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/Brand.md new file mode 100644 index 00000000..9b3f4f2a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/Brand.md @@ -0,0 +1,20 @@ +# Type Alias: Brand\ + +> **Brand**\<`T`, `TBrand`\> = `T` & `object` + +Defined in: [packages/react-native-client/src/types.ts:34](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/types.ts#L34) + +Branded type + +## Type declaration + +### \[brand\] + +> **\[brand\]**: `TBrand` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | +| `TBrand` *extends* `string` | diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/CallKitAction.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/CallKitAction.md new file mode 100644 index 00000000..3065cf66 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/CallKitAction.md @@ -0,0 +1,45 @@ +# Type Alias: CallKitAction + +> **CallKitAction** = `object` + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:6](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L6) + +## Properties + +### ended + +> **ended**: `undefined` + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:8](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L8) + +*** + +### failed + +> **failed**: `string` + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L9) + +*** + +### held + +> **held**: `boolean` + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:11](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L11) + +*** + +### muted + +> **muted**: `boolean` + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L10) + +*** + +### started + +> **started**: `undefined` + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:7](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L7) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/CallKitConfig.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/CallKitConfig.md new file mode 100644 index 00000000..35a86dc1 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/CallKitConfig.md @@ -0,0 +1,25 @@ +# Type Alias: CallKitConfig + +> **CallKitConfig** = `object` + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:32](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L32) + +## Properties + +### displayName + +> **displayName**: `string` + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:36](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L36) + +The name to display in the CallKit UI + +*** + +### isVideo + +> **isVideo**: `boolean` + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:40](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L40) + +Whether the should support video diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/Camera.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/Camera.md new file mode 100644 index 00000000..ac4ea765 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/Camera.md @@ -0,0 +1,29 @@ +# Type Alias: Camera + +> **Camera** = `object` + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L12) + +## Properties + +### facingDirection + +> **facingDirection**: [`CameraFacingDirection`](CameraFacingDirection.md) + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L15) + +*** + +### id + +> **id**: [`CameraId`](CameraId.md) + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:13](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L13) + +*** + +### name + +> **name**: `string` + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:14](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L14) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/CameraConfig.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/CameraConfig.md new file mode 100644 index 00000000..94748bdd --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/CameraConfig.md @@ -0,0 +1,15 @@ +# Type Alias: CameraConfig + +> **CameraConfig** = [`CameraConfigBase`](CameraConfigBase.md) & `object` + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:74](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L74) + +## Type declaration + +### ~~simulcastEnabled?~~ + +> `optional` **simulcastEnabled**: `boolean` + +#### Deprecated + +Simulcast is no longer supported diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/CameraConfigBase.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/CameraConfigBase.md new file mode 100644 index 00000000..06eb9c64 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/CameraConfigBase.md @@ -0,0 +1,78 @@ +# Type Alias: CameraConfigBase + +> **CameraConfigBase** = `object` + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:36](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L36) + +## Properties + +### cameraEnabled? + +> `optional` **cameraEnabled**: `boolean` + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:65](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L65) + +whether the camera track is initially enabled, you can toggle it on/off later with toggleCamera method + +#### Default + +`true` + +*** + +### cameraId? + +> `optional` **cameraId**: [`CameraId`](CameraId.md) + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:71](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L71) + +id of the camera to start capture with. Get available cameras with `cameras`. +You can switch the cameras later with `switchCamera` functions. + +#### Default + +`the first front camera` + +*** + +### flipDimensions? + +> `optional` **flipDimensions**: `boolean` + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:60](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L60) + +whether to flip the dimensions of the video, that is whether to film in vertical orientation. +This basically switches width with height and is only used to select closes capture format. + +To record horizontal video your phone orientation must be in landscape and your app must support this orientation. + +Platform specific capture formats: + +#### See + + - [iOS](https://developer.apple.com/documentation/avfoundation/avcapturedevice/format) + - [Android](https://github.com/webrtc-sdk/webrtc/blob/cdc3bba5aa38910a55428b919ba45aceac1ad9ad/sdk/android/api/org/webrtc/CameraEnumerationAndroid.java#L50) + +WebRTC device orientation handling: + - [iOS](https://github.com/webrtc-sdk/webrtc/blob/cdc3bba5aa38910a55428b919ba45aceac1ad9ad/sdk/objc/components/capturer/RTCCameraVideoCapturer.m#L285) + - [Android](https://github.com/pristineio/webrtc-mirror/blob/7a5bcdffaab90a05bc1146b2b1ea71c004e54d71/webrtc/sdk/android/src/java/org/webrtc/Camera2Session.java#L347) + +#### Default + +`true` + +*** + +### quality? + +> `optional` **quality**: [`VideoQuality`](VideoQuality.md) + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:43](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L43) + +resolution + aspect ratio of local video track, one of: `QVGA_169`, `VGA_169`, `QHD_169`, `HD_169`, +`FHD_169`, `QVGA_43`, `VGA_43`, `QHD_43`, `HD_43`, `FHD_43`. Note that quality might be worse than +specified due to device capabilities, internet connection etc. + +#### Default + +`VGA_169` diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/CameraFacingDirection.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/CameraFacingDirection.md new file mode 100644 index 00000000..a8b66299 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/CameraFacingDirection.md @@ -0,0 +1,5 @@ +# Type Alias: CameraFacingDirection + +> **CameraFacingDirection** = `"front"` \| `"back"` \| `"unspecified"` + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L10) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/CameraId.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/CameraId.md new file mode 100644 index 00000000..10889619 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/CameraId.md @@ -0,0 +1,5 @@ +# Type Alias: CameraId + +> **CameraId** = [`Brand`](Brand.md)\<`string`, `"CameraId"`\> + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:8](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L8) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/ConnectionConfig.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/ConnectionConfig.md new file mode 100644 index 00000000..03881d71 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/ConnectionConfig.md @@ -0,0 +1,26 @@ +# Type Alias: ConnectionConfig + +> **ConnectionConfig** = `object` + +Defined in: [packages/react-native-client/src/hooks/useConnection.ts:63](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useConnection.ts#L63) + +## Properties + +### reconnectConfig? + +> `optional` **reconnectConfig**: `object` + +Defined in: [packages/react-native-client/src/hooks/useConnection.ts:72](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useConnection.ts#L72) + +Configuration for automatic reconnection +sdk uses a linear backoff algorithm, that is the formula +for the delay of the nth attempt is +n * delayMs + initialDelayMs + +Pass 0 for maxAttempts to disable automatic reconnection + +| Name | Type | +| ------ | ------ | +| `delayMs?` | `number` | +| `initialDelayMs?` | `number` | +| `maxAttempts?` | `number` | diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/DebugConfig.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/DebugConfig.md new file mode 100644 index 00000000..f1b85ae1 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/DebugConfig.md @@ -0,0 +1,13 @@ +# Type Alias: DebugConfig + +> **DebugConfig** = `object` + +Defined in: [packages/react-native-client/src/utils/config.ts:1](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/utils/config.ts#L1) + +## Properties + +### validateEventPayloads + +> **validateEventPayloads**: `boolean` + +Defined in: [packages/react-native-client/src/utils/config.ts:2](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/utils/config.ts#L2) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/DistinguishedTracks.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/DistinguishedTracks.md new file mode 100644 index 00000000..d15382bb --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/DistinguishedTracks.md @@ -0,0 +1,37 @@ +# Type Alias: DistinguishedTracks + +> **DistinguishedTracks** = `object` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:54](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L54) + +## Properties + +### cameraTrack? + +> `optional` **cameraTrack**: [`VideoTrack`](VideoTrack.md) + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:55](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L55) + +*** + +### microphoneTrack? + +> `optional` **microphoneTrack**: [`AudioTrack`](AudioTrack.md) + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:56](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L56) + +*** + +### screenShareAudioTrack? + +> `optional` **screenShareAudioTrack**: [`AudioTrack`](AudioTrack.md) + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:58](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L58) + +*** + +### screenShareVideoTrack? + +> `optional` **screenShareVideoTrack**: [`VideoTrack`](VideoTrack.md) + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:57](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L57) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/EncodingReason.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/EncodingReason.md new file mode 100644 index 00000000..64adfd91 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/EncodingReason.md @@ -0,0 +1,11 @@ +# Type Alias: EncodingReason + +> **EncodingReason** = `"other"` \| `"encoding_inactive"` \| `"low_bandwidth"` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:52](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L52) + +Type describing possible reasons of currently selected encoding. + +- other - the exact reason couldn't be determined +- encoding_inactive - previously selected encoding became inactive +- low_bandwidth - there is no longer enough bandwidth to maintain previously selected encoding diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/FishjamRoomProps.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/FishjamRoomProps.md new file mode 100644 index 00000000..410c8ae8 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/FishjamRoomProps.md @@ -0,0 +1,25 @@ +# Type Alias: FishjamRoomProps + +> **FishjamRoomProps** = `object` + +Defined in: [packages/react-native-client/src/components/FishjamRoom/index.tsx:7](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/FishjamRoom/index.tsx#L7) + +## Properties + +### fishjamId + +> **fishjamId**: `string` + +Defined in: [packages/react-native-client/src/components/FishjamRoom/index.tsx:11](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/FishjamRoom/index.tsx#L11) + +ID of your fishjam instance + +*** + +### peerToken + +> **peerToken**: `string` + +Defined in: [packages/react-native-client/src/components/FishjamRoom/index.tsx:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/FishjamRoom/index.tsx#L15) + +Peer Token diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/ForegroundServiceConfig.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/ForegroundServiceConfig.md new file mode 100644 index 00000000..2645ef22 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/ForegroundServiceConfig.md @@ -0,0 +1,67 @@ +# Type Alias: ForegroundServiceConfig + +> **ForegroundServiceConfig** = `object` + +Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useForegroundService.ts#L9) + +A type representing the configuration for foreground service permissions. + +## Properties + +### channelId? + +> `optional` **channelId**: `string` + +Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:21](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useForegroundService.ts#L21) + +The id of the channel. Must be unique per package. + +*** + +### channelName? + +> `optional` **channelName**: `string` + +Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:25](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useForegroundService.ts#L25) + +The user visible name of the channel. + +*** + +### enableCamera? + +> `optional` **enableCamera**: `boolean` + +Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:13](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useForegroundService.ts#L13) + +Indicates whether the camera is enabled for the foreground service. + +*** + +### enableMicrophone? + +> `optional` **enableMicrophone**: `boolean` + +Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:17](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useForegroundService.ts#L17) + +Indicates whether the microphone is enabled for the foreground service. + +*** + +### notificationContent? + +> `optional` **notificationContent**: `string` + +Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:33](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useForegroundService.ts#L33) + +The text (second row) of the notification, in a standard notification. + +*** + +### notificationTitle? + +> `optional` **notificationTitle**: `string` + +Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:29](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useForegroundService.ts#L29) + +The title (first row) of the notification, in a standard notification. diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/GenericMetadata.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/GenericMetadata.md new file mode 100644 index 00000000..50b02922 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/GenericMetadata.md @@ -0,0 +1,5 @@ +# Type Alias: GenericMetadata + +> **GenericMetadata** = `Record`\<`string`, `unknown`\> + +Defined in: [packages/react-native-client/src/types.ts:27](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/types.ts#L27) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/JoinRoomConfig.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/JoinRoomConfig.md new file mode 100644 index 00000000..094b6608 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/JoinRoomConfig.md @@ -0,0 +1,52 @@ +# Type Alias: JoinRoomConfig\ + +> **JoinRoomConfig**\<`PeerMetadata`\> = `object` + +Defined in: [packages/react-native-client/src/hooks/useConnection.ts:41](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useConnection.ts#L41) + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | + +## Properties + +### config? + +> `optional` **config**: [`ConnectionConfig`](ConnectionConfig.md) + +Defined in: [packages/react-native-client/src/hooks/useConnection.ts:60](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useConnection.ts#L60) + +Additional connection configuration + +*** + +### fishjamId + +> **fishjamId**: `string` + +Defined in: [packages/react-native-client/src/hooks/useConnection.ts:48](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useConnection.ts#L48) + +Fishjam ID, which is used to connect to the room. +You can get it at https://fishjam.io/app + +*** + +### peerMetadata? + +> `optional` **peerMetadata**: `PeerMetadata` + +Defined in: [packages/react-native-client/src/hooks/useConnection.ts:56](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useConnection.ts#L56) + +String indexed record with metadata, that will be available to all other peers + +*** + +### peerToken + +> **peerToken**: `string` + +Defined in: [packages/react-native-client/src/hooks/useConnection.ts:52](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useConnection.ts#L52) + +Token received from server (or Room Manager) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/Peer.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/Peer.md new file mode 100644 index 00000000..868bd2f9 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/Peer.md @@ -0,0 +1,52 @@ +# Type Alias: Peer\ + +> **Peer**\<`PeerMetadata`, `ServerMetadata`\> = `object` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:66](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L66) + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | +| `ServerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | + +## Properties + +### id + +> **id**: [`PeerId`](PeerId.md) + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:73](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L73) + +id used to identify a peer + +*** + +### isLocal + +> **isLocal**: `boolean` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:77](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L77) + +whether the peer is local or remote + +*** + +### metadata + +> **metadata**: [`PeerTrackMetadata`](PeerTrackMetadata.md)\<`PeerMetadata`, `ServerMetadata`\> + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:81](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L81) + +a type containing peer and server metadata + +*** + +### tracks + +> **tracks**: [`Track`](Track.md)[] + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:85](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L85) + +a list of peer's video and audio tracks diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/PeerId.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/PeerId.md new file mode 100644 index 00000000..17344020 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/PeerId.md @@ -0,0 +1,5 @@ +# Type Alias: PeerId + +> **PeerId** = [`Brand`](Brand.md)\<`string`, `"PeerId"`\> + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L9) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/PeerStatus.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/PeerStatus.md new file mode 100644 index 00000000..289d3997 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/PeerStatus.md @@ -0,0 +1,12 @@ +# Type Alias: PeerStatus + +> **PeerStatus** = `"connecting"` \| `"connected"` \| `"error"` \| `"idle"` + +Defined in: [packages/react-native-client/src/hooks/useConnection.ts:26](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useConnection.ts#L26) + +Represents the possible statuses of a peer connection to a room (websocket state). + +- `idle` - Peer is not connected, either never connected or successfully disconnected. +- `connecting` - Peer is in the process of connecting. +- `connected` - Peer has successfully connected. +- `error` - There was an error in the connection process. diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/PeerTrackMetadata.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/PeerTrackMetadata.md new file mode 100644 index 00000000..8048656a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/PeerTrackMetadata.md @@ -0,0 +1,28 @@ +# Type Alias: PeerTrackMetadata\ + +> **PeerTrackMetadata**\<`PeerMetadata`, `ServerMetadata`\> = `object` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:22](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L22) + +## Type Parameters + +| Type Parameter | +| ------ | +| `PeerMetadata` | +| `ServerMetadata` | + +## Properties + +### peer + +> **peer**: `PeerMetadata` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:23](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L23) + +*** + +### server + +> **server**: `ServerMetadata` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:24](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L24) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/PeerWithTracks.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/PeerWithTracks.md new file mode 100644 index 00000000..5556dd6f --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/PeerWithTracks.md @@ -0,0 +1,12 @@ +# Type Alias: PeerWithTracks\ + +> **PeerWithTracks**\<`PeerMetadata`, `ServerMetadata`\> = [`Peer`](Peer.md)\<`PeerMetadata`, `ServerMetadata`\> & [`DistinguishedTracks`](DistinguishedTracks.md) + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:61](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L61) + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | +| `ServerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/PictureInPictureConfig.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/PictureInPictureConfig.md new file mode 100644 index 00000000..d54d65e7 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/PictureInPictureConfig.md @@ -0,0 +1,45 @@ +# Type Alias: PictureInPictureConfig + +> **PictureInPictureConfig** = `object` + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:5](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L5) + +## Properties + +### allowsCameraInBackground? + +> `optional` **allowsCameraInBackground**: `boolean` + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:8](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L8) + +*** + +### primaryPlaceholderText? + +> `optional` **primaryPlaceholderText**: `string` + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L9) + +*** + +### secondaryPlaceholderText? + +> `optional` **secondaryPlaceholderText**: `string` + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L10) + +*** + +### startAutomatically? + +> `optional` **startAutomatically**: `boolean` + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:6](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L6) + +*** + +### stopAutomatically? + +> `optional` **stopAutomatically**: `boolean` + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:7](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L7) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/ReconnectionStatus.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/ReconnectionStatus.md new file mode 100644 index 00000000..0efb31dd --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/ReconnectionStatus.md @@ -0,0 +1,11 @@ +# Type Alias: ReconnectionStatus + +> **ReconnectionStatus** = `"idle"` \| `"reconnecting"` \| `"error"` + +Defined in: [packages/react-native-client/src/hooks/useConnection.ts:16](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useConnection.ts#L16) + +Represents the possible statuses of a peer while reconnecting to room + +- `idle` - No reconnection in progress. See [PeerStatus](PeerStatus.md) for more details +- `reconnecting` - Peer is in the process of reconnecting. +- `error` - There was an error in the reconnection process. diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/RoomType.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/RoomType.md new file mode 100644 index 00000000..69eacb91 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/RoomType.md @@ -0,0 +1,5 @@ +# Type Alias: RoomType + +> **RoomType** = `"conference"` \| `"audio-only"` \| `"livestream"` + +Defined in: [packages/react-native-client/src/types.ts:36](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/types.ts#L36) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/ScreenShareOptions.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/ScreenShareOptions.md new file mode 100644 index 00000000..1c7f5b51 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/ScreenShareOptions.md @@ -0,0 +1,21 @@ +# Type Alias: ScreenShareOptions + +> **ScreenShareOptions** = `object` + +Defined in: [packages/react-native-client/src/hooks/useScreenShare.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useScreenShare.ts#L12) + +## Properties + +### quality + +> **quality**: [`ScreenShareQuality`](ScreenShareQuality.md) + +Defined in: [packages/react-native-client/src/hooks/useScreenShare.ts:19](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useScreenShare.ts#L19) + +Resolution + fps of screen share track, one of: `VGA`, `HD5`, `HD15`, `FHD15`, `FHD30`. +Note that quality might be worse than specified due to device capabilities, internet +connection etc. + +#### Default + +`HD15` diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/ScreenShareQuality.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/ScreenShareQuality.md new file mode 100644 index 00000000..776dd458 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/ScreenShareQuality.md @@ -0,0 +1,5 @@ +# Type Alias: ScreenShareQuality + +> **ScreenShareQuality** = `"VGA"` \| `"HD5"` \| `"HD15"` \| `"FHD15"` \| `"FHD30"` + +Defined in: [packages/react-native-client/src/hooks/useScreenShare.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useScreenShare.ts#L10) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/SimulcastConfig.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/SimulcastConfig.md new file mode 100644 index 00000000..7b8c60ca --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/SimulcastConfig.md @@ -0,0 +1,21 @@ +# Type Alias: SimulcastConfig + +> **SimulcastConfig** = `object` + +Defined in: [packages/react-native-client/src/types.ts:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/types.ts#L15) + +A type describing simulcast configuration. + +At the moment, simulcast track is initialized in three versions - low, medium and high. +High resolution is the original track resolution, while medium and low resolutions are +the original track resolution scaled down by 2 and 4 respectively. + +## Properties + +### enabled + +> **enabled**: `boolean` + +Defined in: [packages/react-native-client/src/types.ts:19](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/types.ts#L19) + +whether to simulcast track or not. By default simulcast is disabled. diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/Track.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/Track.md new file mode 100644 index 00000000..e90ff5dd --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/Track.md @@ -0,0 +1,5 @@ +# Type Alias: Track + +> **Track** = [`VideoTrack`](VideoTrack.md) \| [`AudioTrack`](AudioTrack.md) + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:44](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L44) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/TrackBase.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/TrackBase.md new file mode 100644 index 00000000..d40a2b83 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/TrackBase.md @@ -0,0 +1,37 @@ +# Type Alias: TrackBase + +> **TrackBase** = `object` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:27](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L27) + +## Properties + +### id + +> **id**: [`TrackId`](TrackId.md) + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:28](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L28) + +*** + +### isActive + +> **isActive**: `boolean` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:30](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L30) + +*** + +### metadata? + +> `optional` **metadata**: [`TrackMetadata`](TrackMetadata.md) + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:31](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L31) + +*** + +### type + +> **type**: [`TrackType`](TrackType.md) + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:29](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L29) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/TrackId.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/TrackId.md new file mode 100644 index 00000000..4391791d --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/TrackId.md @@ -0,0 +1,5 @@ +# Type Alias: TrackId + +> **TrackId** = [`Brand`](Brand.md)\<`string`, `"TrackId"`\> + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L10) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/TrackMetadata.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/TrackMetadata.md new file mode 100644 index 00000000..5ca21249 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/TrackMetadata.md @@ -0,0 +1,21 @@ +# Type Alias: TrackMetadata + +> **TrackMetadata** = `object` + +Defined in: [packages/react-native-client/src/types.ts:22](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/types.ts#L22) + +## Properties + +### active + +> **active**: `boolean` + +Defined in: [packages/react-native-client/src/types.ts:23](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/types.ts#L23) + +*** + +### type + +> **type**: `"microphone"` \| `"camera"` \| `"screenShareVideo"` \| `"screenShareAudio"` + +Defined in: [packages/react-native-client/src/types.ts:24](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/types.ts#L24) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/TrackType.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/TrackType.md new file mode 100644 index 00000000..f3b0df1f --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/TrackType.md @@ -0,0 +1,5 @@ +# Type Alias: TrackType + +> **TrackType** = `"Audio"` \| `"Video"` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L12) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/UseCallKitResult.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/UseCallKitResult.md new file mode 100644 index 00000000..33953c15 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/UseCallKitResult.md @@ -0,0 +1,53 @@ +# Type Alias: UseCallKitResult + +> **UseCallKitResult** = `object` + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:14](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L14) + +## Properties + +### endCallKitSession() + +> **endCallKitSession**: () => `Promise`\<`void`\> + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:24](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L24) + +Ends the current CallKit session + +#### Returns + +`Promise`\<`void`\> + +*** + +### getCallKitSessionStatus() + +> **getCallKitSessionStatus**: () => `Promise`\<`boolean`\> + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:29](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L29) + +Returns whether there is currently an active CallKit session + +#### Returns + +`Promise`\<`boolean`\> + +*** + +### startCallKitSession() + +> **startCallKitSession**: (`config`) => `Promise`\<`void`\> + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:19](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L19) + +Starts a CallKit session for the current call + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `config` | [`CallKitConfig`](CallKitConfig.md) | Configuration object containing displayName and isVideo | + +#### Returns + +`Promise`\<`void`\> diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/UsePeersResult.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/UsePeersResult.md new file mode 100644 index 00000000..136886bf --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/UsePeersResult.md @@ -0,0 +1,38 @@ +# Type Alias: UsePeersResult\ + +> **UsePeersResult**\<`PeerMetadata`, `ServerMetadata`\> = `object` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:168](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L168) + +Result type for the usePeers hook. + +## Type Parameters + +| Type Parameter | Default type | Description | +| ------ | ------ | ------ | +| `PeerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | Type for peer-specific metadata | +| `ServerMetadata` *extends* [`GenericMetadata`](GenericMetadata.md) | [`GenericMetadata`](GenericMetadata.md) | Type for server-specific metadata | + +## Properties + +### localPeer + +> **localPeer**: [`PeerWithTracks`](PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\> \| `null` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:172](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L172) + +*** + +### peers + +> **peers**: [`Peer`](Peer.md)\<`PeerMetadata`, `ServerMetadata`\>[] + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:176](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L176) + +*** + +### remotePeers + +> **remotePeers**: [`PeerWithTracks`](PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\>[] + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:174](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L174) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/UseSandboxProps.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/UseSandboxProps.md new file mode 100644 index 00000000..6e797eb7 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/UseSandboxProps.md @@ -0,0 +1,5 @@ +# Type Alias: UseSandboxProps + +> **UseSandboxProps** = \{ `fishjamId`: `string`; `sandboxApiUrl?`: `never`; \} \| \{ `fishjamId?`: `never`; `sandboxApiUrl`: `string`; \} + +Defined in: [packages/react-native-client/src/hooks/useSandbox.ts:13](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useSandbox.ts#L13) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/VadStatus.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/VadStatus.md new file mode 100644 index 00000000..4322ca8a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/VadStatus.md @@ -0,0 +1,10 @@ +# Type Alias: VadStatus + +> **VadStatus** = `"silence"` \| `"speech"` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:20](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L20) + +Type describing Voice Activity Detection statuses. + +- `speech` voice activity has been detected +- `silence` - lack of voice activity has been detected diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoLayout.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoLayout.md new file mode 100644 index 00000000..8993decd --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoLayout.md @@ -0,0 +1,9 @@ +# Type Alias: VideoLayout + +> **VideoLayout** = `"FILL"` \| `"FIT"` + +Defined in: [packages/react-native-client/src/types.ts:6](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/types.ts#L6) + +`FILL` or `FIT` - it works just like RN Image component. `FILL` fills the whole view +with video and it may cut some parts of the video. `FIT` scales the video so the whole +video is visible, but it may leave some empty space in the view. diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoPreviewViewProps.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoPreviewViewProps.md new file mode 100644 index 00000000..930f1d5f --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoPreviewViewProps.md @@ -0,0 +1,41 @@ +# Type Alias: VideoPreviewViewProps + +> **VideoPreviewViewProps** = `object` + +Defined in: [packages/react-native-client/src/components/VideoPreviewView.tsx:8](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/VideoPreviewView.tsx#L8) + +## Properties + +### cameraId? + +> `optional` **cameraId**: [`CameraId`](CameraId.md) + +Defined in: [packages/react-native-client/src/components/VideoPreviewView.tsx:20](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/VideoPreviewView.tsx#L20) + +Id of the camera used for preview. Get available cameras with `cameras` property. + +#### Default + +`the first front camera` + +*** + +### style? + +> `optional` **style**: `StyleProp`\<`ViewStyle`\> + +Defined in: [packages/react-native-client/src/components/VideoPreviewView.tsx:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/VideoPreviewView.tsx#L15) + +*** + +### videoLayout? + +> `optional` **videoLayout**: [`VideoLayout`](VideoLayout.md) + +Defined in: [packages/react-native-client/src/components/VideoPreviewView.tsx:13](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/VideoPreviewView.tsx#L13) + +Video layout inside of the component + +#### Default + +`FILL` diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoQuality.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoQuality.md new file mode 100644 index 00000000..4615451f --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoQuality.md @@ -0,0 +1,5 @@ +# Type Alias: VideoQuality + +> **VideoQuality** = `"QVGA169"` \| `"VGA169"` \| `"QHD169"` \| `"HD169"` \| `"FHD169"` \| `"QVGA43"` \| `"VGA43"` \| `"QHD43"` \| `"HD43"` \| `"FHD43"` + +Defined in: [packages/react-native-client/src/hooks/useCamera.ts:24](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCamera.ts#L24) diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoRendererProps.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoRendererProps.md new file mode 100644 index 00000000..4799799a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoRendererProps.md @@ -0,0 +1,47 @@ +# Type Alias: VideoRendererProps + +> **VideoRendererProps** = `object` + +Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:8](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/VideoRendererView.tsx#L8) + +## Properties + +### skipRenderOutsideVisibleArea? + +> `optional` **skipRenderOutsideVisibleArea**: `boolean` + +Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:21](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/VideoRendererView.tsx#L21) + +Whether the video should be rendered if it's off screen or hidden. + +*** + +### style? + +> `optional` **style**: `StyleProp`\<`ViewStyle`\> + +Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:22](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/VideoRendererView.tsx#L22) + +*** + +### trackId + +> **trackId**: [`TrackId`](TrackId.md) + +Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/VideoRendererView.tsx#L12) + +id of the video track which you want to render. + +*** + +### videoLayout? + +> `optional` **videoLayout**: [`VideoLayout`](VideoLayout.md) + +Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:17](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/VideoRendererView.tsx#L17) + +Video layout inside of the component + +#### Default + +`FILL` diff --git a/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoTrack.md b/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoTrack.md new file mode 100644 index 00000000..3e7ee690 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/type-aliases/VideoTrack.md @@ -0,0 +1,15 @@ +# Type Alias: VideoTrack + +> **VideoTrack** = [`TrackBase`](TrackBase.md) & `object` + +Defined in: [packages/react-native-client/src/hooks/usePeers.ts:39](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePeers.ts#L39) + +## Type declaration + +### aspectRatio + +> **aspectRatio**: `number` + +### type + +> **type**: `"Video"` diff --git a/versioned_docs/version-0.24.0/api/mobile/typedoc-sidebar.cjs b/versioned_docs/version-0.24.0/api/mobile/typedoc-sidebar.cjs new file mode 100644 index 00000000..ef97752e --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ +const typedocSidebar = {items:[{type:"category",label:"Connection",items:[{type:"doc",id:"api/mobile/functions/useConnection",label:"useConnection"},{type:"doc",id:"api/mobile/functions/usePeers",label:"usePeers"},{type:"doc",id:"api/mobile/functions/useScreenShare",label:"useScreenShare"},{type:"doc",id:"api/mobile/functions/useUpdatePeerMetadata",label:"useUpdatePeerMetadata"},{type:"doc",id:"api/mobile/variables/useAppScreenShare",label:"useAppScreenShare"},{type:"doc",id:"api/mobile/variables/useCallKit",label:"useCallKit"},{type:"doc",id:"api/mobile/variables/useCallKitEvent",label:"useCallKitEvent"},{type:"doc",id:"api/mobile/variables/useCallKitService",label:"useCallKitService"},{type:"doc",id:"api/mobile/variables/useForegroundService",label:"useForegroundService"}]},{type:"category",label:"Devices",items:[{type:"doc",id:"api/mobile/functions/useAudioSettings",label:"useAudioSettings"},{type:"doc",id:"api/mobile/functions/useCamera",label:"useCamera"},{type:"doc",id:"api/mobile/functions/useMicrophone",label:"useMicrophone"}]},{type:"category",label:"Components",items:[{type:"doc",id:"api/mobile/functions/FishjamRoom",label:"FishjamRoom"},{type:"doc",id:"api/mobile/variables/PipContainerView",label:"PipContainerView"},{type:"doc",id:"api/mobile/variables/VideoPreviewView",label:"VideoPreviewView"},{type:"doc",id:"api/mobile/variables/VideoRendererView",label:"VideoRendererView"}]},{type:"category",label:"Other",items:[{type:"doc",id:"api/mobile/functions/setOverwriteDebugConfig",label:"setOverwriteDebugConfig"},{type:"doc",id:"api/mobile/functions/useSandbox",label:"useSandbox"},{type:"doc",id:"api/mobile/interfaces/PipContainerViewProps",label:"PipContainerViewProps"},{type:"doc",id:"api/mobile/interfaces/PipContainerViewRef",label:"PipContainerViewRef"},{type:"doc",id:"api/mobile/type-aliases/AppScreenShareData",label:"AppScreenShareData"},{type:"doc",id:"api/mobile/type-aliases/AudioOutputDevice",label:"AudioOutputDevice"},{type:"doc",id:"api/mobile/type-aliases/AudioOutputDeviceType",label:"AudioOutputDeviceType"},{type:"doc",id:"api/mobile/type-aliases/AudioSessionMode",label:"AudioSessionMode"},{type:"doc",id:"api/mobile/type-aliases/AudioTrack",label:"AudioTrack"},{type:"doc",id:"api/mobile/type-aliases/Brand",label:"Brand"},{type:"doc",id:"api/mobile/type-aliases/CallKitAction",label:"CallKitAction"},{type:"doc",id:"api/mobile/type-aliases/CallKitConfig",label:"CallKitConfig"},{type:"doc",id:"api/mobile/type-aliases/Camera",label:"Camera"},{type:"doc",id:"api/mobile/type-aliases/CameraConfig",label:"CameraConfig"},{type:"doc",id:"api/mobile/type-aliases/CameraConfigBase",label:"CameraConfigBase"},{type:"doc",id:"api/mobile/type-aliases/CameraFacingDirection",label:"CameraFacingDirection"},{type:"doc",id:"api/mobile/type-aliases/CameraId",label:"CameraId"},{type:"doc",id:"api/mobile/type-aliases/ConnectionConfig",label:"ConnectionConfig"},{type:"doc",id:"api/mobile/type-aliases/DebugConfig",label:"DebugConfig"},{type:"doc",id:"api/mobile/type-aliases/DistinguishedTracks",label:"DistinguishedTracks"},{type:"doc",id:"api/mobile/type-aliases/EncodingReason",label:"EncodingReason"},{type:"doc",id:"api/mobile/type-aliases/FishjamRoomProps",label:"FishjamRoomProps"},{type:"doc",id:"api/mobile/type-aliases/ForegroundServiceConfig",label:"ForegroundServiceConfig"},{type:"doc",id:"api/mobile/type-aliases/GenericMetadata",label:"GenericMetadata"},{type:"doc",id:"api/mobile/type-aliases/JoinRoomConfig",label:"JoinRoomConfig"},{type:"doc",id:"api/mobile/type-aliases/Peer",label:"Peer"},{type:"doc",id:"api/mobile/type-aliases/PeerId",label:"PeerId"},{type:"doc",id:"api/mobile/type-aliases/PeerStatus",label:"PeerStatus"},{type:"doc",id:"api/mobile/type-aliases/PeerTrackMetadata",label:"PeerTrackMetadata"},{type:"doc",id:"api/mobile/type-aliases/PeerWithTracks",label:"PeerWithTracks"},{type:"doc",id:"api/mobile/type-aliases/PictureInPictureConfig",label:"PictureInPictureConfig"},{type:"doc",id:"api/mobile/type-aliases/ReconnectionStatus",label:"ReconnectionStatus"},{type:"doc",id:"api/mobile/type-aliases/RoomType",label:"RoomType"},{type:"doc",id:"api/mobile/type-aliases/ScreenShareOptions",label:"ScreenShareOptions"},{type:"doc",id:"api/mobile/type-aliases/ScreenShareQuality",label:"ScreenShareQuality"},{type:"doc",id:"api/mobile/type-aliases/SimulcastConfig",label:"SimulcastConfig"},{type:"doc",id:"api/mobile/type-aliases/Track",label:"Track"},{type:"doc",id:"api/mobile/type-aliases/TrackBase",label:"TrackBase"},{type:"doc",id:"api/mobile/type-aliases/TrackId",label:"TrackId"},{type:"doc",id:"api/mobile/type-aliases/TrackMetadata",label:"TrackMetadata"},{type:"doc",id:"api/mobile/type-aliases/TrackType",label:"TrackType"},{type:"doc",id:"api/mobile/type-aliases/UseCallKitResult",label:"UseCallKitResult"},{type:"doc",id:"api/mobile/type-aliases/UsePeersResult",label:"UsePeersResult"},{type:"doc",id:"api/mobile/type-aliases/UseSandboxProps",label:"UseSandboxProps"},{type:"doc",id:"api/mobile/type-aliases/VadStatus",label:"VadStatus"},{type:"doc",id:"api/mobile/type-aliases/VideoLayout",label:"VideoLayout"},{type:"doc",id:"api/mobile/type-aliases/VideoPreviewViewProps",label:"VideoPreviewViewProps"},{type:"doc",id:"api/mobile/type-aliases/VideoQuality",label:"VideoQuality"},{type:"doc",id:"api/mobile/type-aliases/VideoRendererProps",label:"VideoRendererProps"},{type:"doc",id:"api/mobile/type-aliases/VideoTrack",label:"VideoTrack"},{type:"doc",id:"api/mobile/variables/useCameraPermissions",label:"useCameraPermissions"},{type:"doc",id:"api/mobile/variables/useMicrophonePermissions",label:"useMicrophonePermissions"}]},{type:"category",label:"Debugging",items:[{type:"doc",id:"api/mobile/functions/useBandwidthEstimation",label:"useBandwidthEstimation"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/versioned_docs/version-0.24.0/api/mobile/variables/PipContainerView.md b/versioned_docs/version-0.24.0/api/mobile/variables/PipContainerView.md new file mode 100644 index 00000000..152b3e5e --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/variables/PipContainerView.md @@ -0,0 +1,42 @@ +# Variable: PipContainerView + +> `const` **PipContainerView**: `ForwardRefExoticComponent`\<[`PipContainerViewProps`](../interfaces/PipContainerViewProps.md) & `RefAttributes`\<[`PipContainerViewRef`](../interfaces/PipContainerViewRef.md)\>\> + +Defined in: [packages/react-native-client/src/components/PipContainerView.tsx:55](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/PipContainerView.tsx#L55) + +A view component for Picture-in-Picture functionality with split-screen layout. + +Automatically displays: +- Primary view (left): Local camera track or placeholder text +- Secondary view (right): Remote track with active VAD (voice activity) or placeholder text + +Use a ref to call methods on this component: +```js +const pipRef = useRef(null); + +// Start PiP manually (if startAutomatically is false) +await pipRef.current?.startPictureInPicture(); + +// Stop PiP manually +await pipRef.current?.stopPictureInPicture(); +``` + +## Param + +Whether to start PiP automatically when app goes to background (default: true) + +## Param + +Whether to stop PiP automatically when app comes to foreground (default: true) + +## Param + +Whether to allow camera to continue running in PiP mode (default: false, iOS only) + +## Param + +Text to display when local camera is unavailable (default: "No camera") + +## Param + +Text to display when no remote speaker is active (default: "No active speaker") diff --git a/versioned_docs/version-0.24.0/api/mobile/variables/VideoPreviewView.md b/versioned_docs/version-0.24.0/api/mobile/variables/VideoPreviewView.md new file mode 100644 index 00000000..57a76702 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/variables/VideoPreviewView.md @@ -0,0 +1,12 @@ +# Variable: VideoPreviewView + +> `const` **VideoPreviewView**: `ForwardRefExoticComponent`\<[`VideoPreviewViewProps`](../type-aliases/VideoPreviewViewProps.md) & `RefAttributes`\<`ComponentType`\<[`VideoPreviewViewProps`](../type-aliases/VideoPreviewViewProps.md)\>\>\> + +Defined in: [packages/react-native-client/src/components/VideoPreviewView.tsx:35](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/VideoPreviewView.tsx#L35) + +Render camera preview. +Allows to display camera preview before streaming is started + +## Param + +## Param diff --git a/versioned_docs/version-0.24.0/api/mobile/variables/VideoRendererView.md b/versioned_docs/version-0.24.0/api/mobile/variables/VideoRendererView.md new file mode 100644 index 00000000..87a612a0 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/variables/VideoRendererView.md @@ -0,0 +1,20 @@ +# Variable: VideoRendererView + +> `const` **VideoRendererView**: `ForwardRefExoticComponent`\<[`VideoRendererProps`](../type-aliases/VideoRendererProps.md) & `RefAttributes`\<`ComponentType`\<[`VideoRendererProps`](../type-aliases/VideoRendererProps.md)\>\>\> + +Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:45](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/components/VideoRendererView.tsx#L45) + +Render video track received from [usePeers](../functions/usePeers.md) hook + +Example usage: +```js + + ``` + +## Param + +## Param diff --git a/versioned_docs/version-0.24.0/api/mobile/variables/useAppScreenShare.md b/versioned_docs/version-0.24.0/api/mobile/variables/useAppScreenShare.md new file mode 100644 index 00000000..e9446534 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/variables/useAppScreenShare.md @@ -0,0 +1,15 @@ +# Variable: useAppScreenShare() + +> `const` **useAppScreenShare**: () => [`AppScreenShareData`](../type-aliases/AppScreenShareData.md) + +Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:63](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useAppScreenShare.ts#L63) + +This hook can toggle client app screen sharing on/off and provides current screen share state. + +It works only on iOS. + +## Returns + +[`AppScreenShareData`](../type-aliases/AppScreenShareData.md) + +An object with functions to manage app screen share on iOS and null on android. diff --git a/versioned_docs/version-0.24.0/api/mobile/variables/useCallKit.md b/versioned_docs/version-0.24.0/api/mobile/variables/useCallKit.md new file mode 100644 index 00000000..1d1f1940 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/variables/useCallKit.md @@ -0,0 +1,32 @@ +# Variable: useCallKit() + +> `const` **useCallKit**: () => [`UseCallKitResult`](../type-aliases/UseCallKitResult.md) + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:161](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L161) + +A hook for managing CallKit sessions on iOS. Does nothing on other platforms. +CallKit provides a native iOS interface for managing VoIP calls, integrating with the system's +phone UI and controls. Use this hook when you need fine-grained control over the CallKit session lifecycle. + +## Returns + +[`UseCallKitResult`](../type-aliases/UseCallKitResult.md) + +An object containing methods to manage CallKit sessions: + - `startCallKitSession(config: CallKitConfig)` - Starts a CallKit session with the given configuration + - `endCallKitSession()` - Ends the current CallKit session + - `getCallKitSessionStatus()` - Returns whether there is currently an active CallKit session + +## Example + +```typescript +import { useCallKit } from '@fishjam-cloud/react-native-client'; + +const { startCallKitSession, endCallKitSession } = useCallKit(); + +// Start a CallKit session +await startCallKitSession({ displayName: 'John Doe', isVideo: true }); + +// Later, end the session +await endCallKitSession(); +``` diff --git a/versioned_docs/version-0.24.0/api/mobile/variables/useCallKitEvent.md b/versioned_docs/version-0.24.0/api/mobile/variables/useCallKitEvent.md new file mode 100644 index 00000000..a9e345fd --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/variables/useCallKitEvent.md @@ -0,0 +1,39 @@ +# Variable: useCallKitEvent() + +> `const` **useCallKitEvent**: \<`T`\>(`action`, `callback`) => `void` + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:130](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L130) + +A hook for listening to CallKit actions on iOS. Does nothing on other platforms. +This hook allows you to respond to user interactions with the native iOS CallKit interface, +such as muting/unmuting the call, putting the call on hold, or ending the call from the +system's phone UI or lock screen controls. + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* keyof [`CallKitAction`](../type-aliases/CallKitAction.md) | + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `action` | `T` | The CallKit action to listen for. Available actions: - `'started'` - CallKit session has started - `'ended'` - User ended the call from CallKit UI - `'failed'` - CallKit session failed to start - `'muted'` - User toggled mute from CallKit UI - `'held'` - User toggled hold from CallKit UI | +| `callback` | (`event`) => `void` | Function called when the specified action occurs. | + +## Returns + +`void` + +## Example + +```typescript +import { useCallKitEvent } from '@fishjam-cloud/react-native-client'; + +// Listen for hold state changes +useCallKitEvent('held', (isOnHold: boolean) => { + console.log('Call hold state:', isOnHold); + // Handle hold state in your app +}); +``` diff --git a/versioned_docs/version-0.24.0/api/mobile/variables/useCallKitService.md b/versioned_docs/version-0.24.0/api/mobile/variables/useCallKitService.md new file mode 100644 index 00000000..79a60ead --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/variables/useCallKitService.md @@ -0,0 +1,34 @@ +# Variable: useCallKitService() + +> `const` **useCallKitService**: (`config`) => `void` + +Defined in: [packages/react-native-client/src/hooks/useCallKit.ts:192](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useCallKit.ts#L192) + +A convenience hook for automatically managing CallKit session lifecycle on iOS. Does nothing on other platforms. +This hook automatically starts a CallKit session when the component mounts and ends it when the component unmounts. +Use this hook when you want CallKit to be active for the entire lifetime of a component (e.g., during a call). + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `config` | [`CallKitConfig`](../type-aliases/CallKitConfig.md) | Configuration object containing: - `displayName` - The name to display in the CallKit UI (e.g., username, call title) - `isVideo` - Whether the call is video or audio only | + +## Returns + +`void` + +## Example + +```typescript +import React from 'react'; +import { useCallKitService } from '@fishjam-cloud/react-native-client'; + +function CallScreen({ username }: { username: string }) { + // CallKit session will automatically start when this component mounts + // and end when it unmounts + useCallKitService({ displayName: username, isVideo: true }); + + return null; +} +``` diff --git a/versioned_docs/version-0.24.0/api/mobile/variables/useCameraPermissions.md b/versioned_docs/version-0.24.0/api/mobile/variables/useCameraPermissions.md new file mode 100644 index 00000000..a71b5e23 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/variables/useCameraPermissions.md @@ -0,0 +1,25 @@ +# Variable: useCameraPermissions() + +> `const` **useCameraPermissions**: (`options?`) => \[`null` \| `PermissionResponse`, `RequestPermissionMethod`\<`PermissionResponse`\>, `GetPermissionMethod`\<`PermissionResponse`\>\] + +Defined in: [packages/react-native-client/src/hooks/usePermissions.ts:31](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePermissions.ts#L31) + +Check or request permissions to access the camera. +This uses both `requestCameraPermissionsAsync` and `getCameraPermissionsAsync` to interact with the permissions. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `PermissionHookOptions`\<`object`\> | + +## Returns + +\[`null` \| `PermissionResponse`, `RequestPermissionMethod`\<`PermissionResponse`\>, `GetPermissionMethod`\<`PermissionResponse`\>\] + +## Example + +```ts +import { useCameraPermissions } from '@fishjam-cloud/react-native-client'; +const [status, requestPermission] = useCameraPermissions(); +``` diff --git a/versioned_docs/version-0.24.0/api/mobile/variables/useForegroundService.md b/versioned_docs/version-0.24.0/api/mobile/variables/useForegroundService.md new file mode 100644 index 00000000..07ac9cef --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/variables/useForegroundService.md @@ -0,0 +1,18 @@ +# Variable: useForegroundService() + +> `const` **useForegroundService**: (`config`) => `void` + +Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:109](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/useForegroundService.ts#L109) + +A hook for managing a foreground service on Android. Does nothing on other platforms. +You can use this hook to keep your app running in the background. You're also required to run a foreground service when screen sharing. + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `config` | [`ForegroundServiceConfig`](../type-aliases/ForegroundServiceConfig.md) | Configuration options for the foreground service. | + +## Returns + +`void` diff --git a/versioned_docs/version-0.24.0/api/mobile/variables/useMicrophonePermissions.md b/versioned_docs/version-0.24.0/api/mobile/variables/useMicrophonePermissions.md new file mode 100644 index 00000000..533866c8 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/mobile/variables/useMicrophonePermissions.md @@ -0,0 +1,25 @@ +# Variable: useMicrophonePermissions() + +> `const` **useMicrophonePermissions**: (`options?`) => \[`null` \| `PermissionResponse`, `RequestPermissionMethod`\<`PermissionResponse`\>, `GetPermissionMethod`\<`PermissionResponse`\>\] + +Defined in: [packages/react-native-client/src/hooks/usePermissions.ts:63](https://github.com/fishjam-cloud/mobile-client-sdk/blob/efa62a8334bae1f0b89394bc9b884c47f9be9b37/packages/react-native-client/src/hooks/usePermissions.ts#L63) + +Check or request permissions to access the microphone. +This uses both `requestMicrophonePermissionsAsync` and `getMicrophonePermissionsAsync` to interact with the permissions. + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `PermissionHookOptions`\<`object`\> | + +## Returns + +\[`null` \| `PermissionResponse`, `RequestPermissionMethod`\<`PermissionResponse`\>, `GetPermissionMethod`\<`PermissionResponse`\>\] + +## Example + +```ts +import { useMicrophonePermissions } from '@fishjam-cloud/react-native-client'; +const [status, requestPermission] = useMicrophonePermissions(); +``` diff --git a/versioned_docs/version-0.24.0/api/reference.md b/versioned_docs/version-0.24.0/api/reference.md new file mode 100644 index 00000000..4d4a4810 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/reference.md @@ -0,0 +1,50 @@ +--- +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 OpenAPI](https://github.com/fishjam-cloud/documentation/tree/main/static/api/fishjam-server-openapi.yaml) + +### 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.24.0/api/server-python/fishjam/agent/index.md b/versioned_docs/version-0.24.0/api/server-python/fishjam/agent/index.md new file mode 100644 index 00000000..74a0b740 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server-python/fishjam/agent/index.md @@ -0,0 +1,275 @@ +--- +title: agent +sidebar_label: agent +custom_edit_url: null +--- + +# fishjam.agent + + + +## Agent +```python +class Agent: +``` +Allows for connecting to a Fishjam room as an agent peer. + +Provides callbacks for receiving audio. + +Attributes: +- id: The unique identifier of the agent. +- room_id: The ID of the room the agent is connecting to. + +### __init__ +```python +def __init__(id: str, room_id: str, token: str, fishjam_url: str) +``` +Creates an Agent instance. + +This constructor should not be called directly. +Instead, you should call :func:`fishjam.FishjamClient.create_agent`. + +Args: +- id: The unique identifier for the agent. +- room_id: The ID of the room the agent will join. +- token: The authentication token for the agent. +- fishjam_url: The URL of the Fishjam instance. + +### id +```python +id +``` + + +### room_id +```python +room_id +``` + + +### connect +```python +def connect(self) +``` +Connects the agent to Fishjam to start receiving messages. + +Incoming messages from Fishjam will be routed to handlers +defined with :func:`on_track_data`. + +Yields: +- AgentSession: An active session for sending media and handling events. + +Raises: +- AgentAuthError: If authentication with the Fishjam server fails. + +--- +## AgentError +```python +class AgentError(Exception): +``` +Base exception class for all agent exceptions. + +--- +## AgentSession +```python +class AgentSession: +``` +Represents an active connection session for an Agent. + +### __init__ +```python +def __init__( + agent: fishjam.agent.agent.Agent, + websocket: websockets.asyncio.client.ClientConnection +) +``` +Initializes the AgentSession. + +Args: +- agent: The Agent instance owning this session. +- websocket: The active websocket connection. + +### agent +```python +agent +``` + + +### receive +```python +def receive( + self +) -> AsyncIterator[AgentResponseTrackData] +``` +Returns an async iterator over incoming messages from Fishjam. + +Yields: +- IncomingAgentMessage: The next message received from the server. + +### add_track +```python +def add_track( + self, + options: fishjam.agent.agent.OutgoingAudioTrackOptions +) -> fishjam.agent.agent.OutgoingTrack +``` +Adds a track to the connected agent with the specified options. + +Args: +- options: Configuration options and metadata for the new track. + +Returns: +- OutgoingTrack: An object used to send data over the added track. + +### disconnect +```python +def disconnect(self) +``` +Ends the agent session by closing the websocket connection. + +Useful when you don't use the context manager to obtain the session. + +--- +## AgentAuthError +```python +class AgentAuthError(fishjam.agent.errors.AgentError): +``` +Agent failed to authenticate properly. + +### __init__ +```python +def __init__(reason: str) +``` + + +### reason +```python +reason +``` + + +--- +## IncomingTrackData +```python +IncomingTrackData = + +``` + + +--- +## OutgoingTrack +```python +class OutgoingTrack: +``` +Represents an outgoing track of an agent connected to Fishjam. + +This is created by :func:`Agent.add_track`. + +Attributes: +- id: The global identifier of the track. +- session: The agent the track belongs to. +- options: The parameters used to create the track. + +### __init__ +```python +def __init__( + id: str, + session: fishjam.agent.agent.AgentSession, + options: fishjam.agent.agent.OutgoingAudioTrackOptions +) +``` + + +### id +```python +id: str +``` + + +### session +```python +session: fishjam.agent.agent.AgentSession +``` + + +### options +```python +options: fishjam.agent.agent.OutgoingAudioTrackOptions +``` + + +### send_chunk +```python +def send_chunk(self, data: bytes) +``` +Sends a chunk of audio to Fishjam on this track. + +Peers connected to the room of the agent will receive this data. + +Args: +- data: The raw audio bytes to send. + +### interrupt +```python +def interrupt(self) +``` +Interrupts the current track. + +Any audio that has been sent, but not played, will be cleared and +prevented from playing. Audio sent after the interrupt will be played +normally. + +--- +## OutgoingAudioTrackOptions +```python +class OutgoingAudioTrackOptions: +``` +Parameters of an outgoing audio track. + +Attributes: +- encoding: The encoding of the audio source. Defaults to raw 16-bit PCM. +- sample_rate: The sample rate of the audio source. Defaults to 16000. +- channels: The number of channels in the audio source. Supported values are + 1 (mono) and 2 (stereo). Defaults to 1 (mono). +- metadata: Custom metadata for the track. Must be JSON-encodable. + +### __init__ +```python +def __init__( + encoding: TrackEncoding = , + sample_rate: Literal[16000, 24000] = 16000, + channels: Literal[1, 2] = 1, + metadata: dict[str, typing.Any] | None = None +) +``` + + +### encoding +```python +encoding: TrackEncoding = + +``` + + +### sample_rate +```python +sample_rate: Literal[16000, 24000] = 16000 + +``` + + +### channels +```python +channels: Literal[1, 2] = 1 + +``` + + +### metadata +```python +metadata: dict[str, typing.Any] | None = None + +``` + + +--- diff --git a/versioned_docs/version-0.24.0/api/server-python/fishjam/errors/index.md b/versioned_docs/version-0.24.0/api/server-python/fishjam/errors/index.md new file mode 100644 index 00000000..d64a628c --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server-python/fishjam/errors/index.md @@ -0,0 +1,59 @@ +--- +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.24.0/api/server-python/fishjam/events/index.md b/versioned_docs/version-0.24.0/api/server-python/fishjam/events/index.md new file mode 100644 index 00000000..bfde1d69 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server-python/fishjam/events/index.md @@ -0,0 +1,863 @@ +--- +title: events +sidebar_label: events +custom_edit_url: null +--- + +# fishjam.events + + + +## ServerMessageRoomCreated +```python +class ServerMessageRoomCreated(betterproto.Message): +``` +Notification sent when a room is created + +### __init__ +```python +def __init__(room_id: str = ) +``` + + +### room_id +```python +room_id: str +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessageRoomDeleted +```python +class ServerMessageRoomDeleted(betterproto.Message): +``` +Notification sent when a room is deleted + +### __init__ +```python +def __init__(room_id: str = ) +``` + + +### room_id +```python +room_id: str +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessageRoomCrashed +```python +class ServerMessageRoomCrashed(betterproto.Message): +``` +Notification sent when a room crashes + +### __init__ +```python +def __init__(room_id: str = ) +``` + + +### room_id +```python +room_id: str +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessagePeerAdded +```python +class ServerMessagePeerAdded(betterproto.Message): +``` +Notification sent when a peer is added + +### __init__ +```python +def __init__( + room_id: str = , + peer_id: str = , + peer_type: ServerMessagePeerType = +) +``` + + +### room_id +```python +room_id: str +``` + + +### peer_id +```python +peer_id: str +``` + + +### peer_type +```python +peer_type: ServerMessagePeerType +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessagePeerConnected +```python +class ServerMessagePeerConnected(betterproto.Message): +``` +Notification sent when a peer connects + +### __init__ +```python +def __init__( + room_id: str = , + peer_id: str = , + peer_type: ServerMessagePeerType = +) +``` + + +### room_id +```python +room_id: str +``` + + +### peer_id +```python +peer_id: str +``` + + +### peer_type +```python +peer_type: ServerMessagePeerType +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessagePeerDeleted +```python +class ServerMessagePeerDeleted(betterproto.Message): +``` +Notification sent when a peer is removed + +### __init__ +```python +def __init__( + room_id: str = , + peer_id: str = , + peer_type: ServerMessagePeerType = +) +``` + + +### room_id +```python +room_id: str +``` + + +### peer_id +```python +peer_id: str +``` + + +### peer_type +```python +peer_type: ServerMessagePeerType +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessagePeerDisconnected +```python +class ServerMessagePeerDisconnected(betterproto.Message): +``` +Notification sent when a peer disconnects from FJ + +### __init__ +```python +def __init__( + room_id: str = , + peer_id: str = , + peer_type: ServerMessagePeerType = +) +``` + + +### room_id +```python +room_id: str +``` + + +### peer_id +```python +peer_id: str +``` + + +### peer_type +```python +peer_type: ServerMessagePeerType +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessagePeerMetadataUpdated +```python +class ServerMessagePeerMetadataUpdated(betterproto.Message): +``` +Notification sent when peer updates its metadata + +### __init__ +```python +def __init__( + room_id: str = , + peer_id: str = , + metadata: str = , + peer_type: ServerMessagePeerType = +) +``` + + +### room_id +```python +room_id: str +``` + + +### peer_id +```python +peer_id: str +``` + + +### metadata +```python +metadata: str +``` + + +### peer_type +```python +peer_type: ServerMessagePeerType +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessagePeerCrashed +```python +class ServerMessagePeerCrashed(betterproto.Message): +``` +Notification sent when a peer crashes + +### __init__ +```python +def __init__( + room_id: str = , + peer_id: str = , + reason: str = , + peer_type: ServerMessagePeerType = +) +``` + + +### room_id +```python +room_id: str +``` + + +### peer_id +```python +peer_id: str +``` + + +### reason +```python +reason: str +``` + + +### peer_type +```python +peer_type: ServerMessagePeerType +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessageStreamConnected +```python +class ServerMessageStreamConnected(betterproto.Message): +``` +Notification sent when streamer successfully connects + +### __init__ +```python +def __init__(stream_id: str = ) +``` + + +### stream_id +```python +stream_id: str +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessageStreamDisconnected +```python +class ServerMessageStreamDisconnected(betterproto.Message): +``` +Notification sent when streamer disconnects + +### __init__ +```python +def __init__(stream_id: str = ) +``` + + +### stream_id +```python +stream_id: str +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessageTrackAdded +```python +class ServerMessageTrackAdded(betterproto.Message): +``` +Notification sent when peer or component adds new track + +### __init__ +```python +def __init__( + room_id: str = , + peer_id: str = , + component_id: str = , + track: Track = +) +``` + + +### room_id +```python +room_id: str +``` + + +### peer_id +```python +peer_id: str +``` + + +### component_id +```python +component_id: str +``` + + +### track +```python +track: Track +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessageTrackMetadataUpdated +```python +class ServerMessageTrackMetadataUpdated(betterproto.Message): +``` +Notification sent when metadata of a multimedia track is updated + +### __init__ +```python +def __init__( + room_id: str = , + peer_id: str = , + component_id: str = , + track: Track = +) +``` + + +### room_id +```python +room_id: str +``` + + +### peer_id +```python +peer_id: str +``` + + +### component_id +```python +component_id: str +``` + + +### track +```python +track: Track +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessageTrackRemoved +```python +class ServerMessageTrackRemoved(betterproto.Message): +``` +Notification sent when a track is removed + +### __init__ +```python +def __init__( + room_id: str = , + peer_id: str = , + component_id: str = , + track: Track = +) +``` + + +### room_id +```python +room_id: str +``` + + +### peer_id +```python +peer_id: str +``` + + +### component_id +```python +component_id: str +``` + + +### track +```python +track: Track +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessageViewerConnected +```python +class ServerMessageViewerConnected(betterproto.Message): +``` +Notification sent when viewer successfully connects + +### __init__ +```python +def __init__(stream_id: str = , viewer_id: str = ) +``` + + +### stream_id +```python +stream_id: str +``` + + +### viewer_id +```python +viewer_id: str +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## ServerMessageViewerDisconnected +```python +class ServerMessageViewerDisconnected(betterproto.Message): +``` +Notification sent when viewer disconnects + +### __init__ +```python +def __init__(stream_id: str = , viewer_id: str = ) +``` + + +### stream_id +```python +stream_id: str +``` + + +### viewer_id +```python +viewer_id: str +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## Track +```python +class Track(betterproto.Message): +``` +Describes a media track + +### __init__ +```python +def __init__( + id: str = , + type: TrackType = , + metadata: str = +) +``` + + +### id +```python +id: str +``` + + +### type +```python +type: TrackType +``` + + +### metadata +```python +metadata: str +``` + + +#### Inherited Members +* **Message**: + * `SerializeToString` + * `parse` + * `FromString` + * `to_dict` + * `from_dict` + * `to_json` + * `from_json` + * `to_pydict` + * `from_pydict` + * `is_set` +--- +## TrackEncoding +```python +class TrackEncoding(betterproto.Enum): +``` +The base class for protobuf enumerations, all generated enumerations will inherit +from this. Bases :class:`enum.IntEnum`. + +### TRACK_ENCODING_UNSPECIFIED +```python +TRACK_ENCODING_UNSPECIFIED = + +``` + + +### TRACK_ENCODING_PCM16 +```python +TRACK_ENCODING_PCM16 = + +``` + + +### TRACK_ENCODING_OPUS +```python +TRACK_ENCODING_OPUS = + +``` + + +#### Inherited Members +* **Enum**: + * `from_string` + + + + + +* **Enum**: + * `name` + * `value` +--- +## TrackType +```python +class TrackType(betterproto.Enum): +``` +Defines types of tracks being published by peers and component + +### TRACK_TYPE_UNSPECIFIED +```python +TRACK_TYPE_UNSPECIFIED = + +``` + + +### TRACK_TYPE_VIDEO +```python +TRACK_TYPE_VIDEO = + +``` + + +### TRACK_TYPE_AUDIO +```python +TRACK_TYPE_AUDIO = + +``` + + +#### Inherited Members +* **Enum**: + * `from_string` + + + + + +* **Enum**: + * `name` + * `value` +--- +## ServerMessagePeerType +```python +class ServerMessagePeerType(betterproto.Enum): +``` +The base class for protobuf enumerations, all generated enumerations will inherit +from this. Bases :class:`enum.IntEnum`. + +### PEER_TYPE_UNSPECIFIED +```python +PEER_TYPE_UNSPECIFIED = + +``` + + +### PEER_TYPE_WEBRTC +```python +PEER_TYPE_WEBRTC = + +``` + + +### PEER_TYPE_AGENT +```python +PEER_TYPE_AGENT = + +``` + + +#### Inherited Members +* **Enum**: + * `from_string` + + + + + +* **Enum**: + * `name` + * `value` +--- diff --git a/versioned_docs/version-0.24.0/api/server-python/fishjam/index.md b/versioned_docs/version-0.24.0/api/server-python/fishjam/index.md new file mode 100644 index 00000000..2f9558e7 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server-python/fishjam/index.md @@ -0,0 +1,595 @@ +--- +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_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. + +### 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` +--- +## 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, ServerMessageStreamConnected, ServerMessageStreamDisconnected, ServerMessageViewerConnected, ServerMessageViewerDisconnected, ServerMessageTrackAdded, ServerMessageTrackRemoved, ServerMessageTrackMetadataUpdated]], NoneType], Callable[[Union[ServerMessageRoomCreated, ServerMessageRoomDeleted, ServerMessageRoomCrashed, ServerMessagePeerAdded, ServerMessagePeerDeleted, ServerMessagePeerConnected, ServerMessagePeerDisconnected, ServerMessagePeerMetadataUpdated, ServerMessagePeerCrashed, ServerMessageStreamConnected, ServerMessageStreamDisconnected, 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, ServerMessageStreamConnected, ServerMessageStreamDisconnected, 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 + +--- +## 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 a WebRTC 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 (Union['PeerMetadata', None]): 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: Optional[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: Optional[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.24.0/api/server-python/fishjam/integrations/gemini/index.md b/versioned_docs/version-0.24.0/api/server-python/fishjam/integrations/gemini/index.md new file mode 100644 index 00000000..44d3e133 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server-python/fishjam/integrations/gemini/index.md @@ -0,0 +1,18 @@ +--- +title: gemini +sidebar_label: gemini +custom_edit_url: null +--- + +# fishjam.integrations.gemini + + + +## GeminiIntegration +```python +GeminiIntegration = + +``` +Integration with the Gemini Live API. + +--- diff --git a/versioned_docs/version-0.24.0/api/server-python/fishjam/integrations/index.md b/versioned_docs/version-0.24.0/api/server-python/fishjam/integrations/index.md new file mode 100644 index 00000000..a8c2dfd8 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server-python/fishjam/integrations/index.md @@ -0,0 +1,12 @@ +--- +title: integrations +sidebar_label: integrations +custom_edit_url: null +--- + +# fishjam.integrations + + +## Submodules +- [gemini](integrations/gemini) + diff --git a/versioned_docs/version-0.24.0/api/server-python/fishjam/peer/index.md b/versioned_docs/version-0.24.0/api/server-python/fishjam/peer/index.md new file mode 100644 index 00000000..7319cc3a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server-python/fishjam/peer/index.md @@ -0,0 +1,100 @@ +--- +title: peer +sidebar_label: peer +custom_edit_url: null +--- + +# fishjam.peer + + + +## 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] +``` + + +--- +## PeerStatus +```python +class PeerStatus(str, enum.Enum): +``` +Informs about the peer status + +### CONNECTED +```python +CONNECTED = + +``` + + +### DISCONNECTED +```python +DISCONNECTED = + +``` + + +#### Inherited Members +* **Enum**: + * `name` + * `value` +--- +## PeerType +```python +class PeerType(str, enum.Enum): +``` +Peer type + +### AGENT +```python +AGENT = + +``` + + +### WEBRTC +```python +WEBRTC = + +``` + + +#### Inherited Members +* **Enum**: + * `name` + * `value` +--- diff --git a/versioned_docs/version-0.24.0/api/server-python/fishjam/room/index.md b/versioned_docs/version-0.24.0/api/server-python/fishjam/room/index.md new file mode 100644 index 00000000..dbb66e1a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server-python/fishjam/room/index.md @@ -0,0 +1,169 @@ +--- +title: room +sidebar_label: room +custom_edit_url: null +--- + +# fishjam.room + + + +## RoomConfig +```python +class RoomConfig: +``` +Room configuration + +Attributes: +- max_peers (Union[None, Unset, int]): Maximum amount of peers allowed into the room Example: 10. +- public (Union[Unset, bool]): True if livestream viewers can omit specifying a token. Default: False. +- room_type (Union[Unset, RoomType]): The use-case of the room. If not provided, this defaults to conference. +- video_codec (Union[Unset, VideoCodec]): Enforces video codec for each peer in the room +- webhook_url (Union[None, Unset, str]): URL where Fishjam notifications will be sent Example: + https://backend.address.com/fishjam-notifications-endpoint. + +### __init__ +```python +def __init__( + max_peers: Union[NoneType, Unset, int] = , + public: Union[Unset, bool] = False, + room_type: Union[Unset, RoomType] = , + video_codec: Union[Unset, VideoCodec] = , + webhook_url: Union[NoneType, Unset, str] = +) +``` +Method generated by attrs for class RoomConfig. + +### max_peers +```python +max_peers: Union[NoneType, Unset, int] +``` + + +### public +```python +public: Union[Unset, bool] +``` + + +### room_type +```python +room_type: Union[Unset, RoomType] +``` + + +### video_codec +```python +video_codec: Union[Unset, VideoCodec] +``` + + +### webhook_url +```python +webhook_url: Union[NoneType, Unset, str] +``` + + +### 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] +``` + + +--- +## VideoCodec +```python +class VideoCodec(str, enum.Enum): +``` +Enforces video codec for each peer in the room + +### H264 +```python +H264 = + +``` + + +### VP8 +```python +VP8 = + +``` + + +#### Inherited Members +* **Enum**: + * `name` + * `value` +--- +## RoomType +```python +class RoomType(str, enum.Enum): +``` +The use-case of the room. If not provided, this defaults to conference. + +### AUDIO_ONLY +```python +AUDIO_ONLY = + +``` + + +### AUDIO_ONLY_LIVESTREAM +```python +AUDIO_ONLY_LIVESTREAM = + +``` + + +### BROADCASTER +```python +BROADCASTER = + +``` + + +### CONFERENCE +```python +CONFERENCE = + +``` + + +### FULL_FEATURE +```python +FULL_FEATURE = + +``` + + +### LIVESTREAM +```python +LIVESTREAM = + +``` + + +#### Inherited Members +* **Enum**: + * `name` + * `value` +--- diff --git a/versioned_docs/version-0.24.0/api/server/classes/BadRequestException.md b/versioned_docs/version-0.24.0/api/server/classes/BadRequestException.md new file mode 100644 index 00000000..34402519 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/BadRequestException.md @@ -0,0 +1,65 @@ +# Class: BadRequestException + +Defined in: [js-server-sdk/src/exceptions/index.ts:21](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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.24.0/api/server/classes/FishjamAgent.md b/versioned_docs/version-0.24.0/api/server/classes/FishjamAgent.md new file mode 100644 index 00000000..ce2f1399 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/FishjamAgent.md @@ -0,0 +1,146 @@ +# Class: FishjamAgent + +Defined in: [js-server-sdk/src/agent.ts:42](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L42) + +## Extends + +- `TypedEventEmitter`\<[`AgentEvents`](../type-aliases/AgentEvents.md), `this`\> + +## Constructors + +### Constructor + +> **new FishjamAgent**(`config`, `agentToken`, `callbacks?`): `FishjamAgent` + +Defined in: [js-server-sdk/src/agent.ts:48](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L48) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | [`FishjamConfig`](../type-aliases/FishjamConfig.md) | +| `agentToken` | `string` | +| `callbacks?` | [`AgentCallbacks`](../type-aliases/AgentCallbacks.md) | + +#### Returns + +`FishjamAgent` + +#### Overrides + +`(EventEmitter as new () => TypedEmitter).constructor` + +## Methods + +### awaitConnected() + +> **awaitConnected**(): `Promise`\<`void`\> + +Defined in: [js-server-sdk/src/agent.ts:72](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L72) + +Await Agent connection to Fishjam. + +#### Returns + +`Promise`\<`void`\> + +*** + +### createTrack() + +> **createTrack**(`codecParameters`, `metadata`): [`AgentTrack`](../type-aliases/AgentTrack.md) + +Defined in: [js-server-sdk/src/agent.ts:80](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L80) + +Creates an outgoing audio track for the agent + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `codecParameters` | [`AudioCodecParameters`](../type-aliases/AudioCodecParameters.md) | +| `metadata` | `object` | + +#### Returns + +[`AgentTrack`](../type-aliases/AgentTrack.md) + +a new audio track + +*** + +### deleteTrack() + +> **deleteTrack**(`trackId`): `void` + +Defined in: [js-server-sdk/src/agent.ts:112](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L112) + +Deletes an outgoing audio track for the agent + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `trackId` | [`TrackId`](../type-aliases/TrackId.md) | + +#### Returns + +`void` + +*** + +### disconnect() + +> **disconnect**(): `void` + +Defined in: [js-server-sdk/src/agent.ts:127](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L127) + +#### Returns + +`void` + +*** + +### interruptTrack() + +> **interruptTrack**(`trackId`): `void` + +Defined in: [js-server-sdk/src/agent.ts:103](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L103) + +Interrupt track identified by `trackId`. + +Any audio that has been sent by the agent, but not played +by Fishjam will be cleared and be prevented from playing. + +Audio sent after the interrupt will be played normally. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `trackId` | [`TrackId`](../type-aliases/TrackId.md) | + +#### Returns + +`void` + +*** + +### sendData() + +> **sendData**(`trackId`, `data`): `void` + +Defined in: [js-server-sdk/src/agent.ts:121](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L121) + +Send audio data for the given track + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `trackId` | [`TrackId`](../type-aliases/TrackId.md) | +| `data` | `Uint8Array` | + +#### Returns + +`void` diff --git a/versioned_docs/version-0.24.0/api/server/classes/FishjamBaseException.md b/versioned_docs/version-0.24.0/api/server/classes/FishjamBaseException.md new file mode 100644 index 00000000..044c50b7 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/FishjamBaseException.md @@ -0,0 +1,64 @@ +# Class: FishjamBaseException + +Defined in: [js-server-sdk/src/exceptions/index.ts:9](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/exceptions/index.ts#L10) diff --git a/versioned_docs/version-0.24.0/api/server/classes/FishjamClient.md b/versioned_docs/version-0.24.0/api/server/classes/FishjamClient.md new file mode 100644 index 00000000..9c2583a1 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/FishjamClient.md @@ -0,0 +1,286 @@ +# Class: FishjamClient + +Defined in: [js-server-sdk/src/client.ts:20](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L20) + +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:37](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L37) + +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:117](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L117) + +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:218](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L218) + +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:205](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L205) + +Creates a livestream viewer token for the given room. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | + +#### Returns + +`Promise`\<[`ViewerToken`](../interfaces/ViewerToken.md)\> + +a livestream viewer token + +*** + +### createPeer() + +> **createPeer**(`roomId`, `options`): `Promise`\<\{ `peer`: [`Peer`](../type-aliases/Peer.md); `peerToken`: `string`; \}\> + +Defined in: [js-server-sdk/src/client.ts:97](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L97) + +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:55](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L55) + +Create a new room. All peers connected to the same room will be able to send/receive streams to each other. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | [`RoomConfig`](../interfaces/RoomConfig.md) | + +#### Returns + +`Promise`\<[`Room`](../type-aliases/Room.md)\> + +*** + +### deletePeer() + +> **deletePeer**(`roomId`, `peerId`): `Promise`\<`void`\> + +Defined in: [js-server-sdk/src/client.ts:155](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L155) + +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:74](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L74) + +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:85](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L85) + +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:143](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L143) + +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:192](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L192) + +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:167](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L167) + +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:179](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/client.ts#L179) + +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.24.0/api/server/classes/FishjamNotFoundException.md b/versioned_docs/version-0.24.0/api/server/classes/FishjamNotFoundException.md new file mode 100644 index 00000000..29d94b9c --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/FishjamNotFoundException.md @@ -0,0 +1,65 @@ +# Class: FishjamNotFoundException + +Defined in: [js-server-sdk/src/exceptions/index.ts:29](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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.24.0/api/server/classes/FishjamWSNotifier.md b/versioned_docs/version-0.24.0/api/server/classes/FishjamWSNotifier.md new file mode 100644 index 00000000..9efca69a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/FishjamWSNotifier.md @@ -0,0 +1,33 @@ +# Class: FishjamWSNotifier + +Defined in: [js-server-sdk/src/ws\_notifier.ts:76](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L76) + +Notifier object that can be used to get notified about various events related to the Fishjam App. + +## Extends + +- `TypedEventEmitter`\<[`NotificationEvents`](../type-aliases/NotificationEvents.md), `this`\> + +## Constructors + +### Constructor + +> **new FishjamWSNotifier**(`config`, `onError`, `onClose`): `FishjamWSNotifier` + +Defined in: [js-server-sdk/src/ws\_notifier.ts:79](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L79) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | [`FishjamConfig`](../type-aliases/FishjamConfig.md) | +| `onError` | [`ErrorEventHandler`](../type-aliases/ErrorEventHandler.md) | +| `onClose` | [`CloseEventHandler`](../type-aliases/CloseEventHandler.md) | + +#### Returns + +`FishjamWSNotifier` + +#### Overrides + +`(EventEmitter as new () => TypedEmitter).constructor` diff --git a/versioned_docs/version-0.24.0/api/server/classes/ForbiddenException.md b/versioned_docs/version-0.24.0/api/server/classes/ForbiddenException.md new file mode 100644 index 00000000..b2bac7b4 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/ForbiddenException.md @@ -0,0 +1,65 @@ +# Class: ForbiddenException + +Defined in: [js-server-sdk/src/exceptions/index.ts:25](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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.24.0/api/server/classes/MissingFishjamIdException.md b/versioned_docs/version-0.24.0/api/server/classes/MissingFishjamIdException.md new file mode 100644 index 00000000..05f53c62 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/MissingFishjamIdException.md @@ -0,0 +1,23 @@ +# Class: MissingFishjamIdException + +Defined in: [js-server-sdk/src/exceptions/index.ts:3](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/exceptions/index.ts#L4) + +#### Returns + +`MissingFishjamIdException` + +#### Overrides + +`Error.constructor` diff --git a/versioned_docs/version-0.24.0/api/server/classes/PeerNotFoundException.md b/versioned_docs/version-0.24.0/api/server/classes/PeerNotFoundException.md new file mode 100644 index 00000000..57d15e9b --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/PeerNotFoundException.md @@ -0,0 +1,65 @@ +# Class: PeerNotFoundException + +Defined in: [js-server-sdk/src/exceptions/index.ts:31](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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.24.0/api/server/classes/RoomNotFoundException.md b/versioned_docs/version-0.24.0/api/server/classes/RoomNotFoundException.md new file mode 100644 index 00000000..3c51605a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/RoomNotFoundException.md @@ -0,0 +1,65 @@ +# Class: RoomNotFoundException + +Defined in: [js-server-sdk/src/exceptions/index.ts:27](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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.24.0/api/server/classes/ServiceUnavailableException.md b/versioned_docs/version-0.24.0/api/server/classes/ServiceUnavailableException.md new file mode 100644 index 00000000..c30464a4 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/ServiceUnavailableException.md @@ -0,0 +1,65 @@ +# Class: ServiceUnavailableException + +Defined in: [js-server-sdk/src/exceptions/index.ts:33](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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.24.0/api/server/classes/UnauthorizedException.md b/versioned_docs/version-0.24.0/api/server/classes/UnauthorizedException.md new file mode 100644 index 00000000..2d589a99 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/UnauthorizedException.md @@ -0,0 +1,65 @@ +# Class: UnauthorizedException + +Defined in: [js-server-sdk/src/exceptions/index.ts:23](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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.24.0/api/server/classes/UnknownException.md b/versioned_docs/version-0.24.0/api/server/classes/UnknownException.md new file mode 100644 index 00000000..4d68a8a0 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/classes/UnknownException.md @@ -0,0 +1,65 @@ +# Class: UnknownException + +Defined in: [js-server-sdk/src/exceptions/index.ts:35](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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/22932e9e40d6685e876f3295d34a2dc463114ca8/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.24.0/api/server/enumerations/PeerStatus.md b/versioned_docs/version-0.24.0/api/server/enumerations/PeerStatus.md new file mode 100644 index 00000000..ab87ec29 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/enumerations/PeerStatus.md @@ -0,0 +1,23 @@ +# Enumeration: PeerStatus + +Defined in: fishjam-openapi/dist/index.d.ts:363 + +Informs about the peer status + +## Export + +## Enumeration Members + +### Connected + +> **Connected**: `"connected"` + +Defined in: fishjam-openapi/dist/index.d.ts:364 + +*** + +### Disconnected + +> **Disconnected**: `"disconnected"` + +Defined in: fishjam-openapi/dist/index.d.ts:365 diff --git a/versioned_docs/version-0.24.0/api/server/enumerations/RoomType.md b/versioned_docs/version-0.24.0/api/server/enumerations/RoomType.md new file mode 100644 index 00000000..669997bf --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/enumerations/RoomType.md @@ -0,0 +1,55 @@ +# Enumeration: RoomType + +Defined in: fishjam-openapi/dist/index.d.ts:490 + +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:492 + +*** + +### AudioOnlyLivestream + +> **AudioOnlyLivestream**: `"audio_only_livestream"` + +Defined in: fishjam-openapi/dist/index.d.ts:496 + +*** + +### Broadcaster + +> **Broadcaster**: `"broadcaster"` + +Defined in: fishjam-openapi/dist/index.d.ts:493 + +*** + +### Conference + +> **Conference**: `"conference"` + +Defined in: fishjam-openapi/dist/index.d.ts:495 + +*** + +### FullFeature + +> **FullFeature**: `"full_feature"` + +Defined in: fishjam-openapi/dist/index.d.ts:491 + +*** + +### Livestream + +> **Livestream**: `"livestream"` + +Defined in: fishjam-openapi/dist/index.d.ts:494 diff --git a/versioned_docs/version-0.24.0/api/server/enumerations/VideoCodec.md b/versioned_docs/version-0.24.0/api/server/enumerations/VideoCodec.md new file mode 100644 index 00000000..f5cee5bb --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/enumerations/VideoCodec.md @@ -0,0 +1,23 @@ +# Enumeration: VideoCodec + +Defined in: fishjam-openapi/dist/index.d.ts:712 + +Enforces video codec for each peer in the room + +## Export + +## Enumeration Members + +### H264 + +> **H264**: `"h264"` + +Defined in: fishjam-openapi/dist/index.d.ts:713 + +*** + +### Vp8 + +> **Vp8**: `"vp8"` + +Defined in: fishjam-openapi/dist/index.d.ts:714 diff --git a/versioned_docs/version-0.24.0/api/server/index.md b/versioned_docs/version-0.24.0/api/server/index.md new file mode 100644 index 00000000..ee74d762 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/index.md @@ -0,0 +1,66 @@ +# @fishjam-cloud/js-server-sdk + +## 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) +- [PeerOptionsAgent](interfaces/PeerOptionsAgent.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) +- [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) +- [IncomingTrackData](type-aliases/IncomingTrackData.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) +- [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) +- [StreamConnected](type-aliases/StreamConnected.md) +- [StreamDisconnected](type-aliases/StreamDisconnected.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.24.0/api/server/interfaces/PeerOptionsAgent.md b/versioned_docs/version-0.24.0/api/server/interfaces/PeerOptionsAgent.md new file mode 100644 index 00000000..08858b3a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/interfaces/PeerOptionsAgent.md @@ -0,0 +1,33 @@ +# Interface: PeerOptionsAgent + +Defined in: fishjam-openapi/dist/index.d.ts:297 + +Options specific to the Agent peer + +## Export + +PeerOptionsAgent + +## Properties + +### output? + +> `optional` **output**: `AgentOutput` + +Defined in: fishjam-openapi/dist/index.d.ts:303 + +#### Memberof + +PeerOptionsAgent + +*** + +### subscribeMode? + +> `optional` **subscribeMode**: `SubscribeMode` + +Defined in: fishjam-openapi/dist/index.d.ts:309 + +#### Memberof + +PeerOptionsAgent diff --git a/versioned_docs/version-0.24.0/api/server/interfaces/PeerOptionsWebRTC.md b/versioned_docs/version-0.24.0/api/server/interfaces/PeerOptionsWebRTC.md new file mode 100644 index 00000000..481dc84f --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/interfaces/PeerOptionsWebRTC.md @@ -0,0 +1,39 @@ +# Interface: PeerOptionsWebRTC + +Defined in: fishjam-openapi/dist/index.d.ts:316 + +Options specific to the WebRTC peer + +## Export + +PeerOptionsWebRTC + +## Properties + +### metadata? + +> `optional` **metadata**: `object` + +Defined in: fishjam-openapi/dist/index.d.ts:322 + +Custom peer metadata + +#### Index Signature + +\[`key`: `string`\]: `any` + +#### Memberof + +PeerOptionsWebRTC + +*** + +### subscribeMode? + +> `optional` **subscribeMode**: `SubscribeMode` + +Defined in: fishjam-openapi/dist/index.d.ts:330 + +#### Memberof + +PeerOptionsWebRTC diff --git a/versioned_docs/version-0.24.0/api/server/interfaces/RoomConfig.md b/versioned_docs/version-0.24.0/api/server/interfaces/RoomConfig.md new file mode 100644 index 00000000..63061895 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/interfaces/RoomConfig.md @@ -0,0 +1,75 @@ +# Interface: RoomConfig + +Defined in: fishjam-openapi/dist/index.d.ts:408 + +Room configuration + +## Export + +RoomConfig + +## Properties + +### maxPeers? + +> `optional` **maxPeers**: `null` \| `number` + +Defined in: fishjam-openapi/dist/index.d.ts:414 + +Maximum amount of peers allowed into the room + +#### Memberof + +RoomConfig + +*** + +### public? + +> `optional` **public**: `boolean` + +Defined in: fishjam-openapi/dist/index.d.ts:420 + +True if livestream viewers can omit specifying a token. + +#### Memberof + +RoomConfig + +*** + +### roomType? + +> `optional` **roomType**: [`RoomType`](../enumerations/RoomType.md) + +Defined in: fishjam-openapi/dist/index.d.ts:426 + +#### Memberof + +RoomConfig + +*** + +### videoCodec? + +> `optional` **videoCodec**: [`VideoCodec`](../enumerations/VideoCodec.md) + +Defined in: fishjam-openapi/dist/index.d.ts:432 + +#### Memberof + +RoomConfig + +*** + +### webhookUrl? + +> `optional` **webhookUrl**: `null` \| `string` + +Defined in: fishjam-openapi/dist/index.d.ts:438 + +URL where Fishjam notifications will be sent + +#### Memberof + +RoomConfig diff --git a/versioned_docs/version-0.24.0/api/server/interfaces/ServerMessage.md b/versioned_docs/version-0.24.0/api/server/interfaces/ServerMessage.md new file mode 100644 index 00000000..afbdf3b0 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/interfaces/ServerMessage.md @@ -0,0 +1,217 @@ +# Interface: ServerMessage + +Defined in: fishjam-proto/dist/index.d.ts:63 + +Defines any type of message passed between FJ and server peer + +## Properties + +### authenticated? + +> `optional` **authenticated**: `ServerMessage_Authenticated` + +Defined in: fishjam-proto/dist/index.d.ts:69 + +*** + +### authRequest? + +> `optional` **authRequest**: `ServerMessage_AuthRequest` + +Defined in: fishjam-proto/dist/index.d.ts:70 + +*** + +### componentCrashed? + +> `optional` **componentCrashed**: `ServerMessage_ComponentCrashed` + +Defined in: fishjam-proto/dist/index.d.ts:68 + +*** + +### hlsPlayable? + +> `optional` **hlsPlayable**: `ServerMessage_HlsPlayable` + +Defined in: fishjam-proto/dist/index.d.ts:75 + +*** + +### hlsUploadCrashed? + +> `optional` **hlsUploadCrashed**: `ServerMessage_HlsUploadCrashed` + +Defined in: fishjam-proto/dist/index.d.ts:77 + +*** + +### hlsUploaded? + +> `optional` **hlsUploaded**: `ServerMessage_HlsUploaded` + +Defined in: fishjam-proto/dist/index.d.ts:76 + +*** + +### peerAdded? + +> `optional` **peerAdded**: `ServerMessage_PeerAdded` + +Defined in: fishjam-proto/dist/index.d.ts:82 + +*** + +### peerConnected? + +> `optional` **peerConnected**: `ServerMessage_PeerConnected` + +Defined in: fishjam-proto/dist/index.d.ts:65 + +*** + +### peerCrashed? + +> `optional` **peerCrashed**: `ServerMessage_PeerCrashed` + +Defined in: fishjam-proto/dist/index.d.ts:67 + +*** + +### peerDeleted? + +> `optional` **peerDeleted**: `ServerMessage_PeerDeleted` + +Defined in: fishjam-proto/dist/index.d.ts:83 + +*** + +### peerDisconnected? + +> `optional` **peerDisconnected**: `ServerMessage_PeerDisconnected` + +Defined in: fishjam-proto/dist/index.d.ts:66 + +*** + +### peerMetadataUpdated? + +> `optional` **peerMetadataUpdated**: `ServerMessage_PeerMetadataUpdated` + +Defined in: fishjam-proto/dist/index.d.ts:78 + +*** + +### roomCrashed? + +> `optional` **roomCrashed**: `ServerMessage_RoomCrashed` + +Defined in: fishjam-proto/dist/index.d.ts:64 + +*** + +### roomCreated? + +> `optional` **roomCreated**: `ServerMessage_RoomCreated` + +Defined in: fishjam-proto/dist/index.d.ts:73 + +*** + +### roomDeleted? + +> `optional` **roomDeleted**: `ServerMessage_RoomDeleted` + +Defined in: fishjam-proto/dist/index.d.ts:74 + +*** + +### ~~streamConnected?~~ + +> `optional` **streamConnected**: `ServerMessage_StreamConnected` + +Defined in: fishjam-proto/dist/index.d.ts:85 + +#### Deprecated + +*** + +### ~~streamDisconnected?~~ + +> `optional` **streamDisconnected**: `ServerMessage_StreamDisconnected` + +Defined in: fishjam-proto/dist/index.d.ts:87 + +#### Deprecated + +*** + +### streamerConnected? + +> `optional` **streamerConnected**: `ServerMessage_StreamerConnected` + +Defined in: fishjam-proto/dist/index.d.ts:90 + +*** + +### streamerDisconnected? + +> `optional` **streamerDisconnected**: `ServerMessage_StreamerDisconnected` + +Defined in: fishjam-proto/dist/index.d.ts:91 + +*** + +### subscribeRequest? + +> `optional` **subscribeRequest**: `ServerMessage_SubscribeRequest` + +Defined in: fishjam-proto/dist/index.d.ts:71 + +*** + +### subscribeResponse? + +> `optional` **subscribeResponse**: `ServerMessage_SubscribeResponse` + +Defined in: fishjam-proto/dist/index.d.ts:72 + +*** + +### trackAdded? + +> `optional` **trackAdded**: `ServerMessage_TrackAdded` + +Defined in: fishjam-proto/dist/index.d.ts:79 + +*** + +### trackMetadataUpdated? + +> `optional` **trackMetadataUpdated**: `ServerMessage_TrackMetadataUpdated` + +Defined in: fishjam-proto/dist/index.d.ts:81 + +*** + +### trackRemoved? + +> `optional` **trackRemoved**: `ServerMessage_TrackRemoved` + +Defined in: fishjam-proto/dist/index.d.ts:80 + +*** + +### viewerConnected? + +> `optional` **viewerConnected**: `ServerMessage_ViewerConnected` + +Defined in: fishjam-proto/dist/index.d.ts:88 + +*** + +### viewerDisconnected? + +> `optional` **viewerDisconnected**: `ServerMessage_ViewerDisconnected` + +Defined in: fishjam-proto/dist/index.d.ts:89 diff --git a/versioned_docs/version-0.24.0/api/server/interfaces/StreamerToken.md b/versioned_docs/version-0.24.0/api/server/interfaces/StreamerToken.md new file mode 100644 index 00000000..6e9e9bd4 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/interfaces/StreamerToken.md @@ -0,0 +1,21 @@ +# Interface: StreamerToken + +Defined in: fishjam-openapi/dist/index.d.ts:609 + +Token for authorizing broadcaster streamer connection + +## Export + +StreamerToken + +## Properties + +### token + +> **token**: `string` + +Defined in: fishjam-openapi/dist/index.d.ts:615 + +#### Memberof + +StreamerToken diff --git a/versioned_docs/version-0.24.0/api/server/interfaces/ViewerToken.md b/versioned_docs/version-0.24.0/api/server/interfaces/ViewerToken.md new file mode 100644 index 00000000..ce4c9d12 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/interfaces/ViewerToken.md @@ -0,0 +1,21 @@ +# Interface: ViewerToken + +Defined in: fishjam-openapi/dist/index.d.ts:752 + +Token for authorizing broadcaster viewer connection + +## Export + +ViewerToken + +## Properties + +### token + +> **token**: `string` + +Defined in: fishjam-openapi/dist/index.d.ts:758 + +#### Memberof + +ViewerToken diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/AgentCallbacks.md b/versioned_docs/version-0.24.0/api/server/type-aliases/AgentCallbacks.md new file mode 100644 index 00000000..8827c9e0 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/AgentCallbacks.md @@ -0,0 +1,21 @@ +# Type Alias: AgentCallbacks + +> **AgentCallbacks** = `object` + +Defined in: [js-server-sdk/src/types.ts:46](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L46) + +## Properties + +### onClose? + +> `optional` **onClose**: [`CloseEventHandler`](CloseEventHandler.md) + +Defined in: [js-server-sdk/src/types.ts:48](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L48) + +*** + +### onError? + +> `optional` **onError**: [`ErrorEventHandler`](ErrorEventHandler.md) + +Defined in: [js-server-sdk/src/types.ts:47](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L47) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/AgentEvents.md b/versioned_docs/version-0.24.0/api/server/type-aliases/AgentEvents.md new file mode 100644 index 00000000..c8ba8653 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/AgentEvents.md @@ -0,0 +1,5 @@ +# Type Alias: AgentEvents + +> **AgentEvents** = `{ [K in ExpectedAgentEvents]: (message: NonNullable<{ authenticated?: AgentResponse_Authenticated; trackData?: Omit & { peerId: PeerId } }[K]>) => void }` + +Defined in: [js-server-sdk/src/agent.ts:40](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L40) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/AgentTrack.md b/versioned_docs/version-0.24.0/api/server/type-aliases/AgentTrack.md new file mode 100644 index 00000000..716e4a9a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/AgentTrack.md @@ -0,0 +1,11 @@ +# Type Alias: AgentTrack + +> **AgentTrack** = `Omit`\<`ProtoTrack`, `"id"`\> & `object` + +Defined in: [js-server-sdk/src/agent.ts:26](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L26) + +## Type declaration + +### id + +> **id**: [`TrackId`](TrackId.md) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/AudioCodecParameters.md b/versioned_docs/version-0.24.0/api/server/type-aliases/AudioCodecParameters.md new file mode 100644 index 00000000..cc8a6705 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/AudioCodecParameters.md @@ -0,0 +1,29 @@ +# Type Alias: AudioCodecParameters + +> **AudioCodecParameters** = `object` + +Defined in: [js-server-sdk/src/agent.ts:29](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L29) + +## Properties + +### channels + +> **channels**: `1` + +Defined in: [js-server-sdk/src/agent.ts:32](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L32) + +*** + +### encoding + +> **encoding**: `"opus"` \| `"pcm16"` + +Defined in: [js-server-sdk/src/agent.ts:30](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L30) + +*** + +### sampleRate + +> **sampleRate**: `16000` \| `24000` \| `48000` + +Defined in: [js-server-sdk/src/agent.ts:31](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L31) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/Brand.md b/versioned_docs/version-0.24.0/api/server/type-aliases/Brand.md new file mode 100644 index 00000000..f2893f94 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/Brand.md @@ -0,0 +1,20 @@ +# Type Alias: Brand\ + +> **Brand**\<`T`, `TBrand`\> = `T` & `object` + +Defined in: [js-server-sdk/src/types.ts:8](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L8) + +Branded type helper + +## Type declaration + +### \[brand\] + +> **\[brand\]**: `TBrand` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | +| `TBrand` *extends* `string` | diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/CloseEventHandler.md b/versioned_docs/version-0.24.0/api/server/type-aliases/CloseEventHandler.md new file mode 100644 index 00000000..cb98cd21 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/CloseEventHandler.md @@ -0,0 +1,16 @@ +# Type Alias: CloseEventHandler() + +> **CloseEventHandler** = (`code`, `reason`) => `void` + +Defined in: [js-server-sdk/src/types.ts:44](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L44) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `code` | `number` | +| `reason` | `string` | + +## Returns + +`void` diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/ErrorEventHandler.md b/versioned_docs/version-0.24.0/api/server/type-aliases/ErrorEventHandler.md new file mode 100644 index 00000000..3ceade7d --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/ErrorEventHandler.md @@ -0,0 +1,15 @@ +# Type Alias: ErrorEventHandler() + +> **ErrorEventHandler** = (`msg`) => `void` + +Defined in: [js-server-sdk/src/types.ts:43](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L43) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `msg` | `Event` | + +## Returns + +`void` diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/ExpectedAgentEvents.md b/versioned_docs/version-0.24.0/api/server/type-aliases/ExpectedAgentEvents.md new file mode 100644 index 00000000..e38989c0 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/ExpectedAgentEvents.md @@ -0,0 +1,5 @@ +# Type Alias: ExpectedAgentEvents + +> **ExpectedAgentEvents** = `"trackData"` + +Defined in: [js-server-sdk/src/agent.ts:21](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L21) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/ExpectedEvents.md b/versioned_docs/version-0.24.0/api/server/type-aliases/ExpectedEvents.md new file mode 100644 index 00000000..858a3092 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/ExpectedEvents.md @@ -0,0 +1,5 @@ +# Type Alias: ExpectedEvents + +> **ExpectedEvents** = `"roomCreated"` \| `"roomDeleted"` \| `"roomCrashed"` \| `"peerAdded"` \| `"peerDeleted"` \| `"peerConnected"` \| `"peerDisconnected"` \| `"peerMetadataUpdated"` \| `"peerCrashed"` \| `"streamConnected"` \| `"streamDisconnected"` \| `"viewerConnected"` \| `"viewerDisconnected"` \| `"trackAdded"` \| `"trackRemoved"` \| `"trackMetadataUpdated"` + +Defined in: [js-server-sdk/src/ws\_notifier.ts:7](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L7) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/FishjamConfig.md b/versioned_docs/version-0.24.0/api/server/type-aliases/FishjamConfig.md new file mode 100644 index 00000000..08572989 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/FishjamConfig.md @@ -0,0 +1,21 @@ +# Type Alias: FishjamConfig + +> **FishjamConfig** = `object` + +Defined in: [js-server-sdk/src/types.ts:28](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L28) + +## Properties + +### fishjamId + +> **fishjamId**: `string` + +Defined in: [js-server-sdk/src/types.ts:33](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L33) + +*** + +### managementToken + +> **managementToken**: `string` + +Defined in: [js-server-sdk/src/types.ts:39](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L39) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/IncomingTrackData.md b/versioned_docs/version-0.24.0/api/server/type-aliases/IncomingTrackData.md new file mode 100644 index 00000000..5ef31466 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/IncomingTrackData.md @@ -0,0 +1,11 @@ +# Type Alias: IncomingTrackData + +> **IncomingTrackData** = `Omit`\<`NonNullable`\<`AgentResponse_TrackData`\>, `"peerId"`\> & `object` + +Defined in: [js-server-sdk/src/agent.ts:23](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L23) + +## Type declaration + +### peerId + +> **peerId**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/NotificationEvents.md b/versioned_docs/version-0.24.0/api/server/type-aliases/NotificationEvents.md new file mode 100644 index 00000000..197426ef --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/NotificationEvents.md @@ -0,0 +1,5 @@ +# Type Alias: NotificationEvents + +> **NotificationEvents** = `{ [K in ExpectedEvents]: (message: NonNullable<{ authenticated?: ServerMessage_Authenticated; authRequest?: ServerMessage_AuthRequest; componentCrashed?: Omit & { roomId: RoomId }; hlsPlayable?: Omit & { roomId: RoomId }; hlsUploadCrashed?: Omit & { roomId: RoomId }; hlsUploaded?: Omit & { roomId: RoomId }; peerAdded?: Omit & { roomId: RoomId }, "peerId"> & { peerId: PeerId }; peerConnected?: Omit & { roomId: RoomId }, "peerId"> & { peerId: PeerId }; peerCrashed?: Omit & { roomId: RoomId }, "peerId"> & { peerId: PeerId }; peerDeleted?: Omit & { roomId: RoomId }, "peerId"> & { peerId: PeerId }; peerDisconnected?: Omit & { roomId: RoomId }, "peerId"> & { peerId: PeerId }; peerMetadataUpdated?: Omit & { roomId: RoomId }, "peerId"> & { peerId: PeerId }; roomCrashed?: Omit & { roomId: RoomId }; roomCreated?: Omit & { roomId: RoomId }; roomDeleted?: Omit & { roomId: RoomId }; streamConnected?: ServerMessage_StreamConnected; streamDisconnected?: ServerMessage_StreamDisconnected; streamerConnected?: ServerMessage_StreamerConnected; streamerDisconnected?: ServerMessage_StreamerDisconnected; subscribeRequest?: ServerMessage_SubscribeRequest; subscribeResponse?: ServerMessage_SubscribeResponse; trackAdded?: Omit & { roomId: RoomId }; trackMetadataUpdated?: Omit & { roomId: RoomId }; trackRemoved?: Omit & { roomId: RoomId }; viewerConnected?: ServerMessage_ViewerConnected; viewerDisconnected?: ServerMessage_ViewerDisconnected }[K]>) => void }` + +Defined in: [js-server-sdk/src/ws\_notifier.ts:70](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L70) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/OutgoingTrackData.md b/versioned_docs/version-0.24.0/api/server/type-aliases/OutgoingTrackData.md new file mode 100644 index 00000000..e1d0a282 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/OutgoingTrackData.md @@ -0,0 +1,11 @@ +# Type Alias: OutgoingTrackData + +> **OutgoingTrackData** = `Omit`\<`NonNullable`\<`AgentRequest_TrackData`\>, `"peerId"`\> & `object` + +Defined in: [js-server-sdk/src/agent.ts:24](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L24) + +## Type declaration + +### peerId + +> **peerId**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/Peer.md b/versioned_docs/version-0.24.0/api/server/type-aliases/Peer.md new file mode 100644 index 00000000..0eb83a3a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/Peer.md @@ -0,0 +1,11 @@ +# Type Alias: Peer + +> **Peer** = `Omit`\<`OpenApiPeer`, `"id"`\> & `object` + +Defined in: [js-server-sdk/src/types.ts:20](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L20) + +## Type declaration + +### id + +> **id**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/PeerAdded.md b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerAdded.md new file mode 100644 index 00000000..3f743505 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerAdded.md @@ -0,0 +1,5 @@ +# Type Alias: PeerAdded + +> **PeerAdded** = `object`\[`"peerAdded"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:37](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L37) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/PeerConnected.md b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerConnected.md new file mode 100644 index 00000000..05dfa992 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerConnected.md @@ -0,0 +1,5 @@ +# Type Alias: PeerConnected + +> **PeerConnected** = `object`\[`"peerConnected"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:39](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L39) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/PeerCrashed.md b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerCrashed.md new file mode 100644 index 00000000..a1f467e3 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerCrashed.md @@ -0,0 +1,5 @@ +# Type Alias: PeerCrashed + +> **PeerCrashed** = `object`\[`"peerCrashed"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:42](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L42) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/PeerDeleted.md b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerDeleted.md new file mode 100644 index 00000000..e2d44890 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerDeleted.md @@ -0,0 +1,5 @@ +# Type Alias: PeerDeleted + +> **PeerDeleted** = `object`\[`"peerDeleted"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:38](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L38) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/PeerDisconnected.md b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerDisconnected.md new file mode 100644 index 00000000..aa4bc7ea --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerDisconnected.md @@ -0,0 +1,5 @@ +# Type Alias: PeerDisconnected + +> **PeerDisconnected** = `object`\[`"peerDisconnected"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:40](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L40) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/PeerId.md b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerId.md new file mode 100644 index 00000000..9f711b4b --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerId.md @@ -0,0 +1,7 @@ +# Type Alias: PeerId + +> **PeerId** = [`Brand`](Brand.md)\<`string`, `"PeerId"`\> + +Defined in: [js-server-sdk/src/types.ts:18](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L18) + +ID of Peer. Peer is associated with Room and can be created with [FishjamClient.createPeer](../classes/FishjamClient.md#createpeer). diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/PeerMetadataUpdated.md b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerMetadataUpdated.md new file mode 100644 index 00000000..ec1a7216 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerMetadataUpdated.md @@ -0,0 +1,5 @@ +# Type Alias: PeerMetadataUpdated + +> **PeerMetadataUpdated** = `object`\[`"peerMetadataUpdated"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:41](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L41) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/PeerOptions.md b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerOptions.md new file mode 100644 index 00000000..9c901fe6 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/PeerOptions.md @@ -0,0 +1,7 @@ +# Type Alias: PeerOptions + +> **PeerOptions** = [`PeerOptionsAgent`](../interfaces/PeerOptionsAgent.md) \| [`PeerOptionsWebRTC`](../interfaces/PeerOptionsWebRTC.md) + +Defined in: fishjam-openapi/dist/index.d.ts:291 + +## Export diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/Room.md b/versioned_docs/version-0.24.0/api/server/type-aliases/Room.md new file mode 100644 index 00000000..9e9216cd --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/Room.md @@ -0,0 +1,29 @@ +# Type Alias: Room + +> **Room** = `object` + +Defined in: [js-server-sdk/src/types.ts:22](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L22) + +## Properties + +### config + +> **config**: [`RoomConfig`](../interfaces/RoomConfig.md) + +Defined in: [js-server-sdk/src/types.ts:25](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L25) + +*** + +### id + +> **id**: [`RoomId`](RoomId.md) + +Defined in: [js-server-sdk/src/types.ts:23](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L23) + +*** + +### peers + +> **peers**: [`Peer`](Peer.md)[] + +Defined in: [js-server-sdk/src/types.ts:24](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L24) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/RoomCrashed.md b/versioned_docs/version-0.24.0/api/server/type-aliases/RoomCrashed.md new file mode 100644 index 00000000..d7dd9622 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/RoomCrashed.md @@ -0,0 +1,5 @@ +# Type Alias: RoomCrashed + +> **RoomCrashed** = `object`\[`"roomCrashed"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:36](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L36) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/RoomCreated.md b/versioned_docs/version-0.24.0/api/server/type-aliases/RoomCreated.md new file mode 100644 index 00000000..9f780a2c --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/RoomCreated.md @@ -0,0 +1,5 @@ +# Type Alias: RoomCreated + +> **RoomCreated** = `object`\[`"roomCreated"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:34](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L34) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/RoomDeleted.md b/versioned_docs/version-0.24.0/api/server/type-aliases/RoomDeleted.md new file mode 100644 index 00000000..c7756423 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/RoomDeleted.md @@ -0,0 +1,5 @@ +# Type Alias: RoomDeleted + +> **RoomDeleted** = `object`\[`"roomDeleted"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:35](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L35) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/RoomId.md b/versioned_docs/version-0.24.0/api/server/type-aliases/RoomId.md new file mode 100644 index 00000000..004e3932 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/RoomId.md @@ -0,0 +1,8 @@ +# Type Alias: RoomId + +> **RoomId** = [`Brand`](Brand.md)\<`string`, `"RoomId"`\> + +Defined in: [js-server-sdk/src/types.ts:14](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/types.ts#L14) + +ID of the Room. +Room can be created with [FishjamClient.createRoom](../classes/FishjamClient.md#createroom). diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/StreamConnected.md b/versioned_docs/version-0.24.0/api/server/type-aliases/StreamConnected.md new file mode 100644 index 00000000..8b65460a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/StreamConnected.md @@ -0,0 +1,5 @@ +# Type Alias: StreamConnected + +> **StreamConnected** = `object`\[`"streamConnected"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:43](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L43) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/StreamDisconnected.md b/versioned_docs/version-0.24.0/api/server/type-aliases/StreamDisconnected.md new file mode 100644 index 00000000..f40f7e78 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/StreamDisconnected.md @@ -0,0 +1,5 @@ +# Type Alias: StreamDisconnected + +> **StreamDisconnected** = `object`\[`"streamDisconnected"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:44](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L44) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/TrackAdded.md b/versioned_docs/version-0.24.0/api/server/type-aliases/TrackAdded.md new file mode 100644 index 00000000..97dad62a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/TrackAdded.md @@ -0,0 +1,5 @@ +# Type Alias: TrackAdded + +> **TrackAdded** = `object`\[`"trackAdded"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:47](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L47) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/TrackId.md b/versioned_docs/version-0.24.0/api/server/type-aliases/TrackId.md new file mode 100644 index 00000000..99e27dca --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/TrackId.md @@ -0,0 +1,5 @@ +# Type Alias: TrackId + +> **TrackId** = [`Brand`](Brand.md)\<`string`, `"TrackId"`\> + +Defined in: [js-server-sdk/src/agent.ts:34](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L34) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/TrackMetadataUpdated.md b/versioned_docs/version-0.24.0/api/server/type-aliases/TrackMetadataUpdated.md new file mode 100644 index 00000000..c6c27382 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/TrackMetadataUpdated.md @@ -0,0 +1,5 @@ +# Type Alias: TrackMetadataUpdated + +> **TrackMetadataUpdated** = `object`\[`"trackMetadataUpdated"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:49](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L49) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/TrackRemoved.md b/versioned_docs/version-0.24.0/api/server/type-aliases/TrackRemoved.md new file mode 100644 index 00000000..11ac4dcf --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/TrackRemoved.md @@ -0,0 +1,5 @@ +# Type Alias: TrackRemoved + +> **TrackRemoved** = `object`\[`"trackRemoved"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:48](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L48) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/TrackType.md b/versioned_docs/version-0.24.0/api/server/type-aliases/TrackType.md new file mode 100644 index 00000000..522b435d --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/TrackType.md @@ -0,0 +1,5 @@ +# Type Alias: TrackType + +> **TrackType** = `"audio"` \| `"video"` + +Defined in: [js-server-sdk/src/agent.ts:28](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/agent.ts#L28) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/ViewerConnected.md b/versioned_docs/version-0.24.0/api/server/type-aliases/ViewerConnected.md new file mode 100644 index 00000000..c84297ce --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/ViewerConnected.md @@ -0,0 +1,5 @@ +# Type Alias: ViewerConnected + +> **ViewerConnected** = `object`\[`"viewerConnected"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:45](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L45) diff --git a/versioned_docs/version-0.24.0/api/server/type-aliases/ViewerDisconnected.md b/versioned_docs/version-0.24.0/api/server/type-aliases/ViewerDisconnected.md new file mode 100644 index 00000000..0aaf768e --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/type-aliases/ViewerDisconnected.md @@ -0,0 +1,5 @@ +# Type Alias: ViewerDisconnected + +> **ViewerDisconnected** = `object`\[`"viewerDisconnected"`\] + +Defined in: [js-server-sdk/src/ws\_notifier.ts:46](https://github.com/fishjam-cloud/js-server-sdk/blob/22932e9e40d6685e876f3295d34a2dc463114ca8/packages/js-server-sdk/src/ws_notifier.ts#L46) diff --git a/versioned_docs/version-0.24.0/api/server/typedoc-sidebar.cjs b/versioned_docs/version-0.24.0/api/server/typedoc-sidebar.cjs new file mode 100644 index 00000000..3641eff5 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @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/PeerOptionsAgent",label:"PeerOptionsAgent"},{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/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/IncomingTrackData",label:"IncomingTrackData"},{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/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/StreamConnected",label:"StreamConnected"},{type:"doc",id:"api/server/type-aliases/StreamDisconnected",label:"StreamDisconnected"},{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.24.0/api/server/variables/ServerMessage.md b/versioned_docs/version-0.24.0/api/server/variables/ServerMessage.md new file mode 100644 index 00000000..e1bb44b2 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/server/variables/ServerMessage.md @@ -0,0 +1,5 @@ +# Variable: ServerMessage + +> **ServerMessage**: `MessageFns$1`\<[`ServerMessage`](../interfaces/ServerMessage.md)\> + +Defined in: fishjam-proto/dist/index.d.ts:63 diff --git a/versioned_docs/version-0.24.0/api/web/enumerations/Variant.md b/versioned_docs/version-0.24.0/api/web/enumerations/Variant.md new file mode 100644 index 00000000..aa1a7193 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/enumerations/Variant.md @@ -0,0 +1,43 @@ +# Enumeration: Variant + +Defined in: ts-client/dist/index.d.mts:17 + +## Enumeration Members + +### UNRECOGNIZED + +> **UNRECOGNIZED**: `-1` + +Defined in: ts-client/dist/index.d.mts:22 + +*** + +### VARIANT\_HIGH + +> **VARIANT\_HIGH**: `3` + +Defined in: ts-client/dist/index.d.mts:21 + +*** + +### VARIANT\_LOW + +> **VARIANT\_LOW**: `1` + +Defined in: ts-client/dist/index.d.mts:19 + +*** + +### VARIANT\_MEDIUM + +> **VARIANT\_MEDIUM**: `2` + +Defined in: ts-client/dist/index.d.mts:20 + +*** + +### VARIANT\_UNSPECIFIED + +> **VARIANT\_UNSPECIFIED**: `0` + +Defined in: ts-client/dist/index.d.mts:18 diff --git a/versioned_docs/version-0.24.0/api/web/functions/FishjamProvider.md b/versioned_docs/version-0.24.0/api/web/functions/FishjamProvider.md new file mode 100644 index 00000000..b3857428 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/FishjamProvider.md @@ -0,0 +1,17 @@ +# Function: FishjamProvider() + +> **FishjamProvider**(`props`): `Element` + +Defined in: [react-client/src/FishjamProvider.tsx:70](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/FishjamProvider.tsx#L70) + +Provides the Fishjam Context + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`FishjamProviderProps`](../interfaces/FishjamProviderProps.md) | + +## Returns + +`Element` diff --git a/versioned_docs/version-0.24.0/api/web/functions/useCamera.md b/versioned_docs/version-0.24.0/api/web/functions/useCamera.md new file mode 100644 index 00000000..7e01e8ce --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/useCamera.md @@ -0,0 +1,122 @@ +# Function: useCamera() + +> **useCamera**(): `object` + +Defined in: [react-client/src/hooks/devices/useCamera.ts:9](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/devices/useCamera.ts#L9) + +This hook can toggle camera on/off, change camera, provides current camera and other. + +## Returns + +### ~~activeCamera~~ + +> **activeCamera**: `null` \| [`DeviceItem`](../type-aliases/DeviceItem.md) = `cameraManager.activeDevice` + +#### Deprecated + +Use `currentCamera` and `isCameraOn` instead +Indicates which camera is now turned on and streaming + +### cameraDeviceError + +> **cameraDeviceError**: `null` \| [`DeviceError`](../type-aliases/DeviceError.md) = `cameraManager.deviceError` + +Possible error thrown while setting up the camera + +### cameraDevices + +> **cameraDevices**: [`DeviceItem`](../type-aliases/DeviceItem.md)[] = `cameraManager.deviceList` + +List of available camera devices + +### cameraStream + +> **cameraStream**: `null` \| `MediaStream` + +The MediaStream object containing the current stream + +### currentCamera + +> **currentCamera**: `null` \| `MediaDeviceInfo` = `cameraManager.selectedDevice` + +Indicates which camera is now selected + +### currentCameraMiddleware + +> **currentCameraMiddleware**: [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) = `videoTrackManager.currentMiddleware` + +The currently set camera middleware function + +### isCameraOn + +> **isCameraOn**: `boolean` = `!!cameraStream` + +Indicates whether the camera is streaming video + +### selectCamera() + +> **selectCamera**: (`deviceId`) => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> = `videoTrackManager.selectDevice` + +Selects the camera device + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceId` | `string` | + +#### Returns + +`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> + +### setCameraTrackMiddleware() + +> **setCameraTrackMiddleware**: (`middleware`) => `Promise`\<`void`\> = `videoTrackManager.setTrackMiddleware` + +Sets the camera middleware + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `middleware` | [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) | + +#### Returns + +`Promise`\<`void`\> + +### startCamera() + +> **startCamera**: (`deviceId?`) => `Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> = `videoTrackManager.startDevice` + +Starts the camera + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceId?` | `null` \| `string` | + +#### Returns + +`Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> + +### stopCamera() + +> **stopCamera**: () => `void` = `videoTrackManager.stopDevice` + +Stops the camera + +#### Returns + +`void` + +### toggleCamera() + +> **toggleCamera**: () => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> = `videoTrackManager.toggleDevice` + +Toggles current camera on/off + +#### Returns + +`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> diff --git a/versioned_docs/version-0.24.0/api/web/functions/useConnection.md b/versioned_docs/version-0.24.0/api/web/functions/useConnection.md new file mode 100644 index 00000000..e51c8f0d --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/useConnection.md @@ -0,0 +1,53 @@ +# Function: useConnection() + +> **useConnection**(): `object` + +Defined in: [react-client/src/hooks/useConnection.ts:26](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useConnection.ts#L26) + +Hook allows to join or leave a room and check the current connection status. + +## Returns + +### joinRoom() + +> **joinRoom**: \<`PeerMetadata`\>(`__namedParameters`) => `Promise`\<`void`\> + +Join room and start streaming camera and microphone + +#### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | [`JoinRoomConfig`](../interfaces/JoinRoomConfig.md)\<`PeerMetadata`\> | + +#### Returns + +`Promise`\<`void`\> + +### leaveRoom() + +> **leaveRoom**: () => `void` + +Leave room and stop streaming + +#### Returns + +`void` + +### peerStatus + +> **peerStatus**: [`PeerStatus`](../type-aliases/PeerStatus.md) + +Current peer connection status + +### reconnectionStatus + +> **reconnectionStatus**: [`ReconnectionStatus`](../type-aliases/ReconnectionStatus.md) + +Current reconnection status diff --git a/versioned_docs/version-0.24.0/api/web/functions/useCustomSource.md b/versioned_docs/version-0.24.0/api/web/functions/useCustomSource.md new file mode 100644 index 00000000..7f180677 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/useCustomSource.md @@ -0,0 +1,44 @@ +# Function: useCustomSource() + +> **useCustomSource**\<`T`\>(`sourceId`): `object` + +Defined in: [react-client/src/hooks/useCustomSource.ts:9](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useCustomSource.ts#L9) + +This hook can register/deregister a custom MediaStream with Fishjam. + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `string` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `sourceId` | `T` | + +## Returns + +### setStream() + +> **setStream**: (`newStream`) => `Promise`\<`void`\> + +Associates the given stream with the custom source. +This stream will be sent to Fishjam after startStreaming has been called. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `newStream` | `null` \| `MediaStream` | + +#### Returns + +`Promise`\<`void`\> + +### stream + +> **stream**: `undefined` \| `MediaStream` + +The MediaStream currently associated with the custom source diff --git a/versioned_docs/version-0.24.0/api/web/functions/useInitializeDevices.md b/versioned_docs/version-0.24.0/api/web/functions/useInitializeDevices.md new file mode 100644 index 00000000..8077e12e --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/useInitializeDevices.md @@ -0,0 +1,25 @@ +# Function: useInitializeDevices() + +> **useInitializeDevices**(): `object` + +Defined in: [react-client/src/hooks/devices/useInitializeDevices.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L14) + +Hook allows you to initialize access to the devices before joining the room. + +## Returns + +### initializeDevices() + +> **initializeDevices**: (`settings?`) => `Promise`\<[`InitializeDevicesResult`](../type-aliases/InitializeDevicesResult.md)\> + +Initialize access to the devices before joining the room + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `settings?` | [`InitializeDevicesSettings`](../type-aliases/InitializeDevicesSettings.md) | + +#### Returns + +`Promise`\<[`InitializeDevicesResult`](../type-aliases/InitializeDevicesResult.md)\> diff --git a/versioned_docs/version-0.24.0/api/web/functions/useLivestreamStreamer.md b/versioned_docs/version-0.24.0/api/web/functions/useLivestreamStreamer.md new file mode 100644 index 00000000..5e5c76be --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/useLivestreamStreamer.md @@ -0,0 +1,11 @@ +# Function: useLivestreamStreamer() + +> **useLivestreamStreamer**(): [`UseLivestreamStreamerResult`](../interfaces/UseLivestreamStreamerResult.md) + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:51](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamStreamer.ts#L51) + +Hook for publishing a livestream, which can be then received with [useLivestreamViewer](useLivestreamViewer.md) + +## Returns + +[`UseLivestreamStreamerResult`](../interfaces/UseLivestreamStreamerResult.md) diff --git a/versioned_docs/version-0.24.0/api/web/functions/useLivestreamViewer.md b/versioned_docs/version-0.24.0/api/web/functions/useLivestreamViewer.md new file mode 100644 index 00000000..fda417f6 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/useLivestreamViewer.md @@ -0,0 +1,11 @@ +# Function: useLivestreamViewer() + +> **useLivestreamViewer**(): [`UseLivestreamViewerResult`](../interfaces/UseLivestreamViewerResult.md) + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:41](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamViewer.ts#L41) + +Hook for receiving a published livestream. + +## Returns + +[`UseLivestreamViewerResult`](../interfaces/UseLivestreamViewerResult.md) diff --git a/versioned_docs/version-0.24.0/api/web/functions/useMicrophone.md b/versioned_docs/version-0.24.0/api/web/functions/useMicrophone.md new file mode 100644 index 00000000..0d431838 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/useMicrophone.md @@ -0,0 +1,138 @@ +# Function: useMicrophone() + +> **useMicrophone**(): `object` + +Defined in: [react-client/src/hooks/devices/useMicrophone.ts:9](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/devices/useMicrophone.ts#L9) + +Manage microphone + +## Returns + +### ~~activeMicrophone~~ + +> **activeMicrophone**: `null` \| [`DeviceItem`](../type-aliases/DeviceItem.md) = `microphoneManager.activeDevice` + +#### Deprecated + +Use `currentMicrophone` and `isMicrophoneOn` instead +Indicates which microphone is now turned on and streaming audio + +### currentMicrophone + +> **currentMicrophone**: `null` \| `MediaDeviceInfo` = `microphoneManager.selectedDevice` + +Indicates which microphone is now selected + +### currentMicrophoneMiddleware + +> **currentMicrophoneMiddleware**: [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) = `audioTrackManager.currentMiddleware` + +The currently set microphone middleware function + +### isMicrophoneMuted + +> **isMicrophoneMuted**: `boolean` = `!microphoneManager.deviceEnabled` + +Indicates whether the microphone is muted + +### isMicrophoneOn + +> **isMicrophoneOn**: `boolean` = `!!microphoneStream` + +Indicates whether the microphone is streaming audio + +### microphoneDeviceError + +> **microphoneDeviceError**: `null` \| [`DeviceError`](../type-aliases/DeviceError.md) = `microphoneManager.deviceError` + +Possible error thrown while setting up the microphone + +### microphoneDevices + +> **microphoneDevices**: [`DeviceItem`](../type-aliases/DeviceItem.md)[] = `microphoneManager.deviceList` + +List of available microphone devices + +### microphoneStream + +> **microphoneStream**: `null` \| `MediaStream` + +The MediaStream object containing the current audio stream + +### selectMicrophone() + +> **selectMicrophone**: (`deviceId`) => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> = `audioTrackManager.selectDevice` + +Selects the microphone device + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceId` | `string` | + +#### Returns + +`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> + +### setMicrophoneTrackMiddleware() + +> **setMicrophoneTrackMiddleware**: (`middleware`) => `Promise`\<`void`\> = `audioTrackManager.setTrackMiddleware` + +Sets the microphone middleware + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `middleware` | [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) | + +#### Returns + +`Promise`\<`void`\> + +### startMicrophone() + +> **startMicrophone**: (`deviceId?`) => `Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> = `audioTrackManager.startDevice` + +Starts the microphone + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceId?` | `null` \| `string` | + +#### Returns + +`Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> + +### stopMicrophone() + +> **stopMicrophone**: () => `void` = `audioTrackManager.stopDevice` + +Stops the microphone + +#### Returns + +`void` + +### toggleMicrophone() + +> **toggleMicrophone**: () => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> = `audioTrackManager.toggleDevice` + +Toggles current microphone on/off + +#### Returns + +`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> + +### toggleMicrophoneMute() + +> **toggleMicrophoneMute**: () => `Promise`\<`void`\> = `audioTrackManager.toggleMute` + +Mutes/unmutes the microphone + +#### Returns + +`Promise`\<`void`\> diff --git a/versioned_docs/version-0.24.0/api/web/functions/usePeers.md b/versioned_docs/version-0.24.0/api/web/functions/usePeers.md new file mode 100644 index 00000000..bf6c3864 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/usePeers.md @@ -0,0 +1,39 @@ +# Function: usePeers() + +> **usePeers**\<`PeerMetadata`, `ServerMetadata`\>(): `object` + +Defined in: [react-client/src/hooks/usePeers.ts:67](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/usePeers.ts#L67) + +Hook allows to access id, tracks and metadata of the local and remote peers. + +## Type Parameters + +| Type Parameter | Default type | Description | +| ------ | ------ | ------ | +| `PeerMetadata` | `Record`\<`string`, `unknown`\> | Type of metadata set by peer while connecting to a room. | +| `ServerMetadata` | `Record`\<`string`, `unknown`\> | Type of metadata set by the server while creating a peer. | + +## Returns + +### localPeer + +> **localPeer**: `null` \| [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\> + +The local peer with distinguished tracks (camera, microphone, screen share). +Will be null if the local peer is not found. + +### ~~peers~~ + +> **peers**: [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\>[] = `remotePeers` + +#### Deprecated + +Use remotePeers instead +Legacy array containing remote peers. +This property will be removed in future versions. + +### remotePeers + +> **remotePeers**: [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`\>[] + +Array of remote peers with distinguished tracks (camera, microphone, screen share). diff --git a/versioned_docs/version-0.24.0/api/web/functions/useSandbox.md b/versioned_docs/version-0.24.0/api/web/functions/useSandbox.md new file mode 100644 index 00000000..fcaa7ba6 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/useSandbox.md @@ -0,0 +1,60 @@ +# Function: useSandbox() + +> **useSandbox**(`props?`): `object` + +Defined in: [react-client/src/hooks/useSandbox.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/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.24.0/api/web/functions/useScreenShare.md b/versioned_docs/version-0.24.0/api/web/functions/useScreenShare.md new file mode 100644 index 00000000..63d2247a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/useScreenShare.md @@ -0,0 +1,81 @@ +# Function: useScreenShare() + +> **useScreenShare**(): `object` + +Defined in: [react-client/src/hooks/useScreenShare.ts:10](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useScreenShare.ts#L10) + +Hook to enable screen sharing within a room and manage the existing stream. + +## Returns + +### audioTrack + +> **audioTrack**: `null` \| `MediaStreamTrack` = `screenShareManager.audioTrack` + +The separate audio MediaStreamTrack. + +### currentTracksMiddleware + +> **currentTracksMiddleware**: `null` \| [`TracksMiddleware`](../type-aliases/TracksMiddleware.md) = `screenShareManager.currentTracksMiddleware` + +The middleware currently assigned to process the tracks. +A screenshare may include both audio and video tracks, and this middleware is capable of processing +each track type. + +### setTracksMiddleware() + +> **setTracksMiddleware**: (`middleware`) => `Promise`\<`void`\> = `screenShareManager.setTracksMiddleware` + +Sets the middleware responsible for processing the tracks. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `middleware` | `null` \| [`TracksMiddleware`](../type-aliases/TracksMiddleware.md) | The middleware to set, which can be a TracksMiddleware instance or null to remove the middleware. | + +#### Returns + +`Promise`\<`void`\> + +A Promise that resolves once the middleware is successfully set. + +### startStreaming() + +> **startStreaming**: (`props?`) => `Promise`\<`void`\> = `screenShareManager.startStreaming` + +Invokes the screen sharing prompt in the user's browser and starts streaming upon approval. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `props?` | \{ `audioConstraints?`: `boolean` \| `MediaTrackConstraints`; `videoConstraints?`: `boolean` \| `MediaTrackConstraints`; \} | +| `props.audioConstraints?` | `boolean` \| `MediaTrackConstraints` | +| `props.videoConstraints?` | `boolean` \| `MediaTrackConstraints` | + +#### Returns + +`Promise`\<`void`\> + +### stopStreaming() + +> **stopStreaming**: () => `Promise`\<`void`\> = `screenShareManager.stopStreaming` + +Stops the stream and cancels browser screen sharing. + +#### Returns + +`Promise`\<`void`\> + +### stream + +> **stream**: `null` \| `MediaStream` = `screenShareManager.stream` + +The MediaStream object containing both tracks. + +### videoTrack + +> **videoTrack**: `null` \| `MediaStreamTrack` = `screenShareManager.videoTrack` + +The separate video MediaStreamTrack. diff --git a/versioned_docs/version-0.24.0/api/web/functions/useUpdatePeerMetadata.md b/versioned_docs/version-0.24.0/api/web/functions/useUpdatePeerMetadata.md new file mode 100644 index 00000000..43878781 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/useUpdatePeerMetadata.md @@ -0,0 +1,31 @@ +# Function: useUpdatePeerMetadata() + +> **useUpdatePeerMetadata**\<`PeerMetadata`\>(): `object` + +Defined in: [react-client/src/hooks/useUpdatePeerMetadata.ts:12](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useUpdatePeerMetadata.ts#L12) + +Hook provides a method to update the metadata of the local peer. + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | + +## Returns + +### updatePeerMetadata() + +> **updatePeerMetadata**: (`peerMetadata`) => `void` + +Updates metadata visible to other peers + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `peerMetadata` | `PeerMetadata` | + +#### Returns + +`void` diff --git a/versioned_docs/version-0.24.0/api/web/functions/useVAD.md b/versioned_docs/version-0.24.0/api/web/functions/useVAD.md new file mode 100644 index 00000000..da0473df --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/functions/useVAD.md @@ -0,0 +1,31 @@ +# Function: useVAD() + +> **useVAD**(`peerIds`): `Record`\<[`PeerId`](../type-aliases/PeerId.md), `boolean`\> + +Defined in: [react-client/src/hooks/useVAD.ts:25](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useVAD.ts#L25) + +Voice activity detection. Use this hook to check if voice is detected in audio track for given peer(s). + +Example usage: +```tsx +import { useVAD, type PeerId } from "@fishjam-cloud/react-client"; +function WhoIsTalkingComponent({ peerIds }: { peerIds: PeerId[] }) { + const peersInfo = useVAD({peerIds}); + const activePeers = (Object.keys(peersInfo) as PeerId[]).filter((peerId) => peersInfo[peerId]); + + return `Now talking: ${activePeers.join(", ")}`; +} +``` + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `peerIds` | \{ `peerIds`: readonly [`PeerId`](../type-aliases/PeerId.md)[]; \} | List of ids of peers to subscribe to for voice activity detection notifications. | +| `peerIds.peerIds` | readonly [`PeerId`](../type-aliases/PeerId.md)[] | - | + +## Returns + +`Record`\<[`PeerId`](../type-aliases/PeerId.md), `boolean`\> + +Each key is a peerId and the boolean value indicates if voice activity is currently detected for that peer. diff --git a/versioned_docs/version-0.24.0/api/web/index.md b/versioned_docs/version-0.24.0/api/web/index.md new file mode 100644 index 00000000..01c4eb79 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/index.md @@ -0,0 +1,69 @@ +# @fishjam-cloud/react-client + +## Connection + +- [useConnection](functions/useConnection.md) +- [usePeers](functions/usePeers.md) +- [useUpdatePeerMetadata](functions/useUpdatePeerMetadata.md) +- [useVAD](functions/useVAD.md) +- [Metadata](type-aliases/Metadata.md) + +## Devices + +- [useCamera](functions/useCamera.md) +- [useInitializeDevices](functions/useInitializeDevices.md) +- [useMicrophone](functions/useMicrophone.md) +- [useScreenShare](functions/useScreenShare.md) + +## Components + +- [FishjamProvider](functions/FishjamProvider.md) +- [FishjamProviderProps](interfaces/FishjamProviderProps.md) + +## Livestream + +- [useLivestreamStreamer](functions/useLivestreamStreamer.md) +- [useLivestreamViewer](functions/useLivestreamViewer.md) +- [UseLivestreamStreamerResult](interfaces/UseLivestreamStreamerResult.md) +- [UseLivestreamViewerResult](interfaces/UseLivestreamViewerResult.md) +- [ConnectStreamerConfig](type-aliases/ConnectStreamerConfig.md) +- [StreamerInputs](type-aliases/StreamerInputs.md) + +## Other + +- [useCustomSource](functions/useCustomSource.md) +- [useSandbox](functions/useSandbox.md) +- [Variant](enumerations/Variant.md) +- [JoinRoomConfig](interfaces/JoinRoomConfig.md) +- [SimulcastConfig](interfaces/SimulcastConfig.md) +- [AuthErrorReason](type-aliases/AuthErrorReason.md) +- [BandwidthLimits](type-aliases/BandwidthLimits.md) +- [Brand](type-aliases/Brand.md) +- [ConnectViewerConfig](type-aliases/ConnectViewerConfig.md) +- [CustomSource](type-aliases/CustomSource.md) +- [DeviceError](type-aliases/DeviceError.md) +- [DeviceItem](type-aliases/DeviceItem.md) +- [InitializeDevicesResult](type-aliases/InitializeDevicesResult.md) +- [InitializeDevicesSettings](type-aliases/InitializeDevicesSettings.md) +- [InitializeDevicesStatus](type-aliases/InitializeDevicesStatus.md) +- [JoinErrorReason](type-aliases/JoinErrorReason.md) +- [MiddlewareResult](type-aliases/MiddlewareResult.md) +- [PeerId](type-aliases/PeerId.md) +- [PeerStatus](type-aliases/PeerStatus.md) +- [PeerWithTracks](type-aliases/PeerWithTracks.md) +- [PersistLastDeviceHandlers](type-aliases/PersistLastDeviceHandlers.md) +- [ReconnectConfig](type-aliases/ReconnectConfig.md) +- [ReconnectionStatus](type-aliases/ReconnectionStatus.md) +- [RoomType](type-aliases/RoomType.md) +- [SimulcastBandwidthLimit](type-aliases/SimulcastBandwidthLimit.md) +- [SimulcastBandwidthLimits](type-aliases/SimulcastBandwidthLimits.md) +- [StreamConfig](type-aliases/StreamConfig.md) +- [Track](type-aliases/Track.md) +- [TrackBandwidthLimit](type-aliases/TrackBandwidthLimit.md) +- [TrackId](type-aliases/TrackId.md) +- [TrackMiddleware](type-aliases/TrackMiddleware.md) +- [TracksMiddleware](type-aliases/TracksMiddleware.md) +- [TracksMiddlewareResult](type-aliases/TracksMiddlewareResult.md) +- [UseInitializeDevicesParams](type-aliases/UseInitializeDevicesParams.md) +- [UseSandboxProps](type-aliases/UseSandboxProps.md) +- [SimulcastConfig](variables/SimulcastConfig.md) diff --git a/versioned_docs/version-0.24.0/api/web/interfaces/FishjamProviderProps.md b/versioned_docs/version-0.24.0/api/web/interfaces/FishjamProviderProps.md new file mode 100644 index 00000000..522a1af4 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/interfaces/FishjamProviderProps.md @@ -0,0 +1,97 @@ +# Interface: FishjamProviderProps + +Defined in: [react-client/src/FishjamProvider.tsx:27](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/FishjamProvider.tsx#L27) + +## Extends + +- `PropsWithChildren` + +## Properties + +### audioConfig? + +> `optional` **audioConfig**: [`StreamConfig`](../type-aliases/StreamConfig.md) + +Defined in: [react-client/src/FishjamProvider.tsx:55](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/FishjamProvider.tsx#L55) + +Configure whether to use audio simulcast and which layers to send if so. + +*** + +### bandwidthLimits? + +> `optional` **bandwidthLimits**: `Partial`\<[`BandwidthLimits`](../type-aliases/BandwidthLimits.md)\> + +Defined in: [react-client/src/FishjamProvider.tsx:47](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/FishjamProvider.tsx#L47) + +Adjust max bandwidth limit for a single stream and simulcast. + +*** + +### constraints? + +> `optional` **constraints**: `Pick`\<`MediaStreamConstraints`, `"audio"` \| `"video"`\> + +Defined in: [react-client/src/FishjamProvider.tsx:38](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/FishjamProvider.tsx#L38) + +Set preferred constraints. + +#### Param + +The media stream constraints as defined by the Web API. + +#### See + +[MediaStreamConstraints](https://udn.realityripple.com/docs/Web/API/MediaStreamConstraints) + +*** + +### debug? + +> `optional` **debug**: `boolean` + +Defined in: [react-client/src/FishjamProvider.tsx:63](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/FishjamProvider.tsx#L63) + +Enables Fishjam SDK's debug logs in the console. + +*** + +### fishjamId + +> **fishjamId**: `string` + +Defined in: [react-client/src/FishjamProvider.tsx:59](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/FishjamProvider.tsx#L59) + +You can get you Fishjam ID at https://fishjam.io/app + +*** + +### persistLastDevice? + +> `optional` **persistLastDevice**: `boolean` \| [`PersistLastDeviceHandlers`](../type-aliases/PersistLastDeviceHandlers.md) + +Defined in: [react-client/src/FishjamProvider.tsx:43](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/FishjamProvider.tsx#L43) + +Decide if you want Fishjam SDK to persist last used device in the local storage. +You can also provide your getter and setter by using the [PersistLastDeviceHandlers](../type-aliases/PersistLastDeviceHandlers.md) interface. + +*** + +### reconnect? + +> `optional` **reconnect**: `boolean` \| [`ReconnectConfig`](../type-aliases/ReconnectConfig.md) + +Defined in: [react-client/src/FishjamProvider.tsx:32](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/FishjamProvider.tsx#L32) + +Use [ReconnectConfig](../type-aliases/ReconnectConfig.md) to adjust reconnection policy to your needs or set false it. +Set to true by default. + +*** + +### videoConfig? + +> `optional` **videoConfig**: [`StreamConfig`](../type-aliases/StreamConfig.md) + +Defined in: [react-client/src/FishjamProvider.tsx:51](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/FishjamProvider.tsx#L51) + +Configure whether to use video simulcast and which layers to send if so. diff --git a/versioned_docs/version-0.24.0/api/web/interfaces/JoinRoomConfig.md b/versioned_docs/version-0.24.0/api/web/interfaces/JoinRoomConfig.md new file mode 100644 index 00000000..3c33d7ea --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/interfaces/JoinRoomConfig.md @@ -0,0 +1,29 @@ +# Interface: JoinRoomConfig\ + +Defined in: [react-client/src/hooks/useConnection.ts:10](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useConnection.ts#L10) + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | + +## Properties + +### peerMetadata? + +> `optional` **peerMetadata**: `PeerMetadata` + +Defined in: [react-client/src/hooks/useConnection.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useConnection.ts#L18) + +String indexed record with metadata, that will be available to all other peers + +*** + +### peerToken + +> **peerToken**: `string` + +Defined in: [react-client/src/hooks/useConnection.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useConnection.ts#L14) + +Token received from server (or Room Manager) diff --git a/versioned_docs/version-0.24.0/api/web/interfaces/SimulcastConfig.md b/versioned_docs/version-0.24.0/api/web/interfaces/SimulcastConfig.md new file mode 100644 index 00000000..c493b1ea --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/interfaces/SimulcastConfig.md @@ -0,0 +1,27 @@ +# Interface: SimulcastConfig + +Defined in: ts-client/dist/index.d.mts:163 + +## Properties + +### disabledVariants + +> **disabledVariants**: [`Variant`](../enumerations/Variant.md)[] + +Defined in: ts-client/dist/index.d.mts:166 + +*** + +### enabled + +> **enabled**: `boolean` + +Defined in: ts-client/dist/index.d.mts:164 + +*** + +### enabledVariants + +> **enabledVariants**: [`Variant`](../enumerations/Variant.md)[] + +Defined in: ts-client/dist/index.d.mts:165 diff --git a/versioned_docs/version-0.24.0/api/web/interfaces/UseLivestreamStreamerResult.md b/versioned_docs/version-0.24.0/api/web/interfaces/UseLivestreamStreamerResult.md new file mode 100644 index 00000000..88de009a --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/interfaces/UseLivestreamStreamerResult.md @@ -0,0 +1,62 @@ +# Interface: UseLivestreamStreamerResult + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:27](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamStreamer.ts#L27) + +## Properties + +### connect() + +> **connect**: (`inputs`, `urlOverride?`) => `Promise`\<`void`\> + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:34](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamStreamer.ts#L34) + +Callback used to start publishing the selected audio and video media streams. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `inputs` | [`ConnectStreamerConfig`](../type-aliases/ConnectStreamerConfig.md) | +| `urlOverride?` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Remarks + +Calling [connect](#connect) multiple times will have the effect of only publishing the **last** specified inputs. + +*** + +### disconnect() + +> **disconnect**: () => `void` + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:36](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamStreamer.ts#L36) + +Callback to stop publishing anything previously published with [connect](#connect) + +#### Returns + +`void` + +*** + +### error + +> **error**: `null` \| `LivestreamError` + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:38](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamStreamer.ts#L38) + +Any errors encountered in [connect](#connect) will populate this field + +*** + +### isConnected + +> **isConnected**: `boolean` + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:40](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamStreamer.ts#L40) + +Utility flag which indicates the current connection status diff --git a/versioned_docs/version-0.24.0/api/web/interfaces/UseLivestreamViewerResult.md b/versioned_docs/version-0.24.0/api/web/interfaces/UseLivestreamViewerResult.md new file mode 100644 index 00000000..52c2fa67 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/interfaces/UseLivestreamViewerResult.md @@ -0,0 +1,70 @@ +# Interface: UseLivestreamViewerResult + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:11](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamViewer.ts#L11) + +## Properties + +### connect() + +> **connect**: (`config`, `url?`) => `Promise`\<`void`\> + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamViewer.ts#L19) + +Callback to start receiving a livestream. +If the livestream is private, provide `token`. +If the livestream is public, provide `streamId`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | [`ConnectViewerConfig`](../type-aliases/ConnectViewerConfig.md) | +| `url?` | `string` | + +#### Returns + +`Promise`\<`void`\> + +*** + +### disconnect() + +> **disconnect**: () => `void` + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamViewer.ts#L21) + +Callback used to disconnect from a stream previously connected to with [connect](#connect) + +#### Returns + +`void` + +*** + +### error + +> **error**: `null` \| `LivestreamError` + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamViewer.ts#L23) + +Any errors encountered in [connect](#connect) will be present in this field. + +*** + +### isConnected + +> **isConnected**: `boolean` + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:25](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamViewer.ts#L25) + +Utility flag which indicates the current connection status + +*** + +### stream + +> **stream**: `null` \| `MediaStream` + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:13](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamViewer.ts#L13) + +The received livestream media diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/AuthErrorReason.md b/versioned_docs/version-0.24.0/api/web/type-aliases/AuthErrorReason.md new file mode 100644 index 00000000..5ce791b0 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/AuthErrorReason.md @@ -0,0 +1,5 @@ +# Type Alias: AuthErrorReason + +> **AuthErrorReason** = *typeof* `AUTH_ERROR_REASONS`\[`number`\] + +Defined in: ts-client/dist/index.d.mts:5 diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/BandwidthLimits.md b/versioned_docs/version-0.24.0/api/web/type-aliases/BandwidthLimits.md new file mode 100644 index 00000000..61461419 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/BandwidthLimits.md @@ -0,0 +1,21 @@ +# Type Alias: BandwidthLimits + +> **BandwidthLimits** = `object` + +Defined in: [react-client/src/types/public.ts:61](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L61) + +## Properties + +### simulcast + +> **simulcast**: [`SimulcastBandwidthLimits`](SimulcastBandwidthLimits.md) + +Defined in: [react-client/src/types/public.ts:61](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L61) + +*** + +### singleStream + +> **singleStream**: `number` + +Defined in: [react-client/src/types/public.ts:61](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L61) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/Brand.md b/versioned_docs/version-0.24.0/api/web/type-aliases/Brand.md new file mode 100644 index 00000000..ae078827 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/Brand.md @@ -0,0 +1,18 @@ +# Type Alias: Brand\ + +> **Brand**\<`T`, `TBrand`\> = `T` & `object` + +Defined in: [react-client/src/types/public.ts:72](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L72) + +## Type declaration + +### \[brand\] + +> **\[brand\]**: `TBrand` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | +| `TBrand` *extends* `string` | diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/ConnectStreamerConfig.md b/versioned_docs/version-0.24.0/api/web/type-aliases/ConnectStreamerConfig.md new file mode 100644 index 00000000..d9d82e10 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/ConnectStreamerConfig.md @@ -0,0 +1,23 @@ +# Type Alias: ConnectStreamerConfig + +> **ConnectStreamerConfig** = `object` + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamStreamer.ts#L20) + +## Properties + +### inputs + +> **inputs**: [`StreamerInputs`](StreamerInputs.md) + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamStreamer.ts#L21) + +*** + +### token + +> **token**: `string` + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamStreamer.ts#L23) + +Streamer token used to authenticate with Fishjam diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/ConnectViewerConfig.md b/versioned_docs/version-0.24.0/api/web/type-aliases/ConnectViewerConfig.md new file mode 100644 index 00000000..f193bc59 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/ConnectViewerConfig.md @@ -0,0 +1,5 @@ +# Type Alias: ConnectViewerConfig + +> **ConnectViewerConfig** = \{ `streamId?`: `never`; `token`: `string`; \} \| \{ `streamId`: `string`; `token?`: `never`; \} + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:6](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamViewer.ts#L6) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/CustomSource.md b/versioned_docs/version-0.24.0/api/web/type-aliases/CustomSource.md new file mode 100644 index 00000000..34212bb8 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/CustomSource.md @@ -0,0 +1,40 @@ +# Type Alias: CustomSource\ + +> **CustomSource**\<`T`\> = `object` + +Defined in: [react-client/src/types/public.ts:74](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L74) + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `string` | + +## Properties + +### id + +> **id**: `T` + +Defined in: [react-client/src/types/public.ts:75](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L75) + +*** + +### stream? + +> `optional` **stream**: `MediaStream` + +Defined in: [react-client/src/types/public.ts:77](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L77) + +*** + +### trackIds? + +> `optional` **trackIds**: `object` + +Defined in: [react-client/src/types/public.ts:76](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L76) + +| Name | Type | +| ------ | ------ | +| `audioId?` | `string` | +| `videoId?` | `string` | diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/DeviceError.md b/versioned_docs/version-0.24.0/api/web/type-aliases/DeviceError.md new file mode 100644 index 00000000..3e7ddbdf --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/DeviceError.md @@ -0,0 +1,5 @@ +# Type Alias: DeviceError + +> **DeviceError** = \{ `name`: `"OverconstrainedError"`; \} \| \{ `name`: `"NotAllowedError"`; \} \| \{ `name`: `"NotFoundError"`; \} \| \{ `name`: `"UNHANDLED_ERROR"`; \} + +Defined in: [react-client/src/types/public.ts:65](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L65) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/DeviceItem.md b/versioned_docs/version-0.24.0/api/web/type-aliases/DeviceItem.md new file mode 100644 index 00000000..1f0621ee --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/DeviceItem.md @@ -0,0 +1,21 @@ +# Type Alias: DeviceItem + +> **DeviceItem** = `object` + +Defined in: [react-client/src/types/public.ts:46](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L46) + +## Properties + +### deviceId + +> **deviceId**: `string` + +Defined in: [react-client/src/types/public.ts:46](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L46) + +*** + +### label + +> **label**: `string` + +Defined in: [react-client/src/types/public.ts:46](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L46) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/InitializeDevicesResult.md b/versioned_docs/version-0.24.0/api/web/type-aliases/InitializeDevicesResult.md new file mode 100644 index 00000000..362f45f9 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/InitializeDevicesResult.md @@ -0,0 +1,29 @@ +# Type Alias: InitializeDevicesResult + +> **InitializeDevicesResult** = `object` + +Defined in: [react-client/src/types/public.ts:5](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L5) + +## Properties + +### errors + +> **errors**: \{ `audio`: [`DeviceError`](DeviceError.md) \| `null`; `video`: [`DeviceError`](DeviceError.md) \| `null`; \} \| `null` + +Defined in: [react-client/src/types/public.ts:8](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L8) + +*** + +### status + +> **status**: [`InitializeDevicesStatus`](InitializeDevicesStatus.md) + +Defined in: [react-client/src/types/public.ts:6](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L6) + +*** + +### stream + +> **stream**: `MediaStream` \| `null` + +Defined in: [react-client/src/types/public.ts:7](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L7) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/InitializeDevicesSettings.md b/versioned_docs/version-0.24.0/api/web/type-aliases/InitializeDevicesSettings.md new file mode 100644 index 00000000..2d669c0e --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/InitializeDevicesSettings.md @@ -0,0 +1,21 @@ +# Type Alias: InitializeDevicesSettings + +> **InitializeDevicesSettings** = `object` + +Defined in: [react-client/src/hooks/internal/devices/useMediaDevices.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/internal/devices/useMediaDevices.ts#L16) + +## Properties + +### enableAudio? + +> `optional` **enableAudio**: `boolean` + +Defined in: [react-client/src/hooks/internal/devices/useMediaDevices.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/internal/devices/useMediaDevices.ts#L16) + +*** + +### enableVideo? + +> `optional` **enableVideo**: `boolean` + +Defined in: [react-client/src/hooks/internal/devices/useMediaDevices.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/internal/devices/useMediaDevices.ts#L16) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/InitializeDevicesStatus.md b/versioned_docs/version-0.24.0/api/web/type-aliases/InitializeDevicesStatus.md new file mode 100644 index 00000000..3826029f --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/InitializeDevicesStatus.md @@ -0,0 +1,5 @@ +# Type Alias: InitializeDevicesStatus + +> **InitializeDevicesStatus** = `"initialized"` \| `"failed"` \| `"initialized_with_errors"` \| `"already_initialized"` + +Defined in: [react-client/src/types/public.ts:3](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L3) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/JoinErrorReason.md b/versioned_docs/version-0.24.0/api/web/type-aliases/JoinErrorReason.md new file mode 100644 index 00000000..53f1626b --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/JoinErrorReason.md @@ -0,0 +1,5 @@ +# Type Alias: JoinErrorReason + +> **JoinErrorReason** = *typeof* `JOIN_ERRORS`\[`number`\] + +Defined in: ts-client/dist/index.d.mts:789 diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/Metadata.md b/versioned_docs/version-0.24.0/api/web/type-aliases/Metadata.md new file mode 100644 index 00000000..9ea92247 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/Metadata.md @@ -0,0 +1,28 @@ +# Type Alias: Metadata\ + +> **Metadata**\<`PeerMetadata`, `ServerMetadata`\> = `object` + +Defined in: ts-client/dist/index.d.mts:812 + +## Type Parameters + +| Type Parameter | Default type | Description | +| ------ | ------ | ------ | +| `PeerMetadata` | `GenericMetadata` | Type of metadata set by peer while connecting to a room. | +| `ServerMetadata` | `GenericMetadata` | Type of metadata set by the server while creating a peer. | + +## Properties + +### peer + +> **peer**: `PeerMetadata` + +Defined in: ts-client/dist/index.d.mts:813 + +*** + +### server + +> **server**: `ServerMetadata` + +Defined in: ts-client/dist/index.d.mts:814 diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/MiddlewareResult.md b/versioned_docs/version-0.24.0/api/web/type-aliases/MiddlewareResult.md new file mode 100644 index 00000000..2f32d9ec --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/MiddlewareResult.md @@ -0,0 +1,25 @@ +# Type Alias: MiddlewareResult + +> **MiddlewareResult** = `object` + +Defined in: [react-client/src/types/public.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L23) + +## Properties + +### onClear()? + +> `optional` **onClear**: () => `void` + +Defined in: [react-client/src/types/public.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L23) + +#### Returns + +`void` + +*** + +### track + +> **track**: `MediaStreamTrack` + +Defined in: [react-client/src/types/public.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L23) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/PeerId.md b/versioned_docs/version-0.24.0/api/web/type-aliases/PeerId.md new file mode 100644 index 00000000..85957fd2 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/PeerId.md @@ -0,0 +1,5 @@ +# Type Alias: PeerId + +> **PeerId** = [`Brand`](Brand.md)\<`string`, `"PeerId"`\> + +Defined in: [react-client/src/types/public.ts:12](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L12) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/PeerStatus.md b/versioned_docs/version-0.24.0/api/web/type-aliases/PeerStatus.md new file mode 100644 index 00000000..838efa82 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/PeerStatus.md @@ -0,0 +1,12 @@ +# Type Alias: PeerStatus + +> **PeerStatus** = `"connecting"` \| `"connected"` \| `"error"` \| `"idle"` + +Defined in: [react-client/src/types/public.ts:44](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L44) + +Represents the possible statuses of a peer connection. + +- `idle` - Peer is not connected, either never connected or successfully disconnected. +- `connecting` - Peer is in the process of connecting. +- `connected` - Peer has successfully connected. +- `error` - There was an error in the connection process. diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/PeerWithTracks.md b/versioned_docs/version-0.24.0/api/web/type-aliases/PeerWithTracks.md new file mode 100644 index 00000000..d6c22918 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/PeerWithTracks.md @@ -0,0 +1,84 @@ +# Type Alias: PeerWithTracks\ + +> **PeerWithTracks**\<`PeerMetadata`, `ServerMetadata`\> = `object` + +Defined in: [react-client/src/hooks/usePeers.ts:13](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/usePeers.ts#L13) + +## Type Parameters + +| Type Parameter | Description | +| ------ | ------ | +| `PeerMetadata` | Type of metadata set by peer while connecting to a room. | +| `ServerMetadata` | Type of metadata set by the server while creating a peer. | + +## Properties + +### cameraTrack? + +> `optional` **cameraTrack**: [`Track`](Track.md) + +Defined in: [react-client/src/hooks/usePeers.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/usePeers.ts#L17) + +*** + +### customAudioTracks + +> **customAudioTracks**: [`Track`](Track.md)[] + +Defined in: [react-client/src/hooks/usePeers.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/usePeers.ts#L22) + +*** + +### customVideoTracks + +> **customVideoTracks**: [`Track`](Track.md)[] + +Defined in: [react-client/src/hooks/usePeers.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/usePeers.ts#L21) + +*** + +### id + +> **id**: [`PeerId`](PeerId.md) + +Defined in: [react-client/src/hooks/usePeers.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/usePeers.ts#L14) + +*** + +### metadata? + +> `optional` **metadata**: [`Metadata`](Metadata.md)\<`PeerMetadata`, `ServerMetadata`\> + +Defined in: [react-client/src/hooks/usePeers.ts:15](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/usePeers.ts#L15) + +*** + +### microphoneTrack? + +> `optional` **microphoneTrack**: [`Track`](Track.md) + +Defined in: [react-client/src/hooks/usePeers.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/usePeers.ts#L18) + +*** + +### screenShareAudioTrack? + +> `optional` **screenShareAudioTrack**: [`Track`](Track.md) + +Defined in: [react-client/src/hooks/usePeers.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/usePeers.ts#L20) + +*** + +### screenShareVideoTrack? + +> `optional` **screenShareVideoTrack**: [`Track`](Track.md) + +Defined in: [react-client/src/hooks/usePeers.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/usePeers.ts#L19) + +*** + +### tracks + +> **tracks**: [`Track`](Track.md)[] + +Defined in: [react-client/src/hooks/usePeers.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/usePeers.ts#L16) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/PersistLastDeviceHandlers.md b/versioned_docs/version-0.24.0/api/web/type-aliases/PersistLastDeviceHandlers.md new file mode 100644 index 00000000..0499aab2 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/PersistLastDeviceHandlers.md @@ -0,0 +1,42 @@ +# Type Alias: PersistLastDeviceHandlers + +> **PersistLastDeviceHandlers** = `object` + +Defined in: [react-client/src/types/public.ts:48](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L48) + +## Properties + +### getLastDevice() + +> **getLastDevice**: (`deviceType`) => `MediaDeviceInfo` \| `null` + +Defined in: [react-client/src/types/public.ts:49](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L49) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceType` | `"audio"` \| `"video"` | + +#### Returns + +`MediaDeviceInfo` \| `null` + +*** + +### saveLastDevice() + +> **saveLastDevice**: (`info`, `deviceType`) => `void` + +Defined in: [react-client/src/types/public.ts:50](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L50) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `info` | `MediaDeviceInfo` | +| `deviceType` | `"audio"` \| `"video"` | + +#### Returns + +`void` diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/ReconnectConfig.md b/versioned_docs/version-0.24.0/api/web/type-aliases/ReconnectConfig.md new file mode 100644 index 00000000..4421aaa1 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/ReconnectConfig.md @@ -0,0 +1,37 @@ +# Type Alias: ReconnectConfig + +> **ReconnectConfig** = `object` + +Defined in: ts-client/dist/index.d.mts:793 + +## Properties + +### addTracksOnReconnect? + +> `optional` **addTracksOnReconnect**: `boolean` + +Defined in: ts-client/dist/index.d.mts:797 + +*** + +### delay? + +> `optional` **delay**: `number` + +Defined in: ts-client/dist/index.d.mts:796 + +*** + +### initialDelay? + +> `optional` **initialDelay**: `number` + +Defined in: ts-client/dist/index.d.mts:795 + +*** + +### maxAttempts? + +> `optional` **maxAttempts**: `number` + +Defined in: ts-client/dist/index.d.mts:794 diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/ReconnectionStatus.md b/versioned_docs/version-0.24.0/api/web/type-aliases/ReconnectionStatus.md new file mode 100644 index 00000000..467b5bf1 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/ReconnectionStatus.md @@ -0,0 +1,5 @@ +# Type Alias: ReconnectionStatus + +> **ReconnectionStatus** = `"reconnecting"` \| `"idle"` \| `"error"` + +Defined in: ts-client/dist/index.d.mts:792 diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/RoomType.md b/versioned_docs/version-0.24.0/api/web/type-aliases/RoomType.md new file mode 100644 index 00000000..a11059f3 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/RoomType.md @@ -0,0 +1,5 @@ +# 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/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useSandbox.ts#L17) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/SimulcastBandwidthLimit.md b/versioned_docs/version-0.24.0/api/web/type-aliases/SimulcastBandwidthLimit.md new file mode 100644 index 00000000..129bfb4e --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/SimulcastBandwidthLimit.md @@ -0,0 +1,9 @@ +# Type Alias: SimulcastBandwidthLimit + +> **SimulcastBandwidthLimit** = `Map`\<[`Variant`](../enumerations/Variant.md), `BandwidthLimit`\> + +Defined in: ts-client/dist/index.d.mts:218 + +Type describing bandwidth limit for simulcast track. +It is a mapping (encoding => BandwidthLimit). +If encoding isn't present in this mapping, it will be assumed that this particular encoding shouldn't have any bandwidth limit diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/SimulcastBandwidthLimits.md b/versioned_docs/version-0.24.0/api/web/type-aliases/SimulcastBandwidthLimits.md new file mode 100644 index 00000000..b0816545 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/SimulcastBandwidthLimits.md @@ -0,0 +1,29 @@ +# Type Alias: SimulcastBandwidthLimits + +> **SimulcastBandwidthLimits** = `object` + +Defined in: [react-client/src/types/public.ts:53](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L53) + +## Properties + +### 1 + +> **1**: `number` + +Defined in: [react-client/src/types/public.ts:54](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L54) + +*** + +### 2 + +> **2**: `number` + +Defined in: [react-client/src/types/public.ts:55](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L55) + +*** + +### 3 + +> **3**: `number` + +Defined in: [react-client/src/types/public.ts:56](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L56) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/StreamConfig.md b/versioned_docs/version-0.24.0/api/web/type-aliases/StreamConfig.md new file mode 100644 index 00000000..250634aa --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/StreamConfig.md @@ -0,0 +1,13 @@ +# Type Alias: StreamConfig + +> **StreamConfig** = `object` + +Defined in: [react-client/src/types/public.ts:59](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L59) + +## Properties + +### simulcast? + +> `optional` **simulcast**: [`Variant`](../enumerations/Variant.md)[] \| `false` + +Defined in: [react-client/src/types/public.ts:59](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L59) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/StreamerInputs.md b/versioned_docs/version-0.24.0/api/web/type-aliases/StreamerInputs.md new file mode 100644 index 00000000..f9cf48ff --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/StreamerInputs.md @@ -0,0 +1,31 @@ +# Type Alias: StreamerInputs + +> **StreamerInputs** = \{ `audio?`: `MediaStream` \| `null`; `video`: `MediaStream`; \} \| \{ `audio`: `MediaStream`; `video?`: `null`; \} + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:7](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useLivestreamStreamer.ts#L7) + +## Type declaration + +\{ `audio?`: `MediaStream` \| `null`; `video`: `MediaStream`; \} + +### audio? + +> `optional` **audio**: `MediaStream` \| `null` + +The audio source to publish. e.g. `microphoneStream` from [useMicrophone](../functions/useMicrophone.md) or `stream` from [useScreenShare](../functions/useScreenShare.md) + +### video + +> **video**: `MediaStream` + +The video source to publish. e.g. `cameraStream` from [useCamera](../functions/useCamera.md) or `stream` from [useScreenShare](../functions/useScreenShare.md) + +\{ `audio`: `MediaStream`; `video?`: `null`; \} + +### audio + +> **audio**: `MediaStream` + +### video? + +> `optional` **video**: `null` diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/Track.md b/versioned_docs/version-0.24.0/api/web/type-aliases/Track.md new file mode 100644 index 00000000..58b5e351 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/Track.md @@ -0,0 +1,53 @@ +# Type Alias: Track + +> **Track** = `object` + +Defined in: [react-client/src/types/public.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L14) + +## Properties + +### encoding + +> **encoding**: [`Variant`](../enumerations/Variant.md) \| `null` + +Defined in: [react-client/src/types/public.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L16) + +*** + +### metadata? + +> `optional` **metadata**: `TrackMetadata` + +Defined in: [react-client/src/types/public.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L18) + +*** + +### simulcastConfig + +> **simulcastConfig**: [`SimulcastConfig`](../interfaces/SimulcastConfig.md) \| `null` + +Defined in: [react-client/src/types/public.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L19) + +*** + +### stream + +> **stream**: `MediaStream` \| `null` + +Defined in: [react-client/src/types/public.ts:15](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L15) + +*** + +### track + +> **track**: `MediaStreamTrack` \| `null` + +Defined in: [react-client/src/types/public.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L20) + +*** + +### trackId + +> **trackId**: [`TrackId`](TrackId.md) + +Defined in: [react-client/src/types/public.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L17) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/TrackBandwidthLimit.md b/versioned_docs/version-0.24.0/api/web/type-aliases/TrackBandwidthLimit.md new file mode 100644 index 00000000..0fd6cb61 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/TrackBandwidthLimit.md @@ -0,0 +1,8 @@ +# Type Alias: TrackBandwidthLimit + +> **TrackBandwidthLimit** = `BandwidthLimit` \| [`SimulcastBandwidthLimit`](SimulcastBandwidthLimit.md) + +Defined in: ts-client/dist/index.d.mts:223 + +Type describing bandwidth limitation of a Track, including simulcast and non-simulcast tracks. +A sum type of `BandwidthLimit` and `SimulcastBandwidthLimit` diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/TrackId.md b/versioned_docs/version-0.24.0/api/web/type-aliases/TrackId.md new file mode 100644 index 00000000..f285bdcc --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/TrackId.md @@ -0,0 +1,5 @@ +# Type Alias: TrackId + +> **TrackId** = [`Brand`](Brand.md)\<`string`, `"TrackId"`\> + +Defined in: [react-client/src/types/public.ts:11](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L11) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/TrackMiddleware.md b/versioned_docs/version-0.24.0/api/web/type-aliases/TrackMiddleware.md new file mode 100644 index 00000000..7c8b4128 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/TrackMiddleware.md @@ -0,0 +1,5 @@ +# Type Alias: TrackMiddleware + +> **TrackMiddleware** = (`track`) => [`MiddlewareResult`](MiddlewareResult.md) \| `Promise`\<[`MiddlewareResult`](MiddlewareResult.md)\> \| `null` + +Defined in: [react-client/src/types/public.ts:24](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L24) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/TracksMiddleware.md b/versioned_docs/version-0.24.0/api/web/type-aliases/TracksMiddleware.md new file mode 100644 index 00000000..5fb7f142 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/TracksMiddleware.md @@ -0,0 +1,16 @@ +# Type Alias: TracksMiddleware() + +> **TracksMiddleware** = (`videoTrack`, `audioTrack`) => [`TracksMiddlewareResult`](TracksMiddlewareResult.md) \| `Promise`\<[`TracksMiddlewareResult`](TracksMiddlewareResult.md)\> + +Defined in: [react-client/src/types/public.ts:31](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L31) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `videoTrack` | `MediaStreamTrack` | +| `audioTrack` | `MediaStreamTrack` \| `null` | + +## Returns + +[`TracksMiddlewareResult`](TracksMiddlewareResult.md) \| `Promise`\<[`TracksMiddlewareResult`](TracksMiddlewareResult.md)\> diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/TracksMiddlewareResult.md b/versioned_docs/version-0.24.0/api/web/type-aliases/TracksMiddlewareResult.md new file mode 100644 index 00000000..871c8617 --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/TracksMiddlewareResult.md @@ -0,0 +1,33 @@ +# Type Alias: TracksMiddlewareResult + +> **TracksMiddlewareResult** = `object` + +Defined in: [react-client/src/types/public.ts:26](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L26) + +## Properties + +### audioTrack + +> **audioTrack**: `MediaStreamTrack` \| `null` + +Defined in: [react-client/src/types/public.ts:28](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L28) + +*** + +### onClear() + +> **onClear**: () => `void` + +Defined in: [react-client/src/types/public.ts:29](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L29) + +#### Returns + +`void` + +*** + +### videoTrack + +> **videoTrack**: `MediaStreamTrack` + +Defined in: [react-client/src/types/public.ts:27](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/types/public.ts#L27) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/UseInitializeDevicesParams.md b/versioned_docs/version-0.24.0/api/web/type-aliases/UseInitializeDevicesParams.md new file mode 100644 index 00000000..112b22ce --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/UseInitializeDevicesParams.md @@ -0,0 +1,21 @@ +# Type Alias: UseInitializeDevicesParams + +> **UseInitializeDevicesParams** = `object` + +Defined in: [react-client/src/hooks/devices/useInitializeDevices.ts:5](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L5) + +## Properties + +### enableAudio? + +> `optional` **enableAudio**: `boolean` + +Defined in: [react-client/src/hooks/devices/useInitializeDevices.ts:7](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L7) + +*** + +### enableVideo? + +> `optional` **enableVideo**: `boolean` + +Defined in: [react-client/src/hooks/devices/useInitializeDevices.ts:6](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L6) diff --git a/versioned_docs/version-0.24.0/api/web/type-aliases/UseSandboxProps.md b/versioned_docs/version-0.24.0/api/web/type-aliases/UseSandboxProps.md new file mode 100644 index 00000000..b866451c --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/type-aliases/UseSandboxProps.md @@ -0,0 +1,17 @@ +# Type Alias: UseSandboxProps + +> **UseSandboxProps** = `object` + +Defined in: [react-client/src/hooks/useSandbox.ts:12](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useSandbox.ts#L12) + +## Properties + +### configOverride? + +> `optional` **configOverride**: `object` + +Defined in: [react-client/src/hooks/useSandbox.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/a1e4bfe8ef582d1924accb8053fa0de389380124/packages/react-client/src/hooks/useSandbox.ts#L14) + +| Name | Type | +| ------ | ------ | +| `sandboxApiUrl?` | `string` | diff --git a/versioned_docs/version-0.24.0/api/web/typedoc-sidebar.cjs b/versioned_docs/version-0.24.0/api/web/typedoc-sidebar.cjs new file mode 100644 index 00000000..3f4a788e --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ +const typedocSidebar = {items:[{type:"category",label:"Connection",items:[{type:"doc",id:"api/web/functions/useConnection",label:"useConnection"},{type:"doc",id:"api/web/functions/usePeers",label:"usePeers"},{type:"doc",id:"api/web/functions/useUpdatePeerMetadata",label:"useUpdatePeerMetadata"},{type:"doc",id:"api/web/functions/useVAD",label:"useVAD"},{type:"doc",id:"api/web/type-aliases/Metadata",label:"Metadata"}]},{type:"category",label:"Devices",items:[{type:"doc",id:"api/web/functions/useCamera",label:"useCamera"},{type:"doc",id:"api/web/functions/useInitializeDevices",label:"useInitializeDevices"},{type:"doc",id:"api/web/functions/useMicrophone",label:"useMicrophone"},{type:"doc",id:"api/web/functions/useScreenShare",label:"useScreenShare"}]},{type:"category",label:"Components",items:[{type:"doc",id:"api/web/functions/FishjamProvider",label:"FishjamProvider"},{type:"doc",id:"api/web/interfaces/FishjamProviderProps",label:"FishjamProviderProps"}]},{type:"category",label:"Livestream",items:[{type:"doc",id:"api/web/functions/useLivestreamStreamer",label:"useLivestreamStreamer"},{type:"doc",id:"api/web/functions/useLivestreamViewer",label:"useLivestreamViewer"},{type:"doc",id:"api/web/interfaces/UseLivestreamStreamerResult",label:"UseLivestreamStreamerResult"},{type:"doc",id:"api/web/interfaces/UseLivestreamViewerResult",label:"UseLivestreamViewerResult"},{type:"doc",id:"api/web/type-aliases/ConnectStreamerConfig",label:"ConnectStreamerConfig"},{type:"doc",id:"api/web/type-aliases/StreamerInputs",label:"StreamerInputs"}]},{type:"category",label:"Other",items:[{type:"doc",id:"api/web/functions/useCustomSource",label:"useCustomSource"},{type:"doc",id:"api/web/functions/useSandbox",label:"useSandbox"},{type:"doc",id:"api/web/enumerations/Variant",label:"Variant"},{type:"doc",id:"api/web/interfaces/JoinRoomConfig",label:"JoinRoomConfig"},{type:"doc",id:"api/web/interfaces/SimulcastConfig",label:"SimulcastConfig"},{type:"doc",id:"api/web/type-aliases/AuthErrorReason",label:"AuthErrorReason"},{type:"doc",id:"api/web/type-aliases/BandwidthLimits",label:"BandwidthLimits"},{type:"doc",id:"api/web/type-aliases/Brand",label:"Brand"},{type:"doc",id:"api/web/type-aliases/ConnectViewerConfig",label:"ConnectViewerConfig"},{type:"doc",id:"api/web/type-aliases/CustomSource",label:"CustomSource"},{type:"doc",id:"api/web/type-aliases/DeviceError",label:"DeviceError"},{type:"doc",id:"api/web/type-aliases/DeviceItem",label:"DeviceItem"},{type:"doc",id:"api/web/type-aliases/InitializeDevicesResult",label:"InitializeDevicesResult"},{type:"doc",id:"api/web/type-aliases/InitializeDevicesSettings",label:"InitializeDevicesSettings"},{type:"doc",id:"api/web/type-aliases/InitializeDevicesStatus",label:"InitializeDevicesStatus"},{type:"doc",id:"api/web/type-aliases/JoinErrorReason",label:"JoinErrorReason"},{type:"doc",id:"api/web/type-aliases/MiddlewareResult",label:"MiddlewareResult"},{type:"doc",id:"api/web/type-aliases/PeerId",label:"PeerId"},{type:"doc",id:"api/web/type-aliases/PeerStatus",label:"PeerStatus"},{type:"doc",id:"api/web/type-aliases/PeerWithTracks",label:"PeerWithTracks"},{type:"doc",id:"api/web/type-aliases/PersistLastDeviceHandlers",label:"PersistLastDeviceHandlers"},{type:"doc",id:"api/web/type-aliases/ReconnectConfig",label:"ReconnectConfig"},{type:"doc",id:"api/web/type-aliases/ReconnectionStatus",label:"ReconnectionStatus"},{type:"doc",id:"api/web/type-aliases/RoomType",label:"RoomType"},{type:"doc",id:"api/web/type-aliases/SimulcastBandwidthLimit",label:"SimulcastBandwidthLimit"},{type:"doc",id:"api/web/type-aliases/SimulcastBandwidthLimits",label:"SimulcastBandwidthLimits"},{type:"doc",id:"api/web/type-aliases/StreamConfig",label:"StreamConfig"},{type:"doc",id:"api/web/type-aliases/Track",label:"Track"},{type:"doc",id:"api/web/type-aliases/TrackBandwidthLimit",label:"TrackBandwidthLimit"},{type:"doc",id:"api/web/type-aliases/TrackId",label:"TrackId"},{type:"doc",id:"api/web/type-aliases/TrackMiddleware",label:"TrackMiddleware"},{type:"doc",id:"api/web/type-aliases/TracksMiddleware",label:"TracksMiddleware"},{type:"doc",id:"api/web/type-aliases/TracksMiddlewareResult",label:"TracksMiddlewareResult"},{type:"doc",id:"api/web/type-aliases/UseInitializeDevicesParams",label:"UseInitializeDevicesParams"},{type:"doc",id:"api/web/type-aliases/UseSandboxProps",label:"UseSandboxProps"},{type:"doc",id:"api/web/variables/SimulcastConfig",label:"SimulcastConfig"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/versioned_docs/version-0.24.0/api/web/variables/SimulcastConfig.md b/versioned_docs/version-0.24.0/api/web/variables/SimulcastConfig.md new file mode 100644 index 00000000..319d0b8f --- /dev/null +++ b/versioned_docs/version-0.24.0/api/web/variables/SimulcastConfig.md @@ -0,0 +1,5 @@ +# Variable: SimulcastConfig + +> **SimulcastConfig**: `MessageFns`\<[`SimulcastConfig`](../interfaces/SimulcastConfig.md)\> + +Defined in: ts-client/dist/index.d.mts:163 diff --git a/versioned_docs/version-0.24.0/explanation/_category_.json b/versioned_docs/version-0.24.0/explanation/_category_.json new file mode 100644 index 00000000..d34d9b78 --- /dev/null +++ b/versioned_docs/version-0.24.0/explanation/_category_.json @@ -0,0 +1,11 @@ +{ + "label": "Explanation", + "position": 4, + "link": { + "type": "generated-index", + "title": "Explanation", + "description": "Big-picture explanations of higher-level Fishjam concepts. Most useful for building understanding of a particular topic.", + "slug": "/explanation" + }, + "collapsible": false +} diff --git a/versioned_docs/version-0.24.0/explanation/agent-internals.mdx b/versioned_docs/version-0.24.0/explanation/agent-internals.mdx new file mode 100644 index 00000000..6c6bd3ae --- /dev/null +++ b/versioned_docs/version-0.24.0/explanation/agent-internals.mdx @@ -0,0 +1,106 @@ +--- +type: explanation +title: Agent Internals +sidebar_position: 5 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import AgentDefinition from "../_common/agents/definition.mdx"; +import RememberToDisconnect from "../_common/agents/remember-to-disconnect.mdx"; +import Subscriptions from "../_common/agents/subscriptions.mdx"; + +# Agent Internals + +:::info +This explanation focuses on the inner workings of Fishjam Agents. +If you are looking for a tutorial that shows how to implement an agent, then you may find the [Agent Introduction](../tutorials/agents) more useful. +::: + + + +## Agent lifecycle + +There are four steps to the lifecycle of a Fishjam Agent: + +1. The agent is created in the room `roomId`. + Fishjam generates a token that the agent will use to connect to the room. +2. The agent connects to the room `roomId` via a WebSocket connection. +3. The agent receives audio from **subscribed** peers in the room `roomId`. + Subscriptions are explained in the [Peer subscriptions](#peer-subscriptions) section. +4. The agent disconnects from the room `roomId` by closing the WebSocket connection. + +We describe the steps of an agent's lifecycle in detail below. + +:::tip +The Fishjam [server SDKs](../tutorials/agents#writing-an-agent) provide a simple way to integrate with the APIs described below. +::: + +### Step 1. Creating an Agent in Fishjam + +Agents are created via the `/room/{roomId}/peer` [REST API](../api/reference#rest-api) endpoint, by setting the `type` option to `"agent"`. +An example request with [cURL](https://curl.se/) would look like: + +```bash +# [!code word:{"type"\: "agent"}] +curl -XPOST -H "Authorization: Bearer $FISHJAM_MANAGEMENT_TOKEN" \ +"https://fishjam.io/api/v1/room/$ROOM_ID/peer" \ +--json '{"type": "agent"}' +``` + +### Step 2. Connecting to the Room + +Agents connect to Fishjam by initiating a WebSocket connection on the `/socket/agent/websocket` REST API endpoint. +All communication over the WebSocket between Agent the Fishjam is done using [Protobuf messages](https://protobuf.dev/). +Check [Fishjam Protobuf reference](../api/reference#protobufs) for more info. +Once connected, the agent must authenticate with Fishjam by sending an [`AgentRequest.AuthRequest` protobuf message](../api/reference#protobufs). +An example of initiating a connection using [websocat](https://github.com/vi/websocat) and [Buf CLI](https://buf.build/docs/cli/) would look like: + +```bash +# Get the Fishjam protobuf definitions +git clone https://github.com/fishjam-cloud/protos.git + +echo "{\"authRequest\": {\"token\": \"$AGENT_TOKEN\"}}" \ +| buf convert protos/fishjam/agent_notifications.proto \ + --type="fishjam.AgentRequest" --from="-#format=json" \ +| websocat -vbn wss://fishjam.io/api/v1/connect/$FISHJAM_ID/socket/agent/websocket +``` + +In a backend application, we suggest using the [Protobuf compiler](https://protobuf.dev/installation/) to generate utilities for creating protobuf message from code. + +### Step 3. Receiving Audio + +Once connected, an agent will receive chunks of audio as [`AgentRequest.TrackData` protobuf message](../api/reference#protobufs). + +### Step 4. Sending Audio + +All further steps are done via the WebSocket connection created in [Step 2](#step-2-connecting-to-the-room). + +To send audio to an agent, you need to create an audio track first. +This is done by sending an [`AgentRequest.CreateTrack` protobuf message](../api/reference#protobufs). +Once the track is created, you can send audio to it using [`AgentRequest.TrackData` protobuf message](../api/reference#protobufs). + +### Step 5. Disconnecting from the Room + +An agent disconnects from the room by closing the WebSocket connection created in [Step 2](#step-2-connecting-to-the-room). +It may reconnect using the same token it provided in [Step 2](#step-2-connecting-to-the-room). + + + +## Peer subscriptions + + + +The subscribe option contains parameters describing the desired output format of the peer's audio stream. +This output format will be sent to connected agents. + +### Output format + +Currently, only **16-bit PCM** (raw) audio output is supported. + +### Output sample rate + +The output can have either a sample rate of **16kHz** or **24kHz**. + +The above values aim to be compatible with popular real-time AI audio APIs. +If you require a different output format, then make sure to contact us at `contact@fishjam.io`. diff --git a/versioned_docs/version-0.24.0/explanation/architecture.mdx b/versioned_docs/version-0.24.0/explanation/architecture.mdx new file mode 100644 index 00000000..7acb9338 --- /dev/null +++ b/versioned_docs/version-0.24.0/explanation/architecture.mdx @@ -0,0 +1,91 @@ +--- +type: explanation +sidebar_position: 2 +--- + +# Fishjam Architecture + +_Understanding how Fishjam works under the hood_ + +This document explains the technical architecture of Fishjam and how data flows through the system. + +## High-level Architecture + +Streaming with Fishjam is simple: you create a room, add peers to it, and start streaming. Below is a high-level overview of how Fishjam works. + +![Fishjam Data Flow](@site/static/img/architecture.svg) + +## Components Overview + +### 1. Your Backend Server + +Your application's backend server is responsible for: + +- Authenticating users +- Creating rooms using Fishjam Server SDKs +- Generating peer tokens for clients +- Managing room lifecycle and permissions + +### 2. Fishjam Media Server + +The Fishjam Media Server is the core infrastructure component that: + +- Routes audio and video streams between participants +- Handles WebRTC negotiations and connections +- Manages different room types (conference, audio-only, livestream) +- Processes and transcodes media when needed +- Enforces security policies and token validation + +### 3. Client Applications + +Client applications (React Native, React) use Fishjam Client SDKs to: + +- Connect to rooms using peer tokens +- Send and receive audio/video streams +- Handle device management (cameras, microphones) +- Manage connection state and reconnections + +## Data Flow + +### 1. Room Creation Flow + +```mermaid +sequenceDiagram + participant FM as Fishjam Media Server + participant BE as Your Backend + participant Client as Client App + + Client->>BE: Request to join room + BE->>FM: Create room (Server SDK) + FM->>BE: Return room ID + BE->>FM: Create peer (Server SDK) + FM->>BE: Return peer token + BE->>Client: Send peer token + Fishjam ID +``` + +### 2. Media Streaming Flow + +```mermaid +sequenceDiagram + participant C1 as Client 1 + participant FM as Fishjam Media Server + participant C2 as Client 2 + + C1->>FM: Connect with peer token + C2->>FM: Connect with peer token + C1->>FM: Send video/audio stream + FM->>C2: Route stream to other peers + C2->>FM: Send video/audio stream + FM->>C1: Route stream to other peers +``` + +## Next Steps + +To understand different room types in detail, see [Room Types Explained](../explanation/room-types). + +To learn about security and token management, see [Security & Token Model](../explanation/security-tokens). + +Ready to implement? Start with our tutorials: + +- [React Native Quick Start](../tutorials/react-native-quick-start) +- [Backend Quick Start](../tutorials/backend-quick-start) diff --git a/versioned_docs/version-0.24.0/explanation/glossary.md b/versioned_docs/version-0.24.0/explanation/glossary.md new file mode 100644 index 00000000..73539dc5 --- /dev/null +++ b/versioned_docs/version-0.24.0/explanation/glossary.md @@ -0,0 +1,39 @@ +--- +type: reference +--- + +# Glossary + +A brief walk-through of the terms we use in the documentation. + +### Room + +A collection of peers that can send and receive video/audio to and from other peers. + +### Peer + +A user that is connected to a room. Each peer has some associated metadata and tracks. + +### Agent + +A program connected to a room using the Fishjam server SDK; a programmatic peer. + +### Track + +A single stream of video or audio from a peer. It could be a camera view, shared screen, or microphone audio. Each peer can stream multiple tracks. + +### Management Token + +A secret token that should be stored on your backend. It allows you to create rooms and add peers. + +### Peer Token + +A token that your backend should pass to end clients to allow access to a specific room. + +### Fishjam ID + +The ID of your Fishjam instance. It is used by your backend server to add peers to rooms (and create rooms). It is also used by end client apps to join rooms. + +### Sandbox API + +A simple testing API allowing you to test Fishjam features without requiring you to add any functionalities to your backend. As the name suggests, it's available **only** in the Sandbox environment. You can find more details [here](/how-to/features/sandbox-api-testing). diff --git a/versioned_docs/version-0.24.0/explanation/public-livestreams.mdx b/versioned_docs/version-0.24.0/explanation/public-livestreams.mdx new file mode 100644 index 00000000..bb990e11 --- /dev/null +++ b/versioned_docs/version-0.24.0/explanation/public-livestreams.mdx @@ -0,0 +1,224 @@ +--- +type: explanation +title: Private vs Public Livestreams +sidebar_position: 6 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Private vs Public Livestreams + +:::info +This explanation only applies to Fishjam rooms with type `livestream`. +::: + +When livestreaming with Fishjam, you can chose to make your livestream `private` or `public`. +By default, created livestreams are `private`, to prevent possible bugs. + + + + + ```ts + const fishjamId = ''; + const managementToken = ''; + + // ---cut--- + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamClient = new FishjamClient({ + fishjamId, + managementToken, + }); + + const privateRoom = await fishjamClient.createRoom({ roomType: 'livestream' }); // [!code highlight] + const publicRoom = await fishjamClient.createRoom({ roomType: 'livestream', public: true }); // [!code highlight] + ``` + + + + + + ```python + from fishjam import FishjamClient + + fishjam_client = FishjamClient( + fishjam_id=fishjam_id, + management_token=management_token, + ); + + private_room = fishjam_client.create_room(room_type="livestream") # [!code highlight] + public_room = fishjam_client.create_room(room_type="livestream", public=True) # [!code highlight] + ``` + + + + +The choice you make affects how **viewers** connect to the livestream and has no effect on streamers. + +## Private livestreams + +When you create a private livestream, viewers are required to provide a viewer token when connecting to the livestream. + +This aims to provide control over who can view a livestream, but requires you to distribute tokens from your backend application to your frontend applications. + +### Creating a viewer token + +Below we show how you would create a livestream viewer token in a production scenario, with your own backend. +Note that for development purposes, you can [use the Sandbox API to generate a viewer token](../tutorials/livestreaming#obtaining-a-token-1). + + + + + ```ts + const fishjamId = ''; + const managementToken = ''; + + // ---cut--- + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamClient = new FishjamClient({ + fishjamId, + managementToken, + }); + + + const privateRoom = await fishjamClient.createRoom({ roomType: 'livestream' }); + const { token: viewerToken } = await fishjamClient.createLivestreamViewerToken(privateRoom.id); // [!code highlight] + ``` + + + + + + ```python + from fishjam import FishjamClient + + fishjam_client = FishjamClient( + fishjam_id=fishjam_id, + management_token=management_token, + ); + + private_room = fishjam_client.create_room(room_type="livestream") + viewer_token = fishjam_client.create_livestream_viewer_token(private_room.id) # [!code highlight] + ``` + + + + +### Connecting to a private room + +Once you've created a viewer token, you can connect to a room using the Fishjam client SDKs (examples below), or alternatively you can use [WHEP](../how-to/features/whip-whep#private-livestreams). + + + + + ```tsx + const viewerToken = ''; + + // ---cut--- + import { useLivestreamViewer } from '@fishjam-cloud/react-client'; + + // ... + + const { connect, stream } = useLivestreamViewer(); + + // ... + + await connect({ token: viewerToken }); + // after connecting stream will be available + ``` + + + + + + ```tsx + import React from 'react'; + + const viewerToken = ''; + + // ---cut--- + import { + LivestreamViewer, + useLivestreamViewer, + } from '@fishjam-cloud/react-native-client/livestream'; + + // ... + + const { connect, whepClientRef } = useLivestreamViewer(); + + // ... + + await connect({ token: viewerToken }); + + // Use `LivestreamViewer` to render the stream + + ``` + + + + +## Public livestreams + +Public livestreams simplify the viewing process by omitting the viewer token. +All a viewer needs to view a public livestream is the ID of the room, so your backend doesn't need to manage the creation and distribution of viewer tokens. + +Note however, that public livestreams are _not suitable for all use-cases_. + +For example, if you are developing an app, which includes exclusive live content that requires a subscription to view, then you will want to authorize viewers before allowing them to view a livestream. +Failing to do so may result in extra costs, as livestreams are billed per-viewer. +Such an application will benefit from the token-based authorization in [private livestreams](#private-livestreams). + +### Connecting to a public room + +Once you've created a room of type `livestream` with the `public` flag enabled, you may start connecting viewers to the stream via the Fishjam client SDKs or [WHEP](../how-to/features/whip-whep#public-livestreams). + + + + + ```tsx + const roomId = ''; + + // ---cut--- + import { useLivestreamViewer } from '@fishjam-cloud/react-client'; + + // ... + + const { connect, stream } = useLivestreamViewer(); + + // ... + + await connect({ streamId: roomId }); + // after connecting `stream` will be available + ``` + + + + + + ```tsx + import React from 'react'; + + const roomId = ''; + + // ---cut--- + import { + LivestreamViewer, + useLivestreamViewer, + } from '@fishjam-cloud/react-native-client/livestream'; + + // ... + + const { connect, whepClientRef } = useLivestreamViewer(); + + // ... + + await connect({ streamId: roomId }); + + // Use `LivestreamViewer` to render the stream + + ``` + + + diff --git a/versioned_docs/version-0.24.0/explanation/room-types.mdx b/versioned_docs/version-0.24.0/explanation/room-types.mdx new file mode 100644 index 00000000..2257dd72 --- /dev/null +++ b/versioned_docs/version-0.24.0/explanation/room-types.mdx @@ -0,0 +1,130 @@ +--- +type: explanation +sidebar_position: 3 +--- + +# Room Types Explained + +_Understanding different types of rooms and when to use them_ + +Fishjam provides three distinct room types, each optimized for different use cases and scenarios. +Understanding these room types helps you choose the right approach for your application. + +## Conference Rooms (Default) + +### What are Conference Rooms? + +Conference rooms are the default room type designed for multi-participant video conferencing scenarios. They support all Fishjam features and provide the most flexibility. + +### Key Characteristics + +- **Multi-participant**: Support for many participants simultaneously +- **Bidirectional media**: All participants can send and receive video/audio +- **Multiple sources**: Participants can share their camera, screen, microphone and more all at once +- **Flexible track management**: Participants can add/remove tracks dynamically + +### Best Use Cases + +- **Video conferencing applications** +- **Interactive webinars** with participant engagement + +### Cost Considerations + +Conference rooms are priced based on total connection time of all peers. + +## Audio-only Rooms + +### What are Audio-only Rooms? + +Audio-only rooms are optimized specifically for voice communication, removing video capabilities to improve performance and reduce costs. + +### Key Characteristics + +- **Voice-only communication**: No video tracks allowed +- **Cheap pricing**: Audio only rooms cost much less than other room types +- **Optimized network usage**: Works well in degraded network conditions + +### Best Use Cases + +- **Audio chat applications** +- **Podcast recording** with multiple participants +- **Large-scale audio events** (town halls, announcements) + +### Cost Benefits + +Audio-only rooms come at a **75% discount** compared to conference rooms: + +- 2 peers for 30 minutes = 60 minutes total time in conference room +- Same scenario in audio-only room = 15 minutes equivalent cost + +### Video Behavior in Audio-only Rooms + +If you attempt to add video to an audio-only room: + +- Video tracks are ignored (not transmitted) +- SDKs log warnings to help with debugging +- Only audio from screen sharing is transmitted +- No errors thrown, graceful degradation + +## Livestream Rooms + +### What are Livestream Rooms? + +Livestream rooms are designed for one-to-many livestreaming scenarios where a single streamer streams to multiple viewers. + +### Key Characteristics + +- **One sender**: Only one streamer can send media +- **Many receivers**: Unlimited viewers can watch +- **Optimized for scale**: Efficient distribution architecture + +### Livestreaming Limitations + +- **Single video track**: Only one video stream allowed +- **Single audio track**: Only one audio stream allowed +- **Additional tracks ignored**: Extra tracks are not forwarded to viewers + +### Viewer Experience + +- **Configurable access**: Livestreams can either be public, where anyone with the stream's ID can join, or private, where every viewer needs a token +- **Standard compatibility**: Any [WHEP](https://blog.swmansion.com/building-interactive-streaming-apps-webrtc-whip-whep-explained-d38f4825ec90)-compatible player works + +### Best Use Cases + +- **Live events** +- **Streaming platforms** and content distribution +- **Corporate livestreams** and announcements +- **Sports and entertainment** streaming + +### Cost Benefits + +Livestream rooms are **20% cheaper** than conference rooms for equivalent usage. + +## Choosing the Right Room Type + +### Decision Matrix + +| Use Case | Room Type | Why | +| ---------------------- | ---------- | ------------------------------------------- | +| Classic video meetings | Conference | Multiple video sources | +| Voice-only meetings | Audio-only | Cheapest and most performant option | +| Live Podcasts | Audio-only | Cheapest and most performant option | +| Sport streaming | Livestream | Highly scalable and cheaper than conference | +| Interactive workshop | Conference | Multiple video sources | + +## Next Steps + +To understand how to use each room type: + +- [How to implement livestreaming](../tutorials/livestreaming) +- [How to create audio-only calls](../how-to/features/audio-only-calls) + +To learn about the underlying architecture: + +- [Fishjam Architecture](../explanation/architecture) +- [Security & Token Model](../explanation/security-tokens) + +Ready to start building? Check our tutorials: + +- [React Native Quick Start](../tutorials/react-native-quick-start) +- [Backend Quick Start](../tutorials/backend-quick-start) diff --git a/versioned_docs/version-0.24.0/explanation/sandbox-api-concept.mdx b/versioned_docs/version-0.24.0/explanation/sandbox-api-concept.mdx new file mode 100644 index 00000000..6595b42f --- /dev/null +++ b/versioned_docs/version-0.24.0/explanation/sandbox-api-concept.mdx @@ -0,0 +1,78 @@ +--- +type: explanation +sidebar_position: 1 +--- + +# What is the Sandbox API? + +The Sandbox API is a development tool that simplifies getting started with Fishjam by providing a simple backend for testing, eliminating the need to build your own server initially. + +## What can the Sandbox API do? + +The Sandbox API is an HTTP server that comes with Fishjam's Sandbox environment. +It provides basic room creation and peer management functionality without requiring you to set up your own backend infrastructure. + +### Key Characteristics + +- **Development-purposed**: Designed for initial development and testing +- **No authentication**: Simplified access for quick prototyping +- **Sandbox-only**: Only available in the Sandbox environment + +## The Problem Sandbox API Solves + +When starting with videoconferencing or livestreaming development, you typically need: + +1. A **Backend server** to create rooms +2. An **Authentication system** to manage users +3. **Token management** for secure peer access +4. **API endpoints** for your frontend to call + +This creates a problem: to test your frontend, you need a backend, but during prototyping you want to focus on frontend development first. +The Sandbox API mitigates this issue and allows you to start frontend development ASAP. + +## Relationship to Server SDKs + +The Sandbox API is essentially a simplified application built using the Fishjam Server SDKs: + +```typescript +import { FishjamClient, RoomType } from "@fishjam-cloud/js-server-sdk"; +import express from "express"; +const fishjamId = ""; +const managementToken = ""; +const app = express(); + +// ---cut--- +// What Sandbox API does internally (simplified) +const fishjamClient = new FishjamClient({ fishjamId, managementToken }); + +app.get("/", async (req: express.Request, res: express.Response) => { + const { roomName, peerName, roomType } = req.query; + + // Create or get room + const room = await fishjamClient.createRoom({ + roomType: roomType as RoomType, + }); + + // Create or get peer + const { peer, peerToken } = await fishjamClient.createPeer(room.id); + + res.json({ peerToken }); +}); +``` + +This shows you exactly what your production backend needs to do, just with proper authentication and error handling. + +## See also + +To understand how to use The Sandbox API for development: + +- [How to use The Sandbox API for testing](../how-to/features/sandbox-api-testing) + +To learn about building your own backend: + +- [Backend Quick Start Tutorial](../tutorials/backend-quick-start) +- [How to set up your server](../how-to/backend/server-setup) + +To understand the security model: + +- [Security & Token Model](../explanation/security-tokens) diff --git a/versioned_docs/version-0.24.0/explanation/security-tokens.mdx b/versioned_docs/version-0.24.0/explanation/security-tokens.mdx new file mode 100644 index 00000000..27aaf541 --- /dev/null +++ b/versioned_docs/version-0.24.0/explanation/security-tokens.mdx @@ -0,0 +1,117 @@ +--- +type: explanation +sidebar_position: 4 +--- + +# Security & Token Model + +_Understanding Fishjam's security architecture and token system_ + +Fishjam uses a token-based security model to ensure secure access control while keeping the developer experience simple. + +## Security Architecture Overview + +Fishjam's security is built on a **two-tier token system**: + +1. **Management Tokens**: For backend-to-Fishjam server communication +2. **Peer Tokens**: For client-to-Fishjam server communication + +This separation ensures that sensitive operations remain on your backend while allowing clients secure, limited access to media streaming. + +## Management Tokens + +### Purpose + +Management tokens provide your backend server with administrative access to Fishjam resources. They allow creating, managing, and deleting rooms and peers. + +### Characteristics + +- **Long-lived**: Management tokens remain valid until manually regenerated +- **High privilege**: Management tokens allow performing administrative operations and should only be used in backend applications. +- **Backend-only**: Management tokens should never be sent to client applications. +- **Environment-specific**: There are different tokens for sandbox and production. + +### What Management Tokens Can Do + +Management tokens give permission to: + +- Create and manage rooms and peers +- Setup [webhooks](../how-to/backend/server-setup#webhooks) +- Set [immutable peer metadata](../how-to/backend/server-setup#metadata) + +## Peer Tokens + +### Purpose + +Peer tokens provide client applications with limited, time-bound access to join a specific room as a specific peer. + +### Characteristics + +- **Short-lived**: Peer tokens expire 24h after creation. +- **Scope-limited**: Peer tokens give access to one specific room as one specific peer only. +- **Client-safe**: Peer tokens are safe to send to frontend applications. + +### What Peer Tokens Can Do + +Peer tokens give permission to: + +- Connect to the specific room they were issued for +- Participate in room activities (audio/video/screen sharing) +- Access peer metadata and room state + +### What Peer Tokens Cannot Do + +- Create or delete rooms +- Access multiple rooms +- Add or remove peers + +### Generation Process + +```typescript +import { FishjamClient, RoomId } from "@fishjam-cloud/js-server-sdk"; +import express from "express"; +const res = {} as any; +const managementToken = ""; +const fishjamId = ""; +const roomId = "" as unknown as RoomId; +const fishjamClient = new FishjamClient({ fishjamId, managementToken }); + +// ---cut--- +// Backend generates peer token (using management token) +const { peer, peerToken } = await fishjamClient.createPeer(roomId, { + metadata: { name: "John Doe", userId: "user-123" }, +}); + +// Backend sends peer token to client +res.json({ + peerToken, // Client uses this to connect + roomId, // Room information +}); +``` + +### Client Usage + +```typescript +import { useConnection } from "@fishjam-cloud/react-client"; +const joinRoom = {} as any; +const peerToken = ""; + +// ---cut--- +// Client uses peer token to connect (safe to use in frontend) +await joinRoom({ peerToken }); // This is safe in client code +``` + +## Next Steps + +To implement secure authentication: + +- [Backend Quick Start Tutorial](../tutorials/backend-quick-start) +- [How to set up your server](../how-to/backend/server-setup) + +To understand the broader architecture: + +- [Fishjam Architecture](../explanation/architecture) + +To learn about the Sandbox API's security limitations: + +- [Understanding the Sandbox API](../explanation/sandbox-api-concept) diff --git a/versioned_docs/version-0.24.0/explanation/what-is-fishjam.mdx b/versioned_docs/version-0.24.0/explanation/what-is-fishjam.mdx new file mode 100644 index 00000000..a2e80309 --- /dev/null +++ b/versioned_docs/version-0.24.0/explanation/what-is-fishjam.mdx @@ -0,0 +1,67 @@ +--- +type: explanation +sidebar_position: 0 +--- + +# What is Fishjam? + +_Understanding the role and purpose of Fishjam_ + +Fishjam is a multimedia streaming toolkit that allows you to build real-time video and audio streaming applications. +It uses [WebRTC](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API) under the hood to ensure sub-second (in most cases **less than 300ms**) latency. +We provide the infrastructure, media server, and client SDKs so you can focus on building your apps. + +**No WebRTC knowledge is required!** + +## The Problem Fishjam Solves + +Building real-time video and audio applications is complex. Developers typically need to: + +- Set up and manage WebRTC infrastructure +- Handle complex peer-to-peer networking +- Manage media servers and scaling +- Deal with different devices and codec compatibility +- Implement secure token-based authentication + +Fishjam abstracts away this complexity, providing a simple API and managed infrastructure. + +## What Fishjam Provides + +Fishjam consists of several components that work together to provide a seamless multimedia streaming experience: + +| Component | Description | +| --------------------- | ------------------------------------------------------------------------------------------------------- | +| Developer panel | The place to access your credentials and manage your Fishjam usage. | +| Fishjam Media Servers | Media servers route your multimedia traffic. We host and manage them for you. | +| Fishjam Client SDKs | Toolkit used for multimedia integration on endpoint devices. | +| Fishjam Server SDKs | Toolkit for integrating your backend with Fishjam. We currently support Python and NodeJS. | +| Sandbox API | Simple backend for creating test rooms. You can test Fishjam without having to set up your own backend. | + +## Use Cases + +Fishjam is ideal for: + +### Video Conferencing + +Build videoconferencing applications with multiple participants in rooms, screen sharing, and audio/video. + +### Livestreaming + +Stream live content from one streamer to many viewers with low latency. +Perfect for live events or streaming platforms. + +### Audio-only Applications + +Create voice-only experiences like audio conferencing, podcasts, or voice chat applications. + +## Next Steps + +To understand how Fishjam works technically, see [Fishjam Architecture](../explanation/architecture). + +To learn about the different types of rooms available, see [Room Types Explained](../explanation/room-types). + +Ready to start building? Check out our tutorials: + +- [React Native Quick Start](../tutorials/react-native-quick-start) +- [React Quick Start](../tutorials/react-quick-start) +- [Backend Quick Start](../tutorials/backend-quick-start) diff --git a/versioned_docs/version-0.24.0/how-to/_category_.json b/versioned_docs/version-0.24.0/how-to/_category_.json new file mode 100644 index 00000000..a932906d --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/_category_.json @@ -0,0 +1,11 @@ +{ + "label": "How-to Guides", + "position": 3, + "link": { + "type": "generated-index", + "title": "How-to Guides", + "description": "Practical step-by-step guides to help you achieve a specific goal. Most useful when you're trying to get something done.", + "slug": "/how-to" + }, + "collapsible": false +} diff --git a/versioned_docs/version-0.24.0/how-to/_common/metadata/header.mdx b/versioned_docs/version-0.24.0/how-to/_common/metadata/header.mdx new file mode 100644 index 00000000..aafb60c4 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/_common/metadata/header.mdx @@ -0,0 +1,10 @@ +Alongside audio and video, it is possible to send additional metadata with each peer. Metadata is just +JSON that can contain arbitrary information. Its most common use is sending a user name associated with a peer. +However, it can be also used to send the peer's camera type, application information etc. + +:::info + +You can also set metadata on [the server side, when adding user to the room](../../../how-to/backend/server-setup#metadata). This metadata is persistent throughout its lifetime and is useful for attaching information that +can't be overwritten by the peer, like information about real user names or basic permission info. + +::: diff --git a/versioned_docs/version-0.24.0/how-to/_common/metadata/joining_room.mdx b/versioned_docs/version-0.24.0/how-to/_common/metadata/joining_room.mdx new file mode 100644 index 00000000..517a5b30 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/_common/metadata/joining_room.mdx @@ -0,0 +1,5 @@ +## Setting metadata when joining the room + +The `joinRoom` method from the `useConnection` hook has a `peerMetadata` parameter, that can be used for setting object metadata. + +{props.children} diff --git a/versioned_docs/version-0.24.0/how-to/_common/metadata/reading.mdx b/versioned_docs/version-0.24.0/how-to/_common/metadata/reading.mdx new file mode 100644 index 00000000..b0516650 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/_common/metadata/reading.mdx @@ -0,0 +1,9 @@ +## Reading metadata + +Peer metadata is available as the `metadata` property for each peer. Therefore, when you list your peers with the `usePeers` hook, you can read +the metadata associated with them. +Note that the `metadata.peer` property contains only the metadata set by the client SDK (as in the examples examples above). +The metadata set on the server side is available as `metadata.server`. +Learn more about server metadata [here](../backend/server-setup#metadata). + +{props.children} diff --git a/versioned_docs/version-0.24.0/how-to/_common/metadata/updating.mdx b/versioned_docs/version-0.24.0/how-to/_common/metadata/updating.mdx new file mode 100644 index 00000000..97bd1a1b --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/_common/metadata/updating.mdx @@ -0,0 +1,5 @@ +## Updating metadata during connection + +Once you've joined the room, you can update your peer metadata with the `updatePeerMetadata` method of the `useUpdatePeerMetadata` hook: + +{props.children} diff --git a/versioned_docs/version-0.24.0/how-to/backend/_category_.json b/versioned_docs/version-0.24.0/how-to/backend/_category_.json new file mode 100644 index 00000000..2d5af2e1 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/backend/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Backend", + "position": 4 +} diff --git a/versioned_docs/version-0.24.0/how-to/backend/fastapi-example.mdx b/versioned_docs/version-0.24.0/how-to/backend/fastapi-example.mdx new file mode 100644 index 00000000..3564cc26 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/backend/fastapi-example.mdx @@ -0,0 +1,99 @@ +--- +sidebar_position: 1 +title: FastAPI +--- + +# FastAPI example + +The example assumes you've already installed [**our SDK**](https://github.com/fishjam-cloud/python-server-sdk) and you're ready to go. +If you wish to see more general info, visit [**Set up your server**](../../how-to/backend/server-setup) article. + +## Minimal setup + +The same way as in the [**FastAPI docs**](https://fastapi.tiangolo.com/tutorial/first-steps/), the code below can be copied and run immediately. +Just make sure you set `FISHJAM_ID` and `FISHJAM_MANAGEMENT_TOKEN` environment variables. +The `Depends` function allows the `FishjamClient` to be provided to the route function as a dependency, which avoids code duplication and allows easy mocking. + +```python +import os +from typing import Annotated +from fastapi import Depends, FastAPI +from fishjam import FishjamClient + + +app = FastAPI() + +def fishjam_client(): + fishjam_id = os.environ["FISHJAM_ID"] + management_token = os.environ["FISHJAM_MANAGEMENT_TOKEN"] + return FishjamClient(fishjam_id=fishjam_id, management_token=management_token) + + +@app.get("/") +async def get_rooms(fishjam_client: Annotated[FishjamClient, Depends(fishjam_client)]): + rooms = fishjam_client.get_all_rooms() + return {"rooms": rooms} +``` + +## Listening to events + +Fishjam instance is a stateful server that is emitting messages upon certain events. +You can listen for those messages and react as you prefer. +There are two options for obtaining these. + +### Webhooks + +To receive and parse Fishjam protobuf messages, create a dependable function that parses the request body using the `receive_binary` function from the `fishjam` package. +Then, you will be able to use pattern matching to respond to different kinds of events. + +```python +from fastapi import Depends, FastAPI, HTTPException, Request +from fishjam import receive_binary +from fishjam.events import ServerMessagePeerAdded + +app = FastAPI() + +async def parse_fishjam_message(request: Request): + binary = await request.body() + if message := receive_binary(binary): + return message + raise HTTPException(status_code=400, detail="Invalid Fishjam message") + +@app.post("/fishjam-webhook") +async def fishjam_webhook(fishjam_message = Depends(parse_fishjam_message)): + match fishjam_message: + case ServerMessagePeerAdded(): + print(f"Peer added: {fishjam_message.peer_id}") + case _: + ... +``` + +### SDK Notifier + +Use the `asyncio` library to run the SDK notifier. +It doesn't interact with the FastAPI library per se, just start the event loop and it will run alongside the server. + +```python +import asyncio +from fishjam import FishjamNotifier + +notifier = FishjamNotifier(server_address=fishjam_id, server_api_token=management_token) + +@notifier.on_server_notification +def handle_notification(notification): + match notification: + case ServerMessagePeerAdded(): + print(f"Peer added: {notification.peer_id}") + case _: + ... + +async def run_notifier(): + notifier_task = asyncio.create_task(notifier.connect()) + + # Wait for the notifier to be ready to receive messages + await notifier.wait_ready() + + await notifier_task + +asyncio.run(run_notifier()) +``` diff --git a/versioned_docs/version-0.24.0/how-to/backend/fastify-example.mdx b/versioned_docs/version-0.24.0/how-to/backend/fastify-example.mdx new file mode 100644 index 00000000..2fd837c4 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/backend/fastify-example.mdx @@ -0,0 +1,239 @@ +--- +sidebar_position: 0 +title: Fastify +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Fastify example + +The example assumes you've already installed [**our SDK**](https://www.npmjs.com/package/@fishjam-cloud/js-server-sdk) and you're ready to go. +If you wish to see more general info, visit [**set up your server**](../../how-to/backend/server-setup) article. + +## Load environment variables to Fastify + +Use [`@fastify/env` package](https://github.com/fastify/fastify-env) to load and set environment variables in your Fastify instance. + +```ts title='main.ts' +import Fastify from "fastify"; +import fastifyEnv from "@fastify/env"; + +const fastify = Fastify(); + +const envSchema = { + type: "object", + required: ["FISHJAM_ID", "FISHJAM_MANAGEMENT_TOKEN"], + properties: { + FISHJAM_ID: { + type: "string", + }, + FISHJAM_MANAGEMENT_TOKEN: { + type: "string", + }, + }, +}; + +await fastify.register(fastifyEnv, { schema: envSchema }); + +fastify.listen({ port: 3000 }); +``` + +## Setup Fishjam Fastify plugin + +Fastify allows you to create plugins to encapsulate functionality in scopes. +Check out [fastify documentation](https://fastify.dev/docs/latest/Reference/Plugins) for a deeper understanding of the concept. + +First, extend the `FastifyInstance` interface with `fishjam` entry. +This will provide types of FishjamClient wherever you access `fastify.fishjam` in the codebase. +Then, declare the plugin by invoking the `fp` function with the setup function with as an argument. + +```ts title='fishjamPlugin.ts' +import fastifyPlugin from "fastify-plugin"; +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; + +declare module "fastify" { + interface FastifyInstance { + fishjam: FishjamClient; + config: { + FISHJAM_ID: string; + FISHJAM_MANAGEMENT_TOKEN: string; + }; + } +} + +export const fishjamPlugin = fastifyPlugin((fastify) => { + const fishjamClient = new FishjamClient({ + fishjamId: fastify.config.FISHJAM_ID, + managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN, + }); + + fastify.decorate("fishjam", fishjamClient); +}); +``` + +Now, after registering the plugin, we will be able to use Fishjam client by accessing the `fastify.fishjam` property. + +```ts title='main.ts' +import fastifyPlugin from "fastify-plugin"; +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; +import Fastify from "fastify"; + +declare module "fastify" { + interface FastifyInstance { + fishjam: FishjamClient; + config: { + FISHJAM_ID: string; + FISHJAM_MANAGEMENT_TOKEN: string; + }; + } +} + +export const fishjamPlugin = fastifyPlugin((fastify) => { + const fishjamClient = new FishjamClient({ + fishjamId: fastify.config.FISHJAM_ID, + managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN, + }); + + fastify.decorate("fishjam", fishjamClient); +}); + +const fastify = Fastify(); + +// ---cut--- +await fastify.register(fishjamPlugin); + +fastify.get("/rooms", () => fastify.fishjam.getAllRooms()); + +fastify.listen({ port: 3000 }); +``` + +## Listening to events + +Fishjam instance is a stateful server that is emitting messages upon certain events. +You can listen for those messages and react as you prefer. +There are two options to obtain these. + +### Webhooks + +To receive and parse the Fishjam protobuf messages, add a content type parser to your global (or scoped) Fastify instance. +Then, you will be able to access the parsed message at `request.Body`. + +```ts title='main.ts' +import Fastify, { FastifyRequest } from "fastify"; +import { ServerMessage } from "@fishjam-cloud/js-server-sdk"; + +const fastify = Fastify(); + +fastify.addContentTypeParser( + "application/x-protobuf", + { parseAs: "buffer" }, + async (_: FastifyRequest, body: Buffer) => + ServerMessage.decode(new Uint8Array(body)), +); + +fastify.post<{ Body: ServerMessage }>("/fishjam-webhook", (request) => { + // handle the message + console.log(request.body); +}); +``` + +### SDK Notifier + +You can also leverage the Fastify plugin mechanism to use websockets to receive messages from Fishjam. +Let's create another plugin in `fishjamNotifierPlugin.ts` file. + +In this case, we don't need to extend the Fastify instance type, because the plugin doesn't decorate the Fastify instance with any properties. It will work in the background. + +```ts title='fishjamNotifierPlugin.ts' +import fastifyPlugin from "fastify-plugin"; +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; +import Fastify from "fastify"; + +declare module "fastify" { + interface FastifyInstance { + fishjam: FishjamClient; + config: { + FISHJAM_ID: string; + FISHJAM_MANAGEMENT_TOKEN: string; + }; + } +} + +export const fishjamPlugin = fastifyPlugin((fastify) => { + const fishjamClient = new FishjamClient({ + fishjamId: fastify.config.FISHJAM_ID, + managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN, + }); + + fastify.decorate("fishjam", fishjamClient); +}); + +const fastify = Fastify(); + +// ---cut--- +import { type FastifyInstance } from "fastify"; +import fp from "fastify-plugin"; +import { FishjamWSNotifier } from "@fishjam-cloud/js-server-sdk"; + +export const fishjamNotifierPlugin = fp((fastify) => { + const fishjamId = fastify.config.FISHJAM_ID; + const managementToken = fastify.config.FISHJAM_MANAGEMENT_TOKEN; + + const fishjamNotifier = new FishjamWSNotifier( + { fishjamId, managementToken }, + (err) => fastify.log.error(err), + () => fastify.log.info("Websocket connection to Fishjam closed"), + ); + + // handle the messages + const handleRoomCreated = console.log; + const handlePeerAdded = console.log; + + fishjamNotifier.on("roomCreated", handleRoomCreated); + fishjamNotifier.on("peerAdded", handlePeerAdded); +}); +``` + +Don't forget to register your plugin. + +```ts title='main.ts' +import fastifyPlugin from "fastify-plugin"; +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; +import Fastify from "fastify"; +import { FishjamWSNotifier } from "@fishjam-cloud/js-server-sdk"; + +declare module "fastify" { + interface FastifyInstance { + fishjam: FishjamClient; + config: { + FISHJAM_ID: string; + FISHJAM_MANAGEMENT_TOKEN: string; + }; + } +} + +export const fishjamPlugin = fastifyPlugin((fastify) => { + const fishjamClient = new FishjamClient({ + fishjamId: "aaa", + managementToken: "bbb", + }); + + fastify.decorate("fishjam", fishjamClient); +}); + +const fastify = Fastify(); + +const fishjamNotifierPlugin = fastifyPlugin((fastify) => { + const fishjamNotifier = new FishjamWSNotifier( + { fishjamId: "aaa", managementToken: "bbb" }, + (err) => fastify.log.error(err), + (_code, _reason) => + fastify.log.info("Websocket connection to Fishjam closed"), + ); +}); + +// ---cut--- +await fastify.register(fishjamPlugin); +await fastify.register(fishjamNotifierPlugin); +``` diff --git a/versioned_docs/version-0.24.0/how-to/backend/production-deployment.mdx b/versioned_docs/version-0.24.0/how-to/backend/production-deployment.mdx new file mode 100644 index 00000000..7be6b05d --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/backend/production-deployment.mdx @@ -0,0 +1,297 @@ +--- +type: how-to +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# How to Deploy Fishjam to Production + +**How-to Guide** - _Deploy your Fishjam backend safely to production_ + +This guide covers the essential steps to move from development (using the Sandbox API) to a production-ready Fishjam backend deployment. + +## Prerequisites + +- Working Fishjam backend (see [Backend Quick Start](../../tutorials/backend-quick-start)) +- Production Fishjam environment (not Sandbox) +- Domain and SSL certificates for your backend +- Production database and infrastructure + +## Step 1: Set up production Fishjam environment + +### Get production credentials + +1. Log in to [Fishjam Dashboard](https://fishjam.io/app) +2. Create or select your **Production** environment (not Sandbox) +3. Copy your production **Fishjam ID** and **Management Token** +4. Note: These are different from your sandbox credentials + +### Environment variables setup + +Create production environment variables: + +```bash +# Production Fishjam credentials +FISHJAM_ID="your-production-fishjam-id" +FISHJAM_MANAGEMENT_TOKEN="your-production-management-token" + +# Your application settings +NODE_ENV="production" +PORT="3000" +DATABASE_URL="your-production-database-url" + +# Security settings +JWT_SECRET="your-secure-jwt-secret" +CORS_ORIGIN="https://yourdomain.com" +``` + +## Step 2: Implement proper authentication + +### Replace Sandbox API calls + +Remove any Sandbox API dependencies from your client code: + +```typescript +// @noErrors: 2451 +import { useSandbox } from "@fishjam-cloud/react-client"; +import express from "express"; + +const authenticateUser = {} as any; +const app = express(); + +const { getSandboxPeerToken } = useSandbox(); + +const userToken = ""; +const roomName = ""; +const userName = ""; + +// ---cut--- +// ❌ Remove: Sandbox API calls +const peerToken = await getSandboxPeerToken(roomName, userName); + +// ✅ Replace with: Your authenticated API +const response = await fetch("https://your-backend.com/api/join-room", { + method: "POST", + headers: { + "Content-Type": "application/json", + Authorization: `Bearer ${userToken}`, + }, + body: JSON.stringify({ roomName, userName }), +}); +``` + +### Implement user authentication + +```typescript +// @noErrors: 2339 +const jwt = {} as any; +import { FishjamClient, Room } from "@fishjam-cloud/js-server-sdk"; +import express from "express"; + +const app = express(); +const getUserById = async (userId: string) => ({ + id: userId, + name: "User", + avatar: "", + role: "user", +}); +const getOrCreateRoom = async (roomName: string) => + ({ id: "room-id" }) as unknown as Room; +const canUserJoinRoom = (user: any, room: any) => true; +process.env.FISHJAM_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.24.0/how-to/backend/server-setup.mdx b/versioned_docs/version-0.24.0/how-to/backend/server-setup.mdx new file mode 100644 index 00000000..77a75a88 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/backend/server-setup.mdx @@ -0,0 +1,295 @@ +--- +sidebar_position: 0 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Set up your server + +## Install the SDK + +Install the SDK for the language of your choice. We provide libraries for [**Node**](https://github.com/fishjam-cloud/js-server-sdk) and [**Python**](https://github.com/fishjam-cloud/python-server-sdk). +It's also possible to use the bare REST API, in this case you can skip this step. + + + + + ```bash + npm install @fishjam-cloud/js-server-sdk + ``` + + + + + + ```bash + yarn add @fishjam-cloud/js-server-sdk + ``` + + + + + + ```bash + pip install fishjam-server-sdk + ``` + + + + + + ```bash + poetry add fishjam-server-sdk + ``` + + + + +## Setup your client + +Let's setup everything you need to start communicating with a Fishjam instance. +First of all, view your app in the [**Fishjam developer panel**](https://fishjam.io/app) and copy your **Fishjam ID** and the **Management Token**. +They are required to proceed. Now, we are ready to dive into the code. + + + + + ```ts + process.env.FISHJAM_ID = "aaa"; + process.env.FISHJAM_MANAGEMENT_TOKEN = "bbb"; + + // ---cut--- + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamId = process.env.FISHJAM_ID; + const managementToken = process.env.FISHJAM_MANAGEMENT_TOKEN; + + const fishjamClient = new FishjamClient({ fishjamId, managementToken }); + ``` + + + + + + ```python + import os + from fishjam import FishjamClient + + fishjam_id = os.environ["FISHJAM_ID"] + management_token = os.environ["FISHJAM_MANAGEMENT_TOKEN"] + + fishjam_client = FishjamClient(fishjam_id, management_token) + ``` + + + + +### Managing rooms + +Create a room to get the `roomId` and be able to start adding peers. + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + const fishjamClient = new FishjamClient({ + + fishjamId: "https://fishjam.io", + managementToken: "bbb", + }); + // ---cut--- + const createdRoom = await fishjamClient.createRoom(); + + const theSameRoom = await fishjamClient.getRoom(createdRoom.id); + + await fishjamClient.deleteRoom(theSameRoom.id) + + // puff, it's gone! + ``` + + + + + + ```python + created_room = fishjam_client.create_room() + + the_same_room = fishjam_client.get_room(created_room.id) + + fishjam_client.delete_room(the_same_room.id) + + # puff, it's gone! + ``` + + + + + +### Managing peers + +Create a peer to obtain the peer token allowing your user to join the room. +At any time you can terminate user's access by deleting the peer. + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + const fishjamClient = new FishjamClient({ + fishjamId: "https://fishjam.io", + managementToken: "bbb", + }); + const created_room = await fishjamClient.createRoom(); + // ---cut--- + const { peer, peerToken } = await fishjamClient.createPeer(created_room.id); + + await fishjamClient.deletePeer(created_room.id, peer.id); + ``` + + + + + + ```python + peer, token = fishjam_client.create_peer(room_id) + + fishjam_client.delete_peer(room_id, peer.id) + ``` + + + + + +#### Metadata + +When creating a peer, you can also assign metadata to that peer, which can be read later with the [mobile SDK](../../how-to/react-native/metadata) +or [web SDK](../../how-to/react/metadata). This metadata can be only set when creating the peer and can't be updated later. + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + const fishjamClient = new FishjamClient({ + fishjamId: "https://fishjam.io", + managementToken: "bbb", + }); + const created_room = await fishjamClient.createRoom(); + // ---cut--- + const { peer, peerToken } = await fishjamClient.createPeer(created_room.id, { + metadata: { realName: 'Tom Reeves' }, + }); + ``` + + + + + + ```py + options = PeerOptions( + metadata={"realName": "Tom Reeves"}, + ) + peer, token = self.fishjam_client.create_peer(room_id, options=options) + ``` + + + + +## Listening to events + +Fishjam instance is a stateful server that is emitting messages upon certain events. +You can listen for those messages and react as you prefer. +There are two options to obtain these. + +### Webhooks + +Simply pass the your webhook url as a `webhookUrl` parameter when creating a room. + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamClient = new FishjamClient({ + fishjamId: "https://fishjam.io", + managementToken: "bbb", + }); + // ---cut--- + const webhookUrl = "https://example.com/"; + await fishjamClient.createRoom({ webhookUrl }); + ``` + + + + + + ```python + from fishjam import RoomOptions + + options = RoomOptions(webhook_url="https://example.com/") + + fishjam_client.create_room(options) + ``` + + + + + +### SDK Notifier + +Our SDKs come equipped with a Notifier allowing you to subscribe for messages. +It sets up a websocket connection with a Fishjam instance and provides a simple interface allowing you to handle messages. + + + + + ```ts + const fishjamId = "https://fishjam.io"; + const managementToken = "bbb"; + // ---cut--- + import { FishjamWSNotifier } from '@fishjam-cloud/js-server-sdk'; + + const onClose = console.log; + const onError = console.error; + const onConnectionFailed = console.error; + + const fishjamNotifier = new FishjamWSNotifier({ fishjamId, managementToken }, onError, onClose); + + fishjamNotifier.on('roomCreated', console.log); + ``` + + + + + + ```python + import asyncio + from fishjam import FishjamNotifier + + notifier = FishjamNotifier(fishjam_id, management_token) + + @notifier.on_server_notification + def handle_notification(notification): + match notification: + case ServerMessageRoomCreated(): + print(notification) + case _: + ... + + async def run_notifier(): + notifier_task = asyncio.create_task(notifier.connect()) + + # Wait for notifier to be ready to receive messages + await notifier.wait_ready() + + await notifier_task + + asyncio.run(run_notifier()) + ``` + + + + diff --git a/versioned_docs/version-0.24.0/how-to/features/_category_.json b/versioned_docs/version-0.24.0/how-to/features/_category_.json new file mode 100644 index 00000000..4aaeb074 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/features/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Features", + "position": 3 +} diff --git a/versioned_docs/version-0.24.0/how-to/features/audio-only-calls.mdx b/versioned_docs/version-0.24.0/how-to/features/audio-only-calls.mdx new file mode 100644 index 00000000..16ffab7a --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/features/audio-only-calls.mdx @@ -0,0 +1,99 @@ +--- +type: how-to +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Audio-only Conferences and Livestreams + +In many use cases, you only need real-time audio, without any video streaming. +If your use case falls into this category, then you can benefit greatly from using audio-only rooms in Fishjam. + +## Why Should I Care? + +Audio-only rooms are heavily discounted compared to normal rooms. +As described in more detail on the [pricing page](https://fishjam.io/#pricing), Fishjam rooms are priced based on the total connection time of peers in them. +Audio-only rooms come at a **75% discount** for both conferencing and livestreaming. + +### Conferencing + +For conferencing, the base price is $1 per 1000 participant minutes. + +For example, if you have a normal room with 10 peers connected for 100 minutes, then the total cost of the room will be $1. +If the same room were audio-only, the final cost of the room would only be $0.25. + +### Livestreaming + +For livestreaming, the base price is $0.8 per 1000 minutes of streamer and each viewer. + +In a livestream with 1 streamer and 9999 viewers, all connected for 100 minutes, the total connection time is 10,000 minutes. +For a normal livestream, this would cost $8.00. +If the same room were audio-only, the final cost would only be $2.00. + +## How Do I Use It? + +Using this feature is as easy as setting the `roomType` field when creating a room using our [Server SDKs](../../how-to/backend/server-setup). + +:::info +Attempting to stream a video while connected to an `audio_only` or `audio_only_livestream` room will result in only the audio being sent to the other peers. +::: + +### Conferencing + +Set `roomType` to `audio_only` when creating a room: + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + const fishjamClient = new FishjamClient({ + fishjamId: "aaa", + managementToken: "bbb", + }); + // ---cut--- + const audioOnlyRoom = await fishjamClient.createRoom({ roomType: 'audio_only' }); + ``` + + + ```python + options = RoomOptions(room_type="audio_only") + audio_only_room = fishjam_client.create_room(options) + ``` + + + +Now, you can connect peers normally to the room as described in our [React Native](../../how-to/react-native/connecting) and [React](../../how-to/react/connecting) docs. + +### Livestreaming + +Set `roomType` to `audio_only_livestream` when creating a room: + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + const fishjamClient = new FishjamClient({ + fishjamId: "aaa", + managementToken: "bbb", + }); + // ---cut--- + const audioOnlyRoom = await fishjamClient.createRoom({ roomType: 'audio_only_livestream' }); + ``` + + + ```python + options = RoomOptions(room_type="audio_only_livestream") + audio_only_room = fishjam_client.create_room(options) + ``` + + + +Refer to our [Livestreaming tutorial](../../tutorials/livestreaming.mdx) to learn how to connect streamers and viewers. + +:::info +The React Native and React SDKs will log a warning in the console if any attempt to add video to an audio-only room is made. +This aims to assist in debugging, as adding video to an audio-only room has no effect and is most likely a mistake. +::: diff --git a/versioned_docs/version-0.24.0/how-to/features/sandbox-api-testing.mdx b/versioned_docs/version-0.24.0/how-to/features/sandbox-api-testing.mdx new file mode 100644 index 00000000..a9b5ac71 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/features/sandbox-api-testing.mdx @@ -0,0 +1,321 @@ +--- +type: how-to +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Testing with the Sandbox API + +The Sandbox API is a development tool that lets you create rooms and peers for testing without setting up your own backend server. This guide shows you how to use it effectively. + +## Prerequisites + +- Access to [Fishjam Dashboard](https://fishjam.io/app) +- A Sandbox environment set up + +## Step 1: Get your Fishjam ID + +1. Log in to [Fishjam Dashboard](https://fishjam.io/app) +2. Navigate to your [Sandbox Environment](https://fishjam.io/app/sandbox) +3. Copy your **Fishjam ID** + +:::note +`FISHJAM_ID` is your unique sandbox identifier. Anyone who knows this ID can join your rooms, so keep it secure during development. +::: + +## Step 2: Create a room and get peer tokens + +### With the `useSandbox` hook + + + + + ```ts + const FISHJAM_ID = "..."; + const roomName = "testRoom"; + const peerName = "testUser"; + // ---cut--- + import { useSandbox } from '@fishjam-cloud/react-native-client'; + + // ... + + const { getSandboxPeerToken } = useSandbox({ fishjamId: FISHJAM_ID }); + const peerToken = await getSandboxPeerToken(roomName, peerName); + ``` + + + + + + ```ts + const FISHJAM_ID = "..."; + const roomName = "testRoom"; + const peerName = "testUser"; + // ---cut--- + import { useSandbox } from '@fishjam-cloud/react-client'; + + // ... + + const { getSandboxPeerToken } = useSandbox(); + const peerToken = await getSandboxPeerToken(roomName, peerName); + ``` + + + + +### Required parameters + +- `roomName` - Name of the room to create/join +- `peerName` - Name for the peer joining the room + +### Optional parameters + +- `roomType` - Type of room to create (defaults to `conference`) + +### Room types available + +- `conference` - For video/audio conferencing (default) +- `audio-only` - For audio-only conferencing +- `livestream` - For one-to-many video/audio streaming + +## Step 3: Handle the response + +The Sandbox API returns a JSON response with connection details: + +```json +{ + "peerToken": "", + "url": "wss://fishjam.io/api/v1/connect/${YOUR_APP_UUID}", + "room": { + "id": "", + "name": "foo" + }, + "peer": { + "id": "", + "name": "bar" + } +} +``` + +## Step 4: Use the tokens in your client app + +Below are examples on how to use tokens from the Sandbox API in your frontend applications: + + + + + ```tsx + import React, { useEffect, useState } from "react"; + import { Text } from "react-native"; + + const roomName = "testRoom"; + const peerName = `user_${Date.now()}`; + const FISHJAM_ID = "..."; + + const RoomView = (props: {peerToken: string}) => null; + // ---cut--- + import { useSandbox } from "@fishjam-cloud/react-native-client"; + + export default function TestScreen() { + const [peerToken, setPeerToken] = useState(null); + const { getSandboxPeerToken } = useSandbox({ fishjamId: FISHJAM_ID }); + + useEffect(() => { + const fetchPeerToken = async () => { + try { + const token = await getSandboxPeerToken(roomName, peerName); + setPeerToken(token); + } catch (error) { + console.error("Failed to create room:", error); + } + }; + + fetchPeerToken(); + }, []); + + if (!peerToken) { + return Creating room...; + } + + return ( + + ); + } + ``` + + + + + + ```tsx + import React, { useState, useEffect } from "react"; + + const FISHJAM_ID = "your-app-uuid-here"; + // ---cut--- + import { FishjamProvider, useConnection, useSandbox } from "@fishjam-cloud/react-client"; + + function VideoCallComponent() { + const { joinRoom, peerStatus } = useConnection(); + const { getSandboxPeerToken } = useSandbox(); + + const handleJoinRoom = async () => { + const roomName = "testRoom"; + const peerName = `user_${Date.now()}`; + + try { + const peerToken = await getSandboxPeerToken(roomName, peerName) + await joinRoom({ peerToken }); + } catch (error) { + console.error("Failed to join room:", error); + } + }; + + const isConnected = peerStatus === "connected"; + + return ( +
+ {isConnected ?

Connected to room!

: } +
+ ); + } + + export default function App() { + return ( + + + + ); + } + ``` + +
+
+ +## Step 5: Test different room types + +### Testing audio-only rooms + +```ts +import { useSandbox } from "@fishjam-cloud/react-client"; +const { getSandboxPeerToken } = useSandbox(); +// ---cut--- +const audioOnlyUrl = await getSandboxPeerToken( + "audioTest", + "user1", + "audio_only", +); +``` + +### Testing livestream rooms + +```ts +import { useSandbox } from "@fishjam-cloud/react-client"; +const { getSandboxLivestream, getSandboxViewerToken } = useSandbox(); +// ---cut--- + +const livestreamName = "livestream1"; +// For the streamer +const streamerUrl = await getSandboxLivestream(livestreamName); + +// For viewers, you need a viewer token (different endpoint) +const viewerTokenUrl = await getSandboxViewerToken(livestreamName); +``` + +## Step 6: Handle multiple peers + +To test with multiple participants, create multiple peer tokens with different peer names: + +```ts +import { useSandbox } from "@fishjam-cloud/react-client"; +const { getSandboxPeerToken } = useSandbox(); +// ---cut--- +// First peer +const peer1Response = await getSandboxPeerToken("multiTest", "alice"); + +// Second peer +const peer2Response = await getSandboxPeerToken("multiTest", "bob"); +``` + +Both peers will join the same room (`multiTest`) and can communicate with each other. + +## Common testing patterns + +### Pattern 1: Random room names for isolation + +```ts +const roomName = `test_${Math.random().toString(36).substring(7)}`; +const peerName = `user_${Date.now()}`; +``` + +### Pattern 2: Consistent naming for repeated tests + +```ts +// @noErrors: 2451 +const roomName = "development-room"; +const peerName = `developer_1`; +``` + +### Pattern 3: Feature-specific room names + +```ts +// @noErrors: 2451 +const roomName = `screenshare-test-${Date.now()}`; +const roomName = `audio-only-test`; +const roomName = `livestream-demo`; +``` + +## Troubleshooting + +### Issue: Room not found errors + +**Problem**: Rooms might not persist between requests. + +**Solution**: Always create rooms fresh for each test session. + +### Issue: Connection failures + +**Problem**: Invalid Fishjam ID or network issues. + +**Solution**: + +1. Verify your Fishjam ID in the Fishjam Dashboard +2. Check network connectivity +3. Ensure you're using the sandbox environment + +## Security reminder + +:::danger +**The Sandbox API is not safe for production!** + +- No authentication required +- Anyone with your Fishjam ID can join rooms +- Identical room/peer names get the same tokens +- No rate limiting or abuse protection + +Only use the Sandbox API for development and testing. +::: + +## Resetting your app + +If you need to reset your Sandbox API: + +1. Go to [Fishjam Dashboard](https://fishjam.io/app/sandbox) +2. Click **Settings** +3. Click **Reset App** +4. Get your new Fishjam ID + +This will invalidate all existing tokens (including the management token!) and give you a fresh sandbox environment. + +## Next steps + +Once you've tested your integration with the Sandbox API: + +- [Set up your own backend](../../tutorials/backend-quick-start) +- [Learn more about the Sandbox API](../../explanation/sandbox-api-concept) +- [Understand security implications](../../explanation/security-tokens) + +For production deployment: + +- [How to set up a production server](../../how-to/backend/server-setup) +- [How to implement proper authentication](../../explanation/security-tokens) diff --git a/versioned_docs/version-0.24.0/how-to/features/selective-subscriptions.mdx b/versioned_docs/version-0.24.0/how-to/features/selective-subscriptions.mdx new file mode 100644 index 00000000..22d1c7a7 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/features/selective-subscriptions.mdx @@ -0,0 +1,338 @@ +--- +type: how-to +title: Selective Subscriptions +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Selective Subscriptions + +In Fishjam, peers in a conferencing room automatically subscribe to every other peer by default. +Selective Subscriptions let you break from that — giving your backend the ability to decide who receives what. + +In **manual subscription mode**, a peer or agent: + +- does not automatically receive **any tracks**, and +- can **explicitly subscribe** to specific tracks from other peers. + +## When to use Selective Subscriptions + +- large-scale rooms with dozens or hundreds of peers, +- “stage & audience” models (viewers only see speakers), +- bandwidth optimization (e.g., audio-only dashboards, or delayed video activation). + +--- + +## Core idea + +- Peers have a `subscribeMode` — either **`auto`** or **`manual`**. +- Peers in **auto** mode subscribe to everyone automatically (default behavior). +- Peers in **manual** mode will **not** receive any media until you explicitly subscribe them using the **Server SDK**. +- Peers in manual mode can subscribe to: + - another **peer** (all of its tracks), or + - specific **tracks** of another peer. + +:::note +Only **connected** peers can subscribe to others. +::: + +--- + +## Step 1 — Create a peer with `manual` subscription mode + +When creating a peer, set `subscribeMode` to `"manual"`. +This peer will start with zero subscriptions — it will not receive anyone’s audio or video. + + + + +```ts +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; + +const fishjamClient = new FishjamClient({ + fishjamId: process.env.FISHJAM_ID!, + managementToken: process.env.MANAGEMENT_TOKEN!, +}); + +// ---cut--- + +// Create a conference room +const room = await fishjamClient.createRoom({ + roomType: "conference", +}); + +// Create a normal publisher +const { peer: publisher } = await fishjamClient.createPeer(room.id, { + subscribeMode: "auto", +}); + +// Create a manual subscriber +const { peer: viewer } = await fishjamClient.createPeer(room.id, { + subscribeMode: "manual", +}); +``` + + + + +from fishjam import RoomOptions, PeerOptions + +```python +room_options = RoomOptions(room_type="conference") +room = fishjam_client.create_room(room_options) + +# Create a manual subscriber +peer_options = PeerOptions(subscribe_mode="manual") +publisher = fishjam_client.create_peer(room.id, peer_options) +viewer = fishjam_client.create_peer(room.id, peer_options) + +``` + + + + +--- + +## Step 2 — Subscribe a peer to another peer + +Use this when you want your manual subscriber to receive **all tracks** published by another peer. + + + + +```ts +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; +const fishjamClient = new FishjamClient({ + fishjamId: process.env.FISHJAM_ID!, + managementToken: process.env.MANAGEMENT_TOKEN!, +}); + +const room = await fishjamClient.createRoom({ + roomType: "conference", +}); + +const { peer: publisher } = await fishjamClient.createPeer(room.id, { + subscribeMode: "auto", +}); + +const { peer: subscriber } = await fishjamClient.createPeer(room.id, { + subscribeMode: "manual", +}); + +// ---cut--- +// Subscribe viewer to everything published by publisher +await fishjamClient.subscribePeer(room.id, subscriber.id, publisher.id); +``` + + + + + +```python +fishjam_client.subscribe_peer(room.id, viewer_id, publisher_id) +``` + + + + +This will make **every current and future track** of the publisher available to the subscriber. +It’s additive — the subscriber can listen to multiple publishers at once. + +--- + +## Step 3 — Subscribe to specific tracks + +Sometimes you only want a subset of a publisher’s tracks, for example: + +- their **screenshare**, but not their camera, +- only **audio**, without video. + + + + +```ts +import { FishjamClient, type TrackId } from "@fishjam-cloud/js-server-sdk"; +const fishjamClient = new FishjamClient({ + fishjamId: process.env.FISHJAM_ID!, + managementToken: process.env.MANAGEMENT_TOKEN!, +}); + +const room = await fishjamClient.createRoom({ + roomType: "conference", +}); + +const { peer: publisher } = await fishjamClient.createPeer(room.id, { + subscribeMode: "auto", +}); + +const { peer: subscriber } = await fishjamClient.createPeer(room.id, { + subscribeMode: "manual", +}); + +// ---cut--- +// Get track IDs from your room state or webhook events +const audioTrackId = "track_audio_abc" as TrackId; +const screenTrackId = "track_screen_xyz" as TrackId; + +// Subscribe to a single track +await fishjamClient.subscribeTracks(room.id, subscriber.id, [audioTrackId]); + +// Or multiple +await fishjamClient.subscribeTracks(room.id, subscriber.id, [ + audioTrackId, + screenTrackId, +]); +``` + + + + + +```python +audio_track_id = "track_audio_abc" +screen_track_id = "track_screen_xyz" + +# Subscribe to one track +fishjam_client.subscribe_tracks(room.id, subscriber_id, [audio_track_id]) + +# Or multiple +fishjam_client.subscribe_tracks(room.id, subscriber_id, [audio_track_id, screen_track_id]) +``` + + + + +:::note +📘 Track IDs are available from [Fishjam’s events in your backend](/how-to/backend/server-setup#listening-to-events). +::: + +--- + +## Step 4 — Combine multiple publishers + +A manual peer can subscribe to **several** publishers at once. +Each call to `subscribePeer` adds more publishers — it doesn’t overwrite the previous ones. + + + + +```ts +import { FishjamClient, type PeerOptions } from "@fishjam-cloud/js-server-sdk"; +const fishjamClient = new FishjamClient({ + fishjamId: process.env.FISHJAM_ID!, + managementToken: process.env.MANAGEMENT_TOKEN!, +}); + +const room = await fishjamClient.createRoom({ + roomType: "conference", +}); + +// ---cut--- +const options = { subscribeMode: "manual" } satisfies PeerOptions; + +const { peer: subscriber } = await fishjamClient.createPeer(room.id, options); +const { peer: publisherA } = await fishjamClient.createPeer(room.id, options); +const { peer: publisherB } = await fishjamClient.createPeer(room.id, options); + +// Subscribe subscriber to two publishers +await fishjamClient.subscribePeer(room.id, subscriber.id, publisherA.id); +await fishjamClient.subscribePeer(room.id, subscriber.id, publisherB.id); +``` + + + + + +```python +fishjam_client.subscribe_peer(room.id, subscriber_id, publisher_a_id) +fishjam_client.subscribe_peer(room.id, subscriber_id, publisher_b_id) +``` + + + + +The subscriber now receives tracks from **both** publishers simultaneously. + +--- + +## Step 5 — Example: curated stage & audience + +You can implement a “stage” system where: + +- speakers are in auto mode (they see/hear each other), +- audience members are manual subscribers (they only see the stage). + + + + +```ts +import { FishjamClient, type Peer } from "@fishjam-cloud/js-server-sdk"; + +const fishjamClient = new FishjamClient({ + fishjamId: process.env.FISHJAM_ID!, + managementToken: process.env.MANAGEMENT_TOKEN!, +}); + +const room = await fishjamClient.createRoom({ + roomType: "conference", +}); + +const { peer: publisher } = await fishjamClient.createPeer(room.id, { + subscribeMode: "auto", +}); + +// ---cut--- + +// fetch room to get actual list of peers +const fetchedRoom = await fishjamClient.getRoom(room.id); +const currentSpeakers = fetchedRoom.peers; + +// audience joins in manual mode +const { peer: audience } = await fishjamClient.createPeer(room.id, { + subscribeMode: "manual", +}); + +// subscribe them to all current speakers +await Promise.all( + currentSpeakers.map((speaker) => + fishjamClient.subscribePeer(room.id, audience.id, speaker.id), + ), +); +``` + + + + + +```python + +audience = fishjam_client.create_peer(room.id, PeerOptions(subscribe_mode="manual")) +current_speakers = fishjam_client.get_room(room.id).peers +# audience peer already exists (manual) +for speaker in current_speakers: + fishjam_client.subscribe_peer(room.id, audience.id, speaker.id) +``` + + + + +As new speakers join, simply call `subscribe_peer` again to add them to the audience’s feed. + +--- + +## Notes & limitations + +- Only **connected** peers can subscribe to others. +- Peers created with `subscribeMode: 'auto'` always subscribe to everyone automatically. +- Unsubscribe support is not yet implemented (for now, just remove peer sessions when needed). + +--- + +## See also + +- [Room types explained](../../explanation/room-types) +- [React quick start](../../tutorials/react-quick-start) +- [React Native quick start](../../tutorials/react-native-quick-start) + +> 🗒️ For server-side recording or media processing, see [Agents](../../tutorials/agents.mdx) (documented separately). diff --git a/versioned_docs/version-0.24.0/how-to/features/whip-whep.mdx b/versioned_docs/version-0.24.0/how-to/features/whip-whep.mdx new file mode 100644 index 00000000..d7de8b01 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/features/whip-whep.mdx @@ -0,0 +1,228 @@ +--- +type: how-to +title: WHIP/WHEP with Fishjam +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Livestreaming using WHIP/WHEP + +:::tip +Make sure to read [Livestreaming with Fishjam](../../tutorials/livestreaming) before reading this guide. +This guide focuses on a low-level way to communicate with Fishjam. + +The majority of use-cases should prefer to use the methods described in [Livestreaming with Fishjam](../../tutorials/livestreaming). +::: + +If you've reading this guide, it is more than likely that you've already heard of **WHIP** (WebRTC HTTP Ingress Protocol) and **WHEP** (WebRTC HTTP Egress Protocol). +If not, then we recommend to read our [article about WHIP/WHEP](https://blog.swmansion.com/building-interactive-streaming-apps-webrtc-whip-whep-explained-d38f4825ec90). +In short, these are two protocols which standardize real-time livestreaming. +This prevents vendor lock-in and allows implementations and solutions to be reused in different scenarios. + +Fishjam supports both WHIP and WHEP, so you can choose how to publish and receive streams. +For example, you can use [OBS Studio](https://obsproject.com/) to publish a livestream with WHIP and then receive the stream using any public online WHEP player you like. + +## WHIP with Fishjam + +WHIP is the protocol used by streamers to start publishing. +To use WHIP you need two things: + +1. The URL of an HTTP endpoint implementing the WHIP specification. +2. A token, used by the endpoint to authorize the streamer. + +### Getting the URL + +Fishjam's WHIP endpoint is available at + +```sh +https://fishjam.io/api/v1/live/api/whip +``` + +You can paste this URL in your WHIP client of choice to start streaming. + +### Getting the token + +To authenticate a streamer, you need to first create a room of type `livestream` and a streamer token for that room. +You can read about this in detail in [Production Livestreaming with Server SDKs](../../tutorials/livestreaming#production-livestreaming-with-server-sdks), but the TL;DR is + + + + + ```ts + const fishjamId = ""; + const managementToken = ""; + + // ---cut--- + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamClient = new FishjamClient({ + fishjamId, + managementToken, + }); + + const room = await fishjamClient.createRoom({ roomType: 'livestream' }); + const { token: streamerToken } = await fishjamClient.createLivestreamStreamerToken(room.id); // [!code highlight] + ``` + + + + + + ```python + from fishjam import FishjamClient + + fishjam_client = FishjamClient( + fishjam_id=fishjam_id, + management_token=management_token, + ); + + room = fishjam_client.create_room(room_type="livestream") + streamer_token = fishjam_client.create_livestream_streamer_token(room.id) # [!code highlight] + ``` + + + + +The created streamer token must be supplied in the HTTP headers of the WHIP request: + +```sh +POST https://fishjam.io/api/v1/live/api/whip +Authorization: Bearer [STREAMER-TOKEN] +``` + +## WHEP with Fishjam + +WHEP is the protocol used by viewers to start receiving a published livestream. +The usage of WHEP is very similar to WHIP, as you need the following: + +1. The URL of an HTTP endpoint implementing the WHEP specification. +2. **(Optional)** A token, used by the endpoint to authorize the viewer. + +With Fishjam, if the livestream is private, then the **token is required**. +On the other hand, if the livestream is public, then the **token is omitted**. + +[Private vs Public Livestreams](../../explanation/public-livestreams) explains private and public livestreams in more detail. +In this guide we demonstrate how to view each livestream type using WHEP directly. + +### Private livestreams + +#### Getting the URL + +For private livestreams, Fishjam's WHEP endpoint is available at + +```sh +https://fishjam.io/api/v1/live/api/whep +``` + +You can paste this URL in your WHEP client of choice to start viewing. + +#### Getting the token + +To authenticate a viewer, you need to create a viewer token for a room of `livestream` type. +You can read about this in detail in [Production Livestreaming with Server SDKs](../../tutorials/livestreaming#production-livestreaming-with-server-sdks), but the TL;DR is + + + + + ```ts + const fishjamId = ""; + const managementToken = ""; + + // ---cut--- + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamClient = new FishjamClient({ + fishjamId, + managementToken, + }); + + const room = await fishjamClient.createRoom({ roomType: 'livestream', public: false }); + + // ... + + const { token: viewerToken } = await fishjamClient.createLivestreamViewerToken(room.id); // [!code highlight] + ``` + + + + + + ```python + from fishjam import FishjamClient + + fishjam_client = FishjamClient( + fishjam_id=fishjam_id, + management_token=management_token, + ); + + room = fishjam_client.create_room(room_type="livestream", public=False) + + # ... + + viewer_token = fishjam_client.create_livestream_viewer_token(room.id) # [!code highlight] + ``` + + + + +The created viewer token must be supplied in the HTTP headers of the WHEP request: + +```sh +POST https://fishjam.io/api/v1/live/api/whep +Authorization: Bearer [VIEWER-TOKEN] +``` + +### Public livestreams + +For public livestreams, you don't need a token, however you still need a room of `livestream` type with the `public` flag enabled. + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamId = ""; + const managementToken = ""; + const fishjamClient = new FishjamClient({ + fishjamId, + managementToken, + }); + + // ---cut--- + const room = await fishjamClient.createRoom({ roomType: 'livestream', public: true }); + // now you can use room.id to start viewing + ``` + + + + + + ```python + room = fishjam_client.create_room(room_type="livestream", public=True) + # now you can use room.id to start viewing + ``` + + + + +Once you have such a room, you can view a stream published to that room by supplying the following URL: + +```sh +http://fishjam.io/api/v1/live/api/whep/[ROOM-ID] +``` + +## See also + +More on livestreaming: + +- [Livestreaming tutorial](../../tutorials/livestreaming) +- [Private vs Public livestreams](../../explanation/public-livestreams) + +If livestreaming doesn't fit your use case: + +- [Room types explained](../../explanation/room-types) +- [Videoconferencing in React Native](../../tutorials/react-native-quick-start) +- [Videoconferencing in React](../../tutorials/react-quick-start) +- [Audio-only calls](../../how-to/features/audio-only-calls) diff --git a/versioned_docs/version-0.24.0/how-to/react-native/_category_.json b/versioned_docs/version-0.24.0/how-to/react-native/_category_.json new file mode 100644 index 00000000..1fd79841 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/react-native/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "React Native", + "position": 1 +} diff --git a/versioned_docs/version-0.24.0/how-to/react-native/_components/configure-permissions.mdx b/versioned_docs/version-0.24.0/how-to/react-native/_components/configure-permissions.mdx new file mode 100644 index 00000000..bd5debcc --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/react-native/_components/configure-permissions.mdx @@ -0,0 +1,91 @@ +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +Your app needs to have permissions configured in order to use the microphone and camera. + +### Android + +Permissions below are required to stream audio and video with Fishjam on Android. + +- `android.permission.CAMERA` +- `android.permission.RECORD_AUDIO` +- `android.permission.MODIFY_AUDIO_SETTINGS` + + + + + +Add required permissions to the `app.json` file. + +```json title='app.json' +{ + "expo": { + ... + "android": { + ... + "permissions": [ + "android.permission.CAMERA", + "android.permission.RECORD_AUDIO", + "android.permission.MODIFY_AUDIO_SETTINGS" + ] + } + } +} +``` + + + + +Add required permissions to the `AndroidManifest.xml` file. + +```xml title='AndroidManifest.xml' + + ... + + + + ... + +``` + + + + +### iOS + + + + + +You don't have to make any changes to run app on iOS. +To update default content of permission alert, you can add these settings to `app.json`: + +```json title='app.json' +{ + "expo": { + ... + "ios": { + ... + "infoPlist": { + "NSCameraUsageDescription": "Allow $(PRODUCT_NAME) to access your camera.", + "NSMicrophoneUsageDescription": "Allow $(PRODUCT_NAME) to access your microphone." + } + }, + } +} +``` + + + + +Ensure `Info.plist` contains camera and microphone usage description entries: + +```xml title='Info.plist' + NSCameraUsageDescription + Allow $(PRODUCT_NAME) to access your camera. + NSMicrophoneUsageDescription + Allow $(PRODUCT_NAME) to access your microphone. +``` + + + diff --git a/versioned_docs/version-0.24.0/how-to/react-native/_components/install-package.mdx b/versioned_docs/version-0.24.0/how-to/react-native/_components/install-package.mdx new file mode 100644 index 00000000..356da871 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/react-native/_components/install-package.mdx @@ -0,0 +1,27 @@ +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + + + + +```bash npm2yarn +npm install @fishjam-cloud/react-native-client +``` + + + + + +### Install Expo dependencies + +Follow instructions from official [Expo documentation](https://docs.expo.dev/bare/installing-expo-modules/). + +### Install Fishjam + + ```sh + npx expo install @fishjam-cloud/react-native-client + ``` + + + + diff --git a/versioned_docs/version-0.24.0/how-to/react-native/assets/ios-new-folder.png b/versioned_docs/version-0.24.0/how-to/react-native/assets/ios-new-folder.png new file mode 100644 index 00000000..59299cf3 Binary files /dev/null and b/versioned_docs/version-0.24.0/how-to/react-native/assets/ios-new-folder.png differ diff --git a/versioned_docs/version-0.24.0/how-to/react-native/assets/ios-new-group.png b/versioned_docs/version-0.24.0/how-to/react-native/assets/ios-new-group.png new file mode 100644 index 00000000..8ec7c415 Binary files /dev/null and b/versioned_docs/version-0.24.0/how-to/react-native/assets/ios-new-group.png differ diff --git a/versioned_docs/version-0.24.0/how-to/react-native/assets/ios-new-target.png b/versioned_docs/version-0.24.0/how-to/react-native/assets/ios-new-target.png new file mode 100644 index 00000000..4ecff358 Binary files /dev/null and b/versioned_docs/version-0.24.0/how-to/react-native/assets/ios-new-target.png differ diff --git a/versioned_docs/version-0.24.0/how-to/react-native/background-streaming.mdx b/versioned_docs/version-0.24.0/how-to/react-native/background-streaming.mdx new file mode 100644 index 00000000..9b43c516 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/react-native/background-streaming.mdx @@ -0,0 +1,207 @@ +--- +sidebar_position: 6 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Background calls + +Both Android and iOS support calls running in the background, but they use different approaches: + +- **Android**: Uses foreground services to keep the app active in the background +- **iOS**: Uses CallKit integration to maintain VoIP calls in the background + +Below is configuration required to make it work: + + + + + +You need to modify `app.json` file and add our plugin: + +```json +{ + "expo": { + ... + "plugins": { + ... + [ + "@fishjam-cloud/react-native-client", + { + "android": { + "enableForegroundService": true + }, + "ios": { + "enableVoIPBackgroundMode": true + } + } + ], + ... + } + } +} +``` + + + + +**Android Configuration** + +You need to add the following service to `AndroidManifest.xml`: + +```xml title='AndroidManifest.xml' + + ... + + ... + + + +``` + +**iOS Configuration** + +You need to add VoIP background mode in `Info.plist`: + +```xml title='Info.plist' +UIBackgroundModes + + voip + +``` + + + + +## Usage + + + + + +You can use [`useForegroundService`](../../api/mobile/variables/useForegroundService) hook to handle how foreground service behaves on Android. + +:::important[Permissions] + +If you want to use [`enableCamera`](../../api/mobile/type-aliases/ForegroundServiceConfig#enablecamera) or [`enableMicrophone`](../../api/mobile/type-aliases/ForegroundServiceConfig#enablemicrophone), +user must first grant permission for this resource. [`useForegroundService`](../../api/mobile/variables/useForegroundService) will check if permission is +granted and only then allow to start a service. + +::: + +```tsx +import { + useForegroundService, + useCamera, + useMicrophone, +} from "@fishjam-cloud/react-native-client"; + +const { isCameraOn } = useCamera(); +const { isMicrophoneOn } = useMicrophone(); + +useForegroundService({ + channelId: "io.fishjam.example.fishjamchat.foregroundservice.channel", + channelName: "Fishjam Chat Notifications", + notificationTitle: "Your video call is ongoing", + notificationContent: "Tap to return to the call.", + enableCamera: isCameraOn, + enableMicrophone: isMicrophoneOn, +}); +``` + + + + +On iOS, background calls are achieved through CallKit integration. You can use the CallKit hooks to manage VoIP calls that continue running in the background. + +### Manual CallKit Management + +Use the [`useCallKit`](../../api/mobile/variables/useCallKit) hook for fine-grained control over CallKit sessions: + +```tsx +import { useCallKit } from "@fishjam-cloud/react-native-client"; + +const { startCallKitSession, endCallKitSession } = useCallKit(); + +// Start CallKit session when joining a room +const handleJoinRoom = async () => { + await startCallKitSession({ + displayName: "John Doe", + isVideo: true, + }); + // ... join room logic +}; + +// End CallKit session when leaving +const handleLeaveRoom = async () => { + await endCallKitSession(); + // ... leave room logic +}; +``` + +### Automatic CallKit Management + +Use the [`useCallKitService`](../../api/mobile/variables/useCallKitService) hook for automatic session lifecycle management: + +```tsx +import React from "react"; +import { useCallKitService } from "@fishjam-cloud/react-native-client"; +import { View } from "react-native"; + +function CallScreen({ username }: { username: string }) { + // CallKit session automatically starts when component mounts + // and ends when component unmounts + useCallKitService({ + displayName: username, + isVideo: true, + }); + + return ...; +} +``` + +### Listening to CallKit Events + +Use the [`useCallKitEvent`](../../api/mobile/variables/useCallKitEvent) hook to respond to user interactions with the native CallKit interface: + +```tsx +import { + useCallKitEvent, + useCamera, + useMicrophone, + useConnection, +} from "@fishjam-cloud/react-native-client"; + +const { toggleCamera } = useCamera(); +const { startMicrophone, stopMicrophone } = useMicrophone(); +const { leaveRoom } = useConnection(); + +// Listen for mute toggle from CallKit UI +useCallKitEvent("muted", (isMuted: boolean) => { + if (isMuted) { + stopMicrophone(); + } else { + startMicrophone(); + } +}); + +// Listen for hold state changes +useCallKitEvent("held", (isOnHold: boolean) => { + console.log("Call hold state:", isOnHold); + // Handle hold state in your app +}); + +// Listen for call end from CallKit UI +useCallKitEvent("ended", () => { + // Handle call termination + leaveRoom(); +}); +``` + + + + +## See Also + +For an enhanced user experience when your app is in the background, consider enabling [Picture in Picture](./picture-in-picture), which allows users to see video content in a floating window while using other apps. diff --git a/versioned_docs/version-0.24.0/how-to/react-native/connecting.mdx b/versioned_docs/version-0.24.0/how-to/react-native/connecting.mdx new file mode 100644 index 00000000..e8d6481a --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/react-native/connecting.mdx @@ -0,0 +1,101 @@ +--- +sidebar_position: 2 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Connecting + +This article will guide you through the process of connecting to a Fishjam room. + +## Getting URL and token + +In order to connect, you need to obtain a **Peer Token** (the token that will authenticate the peer in +your Room). + + + + + +Once you create your account on [Fishjam](https://fishjam.io), you will have access to the Sandbox environment as part of the Mini Jar plan. +While using the Sandbox environment, [you can use the Sandbox API](../../how-to/features/sandbox-api-testing) to generate peer tokens for testing or development purposes. +This is basically a service that will create a Room, add your app as +the Room's Peer, and return the token required to use that Room. + +```ts +import { useSandbox } from "@fishjam-cloud/react-native-client"; +const SANDBOX_FISHJAM_ID = "..."; +const roomName = "room"; +const peerName = "user"; +// ---cut--- + +// The `useSandbox` hook will work ONLY with the FISHJAM_ID of the Sandbox environment +const { getSandboxPeerToken } = useSandbox({ fishjamId: SANDBOX_FISHJAM_ID }); +const peerToken = await getSandboxPeerToken(roomName, peerName); +``` + + + + +For the production app, you need to implement your own backend service that will provide the user with a **Peer Token**. To do that, +follow our [server setup instructions](../../how-to/backend/server-setup). + + + + +## Connecting + +In order to connect, call [`joinRoom`](../../api/mobile/functions/useConnection#joinroom) method with the `peerToken` and the fishjam ID: + +```tsx +import React, { useCallback } from "react"; +import { Button } from "react-native"; +import { useConnection, useSandbox } from "@fishjam-cloud/react-native-client"; + +// Check https://fishjam.io/app/ for your Fishjam ID +const FISHJAM_ID = "..."; + +export function JoinRoomButton() { + const { joinRoom } = useConnection(); // [!code highlight] + const { getSandboxPeerToken } = useSandbox({ fishjamId: FISHJAM_ID }); + + const onPressJoin = useCallback(async () => { + // in production environment, get the peerToken from your backend + const peerToken = await getSandboxPeerToken("Room", "User"); + + await joinRoom({ fishjamId: FISHJAM_ID, peerToken }); // [!code highlight] + }, [joinRoom]); + + return ; +} +``` + +## Disconnecting + +In order to close connection, use the [`leaveRoom`](../../api/web/functions/useConnection#leaveroom) method +from [`useConnection`](../../api/web/functions/useConnection) hook. + +```tsx +import { useConnection } from "@fishjam-cloud/react-client"; +import React, { useCallback } from "react"; + +export function LeaveRoomButton() { + const { leaveRoom } = useConnection(); // [!code highlight] + + return ; +} +``` diff --git a/versioned_docs/version-0.24.0/how-to/react/custom-sources.mdx b/versioned_docs/version-0.24.0/how-to/react/custom-sources.mdx new file mode 100644 index 00000000..14e7fde0 --- /dev/null +++ b/versioned_docs/version-0.24.0/how-to/react/custom-sources.mdx @@ -0,0 +1,175 @@ +--- +sidebar_position: 8 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Custom sources + +:::important + +If you only wish to send camera, microphone or screen share output through Fishjam, then you most likely should refer to the documentation in [Streaming media](../../how-to/react/start-streaming) and [Managing devices](../../how-to/react/managing-devices) instead of this page. + +::: + +This section demonstrates how to stream non-standard video or audio to other peers in your web app. +The utilities in this section allow you to integrate Fishjam with powerful browser APIs such as [WebGL](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) and [WebGPU](https://developer.mozilla.org/en-US/docs/Web/API/WebGPU_API), +or higher level libraries, which leverage these APIs, such as [Three.js](https://threejs.org/), [Smelter](https://smelter.dev) or [PixiJS](https://pixijs.com/) + +## Creating a custom source - [`useCustomSource()`](../../api/web/functions/useCustomSource) + +To create a custom source, you only need to do two things: + +1. Call the `useCustomSource` hook. +2. Call the [`setStream`](../../api/web/functions/useCustomSource#setstream) callback provided by the `useCustomSource` hook with a [MediaStream](#how-to-get-a-mediastream-object) object. + +#### Usage Example + +```tsx +import React, { useEffect } from "react"; +import { useCustomSource } from "@fishjam-cloud/react-client"; + +const stream: MediaStream | null = null; // Replace with your MediaStream object +const { setStream } = useCustomSource("my-custom-source"); + +useEffect(() => { + setStream(stream); +}, [stream, setStream]); +``` + +### Using a created custom source + +Once you have called [`setStream`](../../api/web/functions/useCustomSource#setstream) for a given source ID (in the above example, `"my-custom-source"`), any subsequent calls to `useCustomSource` with the same ID will return the same state. +This enables multiple components to control and read a shared custom source. + +### Deleting a custom source + +If you wish to remove a custom source, then you should call the [`setStream`](../../api/web/functions/useCustomSource#setstream) callback with `null` as its argument. + +#### Usage Example + +```tsx +import { useCustomSource } from "@fishjam-cloud/react-client"; +// ---cut--- +const { setStream } = useCustomSource("my-custom-source"); +// ... +await setStream(null); +``` + +## How to get a MediaStream object? + +Depending on your use-case, the way you can obtain a [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream) will vary. +Below are some common examples of how to obtain one from an existing video or audio source. + +### Canvas + +If you have a `` HTML element, then you will need to call the [`captureStream`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/captureStream) method of the given canvas. +This is particularly useful if you are using [Three.js](https://threejs.org/) or [PixiJS](https://pixijs.com/) to render complex animations and more. + +#### Usage Example + +```tsx +import React, { useCallback, useState } from "react"; + +export function CanvasExample() { + const [canvasStream, setCanvasStream] = useState(); + + const streamFromCanvas = useCallback((canvas: HTMLCanvasElement | null) => { + if (!canvas) return; + setCanvasStream(canvas.captureStream()); + }, []); + + // use canvasStream as desired + + return ; +} +``` + +### Smelter + +If you are using [Smelter](https://smelter.dev), then all you need to do is register an output via [`registerOutput`](https://smelter.dev/ts-sdk/outputs/wasm-stream/). + +#### Usage Example + +:::tip + +If you want to see a full example React app which uses Fishjam with Smelter, then you can check out our [full example on GitHub](https://github.com/fishjam-cloud/web-client-sdk/tree/main/examples/react-client/minimal-smelter). + +::: + +```tsx +import React from "react"; +import Smelter, { setWasmBundleUrl } from "@swmansion/smelter-web-wasm"; +import { View } from "@swmansion/smelter"; + +setWasmBundleUrl("/assets/smelter.wasm"); + +async function run() { + const smelter = new Smelter({ framerate: 30 }); + const { stream } = await smelter.registerOutput("example-output", , { + type: "stream", + video: { + resolution: { width: 1920, height: 1080 }, + }, + }); + await smelter.init(); +} +``` + +### Video/Audio HTML tag + +If you have a `