From 038bb75747a33fce452c670170bfd8e1193f4157 Mon Sep 17 00:00:00 2001 From: PiotrWodecki Date: Tue, 10 Feb 2026 11:54:58 +0100 Subject: [PATCH 1/2] Release 0.25.0 and remove 0.22.0 --- api/fishjam-server | 2 +- api/protos | 2 +- api/room-manager | 2 +- docusaurus.config.ts | 28 +- packages/js-server-sdk | 2 +- packages/python-server-sdk | 2 +- packages/web-client-sdk | 2 +- static/api/fishjam-server-openapi.yaml | 26 +- static/api/protobuf/agent_notifications.proto | 12 + .../api/protobuf/server_notifications.proto | 26 +- static/api/room-manager-openapi.yaml | 2 +- .../api/mobile/functions/FishjamRoom.md | 31 - .../functions/setOverwriteDebugConfig.md | 15 - .../api/mobile/functions/useAudioSettings.md | 66 -- .../functions/useBandwidthEstimation.md | 17 - .../api/mobile/functions/useCamera.md | 90 -- .../api/mobile/functions/useMicrophone.md | 45 - .../api/mobile/functions/usePeers.md | 39 - .../api/mobile/functions/useSandbox.md | 60 -- .../api/mobile/functions/useScreenShare.md | 44 - .../mobile/functions/useUpdatePeerMetadata.md | 31 - .../version-0.22.0/api/mobile/index.md | 81 -- .../mobile/type-aliases/AppScreenShareData.md | 39 - .../mobile/type-aliases/AudioOutputDevice.md | 21 - .../type-aliases/AudioOutputDeviceType.md | 5 - .../mobile/type-aliases/AudioSessionMode.md | 5 - .../api/mobile/type-aliases/AudioTrack.md | 15 - .../api/mobile/type-aliases/CallKitAction.md | 45 - .../api/mobile/type-aliases/CallKitConfig.md | 25 - .../api/mobile/type-aliases/Camera.md | 29 - .../api/mobile/type-aliases/CameraConfig.md | 13 - .../mobile/type-aliases/CameraConfigBase.md | 78 -- .../type-aliases/CameraFacingDirection.md | 5 - .../api/mobile/type-aliases/CameraId.md | 5 - .../mobile/type-aliases/ConnectionConfig.md | 26 - .../api/mobile/type-aliases/DebugConfig.md | 13 - .../type-aliases/DistinguishedTracks.md | 37 - .../api/mobile/type-aliases/EncodingReason.md | 11 - .../mobile/type-aliases/FishjamRoomProps.md | 25 - .../type-aliases/ForegroundServiceConfig.md | 67 -- .../mobile/type-aliases/GenericMetadata.md | 5 - .../api/mobile/type-aliases/JoinRoomConfig.md | 52 -- .../api/mobile/type-aliases/Peer.md | 52 -- .../api/mobile/type-aliases/PeerId.md | 5 - .../mobile/type-aliases/PeerTrackMetadata.md | 28 - .../api/mobile/type-aliases/PeerWithTracks.md | 12 - .../mobile/type-aliases/ReconnectionStatus.md | 11 - .../api/mobile/type-aliases/RoomType.md | 5 - .../mobile/type-aliases/ScreenShareOptions.md | 21 - .../mobile/type-aliases/ScreenShareQuality.md | 5 - .../mobile/type-aliases/SimulcastConfig.md | 21 - .../api/mobile/type-aliases/Track.md | 5 - .../api/mobile/type-aliases/TrackBase.md | 37 - .../api/mobile/type-aliases/TrackId.md | 5 - .../api/mobile/type-aliases/TrackMetadata.md | 21 - .../api/mobile/type-aliases/TrackType.md | 5 - .../mobile/type-aliases/UseCallKitResult.md | 53 -- .../api/mobile/type-aliases/UsePeersResult.md | 38 - .../mobile/type-aliases/UseSandboxProps.md | 5 - .../api/mobile/type-aliases/VadStatus.md | 10 - .../api/mobile/type-aliases/VideoLayout.md | 9 - .../type-aliases/VideoPreviewViewProps.md | 41 - .../api/mobile/type-aliases/VideoQuality.md | 5 - .../mobile/type-aliases/VideoRendererProps.md | 47 - .../api/mobile/type-aliases/VideoTrack.md | 15 - .../api/mobile/typedoc-sidebar.cjs | 4 - .../api/mobile/variables/VideoPreviewView.md | 12 - .../api/mobile/variables/VideoRendererView.md | 20 - .../api/mobile/variables/useAppScreenShare.md | 15 - .../api/mobile/variables/useCallKit.md | 32 - .../api/mobile/variables/useCallKitEvent.md | 39 - .../api/mobile/variables/useCallKitService.md | 34 - .../mobile/variables/useCameraPermissions.md | 25 - .../mobile/variables/useForegroundService.md | 18 - .../variables/useMicrophonePermissions.md | 25 - .../api/server/classes/BadRequestException.md | 234 ----- .../api/server/classes/FishjamAgent.md | 530 ----------- .../server/classes/FishjamBaseException.md | 233 ----- .../classes/FishjamNotFoundException.md | 234 ----- .../api/server/classes/FishjamWSNotifier.md | 431 --------- .../api/server/classes/ForbiddenException.md | 234 ----- .../classes/MissingFishjamIdException.md | 192 ---- .../server/classes/PeerNotFoundException.md | 234 ----- .../server/classes/RoomNotFoundException.md | 234 ----- .../classes/ServiceUnavailableException.md | 234 ----- .../server/classes/UnauthorizedException.md | 234 ----- .../api/server/classes/UnknownException.md | 234 ----- .../api/server/enumerations/PeerStatus.md | 23 - .../api/server/interfaces/RoomConfig.md | 79 -- .../api/server/type-aliases/AgentCallbacks.md | 21 - .../api/server/type-aliases/AgentEvents.md | 5 - .../api/server/type-aliases/AgentTrack.md | 11 - .../type-aliases/AudioCodecParameters.md | 29 - .../server/type-aliases/ErrorEventHandler.md | 15 - .../type-aliases/ExpectedAgentEvents.md | 5 - .../api/server/type-aliases/FishjamConfig.md | 21 - .../server/type-aliases/IncomingTrackData.md | 11 - .../server/type-aliases/NotificationEvents.md | 5 - .../server/type-aliases/OutgoingTrackData.md | 11 - .../api/server/type-aliases/Peer.md | 11 - .../api/server/type-aliases/PeerAdded.md | 5 - .../api/server/type-aliases/PeerConnected.md | 5 - .../api/server/type-aliases/PeerCrashed.md | 5 - .../api/server/type-aliases/PeerDeleted.md | 5 - .../server/type-aliases/PeerDisconnected.md | 5 - .../type-aliases/PeerMetadataUpdated.md | 5 - .../api/server/type-aliases/PeerOptions.md | 7 - .../api/server/type-aliases/Room.md | 29 - .../type-aliases/RoomConfigRoomTypeEnum.md | 5 - .../type-aliases/RoomConfigVideoCodecEnum.md | 5 - .../api/server/type-aliases/RoomCrashed.md | 5 - .../api/server/type-aliases/RoomCreated.md | 5 - .../api/server/type-aliases/RoomDeleted.md | 5 - .../api/server/type-aliases/RoomId.md | 8 - .../server/type-aliases/StreamConnected.md | 5 - .../server/type-aliases/StreamDisconnected.md | 5 - .../api/server/type-aliases/TrackAdded.md | 5 - .../api/server/type-aliases/TrackId.md | 5 - .../type-aliases/TrackMetadataUpdated.md | 5 - .../api/server/type-aliases/TrackRemoved.md | 5 - .../api/server/type-aliases/TrackType.md | 5 - .../server/type-aliases/ViewerConnected.md | 5 - .../server/type-aliases/ViewerDisconnected.md | 5 - .../api/server/typedoc-sidebar.cjs | 4 - .../variables/RoomConfigRoomTypeEnum.md | 31 - .../variables/RoomConfigVideoCodecEnum.md | 15 - .../api/web/functions/useVAD.md | 31 - .../web/interfaces/FishjamProviderProps.md | 99 -- .../api/web/interfaces/JoinRoomConfig.md | 29 - .../interfaces/UseLivestreamStreamerResult.md | 62 -- .../interfaces/UseLivestreamViewerResult.md | 70 -- .../api/web/type-aliases/BandwidthLimits.md | 21 - .../web/type-aliases/ConnectStreamerConfig.md | 23 - .../web/type-aliases/ConnectViewerConfig.md | 5 - .../api/web/type-aliases/CustomSource.md | 40 - .../api/web/type-aliases/DeviceItem.md | 21 - .../type-aliases/InitializeDevicesResult.md | 29 - .../type-aliases/InitializeDevicesSettings.md | 21 - .../type-aliases/InitializeDevicesStatus.md | 5 - .../api/web/type-aliases/MiddlewareResult.md | 25 - .../api/web/type-aliases/PeerId.md | 5 - .../api/web/type-aliases/PeerWithTracks.md | 84 -- .../type-aliases/PersistLastDeviceHandlers.md | 42 - .../api/web/type-aliases/RoomType.md | 5 - .../type-aliases/SimulcastBandwidthLimits.md | 29 - .../api/web/type-aliases/StreamConfig.md | 13 - .../api/web/type-aliases/Track.md | 53 -- .../api/web/type-aliases/TrackId.md | 5 - .../api/web/type-aliases/TrackMiddleware.md | 5 - .../type-aliases/TracksMiddlewareResult.md | 33 - .../UseInitializeDevicesParams.md | 21 - .../api/web/type-aliases/UseSandboxProps.md | 17 - .../api/web/typedoc-sidebar.cjs | 4 - .../how-to/react-native/_category_.json | 4 - .../_components/configure-permissions.mdx | 91 -- .../_components/install-package.mdx | 27 - .../how-to/react-native/connecting.mdx | 92 -- .../custom-video-sources/_category_.json | 4 - .../custom-video-sources/index.mdx | 14 - .../custom-video-sources/overview.mdx | 94 -- .../custom-video-sources/vision-camera.mdx | 183 ---- .../how-to/react-native/installation.mdx | 105 --- .../how-to/react-native/list-other-peers.mdx | 48 - .../how-to/react-native/metadata.mdx | 101 -- .../how-to/react-native/start-streaming.mdx | 109 --- .../how-to/react/_category_.json | 4 - .../how-to/react/_common/metadata/header.mdx | 10 - .../react/_common/metadata/joining_room.mdx | 5 - .../how-to/react/_common/metadata/reading.mdx | 9 - .../react/_common/metadata/updating.mdx | 5 - .../how-to/react/connecting.mdx | 52 -- .../how-to/react/installation.mdx | 49 - .../how-to/react/list-other-peers.mdx | 38 - .../how-to/react/managing-devices.mdx | 90 -- .../version-0.22.0/how-to/react/metadata.mdx | 97 -- .../tutorials/react-native-quick-start.mdx | 299 ------ .../_common/agents/definition.mdx | 0 .../_common/agents/remember-to-disconnect.mdx | 0 .../_common/agents/subscriptions.mdx | 0 .../api/_category_.json | 0 .../api/mobile}/enumerations/Variant.md | 12 +- .../api/mobile/functions/FishjamProvider.md | 15 + .../api/mobile/functions/RTCPIPView.md | 15 + .../api/mobile/functions/RTCView.md | 15 + .../api/mobile/functions/useCamera.md | 122 +++ .../api/mobile}/functions/useConnection.md | 2 +- .../api/mobile}/functions/useCustomSource.md | 2 +- .../api/mobile/functions/usePeers.md | 39 + .../version-0.25.0/api/mobile/index.md | 72 ++ .../api/mobile/interfaces/JoinRoomConfig.md | 29 + .../api/mobile}/interfaces/SimulcastConfig.md | 8 +- .../interfaces/UseLivestreamStreamerResult.md | 62 ++ .../interfaces/UseLivestreamViewerResult.md | 70 ++ .../mobile}/type-aliases/AuthErrorReason.md | 0 .../mobile/type-aliases/BandwidthLimits.md | 21 + .../api/mobile}/type-aliases/Brand.md | 2 +- .../type-aliases/ConnectStreamerConfig.md | 23 + .../type-aliases/ConnectViewerConfig.md | 5 + .../api/mobile/type-aliases/CustomSource.md | 40 + .../api/mobile}/type-aliases/DeviceError.md | 2 +- .../api/mobile/type-aliases/DeviceItem.md | 21 + .../type-aliases/FishjamProviderProps.md | 5 + .../type-aliases/ForegroundServiceConfig.md | 79 ++ .../type-aliases/InitializeDevicesResult.md | 29 + .../type-aliases/InitializeDevicesSettings.md | 21 + .../type-aliases/InitializeDevicesStatus.md | 5 + .../mobile}/type-aliases/JoinErrorReason.md | 2 +- .../api/mobile}/type-aliases/Metadata.md | 6 +- .../mobile/type-aliases/MiddlewareResult.md | 25 + .../api/mobile/type-aliases/PeerId.md | 5 + .../api/mobile}/type-aliases/PeerStatus.md | 2 +- .../api/mobile/type-aliases/PeerWithTracks.md | 84 ++ .../type-aliases/PersistLastDeviceHandlers.md | 42 + .../mobile/type-aliases/RTCPIPViewProps.md | 11 + .../mobile/type-aliases/RTCVideoViewProps.md | 11 + .../mobile}/type-aliases/ReconnectConfig.md | 10 +- .../type-aliases/ReconnectionStatus.md | 2 +- .../api/mobile/type-aliases/RoomType.md | 5 + .../type-aliases/SimulcastBandwidthLimit.md | 2 +- .../type-aliases/SimulcastBandwidthLimits.md | 29 + .../api/mobile/type-aliases/StreamConfig.md | 13 + .../api/mobile/type-aliases/StreamerInputs.md | 31 + .../api/mobile/type-aliases/Track.md | 53 ++ .../type-aliases/TrackBandwidthLimit.md | 2 +- .../api/mobile/type-aliases/TrackId.md | 5 + .../mobile/type-aliases/TrackMiddleware.md | 5 + .../mobile}/type-aliases/TracksMiddleware.md | 2 +- .../type-aliases/TracksMiddlewareResult.md | 33 + .../UseInitializeDevicesParams.md | 21 + .../mobile/type-aliases/UseSandboxProps.md | 17 + .../api/mobile/typedoc-sidebar.cjs | 4 + .../api/mobile}/variables/SimulcastConfig.md | 2 +- .../mobile/variables/useForegroundService.md | 20 + .../mobile/variables/useInitializeDevices.md | 25 + .../mobile/variables/useLivestreamStreamer.md | 11 + .../mobile/variables/useLivestreamViewer.md | 11 + .../api/mobile/variables/useMicrophone.md | 9 + .../api/mobile/variables/useSandbox.md | 60 ++ .../api/mobile/variables/useScreenShare.md | 81 ++ .../mobile/variables/useUpdatePeerMetadata.md | 31 + .../api/mobile/variables/useVAD.md | 20 + .../api/reference.md | 4 +- .../api/server-python/fishjam/agent/index.md | 275 ++++++ .../api/server-python/fishjam/errors/index.md | 59 ++ .../api/server-python/fishjam/events/index.md | 863 ++++++++++++++++++ .../api/server-python/fishjam/index.md | 596 ++++++++++++ .../fishjam/integrations/gemini/index.md | 18 + .../fishjam/integrations/index.md | 12 + .../api/server-python/fishjam/peer/index.md | 100 ++ .../api/server-python/fishjam/room/index.md | 157 ++++ .../api/server/classes/BadRequestException.md | 65 ++ .../api/server/classes/FishjamAgent.md | 166 ++++ .../server/classes/FishjamBaseException.md | 64 ++ .../api/server/classes/FishjamClient.md | 32 +- .../classes/FishjamNotFoundException.md | 65 ++ .../api/server/classes/FishjamWSNotifier.md | 33 + .../api/server/classes/ForbiddenException.md | 65 ++ .../classes/MissingFishjamIdException.md | 23 + .../server/classes/PeerNotFoundException.md | 65 ++ .../server/classes/RoomNotFoundException.md | 65 ++ .../classes/ServiceUnavailableException.md | 65 ++ .../server/classes/UnauthorizedException.md | 65 ++ .../api/server/classes/UnknownException.md | 65 ++ .../api/server/enumerations/PeerStatus.md | 23 + .../api/server/enumerations/RoomType.md | 55 ++ .../api/server/enumerations/VideoCodec.md | 23 + .../api/server/index.md | 9 +- .../api/server/interfaces/PeerOptionsAgent.md | 33 + .../server/interfaces/PeerOptionsWebRTC.md | 39 + .../api/server/interfaces/RoomConfig.md | 75 ++ .../api/server/interfaces/ServerMessage.md | 70 +- .../api/server/interfaces/StreamerToken.md | 4 +- .../api/server/interfaces/ViewerToken.md | 4 +- .../api/server/type-aliases/AgentCallbacks.md | 21 + .../api/server/type-aliases/AgentEvents.md | 5 + .../api/server/type-aliases/AgentTrack.md | 11 + .../type-aliases/AudioCodecParameters.md | 29 + .../api/server/type-aliases/Brand.md | 2 +- .../server/type-aliases/CloseEventHandler.md | 2 +- .../server/type-aliases/ErrorEventHandler.md | 15 + .../type-aliases/ExpectedAgentEvents.md | 5 + .../api/server/type-aliases/ExpectedEvents.md | 2 +- .../api/server/type-aliases/FishjamConfig.md | 21 + .../server/type-aliases/IncomingTrackData.md | 11 + .../server/type-aliases/IncomingTrackImage.md | 5 + .../server/type-aliases/NotificationEvents.md | 5 + .../server/type-aliases/OutgoingTrackData.md | 11 + .../api/server/type-aliases/Peer.md | 11 + .../api/server/type-aliases/PeerAdded.md | 5 + .../api/server/type-aliases/PeerConnected.md | 5 + .../api/server/type-aliases/PeerCrashed.md | 5 + .../api/server/type-aliases/PeerDeleted.md | 5 + .../server/type-aliases/PeerDisconnected.md | 5 + .../api/server/type-aliases/PeerId.md | 2 +- .../type-aliases/PeerMetadataUpdated.md | 5 + .../api/server/type-aliases/PeerOptions.md | 7 + .../api/server/type-aliases/Room.md | 29 + .../api/server/type-aliases/RoomCrashed.md | 5 + .../api/server/type-aliases/RoomCreated.md | 5 + .../api/server/type-aliases/RoomDeleted.md | 5 + .../api/server/type-aliases/RoomId.md | 8 + .../server/type-aliases/StreamConnected.md | 5 + .../server/type-aliases/StreamDisconnected.md | 5 + .../api/server/type-aliases/TrackAdded.md | 5 + .../api/server/type-aliases/TrackId.md | 5 + .../type-aliases/TrackMetadataUpdated.md | 5 + .../api/server/type-aliases/TrackRemoved.md | 5 + .../api/server/type-aliases/TrackType.md | 5 + .../server/type-aliases/ViewerConnected.md | 5 + .../server/type-aliases/ViewerDisconnected.md | 5 + .../api/server/typedoc-sidebar.cjs | 4 + .../api/server/variables/ServerMessage.md | 2 +- .../api/web/enumerations/Variant.md | 43 + .../api/web/functions/FishjamProvider.md | 2 +- .../api/web/functions/useCamera.md | 28 +- .../api/web}/functions/useConnection.md | 14 +- .../api/web/functions/useCustomSource.md | 44 + .../api/web/functions/useDataChannel.md | 11 + .../api/web/functions/useInitializeDevices.md | 2 +- .../web/functions/useLivestreamStreamer.md | 2 +- .../api/web/functions/useLivestreamViewer.md | 2 +- .../api/web/functions/useMicrophone.md | 28 +- .../api/web/functions/usePeers.md | 2 +- .../api/web/functions/useSandbox.md | 2 +- .../api/web/functions/useScreenShare.md | 2 +- .../web/functions/useUpdatePeerMetadata.md | 2 +- .../api/web/functions/useVAD.md | 20 + .../api/web/index.md | 4 + .../api/web/interfaces/DataChannelOptions.md | 16 + .../web/interfaces/FishjamProviderProps.md | 107 +++ .../api/web/interfaces/JoinRoomConfig.md | 29 + .../api/web/interfaces/SimulcastConfig.md | 27 + .../interfaces/UseLivestreamStreamerResult.md | 62 ++ .../interfaces/UseLivestreamViewerResult.md | 70 ++ .../api/web/type-aliases/AuthErrorReason.md | 5 + .../api/web/type-aliases/BandwidthLimits.md | 21 + .../api/web}/type-aliases/Brand.md | 4 +- .../web/type-aliases/ConnectStreamerConfig.md | 23 + .../web/type-aliases/ConnectViewerConfig.md | 5 + .../api/web/type-aliases/CustomSource.md | 40 + .../api/web/type-aliases/DataCallback.md | 17 + .../api/web/type-aliases/DeviceError.md | 5 + .../api/web/type-aliases/DeviceItem.md | 21 + .../type-aliases/InitializeDevicesResult.md | 29 + .../type-aliases/InitializeDevicesSettings.md | 21 + .../type-aliases/InitializeDevicesStatus.md | 5 + .../api/web/type-aliases/JoinErrorReason.md | 5 + .../api/web/type-aliases/Metadata.md | 28 + .../api/web/type-aliases/MiddlewareResult.md | 25 + .../api/web/type-aliases/PeerId.md | 5 + .../api/web}/type-aliases/PeerStatus.md | 4 +- .../api/web/type-aliases/PeerWithTracks.md | 84 ++ .../type-aliases/PersistLastDeviceHandlers.md | 42 + .../api/web/type-aliases/ReconnectConfig.md | 37 + .../web/type-aliases/ReconnectionStatus.md | 5 + .../api/web/type-aliases/RoomType.md | 5 + .../type-aliases/SimulcastBandwidthLimit.md | 9 + .../type-aliases/SimulcastBandwidthLimits.md | 29 + .../api/web/type-aliases/StreamConfig.md | 13 + .../api/web/type-aliases/StreamerInputs.md | 2 +- .../api/web/type-aliases/Track.md | 53 ++ .../web/type-aliases/TrackBandwidthLimit.md | 8 + .../api/web/type-aliases/TrackId.md | 5 + .../api/web/type-aliases/TrackMiddleware.md | 5 + .../api/web/type-aliases/TracksMiddleware.md | 16 + .../type-aliases/TracksMiddlewareResult.md | 33 + .../web/type-aliases/UseDataChannelResult.md | 101 ++ .../UseInitializeDevicesParams.md | 21 + .../api/web/type-aliases/UseSandboxProps.md | 17 + .../api/web/typedoc-sidebar.cjs | 4 + .../api/web/variables/SimulcastConfig.md | 5 + .../explanation/_category_.json | 0 .../explanation/agent-internals.mdx | 0 .../explanation/architecture.mdx | 0 .../explanation/data-channels.mdx | 51 ++ .../explanation/glossary.md | 0 .../explanation/public-livestreams.mdx | 28 +- .../explanation/room-types.mdx | 0 .../explanation/sandbox-api-concept.mdx | 7 +- .../explanation/security-tokens.mdx | 0 .../explanation/what-is-fishjam.mdx | 0 .../how-to/_category_.json | 0 .../how-to/_common/metadata/header.mdx | 0 .../how-to/_common/metadata/joining_room.mdx | 0 .../how-to/_common/metadata/reading.mdx | 0 .../how-to/_common/metadata/updating.mdx | 0 .../how-to/backend/_category_.json | 0 .../how-to/backend/fastapi-example.mdx | 0 .../how-to/backend/fastify-example.mdx | 0 .../how-to/backend/production-deployment.mdx | 0 .../how-to/backend/server-setup.mdx | 3 +- .../how-to/client/_category_.json | 8 + .../how-to/client}/background-streaming.mdx | 44 +- .../how-to/client/connecting.mdx | 173 ++++ .../how-to/client}/custom-sources.mdx | 9 +- .../how-to/client/debug-logging.mdx | 71 ++ .../how-to/client/installation.mdx | 208 +++++ .../how-to/client/list-other-peers.mdx | 99 ++ .../how-to/client/managing-devices.mdx | 254 ++++++ .../version-0.25.0/how-to/client/metadata.mdx | 211 +++++ .../how-to/client/migration-guide.mdx | 442 +++++++++ .../how-to/client/picture-in-picture.mdx | 585 ++++++++++++ .../how-to/client}/reconnection-handling.mdx | 9 +- .../how-to/client}/screensharing.mdx | 93 +- .../how-to/client}/start-streaming.mdx | 70 +- .../how-to/client}/stream-middleware.mdx | 9 +- .../how-to/features/_category_.json | 0 .../how-to/features/audio-only-calls.mdx | 2 +- .../how-to/features/sandbox-api-testing.mdx | 6 +- .../features/selective-subscriptions.mdx | 0 .../how-to/features/text-chat.mdx | 212 +++++ .../how-to/features/whip-whep.mdx | 0 .../react-native/assets/ios-new-folder.png | Bin .../react-native/assets/ios-new-group.png | Bin .../react-native/assets/ios-new-target.png | Bin .../how-to/troubleshooting/_category_.json | 0 .../how-to/troubleshooting/video-codecs.mdx | 0 .../index.mdx | 3 +- .../tutorials/_category_.json | 0 .../tutorials/agents.mdx | 0 .../tutorials/backend-quick-start.mdx | 0 .../tutorials/gemini-live-integration.mdx | 277 ++++++ .../tutorials/livestreaming.mdx | 153 +++- .../tutorials/react-native-quick-start.mdx | 430 +++++++++ .../tutorials/react-quick-start.mdx | 6 +- ...bars.json => version-0.25.0-sidebars.json} | 0 versions.json | 2 +- 427 files changed, 9555 insertions(+), 8001 deletions(-) delete mode 100644 versioned_docs/version-0.22.0/api/mobile/functions/FishjamRoom.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/functions/setOverwriteDebugConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/functions/useAudioSettings.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/functions/useBandwidthEstimation.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/functions/useCamera.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/functions/useMicrophone.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/functions/usePeers.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/functions/useSandbox.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/functions/useScreenShare.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/functions/useUpdatePeerMetadata.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/index.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/AppScreenShareData.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioOutputDevice.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioOutputDeviceType.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioSessionMode.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioTrack.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/CallKitAction.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/CallKitConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/Camera.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraConfigBase.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraFacingDirection.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraId.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/ConnectionConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/DebugConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/DistinguishedTracks.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/EncodingReason.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/FishjamRoomProps.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/ForegroundServiceConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/GenericMetadata.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/JoinRoomConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/Peer.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/PeerId.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/PeerTrackMetadata.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/PeerWithTracks.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/ReconnectionStatus.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/RoomType.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/ScreenShareOptions.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/ScreenShareQuality.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/SimulcastConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/Track.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackBase.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackId.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackMetadata.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackType.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/UseCallKitResult.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/UsePeersResult.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/UseSandboxProps.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/VadStatus.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoLayout.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoPreviewViewProps.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoQuality.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoRendererProps.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoTrack.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/typedoc-sidebar.cjs delete mode 100644 versioned_docs/version-0.22.0/api/mobile/variables/VideoPreviewView.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/variables/VideoRendererView.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/variables/useAppScreenShare.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/variables/useCallKit.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/variables/useCallKitEvent.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/variables/useCallKitService.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/variables/useCameraPermissions.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/variables/useForegroundService.md delete mode 100644 versioned_docs/version-0.22.0/api/mobile/variables/useMicrophonePermissions.md delete mode 100644 versioned_docs/version-0.22.0/api/server/classes/BadRequestException.md delete mode 100644 versioned_docs/version-0.22.0/api/server/classes/FishjamAgent.md delete mode 100644 versioned_docs/version-0.22.0/api/server/classes/FishjamBaseException.md delete mode 100644 versioned_docs/version-0.22.0/api/server/classes/FishjamNotFoundException.md delete mode 100644 versioned_docs/version-0.22.0/api/server/classes/FishjamWSNotifier.md delete mode 100644 versioned_docs/version-0.22.0/api/server/classes/ForbiddenException.md delete mode 100644 versioned_docs/version-0.22.0/api/server/classes/MissingFishjamIdException.md delete mode 100644 versioned_docs/version-0.22.0/api/server/classes/PeerNotFoundException.md delete mode 100644 versioned_docs/version-0.22.0/api/server/classes/RoomNotFoundException.md delete mode 100644 versioned_docs/version-0.22.0/api/server/classes/ServiceUnavailableException.md delete mode 100644 versioned_docs/version-0.22.0/api/server/classes/UnauthorizedException.md delete mode 100644 versioned_docs/version-0.22.0/api/server/classes/UnknownException.md delete mode 100644 versioned_docs/version-0.22.0/api/server/enumerations/PeerStatus.md delete mode 100644 versioned_docs/version-0.22.0/api/server/interfaces/RoomConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/AgentCallbacks.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/AgentEvents.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/AgentTrack.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/AudioCodecParameters.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/ErrorEventHandler.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/ExpectedAgentEvents.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/FishjamConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/IncomingTrackData.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/NotificationEvents.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/OutgoingTrackData.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/Peer.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/PeerAdded.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/PeerConnected.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/PeerCrashed.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/PeerDeleted.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/PeerDisconnected.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/PeerMetadataUpdated.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/PeerOptions.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/Room.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/RoomConfigRoomTypeEnum.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/RoomConfigVideoCodecEnum.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/RoomCrashed.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/RoomCreated.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/RoomDeleted.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/RoomId.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/StreamConnected.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/StreamDisconnected.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/TrackAdded.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/TrackId.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/TrackMetadataUpdated.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/TrackRemoved.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/TrackType.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/ViewerConnected.md delete mode 100644 versioned_docs/version-0.22.0/api/server/type-aliases/ViewerDisconnected.md delete mode 100644 versioned_docs/version-0.22.0/api/server/typedoc-sidebar.cjs delete mode 100644 versioned_docs/version-0.22.0/api/server/variables/RoomConfigRoomTypeEnum.md delete mode 100644 versioned_docs/version-0.22.0/api/server/variables/RoomConfigVideoCodecEnum.md delete mode 100644 versioned_docs/version-0.22.0/api/web/functions/useVAD.md delete mode 100644 versioned_docs/version-0.22.0/api/web/interfaces/FishjamProviderProps.md delete mode 100644 versioned_docs/version-0.22.0/api/web/interfaces/JoinRoomConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/web/interfaces/UseLivestreamStreamerResult.md delete mode 100644 versioned_docs/version-0.22.0/api/web/interfaces/UseLivestreamViewerResult.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/BandwidthLimits.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/ConnectStreamerConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/ConnectViewerConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/CustomSource.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/DeviceItem.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/InitializeDevicesResult.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/InitializeDevicesSettings.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/InitializeDevicesStatus.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/MiddlewareResult.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/PeerId.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/PeerWithTracks.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/PersistLastDeviceHandlers.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/RoomType.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/SimulcastBandwidthLimits.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/StreamConfig.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/Track.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/TrackId.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/TrackMiddleware.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/TracksMiddlewareResult.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/UseInitializeDevicesParams.md delete mode 100644 versioned_docs/version-0.22.0/api/web/type-aliases/UseSandboxProps.md delete mode 100644 versioned_docs/version-0.22.0/api/web/typedoc-sidebar.cjs delete mode 100644 versioned_docs/version-0.22.0/how-to/react-native/_category_.json delete mode 100644 versioned_docs/version-0.22.0/how-to/react-native/_components/configure-permissions.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react-native/_components/install-package.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react-native/connecting.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react-native/custom-video-sources/_category_.json delete mode 100644 versioned_docs/version-0.22.0/how-to/react-native/custom-video-sources/index.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react-native/custom-video-sources/overview.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react-native/custom-video-sources/vision-camera.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react-native/installation.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react-native/list-other-peers.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react-native/metadata.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react-native/start-streaming.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react/_category_.json delete mode 100644 versioned_docs/version-0.22.0/how-to/react/_common/metadata/header.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react/_common/metadata/joining_room.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react/_common/metadata/reading.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react/_common/metadata/updating.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react/connecting.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react/installation.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react/list-other-peers.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react/managing-devices.mdx delete mode 100644 versioned_docs/version-0.22.0/how-to/react/metadata.mdx delete mode 100644 versioned_docs/version-0.22.0/tutorials/react-native-quick-start.mdx rename versioned_docs/{version-0.22.0 => version-0.25.0}/_common/agents/definition.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/_common/agents/remember-to-disconnect.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/_common/agents/subscriptions.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/_category_.json (100%) rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/enumerations/Variant.md (50%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/functions/FishjamProvider.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/functions/RTCPIPView.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/functions/RTCView.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/functions/useCamera.md rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/functions/useConnection.md (82%) rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/functions/useCustomSource.md (78%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/functions/usePeers.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/index.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/interfaces/JoinRoomConfig.md rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/interfaces/SimulcastConfig.md (56%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/interfaces/UseLivestreamStreamerResult.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/interfaces/UseLivestreamViewerResult.md rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/type-aliases/AuthErrorReason.md (100%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/BandwidthLimits.md rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/type-aliases/Brand.md (54%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/ConnectStreamerConfig.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/ConnectViewerConfig.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/CustomSource.md rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/type-aliases/DeviceError.md (50%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/DeviceItem.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/FishjamProviderProps.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/ForegroundServiceConfig.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/InitializeDevicesResult.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/InitializeDevicesSettings.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/InitializeDevicesStatus.md rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/type-aliases/JoinErrorReason.md (63%) rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/type-aliases/Metadata.md (76%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/MiddlewareResult.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/PeerId.md rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/type-aliases/PeerStatus.md (67%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/PeerWithTracks.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/PersistLastDeviceHandlers.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/RTCPIPViewProps.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/RTCVideoViewProps.md rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/type-aliases/ReconnectConfig.md (56%) rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/type-aliases/ReconnectionStatus.md (66%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/RoomType.md rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/type-aliases/SimulcastBandwidthLimit.md (87%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/SimulcastBandwidthLimits.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/StreamConfig.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/StreamerInputs.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/Track.md rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/type-aliases/TrackBandwidthLimit.md (85%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/TrackId.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/TrackMiddleware.md rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/type-aliases/TracksMiddleware.md (71%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/TracksMiddlewareResult.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/UseInitializeDevicesParams.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/type-aliases/UseSandboxProps.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/typedoc-sidebar.cjs rename versioned_docs/{version-0.22.0/api/web => version-0.25.0/api/mobile}/variables/SimulcastConfig.md (70%) create mode 100644 versioned_docs/version-0.25.0/api/mobile/variables/useForegroundService.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/variables/useInitializeDevices.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/variables/useLivestreamStreamer.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/variables/useLivestreamViewer.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/variables/useMicrophone.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/variables/useSandbox.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/variables/useScreenShare.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/variables/useUpdatePeerMetadata.md create mode 100644 versioned_docs/version-0.25.0/api/mobile/variables/useVAD.md rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/reference.md (90%) create mode 100644 versioned_docs/version-0.25.0/api/server-python/fishjam/agent/index.md create mode 100644 versioned_docs/version-0.25.0/api/server-python/fishjam/errors/index.md create mode 100644 versioned_docs/version-0.25.0/api/server-python/fishjam/events/index.md create mode 100644 versioned_docs/version-0.25.0/api/server-python/fishjam/index.md create mode 100644 versioned_docs/version-0.25.0/api/server-python/fishjam/integrations/gemini/index.md create mode 100644 versioned_docs/version-0.25.0/api/server-python/fishjam/integrations/index.md create mode 100644 versioned_docs/version-0.25.0/api/server-python/fishjam/peer/index.md create mode 100644 versioned_docs/version-0.25.0/api/server-python/fishjam/room/index.md create mode 100644 versioned_docs/version-0.25.0/api/server/classes/BadRequestException.md create mode 100644 versioned_docs/version-0.25.0/api/server/classes/FishjamAgent.md create mode 100644 versioned_docs/version-0.25.0/api/server/classes/FishjamBaseException.md rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/server/classes/FishjamClient.md (65%) create mode 100644 versioned_docs/version-0.25.0/api/server/classes/FishjamNotFoundException.md create mode 100644 versioned_docs/version-0.25.0/api/server/classes/FishjamWSNotifier.md create mode 100644 versioned_docs/version-0.25.0/api/server/classes/ForbiddenException.md create mode 100644 versioned_docs/version-0.25.0/api/server/classes/MissingFishjamIdException.md create mode 100644 versioned_docs/version-0.25.0/api/server/classes/PeerNotFoundException.md create mode 100644 versioned_docs/version-0.25.0/api/server/classes/RoomNotFoundException.md create mode 100644 versioned_docs/version-0.25.0/api/server/classes/ServiceUnavailableException.md create mode 100644 versioned_docs/version-0.25.0/api/server/classes/UnauthorizedException.md create mode 100644 versioned_docs/version-0.25.0/api/server/classes/UnknownException.md create mode 100644 versioned_docs/version-0.25.0/api/server/enumerations/PeerStatus.md create mode 100644 versioned_docs/version-0.25.0/api/server/enumerations/RoomType.md create mode 100644 versioned_docs/version-0.25.0/api/server/enumerations/VideoCodec.md rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/server/index.md (91%) create mode 100644 versioned_docs/version-0.25.0/api/server/interfaces/PeerOptionsAgent.md create mode 100644 versioned_docs/version-0.25.0/api/server/interfaces/PeerOptionsWebRTC.md create mode 100644 versioned_docs/version-0.25.0/api/server/interfaces/RoomConfig.md rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/server/interfaces/ServerMessage.md (55%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/server/interfaces/StreamerToken.md (54%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/server/interfaces/ViewerToken.md (53%) create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/AgentCallbacks.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/AgentEvents.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/AgentTrack.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/AudioCodecParameters.md rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/server/type-aliases/Brand.md (55%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/server/type-aliases/CloseEventHandler.md (50%) create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/ErrorEventHandler.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/ExpectedAgentEvents.md rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/server/type-aliases/ExpectedEvents.md (64%) create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/FishjamConfig.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/IncomingTrackData.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/IncomingTrackImage.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/NotificationEvents.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/OutgoingTrackData.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/Peer.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/PeerAdded.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/PeerConnected.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/PeerCrashed.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/PeerDeleted.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/PeerDisconnected.md rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/server/type-aliases/PeerId.md (50%) create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/PeerMetadataUpdated.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/PeerOptions.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/Room.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/RoomCrashed.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/RoomCreated.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/RoomDeleted.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/RoomId.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/StreamConnected.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/StreamDisconnected.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/TrackAdded.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/TrackId.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/TrackMetadataUpdated.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/TrackRemoved.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/TrackType.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/ViewerConnected.md create mode 100644 versioned_docs/version-0.25.0/api/server/type-aliases/ViewerDisconnected.md create mode 100644 versioned_docs/version-0.25.0/api/server/typedoc-sidebar.cjs rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/server/variables/ServerMessage.md (60%) create mode 100644 versioned_docs/version-0.25.0/api/web/enumerations/Variant.md rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/web/functions/FishjamProvider.md (55%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/web/functions/useCamera.md (75%) rename versioned_docs/{version-0.22.0/api/mobile => version-0.25.0/api/web}/functions/useConnection.md (53%) create mode 100644 versioned_docs/version-0.25.0/api/web/functions/useCustomSource.md create mode 100644 versioned_docs/version-0.25.0/api/web/functions/useDataChannel.md rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/web/functions/useInitializeDevices.md (72%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/web/functions/useLivestreamStreamer.md (60%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/web/functions/useLivestreamViewer.md (54%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/web/functions/useMicrophone.md (77%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/web/functions/usePeers.md (85%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/web/functions/useSandbox.md (86%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/web/functions/useScreenShare.md (91%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/web/functions/useUpdatePeerMetadata.md (70%) create mode 100644 versioned_docs/version-0.25.0/api/web/functions/useVAD.md rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/web/index.md (93%) create mode 100644 versioned_docs/version-0.25.0/api/web/interfaces/DataChannelOptions.md create mode 100644 versioned_docs/version-0.25.0/api/web/interfaces/FishjamProviderProps.md create mode 100644 versioned_docs/version-0.25.0/api/web/interfaces/JoinRoomConfig.md create mode 100644 versioned_docs/version-0.25.0/api/web/interfaces/SimulcastConfig.md create mode 100644 versioned_docs/version-0.25.0/api/web/interfaces/UseLivestreamStreamerResult.md create mode 100644 versioned_docs/version-0.25.0/api/web/interfaces/UseLivestreamViewerResult.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/AuthErrorReason.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/BandwidthLimits.md rename versioned_docs/{version-0.22.0/api/mobile => version-0.25.0/api/web}/type-aliases/Brand.md (51%) create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/ConnectStreamerConfig.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/ConnectViewerConfig.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/CustomSource.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/DataCallback.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/DeviceError.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/DeviceItem.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/InitializeDevicesResult.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/InitializeDevicesSettings.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/InitializeDevicesStatus.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/JoinErrorReason.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/Metadata.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/MiddlewareResult.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/PeerId.md rename versioned_docs/{version-0.22.0/api/mobile => version-0.25.0/api/web}/type-aliases/PeerStatus.md (52%) create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/PeerWithTracks.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/PersistLastDeviceHandlers.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/ReconnectConfig.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/ReconnectionStatus.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/RoomType.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/SimulcastBandwidthLimit.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/SimulcastBandwidthLimits.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/StreamConfig.md rename versioned_docs/{version-0.22.0 => version-0.25.0}/api/web/type-aliases/StreamerInputs.md (78%) create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/Track.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/TrackBandwidthLimit.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/TrackId.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/TrackMiddleware.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/TracksMiddleware.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/TracksMiddlewareResult.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/UseDataChannelResult.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/UseInitializeDevicesParams.md create mode 100644 versioned_docs/version-0.25.0/api/web/type-aliases/UseSandboxProps.md create mode 100644 versioned_docs/version-0.25.0/api/web/typedoc-sidebar.cjs create mode 100644 versioned_docs/version-0.25.0/api/web/variables/SimulcastConfig.md rename versioned_docs/{version-0.22.0 => version-0.25.0}/explanation/_category_.json (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/explanation/agent-internals.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/explanation/architecture.mdx (100%) create mode 100644 versioned_docs/version-0.25.0/explanation/data-channels.mdx rename versioned_docs/{version-0.22.0 => version-0.25.0}/explanation/glossary.md (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/explanation/public-livestreams.mdx (91%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/explanation/room-types.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/explanation/sandbox-api-concept.mdx (94%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/explanation/security-tokens.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/explanation/what-is-fishjam.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/_category_.json (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/_common/metadata/header.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/_common/metadata/joining_room.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/_common/metadata/reading.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/_common/metadata/updating.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/backend/_category_.json (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/backend/fastapi-example.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/backend/fastify-example.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/backend/production-deployment.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/backend/server-setup.mdx (97%) create mode 100644 versioned_docs/version-0.25.0/how-to/client/_category_.json rename versioned_docs/{version-0.22.0/how-to/react-native => version-0.25.0/how-to/client}/background-streaming.mdx (75%) create mode 100644 versioned_docs/version-0.25.0/how-to/client/connecting.mdx rename versioned_docs/{version-0.22.0/how-to/react => version-0.25.0/how-to/client}/custom-sources.mdx (95%) create mode 100644 versioned_docs/version-0.25.0/how-to/client/debug-logging.mdx create mode 100644 versioned_docs/version-0.25.0/how-to/client/installation.mdx create mode 100644 versioned_docs/version-0.25.0/how-to/client/list-other-peers.mdx create mode 100644 versioned_docs/version-0.25.0/how-to/client/managing-devices.mdx create mode 100644 versioned_docs/version-0.25.0/how-to/client/metadata.mdx create mode 100644 versioned_docs/version-0.25.0/how-to/client/migration-guide.mdx create mode 100644 versioned_docs/version-0.25.0/how-to/client/picture-in-picture.mdx rename versioned_docs/{version-0.22.0/how-to/react-native => version-0.25.0/how-to/client}/reconnection-handling.mdx (84%) rename versioned_docs/{version-0.22.0/how-to/react-native => version-0.25.0/how-to/client}/screensharing.mdx (66%) rename versioned_docs/{version-0.22.0/how-to/react => version-0.25.0/how-to/client}/start-streaming.mdx (51%) rename versioned_docs/{version-0.22.0/how-to/react => version-0.25.0/how-to/client}/stream-middleware.mdx (93%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/features/_category_.json (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/features/audio-only-calls.mdx (96%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/features/sandbox-api-testing.mdx (97%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/features/selective-subscriptions.mdx (100%) create mode 100644 versioned_docs/version-0.25.0/how-to/features/text-chat.mdx rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/features/whip-whep.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/react-native/assets/ios-new-folder.png (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/react-native/assets/ios-new-group.png (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/react-native/assets/ios-new-target.png (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/troubleshooting/_category_.json (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/how-to/troubleshooting/video-codecs.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/index.mdx (95%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/tutorials/_category_.json (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/tutorials/agents.mdx (100%) rename versioned_docs/{version-0.22.0 => version-0.25.0}/tutorials/backend-quick-start.mdx (100%) create mode 100644 versioned_docs/version-0.25.0/tutorials/gemini-live-integration.mdx rename versioned_docs/{version-0.22.0 => version-0.25.0}/tutorials/livestreaming.mdx (68%) create mode 100644 versioned_docs/version-0.25.0/tutorials/react-native-quick-start.mdx rename versioned_docs/{version-0.22.0 => version-0.25.0}/tutorials/react-quick-start.mdx (97%) rename versioned_sidebars/{version-0.22.0-sidebars.json => version-0.25.0-sidebars.json} (100%) diff --git a/api/fishjam-server b/api/fishjam-server index 4d7c5508..2a8c6e20 160000 --- a/api/fishjam-server +++ b/api/fishjam-server @@ -1 +1 @@ -Subproject commit 4d7c550873599856cece48d95be58b8636016dbd +Subproject commit 2a8c6e20cd551f8ba9528b92903820327331a076 diff --git a/api/protos b/api/protos index 1ff0f980..9d807b55 160000 --- a/api/protos +++ b/api/protos @@ -1 +1 @@ -Subproject commit 1ff0f9806c53da1d29be98e14d31096cdabeffef +Subproject commit 9d807b55279de385136f82b12f5df75d73104514 diff --git a/api/room-manager b/api/room-manager index ac1122a5..31836f4e 160000 --- a/api/room-manager +++ b/api/room-manager @@ -1 +1 @@ -Subproject commit ac1122a55f70c7f06872e4106b6452a9f199480b +Subproject commit 31836f4ed6c8551b3892cea50d2872cdf2292e71 diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 1bc50728..5b20e71e 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -65,12 +65,6 @@ function injectTypeDocSidebar( version: SidebarItemsGeneratorVersion, items: NormalizedSidebar, ): NormalizedSidebar { - const docs_without_python_reference = ["0.22.0"]; - - const exclude_python = docs_without_python_reference.includes( - version.versionName, - ); - return items.map((item) => { if (item.customProps?.id === "generated-api" && item.type === "category") { const injectedItems: (CustomInjectedCategory | NormalizedSidebarItem)[] = @@ -101,18 +95,16 @@ function injectTypeDocSidebar( }, ]; - if (!exclude_python) { - injectedItems.push({ - type: "category", - label: "Server SDK for Python", - items: [ - { - type: "autogenerated", - dirName: "api/server-python", - }, - ], - }); - } + injectedItems.push({ + type: "category", + label: "Server SDK for Python", + items: [ + { + type: "autogenerated", + dirName: "api/server-python", + }, + ], + }); return { ...item, diff --git a/packages/js-server-sdk b/packages/js-server-sdk index 7aa91272..5093c326 160000 --- a/packages/js-server-sdk +++ b/packages/js-server-sdk @@ -1 +1 @@ -Subproject commit 7aa91272ab7d18fdf42ce6de3cf7585b5d0dd285 +Subproject commit 5093c326f087fbff97ecb84523e27d6e67ca1662 diff --git a/packages/python-server-sdk b/packages/python-server-sdk index fb05c3cb..0889d548 160000 --- a/packages/python-server-sdk +++ b/packages/python-server-sdk @@ -1 +1 @@ -Subproject commit fb05c3cb78450e442ecd683e679e0d3654ac7f1d +Subproject commit 0889d54851167442d6a9318847a269f9c7466854 diff --git a/packages/web-client-sdk b/packages/web-client-sdk index 52dcce8e..b73a7b1d 160000 --- a/packages/web-client-sdk +++ b/packages/web-client-sdk @@ -1 +1 @@ -Subproject commit 52dcce8e5d9028b4b4a64ceba99c1e70db0838ed +Subproject commit b73a7b1d96c4a63909b2bb641aa3285b51a01999 diff --git a/static/api/fishjam-server-openapi.yaml b/static/api/fishjam-server-openapi.yaml index c6802c5b..462da28d 100644 --- a/static/api/fishjam-server-openapi.yaml +++ b/static/api/fishjam-server-openapi.yaml @@ -276,6 +276,10 @@ components: audioOnly: description: True if stream is restricted to audio only type: boolean + connectedViewers: + description: Number of connected viewers + minimum: 0 + type: integer id: description: Assigned stream id type: string @@ -296,6 +300,7 @@ components: - public - viewers - streamers + - connectedViewers title: Stream type: object StreamConfig: @@ -364,15 +369,22 @@ components: type: string Subscriptions: description: Describes peer's subscriptions in manual mode - items: - properties: - peerId: + properties: + peers: + description: List of peer IDs this peer subscribes to + items: $ref: "#/components/schemas/PeerID" - trackId: + type: array + tracks: + description: List of track IDs this peer subscribes to + items: $ref: "#/components/schemas/TrackID" - type: string + type: array + required: + - peers + - tracks title: Subscriptions - type: array + type: object Track: description: Describes media track of a Peer properties: @@ -438,7 +450,7 @@ info: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 title: Fishjam Media Server - version: 0.22.0 + version: 0.23.0 openapi: 3.0.0 paths: /livestream: diff --git a/static/api/protobuf/agent_notifications.proto b/static/api/protobuf/agent_notifications.proto index c54c7bec..2be78962 100644 --- a/static/api/protobuf/agent_notifications.proto +++ b/static/api/protobuf/agent_notifications.proto @@ -44,12 +44,17 @@ message AgentRequest { string track_id = 1; } + message CaptureImage { + string track_id = 1; + } + oneof content { AuthRequest auth_request = 1; AddTrack add_track = 2; RemoveTrack remove_track = 3; TrackData track_data = 4; InterruptTrack interrupt_track = 5; + CaptureImage capture_image = 6; } } @@ -65,8 +70,15 @@ message AgentResponse { bytes data = 3; } + message TrackImage { + string track_id = 1; + string content_type = 2; + bytes data = 3; + } + oneof content { Authenticated authenticated = 1; TrackData track_data = 2; + TrackImage track_image = 3; } } diff --git a/static/api/protobuf/server_notifications.proto b/static/api/protobuf/server_notifications.proto index 75ae6a88..c833974d 100644 --- a/static/api/protobuf/server_notifications.proto +++ b/static/api/protobuf/server_notifications.proto @@ -74,7 +74,7 @@ message ServerMessage { EVENT_TYPE_SERVER_NOTIFICATION = 1; } - // Request sent by peer to subsribe for certain message type + // Request sent by peer to subscribe for certain message type message SubscribeRequest { EventType event_type = 1; } @@ -100,7 +100,7 @@ message ServerMessage { string component_id = 2; } - // Notification sent when the HLS recording is successfully uploded to AWS S3 + // Notification sent when the HLS recording is successfully uploaded to AWS S3 message HlsUploaded { string room_id = 1; } @@ -148,6 +148,26 @@ message ServerMessage { notifications.Track track = 4; } + // Notification sent when a peer creates a channel + message ChannelAdded { + string room_id = 1; + oneof endpoint_info { + string peer_id = 2; + string component_id = 3; + } + string channel_id = 4; + } + + // Notification sent when a peer deletes a channel + message ChannelRemoved { + string room_id = 1; + oneof endpoint_info { + string peer_id = 2; + string component_id = 3; + } + string channel_id = 4; + } + // Notification sent when streamer successfully connects message StreamConnected { string stream_id = 1; @@ -209,5 +229,7 @@ message ServerMessage { ViewerDisconnected viewer_disconnected = 25; StreamerConnected streamer_connected = 26; StreamerDisconnected streamer_disconnected = 27; + ChannelAdded channel_added = 28; + ChannelRemoved channel_removed = 29; } } diff --git a/static/api/room-manager-openapi.yaml b/static/api/room-manager-openapi.yaml index 40c4b223..264f8986 100644 --- a/static/api/room-manager-openapi.yaml +++ b/static/api/room-manager-openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: Fishjam Room Manager - version: 0.22.0 + version: 0.25.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 diff --git a/versioned_docs/version-0.22.0/api/mobile/functions/FishjamRoom.md b/versioned_docs/version-0.22.0/api/mobile/functions/FishjamRoom.md deleted file mode 100644 index df21e0cb..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/functions/FishjamRoom.md +++ /dev/null @@ -1,31 +0,0 @@ -# Function: FishjamRoom() - -> **FishjamRoom**(`props`): `Element` - -Defined in: [packages/react-native-client/src/components/FishjamRoom/index.tsx:39](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/functions/setOverwriteDebugConfig.md b/versioned_docs/version-0.22.0/api/mobile/functions/setOverwriteDebugConfig.md deleted file mode 100644 index bd43bc21..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/functions/setOverwriteDebugConfig.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/functions/useAudioSettings.md b/versioned_docs/version-0.22.0/api/mobile/functions/useAudioSettings.md deleted file mode 100644 index 1f28787c..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/functions/useAudioSettings.md +++ /dev/null @@ -1,66 +0,0 @@ -# Function: useAudioSettings() - -> **useAudioSettings**(): `object` - -Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:39](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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 bluetooth devices make sure you have the BLUETOOTH_CONNECT permission. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `device` | [`AudioOutputDeviceType`](../type-aliases/AudioOutputDeviceType.md) | - -#### Returns - -`Promise`\<`void`\> - -### showAudioRoutePicker() - -> **showAudioRoutePicker**: () => `Promise`\<`void`\> - -[iOS only] Shows a picker modal that allows user to select output audio device. For more -information refer to Apple's documentation: https://developer.apple.com/documentation/avkit/avroutepickerview - -#### Returns - -`Promise`\<`void`\> diff --git a/versioned_docs/version-0.22.0/api/mobile/functions/useBandwidthEstimation.md b/versioned_docs/version-0.22.0/api/mobile/functions/useBandwidthEstimation.md deleted file mode 100644 index 533e2bfb..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/functions/useBandwidthEstimation.md +++ /dev/null @@ -1,17 +0,0 @@ -# Function: useBandwidthEstimation() - -> **useBandwidthEstimation**(): `object` - -Defined in: [packages/react-native-client/src/hooks/useBandwidthEstimation.ts:11](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/functions/useCamera.md b/versioned_docs/version-0.22.0/api/mobile/functions/useCamera.md deleted file mode 100644 index 56b6513b..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/functions/useCamera.md +++ /dev/null @@ -1,90 +0,0 @@ -# Function: useCamera() - -> **useCamera**(): `object` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:121](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useCamera.ts#L121) - -This hook can toggle camera on/off and provides current camera state. - -## Returns - -### cameras - -> **cameras**: readonly [`Camera`](../type-aliases/Camera.md)[] - -Property that lists cameras available on device. - -#### Returns - -A promise that resolves to the list of available cameras. - -### currentCamera - -> **currentCamera**: `null` \| [`Camera`](../type-aliases/Camera.md) - -Which camera is now used for streaming (or will be used as default when camera will be enabled) - -### isCameraOn - -> **isCameraOn**: `boolean` - -Informs if user camera is streaming video - -### isInitialized - -> **isInitialized**: `boolean` = `isCameraInitialized` - -A value indicating if camera was already initialized (if `prepareCamera` was called). - -### prepareCamera() - -> **prepareCamera**: (`config`) => `Promise`\<`boolean`\> - -Prepares camera and starts local video track - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `config` | `Readonly`\<[`CameraConfig`](../type-aliases/CameraConfig.md)\> | configuration of the camera capture | - -#### Returns - -`Promise`\<`boolean`\> - -A promise that resolves when camera is started. - -### simulcastConfig - -> **simulcastConfig**: [`SimulcastConfig`](../type-aliases/SimulcastConfig.md) - -Simulcast configuration - -### switchCamera() - -> **switchCamera**: (`cameraId`) => `Promise`\<`void`\> - -Switches to the specified camera. -List of available devices can be retrieved from `cameras` variable - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `cameraId` | [`CameraId`](../type-aliases/CameraId.md) | - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when camera is switched. - -### toggleCamera() - -> **toggleCamera**: () => `Promise`\<`void`\> - -Enable/disable current camera - -#### Returns - -`Promise`\<`void`\> diff --git a/versioned_docs/version-0.22.0/api/mobile/functions/useMicrophone.md b/versioned_docs/version-0.22.0/api/mobile/functions/useMicrophone.md deleted file mode 100644 index bb278382..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/functions/useMicrophone.md +++ /dev/null @@ -1,45 +0,0 @@ -# Function: useMicrophone() - -> **useMicrophone**(): `object` - -Defined in: [packages/react-native-client/src/hooks/useMicrophone.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/functions/usePeers.md b/versioned_docs/version-0.22.0/api/mobile/functions/usePeers.md deleted file mode 100644 index e09339af..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/functions/usePeers.md +++ /dev/null @@ -1,39 +0,0 @@ -# Function: usePeers() - -> **usePeers**\<`PeerMetadata`, `ServerMetadata`\>(): `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:186](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/functions/useSandbox.md b/versioned_docs/version-0.22.0/api/mobile/functions/useSandbox.md deleted file mode 100644 index c51bcf73..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/functions/useSandbox.md +++ /dev/null @@ -1,60 +0,0 @@ -# Function: useSandbox() - -> **useSandbox**(`__namedParameters`): `object` - -Defined in: [packages/react-native-client/src/hooks/useSandbox.ts:17](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/functions/useScreenShare.md b/versioned_docs/version-0.22.0/api/mobile/functions/useScreenShare.md deleted file mode 100644 index bea20d48..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/functions/useScreenShare.md +++ /dev/null @@ -1,44 +0,0 @@ -# Function: useScreenShare() - -> **useScreenShare**(): `object` - -Defined in: [packages/react-native-client/src/hooks/useScreenShare.ts:42](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useScreenShare.ts#L42) - -This hook can toggle screen sharing on/off and provides current screen share state. - -## Returns - -An object with functions to manage screen share. - -### handleScreenSharePermission() - -> **handleScreenSharePermission**: () => `Promise`\<`"granted"` \| `"denied"`\> - -#### Returns - -`Promise`\<`"granted"` \| `"denied"`\> - -### isScreenShareOn - -> **isScreenShareOn**: `boolean` - -### simulcastConfig - -> **simulcastConfig**: [`SimulcastConfig`](../type-aliases/SimulcastConfig.md) - -### toggleScreenShare() - -> **toggleScreenShare**: (`screenShareOptions`) => `Promise`\<`void`\> - -Toggles the screen share on/off -Emits warning on ios when user is screensharing app screen. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `screenShareOptions` | `Partial`\<[`ScreenShareOptions`](../type-aliases/ScreenShareOptions.md)\> | - -#### Returns - -`Promise`\<`void`\> diff --git a/versioned_docs/version-0.22.0/api/mobile/functions/useUpdatePeerMetadata.md b/versioned_docs/version-0.22.0/api/mobile/functions/useUpdatePeerMetadata.md deleted file mode 100644 index 847a6394..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/functions/useUpdatePeerMetadata.md +++ /dev/null @@ -1,31 +0,0 @@ -# Function: useUpdatePeerMetadata() - -> **useUpdatePeerMetadata**\<`PeerMetadata`\>(): `object` - -Defined in: [packages/react-native-client/src/hooks/useUpdatePeerMetadata.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/index.md b/versioned_docs/version-0.22.0/api/mobile/index.md deleted file mode 100644 index 36d08e56..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/index.md +++ /dev/null @@ -1,81 +0,0 @@ -# @fishjam-cloud/react-native-client - -## Connection - -- [useConnection](functions/useConnection.md) -- [usePeers](functions/usePeers.md) -- [useScreenShare](functions/useScreenShare.md) -- [useUpdatePeerMetadata](functions/useUpdatePeerMetadata.md) -- [useAppScreenShare](variables/useAppScreenShare.md) -- [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) -- [VideoPreviewView](variables/VideoPreviewView.md) -- [VideoRendererView](variables/VideoRendererView.md) - -## Other - -- [setOverwriteDebugConfig](functions/setOverwriteDebugConfig.md) -- [useSandbox](functions/useSandbox.md) -- [AppScreenShareData](type-aliases/AppScreenShareData.md) -- [AudioOutputDevice](type-aliases/AudioOutputDevice.md) -- [AudioOutputDeviceType](type-aliases/AudioOutputDeviceType.md) -- [AudioSessionMode](type-aliases/AudioSessionMode.md) -- [AudioTrack](type-aliases/AudioTrack.md) -- [Brand](type-aliases/Brand.md) -- [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) -- [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.22.0/api/mobile/type-aliases/AppScreenShareData.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/AppScreenShareData.md deleted file mode 100644 index 464532bc..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/AppScreenShareData.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type Alias: AppScreenShareData - -> **AppScreenShareData** = `object` - -Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:17](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useAppScreenShare.ts#L17) - -## Properties - -### isAppScreenShareOn - -> **isAppScreenShareOn**: `boolean` - -Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:18](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useAppScreenShare.ts#L18) - -*** - -### simulcastConfig - -> **simulcastConfig**: [`SimulcastConfig`](SimulcastConfig.md) - -Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:19](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useAppScreenShare.ts#L19) - -*** - -### toggleAppScreenShare() - -> **toggleAppScreenShare**: (`screenShareOptions?`) => `Promise`\<`void`\> - -Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:20](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useAppScreenShare.ts#L20) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `screenShareOptions?` | `Partial`\<[`ScreenShareOptions`](ScreenShareOptions.md)\> | - -#### Returns - -`Promise`\<`void`\> diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioOutputDevice.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioOutputDevice.md deleted file mode 100644 index 42085285..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioOutputDevice.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: AudioOutputDevice - -> **AudioOutputDevice** = `object` - -Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:17](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useAudioSettings.ts#L18) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioOutputDeviceType.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioOutputDeviceType.md deleted file mode 100644 index 0e24aa06..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioOutputDeviceType.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: AudioOutputDeviceType - -> **AudioOutputDeviceType** = `"bluetooth"` \| `"headset"` \| `"speaker"` \| `"earpiece"` - -Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useAudioSettings.ts#L9) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioSessionMode.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioSessionMode.md deleted file mode 100644 index dd8e49e2..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioSessionMode.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: AudioSessionMode - -> **AudioSessionMode** = `"voiceChat"` \| `"videoChat"` - -Defined in: [packages/react-native-client/src/hooks/useAudioSettings.ts:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useAudioSettings.ts#L15) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioTrack.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioTrack.md deleted file mode 100644 index 09581baf..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/AudioTrack.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: AudioTrack - -> **AudioTrack** = [`TrackBase`](TrackBase.md) & `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:34](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/CallKitAction.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/CallKitAction.md deleted file mode 100644 index 31fc3905..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/CallKitAction.md +++ /dev/null @@ -1,45 +0,0 @@ -# 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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useCallKit.ts#L7) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/CallKitConfig.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/CallKitConfig.md deleted file mode 100644 index 97c114a1..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/CallKitConfig.md +++ /dev/null @@ -1,25 +0,0 @@ -# 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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useCallKit.ts#L40) - -Whether the should support video diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/Camera.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/Camera.md deleted file mode 100644 index ce5adc08..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/Camera.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: Camera - -> **Camera** = `object` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useCamera.ts#L14) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraConfig.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraConfig.md deleted file mode 100644 index 476308b5..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraConfig.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: CameraConfig - -> **CameraConfig** = [`CameraConfigBase`](CameraConfigBase.md) & `object` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:74](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useCamera.ts#L74) - -## Type declaration - -### simulcastEnabled? - -> `optional` **simulcastEnabled**: `boolean` - -whether video track uses simulcast. By default simulcast is disabled. diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraConfigBase.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraConfigBase.md deleted file mode 100644 index 13fcab46..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraConfigBase.md +++ /dev/null @@ -1,78 +0,0 @@ -# Type Alias: CameraConfigBase - -> **CameraConfigBase** = `object` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:36](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/CameraFacingDirection.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraFacingDirection.md deleted file mode 100644 index 1d26943e..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraFacingDirection.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: CameraFacingDirection - -> **CameraFacingDirection** = `"front"` \| `"back"` \| `"unspecified"` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useCamera.ts#L10) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraId.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraId.md deleted file mode 100644 index d0cc3589..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/CameraId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: CameraId - -> **CameraId** = [`Brand`](Brand.md)\<`string`, `"CameraId"`\> - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:8](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useCamera.ts#L8) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/ConnectionConfig.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/ConnectionConfig.md deleted file mode 100644 index abc09ccf..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/ConnectionConfig.md +++ /dev/null @@ -1,26 +0,0 @@ -# Type Alias: ConnectionConfig - -> **ConnectionConfig** = `object` - -Defined in: [packages/react-native-client/src/hooks/useConnection.ts:63](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/DebugConfig.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/DebugConfig.md deleted file mode 100644 index c3a1cb79..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/DebugConfig.md +++ /dev/null @@ -1,13 +0,0 @@ -# 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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/utils/config.ts#L2) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/DistinguishedTracks.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/DistinguishedTracks.md deleted file mode 100644 index b84e01ab..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/DistinguishedTracks.md +++ /dev/null @@ -1,37 +0,0 @@ -# Type Alias: DistinguishedTracks - -> **DistinguishedTracks** = `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:54](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/usePeers.ts#L57) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/EncodingReason.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/EncodingReason.md deleted file mode 100644 index d06aad7e..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/EncodingReason.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: EncodingReason - -> **EncodingReason** = `"other"` \| `"encoding_inactive"` \| `"low_bandwidth"` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:52](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/FishjamRoomProps.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/FishjamRoomProps.md deleted file mode 100644 index eb294562..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/FishjamRoomProps.md +++ /dev/null @@ -1,25 +0,0 @@ -# Type Alias: FishjamRoomProps - -> **FishjamRoomProps** = `object` - -Defined in: [packages/react-native-client/src/components/FishjamRoom/index.tsx:7](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/components/FishjamRoom/index.tsx#L15) - -Peer Token diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/ForegroundServiceConfig.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/ForegroundServiceConfig.md deleted file mode 100644 index bc9818ce..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/ForegroundServiceConfig.md +++ /dev/null @@ -1,67 +0,0 @@ -# Type Alias: ForegroundServiceConfig - -> **ForegroundServiceConfig** = `object` - -Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/GenericMetadata.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/GenericMetadata.md deleted file mode 100644 index cf717d27..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/GenericMetadata.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: GenericMetadata - -> **GenericMetadata** = `Record`\<`string`, `unknown`\> - -Defined in: [packages/react-native-client/src/types.ts:27](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/types.ts#L27) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/JoinRoomConfig.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/JoinRoomConfig.md deleted file mode 100644 index 5924e49e..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/JoinRoomConfig.md +++ /dev/null @@ -1,52 +0,0 @@ -# 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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useConnection.ts#L52) - -Token received from server (or Room Manager) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/Peer.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/Peer.md deleted file mode 100644 index c9e798e3..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/Peer.md +++ /dev/null @@ -1,52 +0,0 @@ -# Type Alias: Peer\ - -> **Peer**\<`PeerMetadata`, `ServerMetadata`\> = `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:66](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/PeerId.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/PeerId.md deleted file mode 100644 index 968f9859..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/PeerId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerId - -> **PeerId** = [`Brand`](Brand.md)\<`string`, `"PeerId"`\> - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:9](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/usePeers.ts#L9) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/PeerTrackMetadata.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/PeerTrackMetadata.md deleted file mode 100644 index 79eaa387..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/PeerTrackMetadata.md +++ /dev/null @@ -1,28 +0,0 @@ -# Type Alias: PeerTrackMetadata\ - -> **PeerTrackMetadata**\<`PeerMetadata`, `ServerMetadata`\> = `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:22](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/usePeers.ts#L24) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/PeerWithTracks.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/PeerWithTracks.md deleted file mode 100644 index d185a65e..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/PeerWithTracks.md +++ /dev/null @@ -1,12 +0,0 @@ -# Type Alias: PeerWithTracks\ - -> **PeerWithTracks**\<`PeerMetadata`, `ServerMetadata`\> = [`Peer`](Peer.md)\<`PeerMetadata`, `ServerMetadata`\> & [`DistinguishedTracks`](DistinguishedTracks.md) - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:61](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/ReconnectionStatus.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/ReconnectionStatus.md deleted file mode 100644 index 45b29391..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/ReconnectionStatus.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: ReconnectionStatus - -> **ReconnectionStatus** = `"idle"` \| `"reconnecting"` \| `"error"` - -Defined in: [packages/react-native-client/src/hooks/useConnection.ts:16](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/RoomType.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/RoomType.md deleted file mode 100644 index 9c55f204..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/RoomType.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomType - -> **RoomType** = `"conference"` \| `"audio-only"` \| `"livestream"` - -Defined in: [packages/react-native-client/src/types.ts:36](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/types.ts#L36) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/ScreenShareOptions.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/ScreenShareOptions.md deleted file mode 100644 index e07164f2..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/ScreenShareOptions.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ScreenShareOptions - -> **ScreenShareOptions** = `object` - -Defined in: [packages/react-native-client/src/hooks/useScreenShare.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/ScreenShareQuality.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/ScreenShareQuality.md deleted file mode 100644 index b24a7f09..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/ScreenShareQuality.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ScreenShareQuality - -> **ScreenShareQuality** = `"VGA"` \| `"HD5"` \| `"HD15"` \| `"FHD15"` \| `"FHD30"` - -Defined in: [packages/react-native-client/src/hooks/useScreenShare.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useScreenShare.ts#L10) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/SimulcastConfig.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/SimulcastConfig.md deleted file mode 100644 index 07fd2db4..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/SimulcastConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: SimulcastConfig - -> **SimulcastConfig** = `object` - -Defined in: [packages/react-native-client/src/types.ts:15](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/Track.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/Track.md deleted file mode 100644 index db31b5ea..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/Track.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: Track - -> **Track** = [`VideoTrack`](VideoTrack.md) \| [`AudioTrack`](AudioTrack.md) - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:44](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/usePeers.ts#L44) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackBase.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackBase.md deleted file mode 100644 index ddb545f6..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackBase.md +++ /dev/null @@ -1,37 +0,0 @@ -# Type Alias: TrackBase - -> **TrackBase** = `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:27](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/usePeers.ts#L29) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackId.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackId.md deleted file mode 100644 index 1e64b717..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackId - -> **TrackId** = [`Brand`](Brand.md)\<`string`, `"TrackId"`\> - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:10](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/usePeers.ts#L10) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackMetadata.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackMetadata.md deleted file mode 100644 index d132a873..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackMetadata.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: TrackMetadata - -> **TrackMetadata** = `object` - -Defined in: [packages/react-native-client/src/types.ts:22](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/types.ts#L24) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackType.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackType.md deleted file mode 100644 index d28d2ea0..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/TrackType.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackType - -> **TrackType** = `"Audio"` \| `"Video"` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:12](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/usePeers.ts#L12) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/UseCallKitResult.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/UseCallKitResult.md deleted file mode 100644 index 324f960a..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/UseCallKitResult.md +++ /dev/null @@ -1,53 +0,0 @@ -# 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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/UsePeersResult.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/UsePeersResult.md deleted file mode 100644 index 9074ab28..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/UsePeersResult.md +++ /dev/null @@ -1,38 +0,0 @@ -# Type Alias: UsePeersResult\ - -> **UsePeersResult**\<`PeerMetadata`, `ServerMetadata`\> = `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:168](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/usePeers.ts#L174) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/UseSandboxProps.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/UseSandboxProps.md deleted file mode 100644 index eb12e130..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/UseSandboxProps.md +++ /dev/null @@ -1,5 +0,0 @@ -# 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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useSandbox.ts#L13) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/VadStatus.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/VadStatus.md deleted file mode 100644 index ac3fa3c1..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/VadStatus.md +++ /dev/null @@ -1,10 +0,0 @@ -# Type Alias: VadStatus - -> **VadStatus** = `"silence"` \| `"speech"` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:20](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/VideoLayout.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoLayout.md deleted file mode 100644 index f27d6272..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoLayout.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: VideoLayout - -> **VideoLayout** = `"FILL"` \| `"FIT"` - -Defined in: [packages/react-native-client/src/types.ts:6](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/type-aliases/VideoPreviewViewProps.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoPreviewViewProps.md deleted file mode 100644 index e9367eb7..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoPreviewViewProps.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: VideoPreviewViewProps - -> **VideoPreviewViewProps** = `object` - -Defined in: [packages/react-native-client/src/components/VideoPreviewView.tsx:8](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/components/VideoPreviewView.tsx#L13) - -Video layout inside of the component - -#### Default - -`FILL` diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoQuality.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoQuality.md deleted file mode 100644 index 373bed44..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoQuality.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: VideoQuality - -> **VideoQuality** = `"QVGA169"` \| `"VGA169"` \| `"QHD169"` \| `"HD169"` \| `"FHD169"` \| `"QVGA43"` \| `"VGA43"` \| `"QHD43"` \| `"HD43"` \| `"FHD43"` - -Defined in: [packages/react-native-client/src/hooks/useCamera.ts:24](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useCamera.ts#L24) diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoRendererProps.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoRendererProps.md deleted file mode 100644 index 718b24ac..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoRendererProps.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: VideoRendererProps - -> **VideoRendererProps** = `object` - -Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:8](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/components/VideoRendererView.tsx#L17) - -Video layout inside of the component - -#### Default - -`FILL` diff --git a/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoTrack.md b/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoTrack.md deleted file mode 100644 index 5af9220c..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/type-aliases/VideoTrack.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: VideoTrack - -> **VideoTrack** = [`TrackBase`](TrackBase.md) & `object` - -Defined in: [packages/react-native-client/src/hooks/usePeers.ts:39](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/usePeers.ts#L39) - -## Type declaration - -### aspectRatio - -> **aspectRatio**: `number` - -### type - -> **type**: `"Video"` diff --git a/versioned_docs/version-0.22.0/api/mobile/typedoc-sidebar.cjs b/versioned_docs/version-0.22.0/api/mobile/typedoc-sidebar.cjs deleted file mode 100644 index 533a1f88..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ -const typedocSidebar = {items:[{type:"category",label:"Connection",items:[{type:"doc",id:"api/mobile/functions/useConnection",label:"useConnection"},{type:"doc",id:"api/mobile/functions/usePeers",label:"usePeers"},{type:"doc",id:"api/mobile/functions/useScreenShare",label:"useScreenShare"},{type:"doc",id:"api/mobile/functions/useUpdatePeerMetadata",label:"useUpdatePeerMetadata"},{type:"doc",id:"api/mobile/variables/useAppScreenShare",label:"useAppScreenShare"},{type:"doc",id:"api/mobile/variables/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/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/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/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.22.0/api/mobile/variables/VideoPreviewView.md b/versioned_docs/version-0.22.0/api/mobile/variables/VideoPreviewView.md deleted file mode 100644 index f50c41f9..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/variables/VideoPreviewView.md +++ /dev/null @@ -1,12 +0,0 @@ -# Variable: VideoPreviewView - -> `const` **VideoPreviewView**: `ForwardRefExoticComponent`\<[`VideoPreviewViewProps`](../type-aliases/VideoPreviewViewProps.md) & `RefAttributes`\<`ComponentType`\<[`VideoPreviewViewProps`](../type-aliases/VideoPreviewViewProps.md)\>\>\> - -Defined in: [packages/react-native-client/src/components/VideoPreviewView.tsx:35](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/variables/VideoRendererView.md b/versioned_docs/version-0.22.0/api/mobile/variables/VideoRendererView.md deleted file mode 100644 index fdc1068a..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/variables/VideoRendererView.md +++ /dev/null @@ -1,20 +0,0 @@ -# Variable: VideoRendererView - -> `const` **VideoRendererView**: `ForwardRefExoticComponent`\<[`VideoRendererProps`](../type-aliases/VideoRendererProps.md) & `RefAttributes`\<`ComponentType`\<[`VideoRendererProps`](../type-aliases/VideoRendererProps.md)\>\>\> - -Defined in: [packages/react-native-client/src/components/VideoRendererView.tsx:45](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/variables/useAppScreenShare.md b/versioned_docs/version-0.22.0/api/mobile/variables/useAppScreenShare.md deleted file mode 100644 index e19e67c2..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/variables/useAppScreenShare.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: useAppScreenShare() - -> `const` **useAppScreenShare**: () => [`AppScreenShareData`](../type-aliases/AppScreenShareData.md) - -Defined in: [packages/react-native-client/src/hooks/useAppScreenShare.ts:80](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/packages/react-native-client/src/hooks/useAppScreenShare.ts#L80) - -This hook can toggle client app screen sharing on/off and provides current screen share state. - -It works only on iOS. - -## Returns - -[`AppScreenShareData`](../type-aliases/AppScreenShareData.md) - -An object with functions to manage app screen share on iOS and null on android. diff --git a/versioned_docs/version-0.22.0/api/mobile/variables/useCallKit.md b/versioned_docs/version-0.22.0/api/mobile/variables/useCallKit.md deleted file mode 100644 index 2be31b4e..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/variables/useCallKit.md +++ /dev/null @@ -1,32 +0,0 @@ -# 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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/variables/useCallKitEvent.md b/versioned_docs/version-0.22.0/api/mobile/variables/useCallKitEvent.md deleted file mode 100644 index b2cd2031..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/variables/useCallKitEvent.md +++ /dev/null @@ -1,39 +0,0 @@ -# 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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/variables/useCallKitService.md b/versioned_docs/version-0.22.0/api/mobile/variables/useCallKitService.md deleted file mode 100644 index 990442ba..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/variables/useCallKitService.md +++ /dev/null @@ -1,34 +0,0 @@ -# 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/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/variables/useCameraPermissions.md b/versioned_docs/version-0.22.0/api/mobile/variables/useCameraPermissions.md deleted file mode 100644 index 427fc9eb..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/variables/useCameraPermissions.md +++ /dev/null @@ -1,25 +0,0 @@ -# Variable: useCameraPermissions() - -> `const` **useCameraPermissions**: (`options?`) => \[`null` \| `PermissionResponse`, `RequestPermissionMethod`\<`PermissionResponse`\>, `GetPermissionMethod`\<`PermissionResponse`\>\] - -Defined in: [packages/react-native-client/src/hooks/usePermissions.ts:31](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/variables/useForegroundService.md b/versioned_docs/version-0.22.0/api/mobile/variables/useForegroundService.md deleted file mode 100644 index a31accbf..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/variables/useForegroundService.md +++ /dev/null @@ -1,18 +0,0 @@ -# Variable: useForegroundService() - -> `const` **useForegroundService**: (`config`) => `void` - -Defined in: [packages/react-native-client/src/hooks/useForegroundService.ts:109](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/mobile/variables/useMicrophonePermissions.md b/versioned_docs/version-0.22.0/api/mobile/variables/useMicrophonePermissions.md deleted file mode 100644 index 5b523ebb..00000000 --- a/versioned_docs/version-0.22.0/api/mobile/variables/useMicrophonePermissions.md +++ /dev/null @@ -1,25 +0,0 @@ -# Variable: useMicrophonePermissions() - -> `const` **useMicrophonePermissions**: (`options?`) => \[`null` \| `PermissionResponse`, `RequestPermissionMethod`\<`PermissionResponse`\>, `GetPermissionMethod`\<`PermissionResponse`\>\] - -Defined in: [packages/react-native-client/src/hooks/usePermissions.ts:63](https://github.com/fishjam-cloud/mobile-client-sdk/blob/76d05a6e62b137b02043a8a00ca762ff218a64b5/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.22.0/api/server/classes/BadRequestException.md b/versioned_docs/version-0.22.0/api/server/classes/BadRequestException.md deleted file mode 100644 index ce39b266..00000000 --- a/versioned_docs/version-0.22.0/api/server/classes/BadRequestException.md +++ /dev/null @@ -1,234 +0,0 @@ -# Class: BadRequestException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:21](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L21) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new BadRequestException**(`error`): `BadRequestException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`BadRequestException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -The cause of the error. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:990 - -The maximum number of stack frames to capture. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:985 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -*** - -### isError() - -> `static` **isError**(`value`): `value is Error` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:980 - -Check if a value is an instance of Error - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `value` | `unknown` | The value to check | - -#### Returns - -`value is Error` - -True if the value is an instance of Error, false otherwise - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`isError`](FishjamBaseException.md#iserror) diff --git a/versioned_docs/version-0.22.0/api/server/classes/FishjamAgent.md b/versioned_docs/version-0.22.0/api/server/classes/FishjamAgent.md deleted file mode 100644 index bd1266de..00000000 --- a/versioned_docs/version-0.22.0/api/server/classes/FishjamAgent.md +++ /dev/null @@ -1,530 +0,0 @@ -# Class: FishjamAgent - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:42](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/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: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:45](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L45) - -#### 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 - -### addListener() - -> **addListener**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:22 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* `"trackData"` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`AgentEvents`](../type-aliases/AgentEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).addListener` - -*** - -### createTrack() - -> **createTrack**(`codecParameters`, `metadata`): [`AgentTrack`](../type-aliases/AgentTrack.md) - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:66](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L66) - -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: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:98](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L98) - -Deletes an outgoing audio track for the agent - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `trackId` | [`TrackId`](../type-aliases/TrackId.md) | - -#### Returns - -`void` - -*** - -### disconnect() - -> **disconnect**(): `void` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:113](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L113) - -#### Returns - -`void` - -*** - -### emit() - -> **emit**\<`E`\>(`event`, ...`args`): `boolean` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:32 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* `"trackData"` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| ...`args` | `Parameters`\<[`AgentEvents`](../type-aliases/AgentEvents.md)\[`E`\]\> | - -#### Returns - -`boolean` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).emit` - -*** - -### eventNames() - -> **eventNames**(): (`string` \| `symbol`)[] - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:34 - -#### Returns - -(`string` \| `symbol`)[] - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).eventNames` - -*** - -### getMaxListeners() - -> **getMaxListeners**(): `number` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:39 - -#### Returns - -`number` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).getMaxListeners` - -*** - -### interruptTrack() - -> **interruptTrack**(`trackId`): `void` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:89](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L89) - -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` - -*** - -### listenerCount() - -> **listenerCount**\<`E`\>(`event`): `number` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:37 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* `"trackData"` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | - -#### Returns - -`number` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).listenerCount` - -*** - -### listeners() - -> **listeners**\<`E`\>(`event`): [`AgentEvents`](../type-aliases/AgentEvents.md)\[`E`\][] - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:36 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* `"trackData"` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | - -#### Returns - -[`AgentEvents`](../type-aliases/AgentEvents.md)\[`E`\][] - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).listeners` - -*** - -### off() - -> **off**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:28 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* `"trackData"` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`AgentEvents`](../type-aliases/AgentEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).off` - -*** - -### on() - -> **on**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:23 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* `"trackData"` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`AgentEvents`](../type-aliases/AgentEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).on` - -*** - -### once() - -> **once**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:24 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* `"trackData"` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`AgentEvents`](../type-aliases/AgentEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).once` - -*** - -### prependListener() - -> **prependListener**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:25 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* `"trackData"` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`AgentEvents`](../type-aliases/AgentEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).prependListener` - -*** - -### prependOnceListener() - -> **prependOnceListener**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:26 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* `"trackData"` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`AgentEvents`](../type-aliases/AgentEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).prependOnceListener` - -*** - -### rawListeners() - -> **rawListeners**\<`E`\>(`event`): [`AgentEvents`](../type-aliases/AgentEvents.md)\[`E`\][] - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:35 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* `"trackData"` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | - -#### Returns - -[`AgentEvents`](../type-aliases/AgentEvents.md)\[`E`\][] - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).rawListeners` - -*** - -### removeAllListeners() - -> **removeAllListeners**\<`E`\>(`event?`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:29 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* `"trackData"` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event?` | `E` | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).removeAllListeners` - -*** - -### removeListener() - -> **removeListener**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:30 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* `"trackData"` | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`AgentEvents`](../type-aliases/AgentEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).removeListener` - -*** - -### sendData() - -> **sendData**(`trackId`, `data`): `void` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:107](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L107) - -Send audio data for the given track - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `trackId` | [`TrackId`](../type-aliases/TrackId.md) | -| `data` | `Uint8Array` | - -#### Returns - -`void` - -*** - -### setMaxListeners() - -> **setMaxListeners**(`maxListeners`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:40 - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `maxListeners` | `number` | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).setMaxListeners` diff --git a/versioned_docs/version-0.22.0/api/server/classes/FishjamBaseException.md b/versioned_docs/version-0.22.0/api/server/classes/FishjamBaseException.md deleted file mode 100644 index 3a8875f6..00000000 --- a/versioned_docs/version-0.22.0/api/server/classes/FishjamBaseException.md +++ /dev/null @@ -1,233 +0,0 @@ -# Class: FishjamBaseException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:9](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L9) - -## Extends - -- `Error` - -## Extended by - -- [`BadRequestException`](BadRequestException.md) -- [`UnauthorizedException`](UnauthorizedException.md) -- [`ForbiddenException`](ForbiddenException.md) -- [`RoomNotFoundException`](RoomNotFoundException.md) -- [`FishjamNotFoundException`](FishjamNotFoundException.md) -- [`PeerNotFoundException`](PeerNotFoundException.md) -- [`ServiceUnavailableException`](ServiceUnavailableException.md) -- [`UnknownException`](UnknownException.md) - -## Constructors - -### Constructor - -> **new FishjamBaseException**(`error`): `FishjamBaseException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`FishjamBaseException` - -#### Overrides - -`Error.constructor` - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L11) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -The cause of the error. - -#### Inherited from - -`Error.cause` - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L12) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -`Error.message` - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -`Error.name` - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -`Error.prepareStackTrace` - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -`Error.stack` - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:990 - -The maximum number of stack frames to capture. - -#### Inherited from - -`Error.stackTraceLimit` - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L10) - -## Methods - -### captureStackTrace() - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:985 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -`Error.captureStackTrace` - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -`Error.captureStackTrace` - -*** - -### isError() - -> `static` **isError**(`value`): `value is Error` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:980 - -Check if a value is an instance of Error - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `value` | `unknown` | The value to check | - -#### Returns - -`value is Error` - -True if the value is an instance of Error, false otherwise - -#### Inherited from - -`Error.isError` diff --git a/versioned_docs/version-0.22.0/api/server/classes/FishjamNotFoundException.md b/versioned_docs/version-0.22.0/api/server/classes/FishjamNotFoundException.md deleted file mode 100644 index 12814ecb..00000000 --- a/versioned_docs/version-0.22.0/api/server/classes/FishjamNotFoundException.md +++ /dev/null @@ -1,234 +0,0 @@ -# Class: FishjamNotFoundException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:29](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L29) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new FishjamNotFoundException**(`error`): `FishjamNotFoundException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`FishjamNotFoundException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -The cause of the error. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:990 - -The maximum number of stack frames to capture. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:985 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -*** - -### isError() - -> `static` **isError**(`value`): `value is Error` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:980 - -Check if a value is an instance of Error - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `value` | `unknown` | The value to check | - -#### Returns - -`value is Error` - -True if the value is an instance of Error, false otherwise - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`isError`](FishjamBaseException.md#iserror) diff --git a/versioned_docs/version-0.22.0/api/server/classes/FishjamWSNotifier.md b/versioned_docs/version-0.22.0/api/server/classes/FishjamWSNotifier.md deleted file mode 100644 index 736b7ee7..00000000 --- a/versioned_docs/version-0.22.0/api/server/classes/FishjamWSNotifier.md +++ /dev/null @@ -1,431 +0,0 @@ -# Class: FishjamWSNotifier - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:76](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/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: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:79](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/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` - -## Methods - -### addListener() - -> **addListener**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:22 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).addListener` - -*** - -### emit() - -> **emit**\<`E`\>(`event`, ...`args`): `boolean` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:32 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| ...`args` | `Parameters`\<[`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\]\> | - -#### Returns - -`boolean` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).emit` - -*** - -### eventNames() - -> **eventNames**(): (`string` \| `symbol`)[] - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:34 - -#### Returns - -(`string` \| `symbol`)[] - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).eventNames` - -*** - -### getMaxListeners() - -> **getMaxListeners**(): `number` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:39 - -#### Returns - -`number` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).getMaxListeners` - -*** - -### listenerCount() - -> **listenerCount**\<`E`\>(`event`): `number` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:37 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | - -#### Returns - -`number` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).listenerCount` - -*** - -### listeners() - -> **listeners**\<`E`\>(`event`): [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\][] - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:36 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | - -#### Returns - -[`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\][] - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).listeners` - -*** - -### off() - -> **off**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:28 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).off` - -*** - -### on() - -> **on**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:23 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).on` - -*** - -### once() - -> **once**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:24 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).once` - -*** - -### prependListener() - -> **prependListener**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:25 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).prependListener` - -*** - -### prependOnceListener() - -> **prependOnceListener**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:26 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).prependOnceListener` - -*** - -### rawListeners() - -> **rawListeners**\<`E`\>(`event`): [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\][] - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:35 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | - -#### Returns - -[`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\][] - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).rawListeners` - -*** - -### removeAllListeners() - -> **removeAllListeners**\<`E`\>(`event?`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:29 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event?` | `E` | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).removeAllListeners` - -*** - -### removeListener() - -> **removeListener**\<`E`\>(`event`, `listener`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:30 - -#### Type Parameters - -| Type Parameter | -| ------ | -| `E` *extends* [`ExpectedEvents`](../type-aliases/ExpectedEvents.md) | - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `event` | `E` | -| `listener` | [`NotificationEvents`](../type-aliases/NotificationEvents.md)\[`E`\] | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).removeListener` - -*** - -### setMaxListeners() - -> **setMaxListeners**(`maxListeners`): `this` - -Defined in: packages/js-server-sdk/node\_modules/typed-emitter/index.d.ts:40 - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `maxListeners` | `number` | - -#### Returns - -`this` - -#### Inherited from - -`(EventEmitter as new () => TypedEmitter).setMaxListeners` diff --git a/versioned_docs/version-0.22.0/api/server/classes/ForbiddenException.md b/versioned_docs/version-0.22.0/api/server/classes/ForbiddenException.md deleted file mode 100644 index 970c5f70..00000000 --- a/versioned_docs/version-0.22.0/api/server/classes/ForbiddenException.md +++ /dev/null @@ -1,234 +0,0 @@ -# Class: ForbiddenException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:25](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L25) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new ForbiddenException**(`error`): `ForbiddenException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`ForbiddenException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -The cause of the error. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:990 - -The maximum number of stack frames to capture. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:985 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -*** - -### isError() - -> `static` **isError**(`value`): `value is Error` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:980 - -Check if a value is an instance of Error - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `value` | `unknown` | The value to check | - -#### Returns - -`value is Error` - -True if the value is an instance of Error, false otherwise - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`isError`](FishjamBaseException.md#iserror) diff --git a/versioned_docs/version-0.22.0/api/server/classes/MissingFishjamIdException.md b/versioned_docs/version-0.22.0/api/server/classes/MissingFishjamIdException.md deleted file mode 100644 index 52a19e1b..00000000 --- a/versioned_docs/version-0.22.0/api/server/classes/MissingFishjamIdException.md +++ /dev/null @@ -1,192 +0,0 @@ -# Class: MissingFishjamIdException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:3](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L3) - -## Extends - -- `Error` - -## Constructors - -### Constructor - -> **new MissingFishjamIdException**(): `MissingFishjamIdException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:4](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L4) - -#### Returns - -`MissingFishjamIdException` - -#### Overrides - -`Error.constructor` - -## Properties - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -The cause of the error. - -#### Inherited from - -`Error.cause` - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -`Error.message` - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -`Error.name` - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -`Error.prepareStackTrace` - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -`Error.stack` - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:990 - -The maximum number of stack frames to capture. - -#### Inherited from - -`Error.stackTraceLimit` - -## Methods - -### captureStackTrace() - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:985 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -`Error.captureStackTrace` - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -`Error.captureStackTrace` - -*** - -### isError() - -> `static` **isError**(`value`): `value is Error` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:980 - -Check if a value is an instance of Error - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `value` | `unknown` | The value to check | - -#### Returns - -`value is Error` - -True if the value is an instance of Error, false otherwise - -#### Inherited from - -`Error.isError` diff --git a/versioned_docs/version-0.22.0/api/server/classes/PeerNotFoundException.md b/versioned_docs/version-0.22.0/api/server/classes/PeerNotFoundException.md deleted file mode 100644 index 0bb2247d..00000000 --- a/versioned_docs/version-0.22.0/api/server/classes/PeerNotFoundException.md +++ /dev/null @@ -1,234 +0,0 @@ -# Class: PeerNotFoundException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:31](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L31) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new PeerNotFoundException**(`error`): `PeerNotFoundException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`PeerNotFoundException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -The cause of the error. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:990 - -The maximum number of stack frames to capture. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:985 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -*** - -### isError() - -> `static` **isError**(`value`): `value is Error` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:980 - -Check if a value is an instance of Error - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `value` | `unknown` | The value to check | - -#### Returns - -`value is Error` - -True if the value is an instance of Error, false otherwise - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`isError`](FishjamBaseException.md#iserror) diff --git a/versioned_docs/version-0.22.0/api/server/classes/RoomNotFoundException.md b/versioned_docs/version-0.22.0/api/server/classes/RoomNotFoundException.md deleted file mode 100644 index 9c4bf960..00000000 --- a/versioned_docs/version-0.22.0/api/server/classes/RoomNotFoundException.md +++ /dev/null @@ -1,234 +0,0 @@ -# Class: RoomNotFoundException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:27](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L27) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new RoomNotFoundException**(`error`): `RoomNotFoundException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`RoomNotFoundException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -The cause of the error. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:990 - -The maximum number of stack frames to capture. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:985 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -*** - -### isError() - -> `static` **isError**(`value`): `value is Error` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:980 - -Check if a value is an instance of Error - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `value` | `unknown` | The value to check | - -#### Returns - -`value is Error` - -True if the value is an instance of Error, false otherwise - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`isError`](FishjamBaseException.md#iserror) diff --git a/versioned_docs/version-0.22.0/api/server/classes/ServiceUnavailableException.md b/versioned_docs/version-0.22.0/api/server/classes/ServiceUnavailableException.md deleted file mode 100644 index 5cfb3721..00000000 --- a/versioned_docs/version-0.22.0/api/server/classes/ServiceUnavailableException.md +++ /dev/null @@ -1,234 +0,0 @@ -# Class: ServiceUnavailableException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:33](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L33) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new ServiceUnavailableException**(`error`): `ServiceUnavailableException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`ServiceUnavailableException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -The cause of the error. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:990 - -The maximum number of stack frames to capture. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:985 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -*** - -### isError() - -> `static` **isError**(`value`): `value is Error` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:980 - -Check if a value is an instance of Error - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `value` | `unknown` | The value to check | - -#### Returns - -`value is Error` - -True if the value is an instance of Error, false otherwise - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`isError`](FishjamBaseException.md#iserror) diff --git a/versioned_docs/version-0.22.0/api/server/classes/UnauthorizedException.md b/versioned_docs/version-0.22.0/api/server/classes/UnauthorizedException.md deleted file mode 100644 index e808cb6e..00000000 --- a/versioned_docs/version-0.22.0/api/server/classes/UnauthorizedException.md +++ /dev/null @@ -1,234 +0,0 @@ -# Class: UnauthorizedException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:23](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L23) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new UnauthorizedException**(`error`): `UnauthorizedException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`UnauthorizedException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -The cause of the error. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:990 - -The maximum number of stack frames to capture. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:985 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -*** - -### isError() - -> `static` **isError**(`value`): `value is Error` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:980 - -Check if a value is an instance of Error - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `value` | `unknown` | The value to check | - -#### Returns - -`value is Error` - -True if the value is an instance of Error, false otherwise - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`isError`](FishjamBaseException.md#iserror) diff --git a/versioned_docs/version-0.22.0/api/server/classes/UnknownException.md b/versioned_docs/version-0.22.0/api/server/classes/UnknownException.md deleted file mode 100644 index 086c31a9..00000000 --- a/versioned_docs/version-0.22.0/api/server/classes/UnknownException.md +++ /dev/null @@ -1,234 +0,0 @@ -# Class: UnknownException - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:35](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L35) - -## Extends - -- [`FishjamBaseException`](FishjamBaseException.md) - -## Constructors - -### Constructor - -> **new UnknownException**(`error`): `UnknownException` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L13) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | - -#### Returns - -`UnknownException` - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) - -## Properties - -### axiosCode? - -> `optional` **axiosCode**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L11) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) - -*** - -### cause? - -> `optional` **cause**: `unknown` - -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 - -The cause of the error. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`cause`](FishjamBaseException.md#cause) - -*** - -### details? - -> `optional` **details**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L12) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) - -*** - -### message - -> **message**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`message`](FishjamBaseException.md#message) - -*** - -### name - -> **name**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`name`](FishjamBaseException.md#name) - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:143 - -Optional override for formatting stack traces - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`prepareStackTrace`](FishjamBaseException.md#preparestacktrace) - -*** - -### stack? - -> `optional` **stack**: `string` - -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stack`](FishjamBaseException.md#stack) - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:990 - -The maximum number of stack frames to capture. - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`stackTraceLimit`](FishjamBaseException.md#stacktracelimit) - -*** - -### statusCode - -> **statusCode**: `number` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/exceptions/index.ts#L10) - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) - -## Methods - -### captureStackTrace() - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:985 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -#### Call Signature - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Defined in: packages/js-server-sdk/node\_modules/@types/node/globals.d.ts:136 - -Create .stack property on a target object - -##### Parameters - -| Parameter | Type | -| ------ | ------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -##### Returns - -`void` - -##### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`captureStackTrace`](FishjamBaseException.md#capturestacktrace) - -*** - -### isError() - -> `static` **isError**(`value`): `value is Error` - -Defined in: packages/js-server-sdk/node\_modules/bun-types/globals.d.ts:980 - -Check if a value is an instance of Error - -#### Parameters - -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `value` | `unknown` | The value to check | - -#### Returns - -`value is Error` - -True if the value is an instance of Error, false otherwise - -#### Inherited from - -[`FishjamBaseException`](FishjamBaseException.md).[`isError`](FishjamBaseException.md#iserror) diff --git a/versioned_docs/version-0.22.0/api/server/enumerations/PeerStatus.md b/versioned_docs/version-0.22.0/api/server/enumerations/PeerStatus.md deleted file mode 100644 index 4ec9f1da..00000000 --- a/versioned_docs/version-0.22.0/api/server/enumerations/PeerStatus.md +++ /dev/null @@ -1,23 +0,0 @@ -# Enumeration: PeerStatus - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:369 - -Informs about the peer status - -## Export - -## Enumeration Members - -### Connected - -> **Connected**: `"connected"` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:370 - -*** - -### Disconnected - -> **Disconnected**: `"disconnected"` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:371 diff --git a/versioned_docs/version-0.22.0/api/server/interfaces/RoomConfig.md b/versioned_docs/version-0.22.0/api/server/interfaces/RoomConfig.md deleted file mode 100644 index e5adbbf1..00000000 --- a/versioned_docs/version-0.22.0/api/server/interfaces/RoomConfig.md +++ /dev/null @@ -1,79 +0,0 @@ -# Interface: RoomConfig - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:414 - -Room configuration - -## Export - -RoomConfig - -## Properties - -### maxPeers? - -> `optional` **maxPeers**: `null` \| `number` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:420 - -Maximum amount of peers allowed into the room - -#### Memberof - -RoomConfig - -*** - -### public? - -> `optional` **public**: `boolean` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:426 - -True if livestream viewers can omit specifying a token. - -#### Memberof - -RoomConfig - -*** - -### roomType? - -> `optional` **roomType**: [`RoomConfigRoomTypeEnum`](../type-aliases/RoomConfigRoomTypeEnum.md) - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:432 - -The use-case of the room. If not provided, this defaults to conference. - -#### Memberof - -RoomConfig - -*** - -### videoCodec? - -> `optional` **videoCodec**: [`RoomConfigVideoCodecEnum`](../type-aliases/RoomConfigVideoCodecEnum.md) - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:438 - -Enforces video codec for each peer in the room - -#### Memberof - -RoomConfig - -*** - -### webhookUrl? - -> `optional` **webhookUrl**: `null` \| `string` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:444 - -URL where Fishjam notifications will be sent - -#### Memberof - -RoomConfig diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/AgentCallbacks.md b/versioned_docs/version-0.22.0/api/server/type-aliases/AgentCallbacks.md deleted file mode 100644 index 18b74fab..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/AgentCallbacks.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: AgentCallbacks - -> **AgentCallbacks** = `object` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:46](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/types.ts#L46) - -## Properties - -### onClose? - -> `optional` **onClose**: [`CloseEventHandler`](CloseEventHandler.md) - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:48](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/types.ts#L48) - -*** - -### onError? - -> `optional` **onError**: [`ErrorEventHandler`](ErrorEventHandler.md) - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:47](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/types.ts#L47) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/AgentEvents.md b/versioned_docs/version-0.22.0/api/server/type-aliases/AgentEvents.md deleted file mode 100644 index f8d32b4f..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/AgentEvents.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: AgentEvents - -> **AgentEvents** = `{ [K in ExpectedAgentEvents]: (message: NonNullable<{ authenticated?: AgentResponse_Authenticated; trackData?: Omit & { peerId: PeerId } }[K]>) => void }` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:40](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L40) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/AgentTrack.md b/versioned_docs/version-0.22.0/api/server/type-aliases/AgentTrack.md deleted file mode 100644 index b5dc2183..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/AgentTrack.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: AgentTrack - -> **AgentTrack** = `Omit`\<`ProtoTrack`, `"id"`\> & `object` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:26](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L26) - -## Type declaration - -### id - -> **id**: [`TrackId`](TrackId.md) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/AudioCodecParameters.md b/versioned_docs/version-0.22.0/api/server/type-aliases/AudioCodecParameters.md deleted file mode 100644 index fcca09f8..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/AudioCodecParameters.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: AudioCodecParameters - -> **AudioCodecParameters** = `object` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:29](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L29) - -## Properties - -### channels - -> **channels**: `1` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:32](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L32) - -*** - -### encoding - -> **encoding**: `"opus"` \| `"pcm16"` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:30](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L30) - -*** - -### sampleRate - -> **sampleRate**: `16000` \| `24000` \| `48000` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:31](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L31) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/ErrorEventHandler.md b/versioned_docs/version-0.22.0/api/server/type-aliases/ErrorEventHandler.md deleted file mode 100644 index 737217af..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/ErrorEventHandler.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: ErrorEventHandler() - -> **ErrorEventHandler** = (`msg`) => `void` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:43](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/types.ts#L43) - -## Parameters - -| Parameter | Type | -| ------ | ------ | -| `msg` | `Event` | - -## Returns - -`void` diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/ExpectedAgentEvents.md b/versioned_docs/version-0.22.0/api/server/type-aliases/ExpectedAgentEvents.md deleted file mode 100644 index ae339b51..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/ExpectedAgentEvents.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ExpectedAgentEvents - -> **ExpectedAgentEvents** = `"trackData"` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:21](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L21) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/FishjamConfig.md b/versioned_docs/version-0.22.0/api/server/type-aliases/FishjamConfig.md deleted file mode 100644 index 4cb8e433..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/FishjamConfig.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: FishjamConfig - -> **FishjamConfig** = `object` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:28](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/types.ts#L28) - -## Properties - -### fishjamId - -> **fishjamId**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:33](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/types.ts#L33) - -*** - -### managementToken - -> **managementToken**: `string` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:39](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/types.ts#L39) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/IncomingTrackData.md b/versioned_docs/version-0.22.0/api/server/type-aliases/IncomingTrackData.md deleted file mode 100644 index 03aaf612..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/IncomingTrackData.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: IncomingTrackData - -> **IncomingTrackData** = `Omit`\<`NonNullable`\<`AgentResponse_TrackData`\>, `"peerId"`\> & `object` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:23](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L23) - -## Type declaration - -### peerId - -> **peerId**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/NotificationEvents.md b/versioned_docs/version-0.22.0/api/server/type-aliases/NotificationEvents.md deleted file mode 100644 index b79c0e4f..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/NotificationEvents.md +++ /dev/null @@ -1,5 +0,0 @@ -# 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: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:70](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L70) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/OutgoingTrackData.md b/versioned_docs/version-0.22.0/api/server/type-aliases/OutgoingTrackData.md deleted file mode 100644 index 412f595d..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/OutgoingTrackData.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: OutgoingTrackData - -> **OutgoingTrackData** = `Omit`\<`NonNullable`\<`AgentRequest_TrackData`\>, `"peerId"`\> & `object` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:24](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L24) - -## Type declaration - -### peerId - -> **peerId**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/Peer.md b/versioned_docs/version-0.22.0/api/server/type-aliases/Peer.md deleted file mode 100644 index def48f9a..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/Peer.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: Peer - -> **Peer** = `Omit`\<`OpenApiPeer`, `"id"`\> & `object` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:20](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/types.ts#L20) - -## Type declaration - -### id - -> **id**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerAdded.md b/versioned_docs/version-0.22.0/api/server/type-aliases/PeerAdded.md deleted file mode 100644 index 78b81254..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerAdded.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerAdded - -> **PeerAdded** = `object`\[`"peerAdded"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:37](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L37) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerConnected.md b/versioned_docs/version-0.22.0/api/server/type-aliases/PeerConnected.md deleted file mode 100644 index 6971e390..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerConnected.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerConnected - -> **PeerConnected** = `object`\[`"peerConnected"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:39](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L39) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerCrashed.md b/versioned_docs/version-0.22.0/api/server/type-aliases/PeerCrashed.md deleted file mode 100644 index 0ca797f4..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerCrashed.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerCrashed - -> **PeerCrashed** = `object`\[`"peerCrashed"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:42](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L42) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerDeleted.md b/versioned_docs/version-0.22.0/api/server/type-aliases/PeerDeleted.md deleted file mode 100644 index 48660aa0..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerDeleted.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerDeleted - -> **PeerDeleted** = `object`\[`"peerDeleted"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:38](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L38) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerDisconnected.md b/versioned_docs/version-0.22.0/api/server/type-aliases/PeerDisconnected.md deleted file mode 100644 index 9e0a07a5..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerDisconnected.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerDisconnected - -> **PeerDisconnected** = `object`\[`"peerDisconnected"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:40](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L40) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerMetadataUpdated.md b/versioned_docs/version-0.22.0/api/server/type-aliases/PeerMetadataUpdated.md deleted file mode 100644 index df320740..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerMetadataUpdated.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerMetadataUpdated - -> **PeerMetadataUpdated** = `object`\[`"peerMetadataUpdated"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:41](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L41) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerOptions.md b/versioned_docs/version-0.22.0/api/server/type-aliases/PeerOptions.md deleted file mode 100644 index b72e5720..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/PeerOptions.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: PeerOptions - -> **PeerOptions** = `PeerOptionsAgent` \| `PeerOptionsWebRTC` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:253 - -## Export diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/Room.md b/versioned_docs/version-0.22.0/api/server/type-aliases/Room.md deleted file mode 100644 index 6c1570d2..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/Room.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: Room - -> **Room** = `object` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:22](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/types.ts#L22) - -## Properties - -### config - -> **config**: [`RoomConfig`](../interfaces/RoomConfig.md) - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:25](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/types.ts#L25) - -*** - -### id - -> **id**: [`RoomId`](RoomId.md) - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:23](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/types.ts#L23) - -*** - -### peers - -> **peers**: [`Peer`](Peer.md)[] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:24](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/types.ts#L24) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/RoomConfigRoomTypeEnum.md b/versioned_docs/version-0.22.0/api/server/type-aliases/RoomConfigRoomTypeEnum.md deleted file mode 100644 index c26c538e..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/RoomConfigRoomTypeEnum.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomConfigRoomTypeEnum - -> **RoomConfigRoomTypeEnum** = *typeof* [`RoomConfigRoomTypeEnum`](../variables/RoomConfigRoomTypeEnum.md)\[keyof *typeof* [`RoomConfigRoomTypeEnum`](../variables/RoomConfigRoomTypeEnum.md)\] - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:446 diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/RoomConfigVideoCodecEnum.md b/versioned_docs/version-0.22.0/api/server/type-aliases/RoomConfigVideoCodecEnum.md deleted file mode 100644 index 31221b5e..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/RoomConfigVideoCodecEnum.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomConfigVideoCodecEnum - -> **RoomConfigVideoCodecEnum** = *typeof* [`RoomConfigVideoCodecEnum`](../variables/RoomConfigVideoCodecEnum.md)\[keyof *typeof* [`RoomConfigVideoCodecEnum`](../variables/RoomConfigVideoCodecEnum.md)\] - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:455 diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/RoomCrashed.md b/versioned_docs/version-0.22.0/api/server/type-aliases/RoomCrashed.md deleted file mode 100644 index 4e217b68..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/RoomCrashed.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomCrashed - -> **RoomCrashed** = `object`\[`"roomCrashed"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:36](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L36) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/RoomCreated.md b/versioned_docs/version-0.22.0/api/server/type-aliases/RoomCreated.md deleted file mode 100644 index 9b920b7f..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/RoomCreated.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomCreated - -> **RoomCreated** = `object`\[`"roomCreated"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:34](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L34) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/RoomDeleted.md b/versioned_docs/version-0.22.0/api/server/type-aliases/RoomDeleted.md deleted file mode 100644 index 23e34e3d..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/RoomDeleted.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomDeleted - -> **RoomDeleted** = `object`\[`"roomDeleted"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:35](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L35) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/RoomId.md b/versioned_docs/version-0.22.0/api/server/type-aliases/RoomId.md deleted file mode 100644 index 69771854..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/RoomId.md +++ /dev/null @@ -1,8 +0,0 @@ -# Type Alias: RoomId - -> **RoomId** = [`Brand`](Brand.md)\<`string`, `"RoomId"`\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/types.ts:14](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/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.22.0/api/server/type-aliases/StreamConnected.md b/versioned_docs/version-0.22.0/api/server/type-aliases/StreamConnected.md deleted file mode 100644 index ee03b8f1..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/StreamConnected.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: StreamConnected - -> **StreamConnected** = `object`\[`"streamConnected"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:43](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L43) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/StreamDisconnected.md b/versioned_docs/version-0.22.0/api/server/type-aliases/StreamDisconnected.md deleted file mode 100644 index 42b7f398..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/StreamDisconnected.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: StreamDisconnected - -> **StreamDisconnected** = `object`\[`"streamDisconnected"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:44](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L44) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/TrackAdded.md b/versioned_docs/version-0.22.0/api/server/type-aliases/TrackAdded.md deleted file mode 100644 index f19894fa..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/TrackAdded.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackAdded - -> **TrackAdded** = `object`\[`"trackAdded"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:47](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L47) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/TrackId.md b/versioned_docs/version-0.22.0/api/server/type-aliases/TrackId.md deleted file mode 100644 index 764dec6a..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/TrackId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackId - -> **TrackId** = [`Brand`](Brand.md)\<`string`, `"TrackId"`\> - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:34](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L34) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/TrackMetadataUpdated.md b/versioned_docs/version-0.22.0/api/server/type-aliases/TrackMetadataUpdated.md deleted file mode 100644 index 024549ea..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/TrackMetadataUpdated.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackMetadataUpdated - -> **TrackMetadataUpdated** = `object`\[`"trackMetadataUpdated"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:49](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L49) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/TrackRemoved.md b/versioned_docs/version-0.22.0/api/server/type-aliases/TrackRemoved.md deleted file mode 100644 index df987f1a..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/TrackRemoved.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackRemoved - -> **TrackRemoved** = `object`\[`"trackRemoved"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:48](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L48) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/TrackType.md b/versioned_docs/version-0.22.0/api/server/type-aliases/TrackType.md deleted file mode 100644 index 5b557eff..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/TrackType.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackType - -> **TrackType** = `"audio"` \| `"video"` - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/agent.ts:28](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/agent.ts#L28) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/ViewerConnected.md b/versioned_docs/version-0.22.0/api/server/type-aliases/ViewerConnected.md deleted file mode 100644 index 3e8d4e22..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/ViewerConnected.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ViewerConnected - -> **ViewerConnected** = `object`\[`"viewerConnected"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:45](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L45) diff --git a/versioned_docs/version-0.22.0/api/server/type-aliases/ViewerDisconnected.md b/versioned_docs/version-0.22.0/api/server/type-aliases/ViewerDisconnected.md deleted file mode 100644 index 4da0910b..00000000 --- a/versioned_docs/version-0.22.0/api/server/type-aliases/ViewerDisconnected.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ViewerDisconnected - -> **ViewerDisconnected** = `object`\[`"viewerDisconnected"`\] - -Defined in: [packages/js-server-sdk/packages/js-server-sdk/src/ws\_notifier.ts:46](https://github.com/fishjam-cloud/js-server-sdk/blob/47c214593e589512a3ba31be9d92be66ca83da9a/packages/js-server-sdk/src/ws_notifier.ts#L46) diff --git a/versioned_docs/version-0.22.0/api/server/typedoc-sidebar.cjs b/versioned_docs/version-0.22.0/api/server/typedoc-sidebar.cjs deleted file mode 100644 index a72e5237..00000000 --- a/versioned_docs/version-0.22.0/api/server/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ -const typedocSidebar = {items:[{type:"category",label:"Client",items:[{type:"doc",id:"api/server/classes/FishjamClient",label:"FishjamClient"},{type:"doc",id:"api/server/classes/FishjamWSNotifier",label:"FishjamWSNotifier"}]},{type:"category",label:"Other",items:[{type:"doc",id:"api/server/enumerations/PeerStatus",label:"PeerStatus"},{type:"doc",id:"api/server/classes/BadRequestException",label:"BadRequestException"},{type:"doc",id:"api/server/classes/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/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/RoomConfigRoomTypeEnum",label:"RoomConfigRoomTypeEnum"},{type:"doc",id:"api/server/type-aliases/RoomConfigVideoCodecEnum",label:"RoomConfigVideoCodecEnum"},{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/RoomConfigRoomTypeEnum",label:"RoomConfigRoomTypeEnum"},{type:"doc",id:"api/server/variables/RoomConfigVideoCodecEnum",label:"RoomConfigVideoCodecEnum"},{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.22.0/api/server/variables/RoomConfigRoomTypeEnum.md b/versioned_docs/version-0.22.0/api/server/variables/RoomConfigRoomTypeEnum.md deleted file mode 100644 index 8e021b17..00000000 --- a/versioned_docs/version-0.22.0/api/server/variables/RoomConfigRoomTypeEnum.md +++ /dev/null @@ -1,31 +0,0 @@ -# Variable: RoomConfigRoomTypeEnum - -> `const` **RoomConfigRoomTypeEnum**: `object` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:446 - -## Type declaration - -### AudioOnly - -> `readonly` **AudioOnly**: `"audio_only"` - -### AudioOnlyLivestream - -> `readonly` **AudioOnlyLivestream**: `"audio_only_livestream"` - -### Broadcaster - -> `readonly` **Broadcaster**: `"broadcaster"` - -### Conference - -> `readonly` **Conference**: `"conference"` - -### FullFeature - -> `readonly` **FullFeature**: `"full_feature"` - -### Livestream - -> `readonly` **Livestream**: `"livestream"` diff --git a/versioned_docs/version-0.22.0/api/server/variables/RoomConfigVideoCodecEnum.md b/versioned_docs/version-0.22.0/api/server/variables/RoomConfigVideoCodecEnum.md deleted file mode 100644 index 9d9b5bde..00000000 --- a/versioned_docs/version-0.22.0/api/server/variables/RoomConfigVideoCodecEnum.md +++ /dev/null @@ -1,15 +0,0 @@ -# Variable: RoomConfigVideoCodecEnum - -> `const` **RoomConfigVideoCodecEnum**: `object` - -Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:455 - -## Type declaration - -### H264 - -> `readonly` **H264**: `"h264"` - -### Vp8 - -> `readonly` **Vp8**: `"vp8"` diff --git a/versioned_docs/version-0.22.0/api/web/functions/useVAD.md b/versioned_docs/version-0.22.0/api/web/functions/useVAD.md deleted file mode 100644 index f4fd0321..00000000 --- a/versioned_docs/version-0.22.0/api/web/functions/useVAD.md +++ /dev/null @@ -1,31 +0,0 @@ -# Function: useVAD() - -> **useVAD**(`peerIds`): `Record`\<[`PeerId`](../type-aliases/PeerId.md), `boolean`\> - -Defined in: [packages/react-client/src/hooks/useVAD.ts:25](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/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.22.0/api/web/interfaces/FishjamProviderProps.md b/versioned_docs/version-0.22.0/api/web/interfaces/FishjamProviderProps.md deleted file mode 100644 index 4b24d2a5..00000000 --- a/versioned_docs/version-0.22.0/api/web/interfaces/FishjamProviderProps.md +++ /dev/null @@ -1,99 +0,0 @@ -# Interface: FishjamProviderProps - -Defined in: [packages/react-client/src/FishjamProvider.tsx:27](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/FishjamProvider.tsx#L27) - -## Extends - -- `PropsWithChildren` - -## Properties - -### audioConfig? - -> `optional` **audioConfig**: [`StreamConfig`](../type-aliases/StreamConfig.md) - -Defined in: [packages/react-client/src/FishjamProvider.tsx:55](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/FishjamProvider.tsx#L55) - -Configure whether to use audio simulcast and which layers to send if so. - -*** - -### bandwidthLimits? - -> `optional` **bandwidthLimits**: `Partial`\<[`BandwidthLimits`](../type-aliases/BandwidthLimits.md)\> - -Defined in: [packages/react-client/src/FishjamProvider.tsx:47](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/FishjamProvider.tsx#L47) - -Adjust max bandwidth limit for a single stream and simulcast. - -*** - -### children? - -> `optional` **children**: `ReactNode` - -Defined in: node\_modules/@types/react/index.d.ts:1398 - -#### Inherited from - -`PropsWithChildren.children` - -*** - -### constraints? - -> `optional` **constraints**: `Pick`\<`MediaStreamConstraints`, `"audio"` \| `"video"`\> - -Defined in: [packages/react-client/src/FishjamProvider.tsx:38](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/FishjamProvider.tsx#L38) - -Set preferred constraints. - -#### Param - -The media stream constraints as defined by the Web API. - -#### See - -[MediaStreamConstraints](https://udn.realityripple.com/docs/Web/API/MediaStreamConstraints) - -*** - -### fishjamId - -> **fishjamId**: `string` - -Defined in: [packages/react-client/src/FishjamProvider.tsx:59](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/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: [packages/react-client/src/FishjamProvider.tsx:43](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/FishjamProvider.tsx#L43) - -Decide if you want Fishjam SDK to persist last used device in the local storage. -You can also provide your getter and setter by using the [PersistLastDeviceHandlers](../type-aliases/PersistLastDeviceHandlers.md) interface. - -*** - -### reconnect? - -> `optional` **reconnect**: `boolean` \| [`ReconnectConfig`](../type-aliases/ReconnectConfig.md) - -Defined in: [packages/react-client/src/FishjamProvider.tsx:32](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/FishjamProvider.tsx#L32) - -Use [ReconnectConfig](../type-aliases/ReconnectConfig.md) to adjust reconnection policy to your needs or set false it. -Set to true by default. - -*** - -### videoConfig? - -> `optional` **videoConfig**: [`StreamConfig`](../type-aliases/StreamConfig.md) - -Defined in: [packages/react-client/src/FishjamProvider.tsx:51](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/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.22.0/api/web/interfaces/JoinRoomConfig.md b/versioned_docs/version-0.22.0/api/web/interfaces/JoinRoomConfig.md deleted file mode 100644 index 3ab20f36..00000000 --- a/versioned_docs/version-0.22.0/api/web/interfaces/JoinRoomConfig.md +++ /dev/null @@ -1,29 +0,0 @@ -# Interface: JoinRoomConfig\ - -Defined in: [packages/react-client/src/hooks/useConnection.ts:10](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useConnection.ts#L10) - -## Type Parameters - -| Type Parameter | Default type | -| ------ | ------ | -| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | - -## Properties - -### peerMetadata? - -> `optional` **peerMetadata**: `PeerMetadata` - -Defined in: [packages/react-client/src/hooks/useConnection.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/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: [packages/react-client/src/hooks/useConnection.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useConnection.ts#L14) - -Token received from server (or Room Manager) diff --git a/versioned_docs/version-0.22.0/api/web/interfaces/UseLivestreamStreamerResult.md b/versioned_docs/version-0.22.0/api/web/interfaces/UseLivestreamStreamerResult.md deleted file mode 100644 index 96b626ad..00000000 --- a/versioned_docs/version-0.22.0/api/web/interfaces/UseLivestreamStreamerResult.md +++ /dev/null @@ -1,62 +0,0 @@ -# Interface: UseLivestreamStreamerResult - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:27](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamStreamer.ts#L27) - -## Properties - -### connect() - -> **connect**: (`inputs`, `urlOverride?`) => `Promise`\<`void`\> - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:34](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamStreamer.ts#L34) - -Callback used to start publishing the selected audio and video media streams. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `inputs` | [`ConnectStreamerConfig`](../type-aliases/ConnectStreamerConfig.md) | -| `urlOverride?` | `string` | - -#### Returns - -`Promise`\<`void`\> - -#### Remarks - -Calling [connect](#connect) multiple times will have the effect of only publishing the **last** specified inputs. - -*** - -### disconnect() - -> **disconnect**: () => `void` - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:36](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamStreamer.ts#L36) - -Callback to stop publishing anything previously published with [connect](#connect) - -#### Returns - -`void` - -*** - -### error - -> **error**: `null` \| `LivestreamError` - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:38](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamStreamer.ts#L38) - -Any errors encountered in [connect](#connect) will populate this field - -*** - -### isConnected - -> **isConnected**: `boolean` - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:40](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamStreamer.ts#L40) - -Utility flag which indicates the current connection status diff --git a/versioned_docs/version-0.22.0/api/web/interfaces/UseLivestreamViewerResult.md b/versioned_docs/version-0.22.0/api/web/interfaces/UseLivestreamViewerResult.md deleted file mode 100644 index c48fd045..00000000 --- a/versioned_docs/version-0.22.0/api/web/interfaces/UseLivestreamViewerResult.md +++ /dev/null @@ -1,70 +0,0 @@ -# Interface: UseLivestreamViewerResult - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:11](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamViewer.ts#L11) - -## Properties - -### connect() - -> **connect**: (`config`, `url?`) => `Promise`\<`void`\> - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamViewer.ts#L19) - -Callback to start receiving a livestream. -If the livestream is private, provide `token`. -If the livestream is public, provide `streamId`. - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `config` | [`ConnectViewerConfig`](../type-aliases/ConnectViewerConfig.md) | -| `url?` | `string` | - -#### Returns - -`Promise`\<`void`\> - -*** - -### disconnect() - -> **disconnect**: () => `void` - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamViewer.ts#L21) - -Callback used to disconnect from a stream previously connected to with [connect](#connect) - -#### Returns - -`void` - -*** - -### error - -> **error**: `null` \| `LivestreamError` - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamViewer.ts#L23) - -Any errors encountered in [connect](#connect) will be present in this field. - -*** - -### isConnected - -> **isConnected**: `boolean` - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:25](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamViewer.ts#L25) - -Utility flag which indicates the current connection status - -*** - -### stream - -> **stream**: `null` \| `MediaStream` - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:13](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamViewer.ts#L13) - -The received livestream media diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/BandwidthLimits.md b/versioned_docs/version-0.22.0/api/web/type-aliases/BandwidthLimits.md deleted file mode 100644 index 9e2bae6c..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/BandwidthLimits.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: BandwidthLimits - -> **BandwidthLimits** = `object` - -Defined in: [packages/react-client/src/types/public.ts:61](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L61) - -## Properties - -### simulcast - -> **simulcast**: [`SimulcastBandwidthLimits`](SimulcastBandwidthLimits.md) - -Defined in: [packages/react-client/src/types/public.ts:61](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L61) - -*** - -### singleStream - -> **singleStream**: `number` - -Defined in: [packages/react-client/src/types/public.ts:61](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L61) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/ConnectStreamerConfig.md b/versioned_docs/version-0.22.0/api/web/type-aliases/ConnectStreamerConfig.md deleted file mode 100644 index 7cf777e2..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/ConnectStreamerConfig.md +++ /dev/null @@ -1,23 +0,0 @@ -# Type Alias: ConnectStreamerConfig - -> **ConnectStreamerConfig** = `object` - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamStreamer.ts#L20) - -## Properties - -### inputs - -> **inputs**: [`StreamerInputs`](StreamerInputs.md) - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamStreamer.ts#L21) - -*** - -### token - -> **token**: `string` - -Defined in: [packages/react-client/src/hooks/useLivestreamStreamer.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamStreamer.ts#L23) - -Streamer token used to authenticate with Fishjam diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/ConnectViewerConfig.md b/versioned_docs/version-0.22.0/api/web/type-aliases/ConnectViewerConfig.md deleted file mode 100644 index 2819f4cd..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/ConnectViewerConfig.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: ConnectViewerConfig - -> **ConnectViewerConfig** = \{ `streamId?`: `never`; `token`: `string`; \} \| \{ `streamId`: `string`; `token?`: `never`; \} - -Defined in: [packages/react-client/src/hooks/useLivestreamViewer.ts:6](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useLivestreamViewer.ts#L6) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/CustomSource.md b/versioned_docs/version-0.22.0/api/web/type-aliases/CustomSource.md deleted file mode 100644 index 8568175c..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/CustomSource.md +++ /dev/null @@ -1,40 +0,0 @@ -# Type Alias: CustomSource\ - -> **CustomSource**\<`T`\> = `object` - -Defined in: [packages/react-client/src/types/public.ts:74](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L74) - -## Type Parameters - -| Type Parameter | -| ------ | -| `T` *extends* `string` | - -## Properties - -### id - -> **id**: `T` - -Defined in: [packages/react-client/src/types/public.ts:75](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L75) - -*** - -### stream? - -> `optional` **stream**: `MediaStream` - -Defined in: [packages/react-client/src/types/public.ts:77](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L77) - -*** - -### trackIds? - -> `optional` **trackIds**: `object` - -Defined in: [packages/react-client/src/types/public.ts:76](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L76) - -| Name | Type | -| ------ | ------ | -| `audioId?` | `string` | -| `videoId?` | `string` | diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/DeviceItem.md b/versioned_docs/version-0.22.0/api/web/type-aliases/DeviceItem.md deleted file mode 100644 index da78e3a0..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/DeviceItem.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: DeviceItem - -> **DeviceItem** = `object` - -Defined in: [packages/react-client/src/types/public.ts:46](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L46) - -## Properties - -### deviceId - -> **deviceId**: `string` - -Defined in: [packages/react-client/src/types/public.ts:46](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L46) - -*** - -### label - -> **label**: `string` - -Defined in: [packages/react-client/src/types/public.ts:46](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L46) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/InitializeDevicesResult.md b/versioned_docs/version-0.22.0/api/web/type-aliases/InitializeDevicesResult.md deleted file mode 100644 index 596faa28..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/InitializeDevicesResult.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: InitializeDevicesResult - -> **InitializeDevicesResult** = `object` - -Defined in: [packages/react-client/src/types/public.ts:5](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L5) - -## Properties - -### errors - -> **errors**: \{ `audio`: [`DeviceError`](DeviceError.md) \| `null`; `video`: [`DeviceError`](DeviceError.md) \| `null`; \} \| `null` - -Defined in: [packages/react-client/src/types/public.ts:8](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L8) - -*** - -### status - -> **status**: [`InitializeDevicesStatus`](InitializeDevicesStatus.md) - -Defined in: [packages/react-client/src/types/public.ts:6](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L6) - -*** - -### stream - -> **stream**: `MediaStream` \| `null` - -Defined in: [packages/react-client/src/types/public.ts:7](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L7) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/InitializeDevicesSettings.md b/versioned_docs/version-0.22.0/api/web/type-aliases/InitializeDevicesSettings.md deleted file mode 100644 index f021112a..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/InitializeDevicesSettings.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: InitializeDevicesSettings - -> **InitializeDevicesSettings** = `object` - -Defined in: [packages/react-client/src/hooks/internal/devices/useMediaDevices.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/internal/devices/useMediaDevices.ts#L14) - -## Properties - -### enableAudio? - -> `optional` **enableAudio**: `boolean` - -Defined in: [packages/react-client/src/hooks/internal/devices/useMediaDevices.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/internal/devices/useMediaDevices.ts#L14) - -*** - -### enableVideo? - -> `optional` **enableVideo**: `boolean` - -Defined in: [packages/react-client/src/hooks/internal/devices/useMediaDevices.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/internal/devices/useMediaDevices.ts#L14) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/InitializeDevicesStatus.md b/versioned_docs/version-0.22.0/api/web/type-aliases/InitializeDevicesStatus.md deleted file mode 100644 index 210b66cb..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/InitializeDevicesStatus.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: InitializeDevicesStatus - -> **InitializeDevicesStatus** = `"initialized"` \| `"failed"` \| `"initialized_with_errors"` \| `"already_initialized"` - -Defined in: [packages/react-client/src/types/public.ts:3](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L3) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/MiddlewareResult.md b/versioned_docs/version-0.22.0/api/web/type-aliases/MiddlewareResult.md deleted file mode 100644 index f199bd26..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/MiddlewareResult.md +++ /dev/null @@ -1,25 +0,0 @@ -# Type Alias: MiddlewareResult - -> **MiddlewareResult** = `object` - -Defined in: [packages/react-client/src/types/public.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L23) - -## Properties - -### onClear()? - -> `optional` **onClear**: () => `void` - -Defined in: [packages/react-client/src/types/public.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L23) - -#### Returns - -`void` - -*** - -### track - -> **track**: `MediaStreamTrack` - -Defined in: [packages/react-client/src/types/public.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L23) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/PeerId.md b/versioned_docs/version-0.22.0/api/web/type-aliases/PeerId.md deleted file mode 100644 index 9243125f..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/PeerId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: PeerId - -> **PeerId** = [`Brand`](Brand.md)\<`string`, `"PeerId"`\> - -Defined in: [packages/react-client/src/types/public.ts:12](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L12) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/PeerWithTracks.md b/versioned_docs/version-0.22.0/api/web/type-aliases/PeerWithTracks.md deleted file mode 100644 index e86ba74f..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/PeerWithTracks.md +++ /dev/null @@ -1,84 +0,0 @@ -# Type Alias: PeerWithTracks\ - -> **PeerWithTracks**\<`PeerMetadata`, `ServerMetadata`\> = `object` - -Defined in: [packages/react-client/src/hooks/usePeers.ts:13](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/usePeers.ts#L13) - -## Type Parameters - -| Type Parameter | Description | -| ------ | ------ | -| `PeerMetadata` | Type of metadata set by peer while connecting to a room. | -| `ServerMetadata` | Type of metadata set by the server while creating a peer. | - -## Properties - -### cameraTrack? - -> `optional` **cameraTrack**: [`Track`](Track.md) - -Defined in: [packages/react-client/src/hooks/usePeers.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/usePeers.ts#L17) - -*** - -### customAudioTracks - -> **customAudioTracks**: [`Track`](Track.md)[] - -Defined in: [packages/react-client/src/hooks/usePeers.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/usePeers.ts#L22) - -*** - -### customVideoTracks - -> **customVideoTracks**: [`Track`](Track.md)[] - -Defined in: [packages/react-client/src/hooks/usePeers.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/usePeers.ts#L21) - -*** - -### id - -> **id**: [`PeerId`](PeerId.md) - -Defined in: [packages/react-client/src/hooks/usePeers.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/usePeers.ts#L14) - -*** - -### metadata? - -> `optional` **metadata**: [`Metadata`](Metadata.md)\<`PeerMetadata`, `ServerMetadata`\> - -Defined in: [packages/react-client/src/hooks/usePeers.ts:15](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/usePeers.ts#L15) - -*** - -### microphoneTrack? - -> `optional` **microphoneTrack**: [`Track`](Track.md) - -Defined in: [packages/react-client/src/hooks/usePeers.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/usePeers.ts#L18) - -*** - -### screenShareAudioTrack? - -> `optional` **screenShareAudioTrack**: [`Track`](Track.md) - -Defined in: [packages/react-client/src/hooks/usePeers.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/usePeers.ts#L20) - -*** - -### screenShareVideoTrack? - -> `optional` **screenShareVideoTrack**: [`Track`](Track.md) - -Defined in: [packages/react-client/src/hooks/usePeers.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/usePeers.ts#L19) - -*** - -### tracks - -> **tracks**: [`Track`](Track.md)[] - -Defined in: [packages/react-client/src/hooks/usePeers.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/usePeers.ts#L16) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/PersistLastDeviceHandlers.md b/versioned_docs/version-0.22.0/api/web/type-aliases/PersistLastDeviceHandlers.md deleted file mode 100644 index e6860855..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/PersistLastDeviceHandlers.md +++ /dev/null @@ -1,42 +0,0 @@ -# Type Alias: PersistLastDeviceHandlers - -> **PersistLastDeviceHandlers** = `object` - -Defined in: [packages/react-client/src/types/public.ts:48](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L48) - -## Properties - -### getLastDevice() - -> **getLastDevice**: (`deviceType`) => `MediaDeviceInfo` \| `null` - -Defined in: [packages/react-client/src/types/public.ts:49](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L49) - -#### Parameters - -| Parameter | Type | -| ------ | ------ | -| `deviceType` | `"audio"` \| `"video"` | - -#### Returns - -`MediaDeviceInfo` \| `null` - -*** - -### saveLastDevice() - -> **saveLastDevice**: (`info`, `deviceType`) => `void` - -Defined in: [packages/react-client/src/types/public.ts:50](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/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.22.0/api/web/type-aliases/RoomType.md b/versioned_docs/version-0.22.0/api/web/type-aliases/RoomType.md deleted file mode 100644 index 2bf674a0..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/RoomType.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: RoomType - -> **RoomType** = `"conference"` \| `"livestream"` \| `"audio_only"` - -Defined in: [packages/react-client/src/hooks/useSandbox.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useSandbox.ts#L17) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/SimulcastBandwidthLimits.md b/versioned_docs/version-0.22.0/api/web/type-aliases/SimulcastBandwidthLimits.md deleted file mode 100644 index 7c4017ff..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/SimulcastBandwidthLimits.md +++ /dev/null @@ -1,29 +0,0 @@ -# Type Alias: SimulcastBandwidthLimits - -> **SimulcastBandwidthLimits** = `object` - -Defined in: [packages/react-client/src/types/public.ts:53](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L53) - -## Properties - -### 1 - -> **1**: `number` - -Defined in: [packages/react-client/src/types/public.ts:54](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L54) - -*** - -### 2 - -> **2**: `number` - -Defined in: [packages/react-client/src/types/public.ts:55](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L55) - -*** - -### 3 - -> **3**: `number` - -Defined in: [packages/react-client/src/types/public.ts:56](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L56) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/StreamConfig.md b/versioned_docs/version-0.22.0/api/web/type-aliases/StreamConfig.md deleted file mode 100644 index 9d0c0480..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/StreamConfig.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: StreamConfig - -> **StreamConfig** = `object` - -Defined in: [packages/react-client/src/types/public.ts:59](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L59) - -## Properties - -### simulcast? - -> `optional` **simulcast**: [`Variant`](../enumerations/Variant.md)[] \| `false` - -Defined in: [packages/react-client/src/types/public.ts:59](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L59) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/Track.md b/versioned_docs/version-0.22.0/api/web/type-aliases/Track.md deleted file mode 100644 index 4c32959a..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/Track.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: Track - -> **Track** = `object` - -Defined in: [packages/react-client/src/types/public.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L14) - -## Properties - -### encoding - -> **encoding**: [`Variant`](../enumerations/Variant.md) \| `null` - -Defined in: [packages/react-client/src/types/public.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L16) - -*** - -### metadata? - -> `optional` **metadata**: `TrackMetadata` - -Defined in: [packages/react-client/src/types/public.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L18) - -*** - -### simulcastConfig - -> **simulcastConfig**: [`SimulcastConfig`](../interfaces/SimulcastConfig.md) \| `null` - -Defined in: [packages/react-client/src/types/public.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L19) - -*** - -### stream - -> **stream**: `MediaStream` \| `null` - -Defined in: [packages/react-client/src/types/public.ts:15](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L15) - -*** - -### track - -> **track**: `MediaStreamTrack` \| `null` - -Defined in: [packages/react-client/src/types/public.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L20) - -*** - -### trackId - -> **trackId**: [`TrackId`](TrackId.md) - -Defined in: [packages/react-client/src/types/public.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L17) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/TrackId.md b/versioned_docs/version-0.22.0/api/web/type-aliases/TrackId.md deleted file mode 100644 index 179cb382..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/TrackId.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackId - -> **TrackId** = [`Brand`](Brand.md)\<`string`, `"TrackId"`\> - -Defined in: [packages/react-client/src/types/public.ts:11](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L11) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/TrackMiddleware.md b/versioned_docs/version-0.22.0/api/web/type-aliases/TrackMiddleware.md deleted file mode 100644 index 9d85c9a0..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/TrackMiddleware.md +++ /dev/null @@ -1,5 +0,0 @@ -# Type Alias: TrackMiddleware - -> **TrackMiddleware** = (`track`) => [`MiddlewareResult`](MiddlewareResult.md) \| `Promise`\<[`MiddlewareResult`](MiddlewareResult.md)\> \| `null` - -Defined in: [packages/react-client/src/types/public.ts:24](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L24) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/TracksMiddlewareResult.md b/versioned_docs/version-0.22.0/api/web/type-aliases/TracksMiddlewareResult.md deleted file mode 100644 index 2affdf73..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/TracksMiddlewareResult.md +++ /dev/null @@ -1,33 +0,0 @@ -# Type Alias: TracksMiddlewareResult - -> **TracksMiddlewareResult** = `object` - -Defined in: [packages/react-client/src/types/public.ts:26](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L26) - -## Properties - -### audioTrack - -> **audioTrack**: `MediaStreamTrack` \| `null` - -Defined in: [packages/react-client/src/types/public.ts:28](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L28) - -*** - -### onClear() - -> **onClear**: () => `void` - -Defined in: [packages/react-client/src/types/public.ts:29](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L29) - -#### Returns - -`void` - -*** - -### videoTrack - -> **videoTrack**: `MediaStreamTrack` - -Defined in: [packages/react-client/src/types/public.ts:27](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/types/public.ts#L27) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/UseInitializeDevicesParams.md b/versioned_docs/version-0.22.0/api/web/type-aliases/UseInitializeDevicesParams.md deleted file mode 100644 index e69cb01c..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/UseInitializeDevicesParams.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: UseInitializeDevicesParams - -> **UseInitializeDevicesParams** = `object` - -Defined in: [packages/react-client/src/hooks/devices/useInitializeDevices.ts:5](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L5) - -## Properties - -### enableAudio? - -> `optional` **enableAudio**: `boolean` - -Defined in: [packages/react-client/src/hooks/devices/useInitializeDevices.ts:7](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L7) - -*** - -### enableVideo? - -> `optional` **enableVideo**: `boolean` - -Defined in: [packages/react-client/src/hooks/devices/useInitializeDevices.ts:6](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L6) diff --git a/versioned_docs/version-0.22.0/api/web/type-aliases/UseSandboxProps.md b/versioned_docs/version-0.22.0/api/web/type-aliases/UseSandboxProps.md deleted file mode 100644 index 4b9ded38..00000000 --- a/versioned_docs/version-0.22.0/api/web/type-aliases/UseSandboxProps.md +++ /dev/null @@ -1,17 +0,0 @@ -# Type Alias: UseSandboxProps - -> **UseSandboxProps** = `object` - -Defined in: [packages/react-client/src/hooks/useSandbox.ts:12](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useSandbox.ts#L12) - -## Properties - -### configOverride? - -> `optional` **configOverride**: `object` - -Defined in: [packages/react-client/src/hooks/useSandbox.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/cca0d7a57568ca97560c29d27fcd8b63f2678492/packages/react-client/src/hooks/useSandbox.ts#L14) - -| Name | Type | -| ------ | ------ | -| `sandboxApiUrl?` | `string` | diff --git a/versioned_docs/version-0.22.0/api/web/typedoc-sidebar.cjs b/versioned_docs/version-0.22.0/api/web/typedoc-sidebar.cjs deleted file mode 100644 index 3f4a788e..00000000 --- a/versioned_docs/version-0.22.0/api/web/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ -const typedocSidebar = {items:[{type:"category",label:"Connection",items:[{type:"doc",id:"api/web/functions/useConnection",label:"useConnection"},{type:"doc",id:"api/web/functions/usePeers",label:"usePeers"},{type:"doc",id:"api/web/functions/useUpdatePeerMetadata",label:"useUpdatePeerMetadata"},{type:"doc",id:"api/web/functions/useVAD",label:"useVAD"},{type:"doc",id:"api/web/type-aliases/Metadata",label:"Metadata"}]},{type:"category",label:"Devices",items:[{type:"doc",id:"api/web/functions/useCamera",label:"useCamera"},{type:"doc",id:"api/web/functions/useInitializeDevices",label:"useInitializeDevices"},{type:"doc",id:"api/web/functions/useMicrophone",label:"useMicrophone"},{type:"doc",id:"api/web/functions/useScreenShare",label:"useScreenShare"}]},{type:"category",label:"Components",items:[{type:"doc",id:"api/web/functions/FishjamProvider",label:"FishjamProvider"},{type:"doc",id:"api/web/interfaces/FishjamProviderProps",label:"FishjamProviderProps"}]},{type:"category",label:"Livestream",items:[{type:"doc",id:"api/web/functions/useLivestreamStreamer",label:"useLivestreamStreamer"},{type:"doc",id:"api/web/functions/useLivestreamViewer",label:"useLivestreamViewer"},{type:"doc",id:"api/web/interfaces/UseLivestreamStreamerResult",label:"UseLivestreamStreamerResult"},{type:"doc",id:"api/web/interfaces/UseLivestreamViewerResult",label:"UseLivestreamViewerResult"},{type:"doc",id:"api/web/type-aliases/ConnectStreamerConfig",label:"ConnectStreamerConfig"},{type:"doc",id:"api/web/type-aliases/StreamerInputs",label:"StreamerInputs"}]},{type:"category",label:"Other",items:[{type:"doc",id:"api/web/functions/useCustomSource",label:"useCustomSource"},{type:"doc",id:"api/web/functions/useSandbox",label:"useSandbox"},{type:"doc",id:"api/web/enumerations/Variant",label:"Variant"},{type:"doc",id:"api/web/interfaces/JoinRoomConfig",label:"JoinRoomConfig"},{type:"doc",id:"api/web/interfaces/SimulcastConfig",label:"SimulcastConfig"},{type:"doc",id:"api/web/type-aliases/AuthErrorReason",label:"AuthErrorReason"},{type:"doc",id:"api/web/type-aliases/BandwidthLimits",label:"BandwidthLimits"},{type:"doc",id:"api/web/type-aliases/Brand",label:"Brand"},{type:"doc",id:"api/web/type-aliases/ConnectViewerConfig",label:"ConnectViewerConfig"},{type:"doc",id:"api/web/type-aliases/CustomSource",label:"CustomSource"},{type:"doc",id:"api/web/type-aliases/DeviceError",label:"DeviceError"},{type:"doc",id:"api/web/type-aliases/DeviceItem",label:"DeviceItem"},{type:"doc",id:"api/web/type-aliases/InitializeDevicesResult",label:"InitializeDevicesResult"},{type:"doc",id:"api/web/type-aliases/InitializeDevicesSettings",label:"InitializeDevicesSettings"},{type:"doc",id:"api/web/type-aliases/InitializeDevicesStatus",label:"InitializeDevicesStatus"},{type:"doc",id:"api/web/type-aliases/JoinErrorReason",label:"JoinErrorReason"},{type:"doc",id:"api/web/type-aliases/MiddlewareResult",label:"MiddlewareResult"},{type:"doc",id:"api/web/type-aliases/PeerId",label:"PeerId"},{type:"doc",id:"api/web/type-aliases/PeerStatus",label:"PeerStatus"},{type:"doc",id:"api/web/type-aliases/PeerWithTracks",label:"PeerWithTracks"},{type:"doc",id:"api/web/type-aliases/PersistLastDeviceHandlers",label:"PersistLastDeviceHandlers"},{type:"doc",id:"api/web/type-aliases/ReconnectConfig",label:"ReconnectConfig"},{type:"doc",id:"api/web/type-aliases/ReconnectionStatus",label:"ReconnectionStatus"},{type:"doc",id:"api/web/type-aliases/RoomType",label:"RoomType"},{type:"doc",id:"api/web/type-aliases/SimulcastBandwidthLimit",label:"SimulcastBandwidthLimit"},{type:"doc",id:"api/web/type-aliases/SimulcastBandwidthLimits",label:"SimulcastBandwidthLimits"},{type:"doc",id:"api/web/type-aliases/StreamConfig",label:"StreamConfig"},{type:"doc",id:"api/web/type-aliases/Track",label:"Track"},{type:"doc",id:"api/web/type-aliases/TrackBandwidthLimit",label:"TrackBandwidthLimit"},{type:"doc",id:"api/web/type-aliases/TrackId",label:"TrackId"},{type:"doc",id:"api/web/type-aliases/TrackMiddleware",label:"TrackMiddleware"},{type:"doc",id:"api/web/type-aliases/TracksMiddleware",label:"TracksMiddleware"},{type:"doc",id:"api/web/type-aliases/TracksMiddlewareResult",label:"TracksMiddlewareResult"},{type:"doc",id:"api/web/type-aliases/UseInitializeDevicesParams",label:"UseInitializeDevicesParams"},{type:"doc",id:"api/web/type-aliases/UseSandboxProps",label:"UseSandboxProps"},{type:"doc",id:"api/web/variables/SimulcastConfig",label:"SimulcastConfig"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/versioned_docs/version-0.22.0/how-to/react-native/_category_.json b/versioned_docs/version-0.22.0/how-to/react-native/_category_.json deleted file mode 100644 index 1fd79841..00000000 --- a/versioned_docs/version-0.22.0/how-to/react-native/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "React Native", - "position": 1 -} diff --git a/versioned_docs/version-0.22.0/how-to/react-native/_components/configure-permissions.mdx b/versioned_docs/version-0.22.0/how-to/react-native/_components/configure-permissions.mdx deleted file mode 100644 index bd5debcc..00000000 --- a/versioned_docs/version-0.22.0/how-to/react-native/_components/configure-permissions.mdx +++ /dev/null @@ -1,91 +0,0 @@ -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -Your app needs to have permissions configured in order to use the microphone and camera. - -### Android - -Permissions below are required to stream audio and video with Fishjam on Android. - -- `android.permission.CAMERA` -- `android.permission.RECORD_AUDIO` -- `android.permission.MODIFY_AUDIO_SETTINGS` - - - - - -Add required permissions to the `app.json` file. - -```json title='app.json' -{ - "expo": { - ... - "android": { - ... - "permissions": [ - "android.permission.CAMERA", - "android.permission.RECORD_AUDIO", - "android.permission.MODIFY_AUDIO_SETTINGS" - ] - } - } -} -``` - - - - -Add required permissions to the `AndroidManifest.xml` file. - -```xml title='AndroidManifest.xml' - - ... - - - - ... - -``` - - - - -### iOS - - - - - -You don't have to make any changes to run app on iOS. -To update default content of permission alert, you can add these settings to `app.json`: - -```json title='app.json' -{ - "expo": { - ... - "ios": { - ... - "infoPlist": { - "NSCameraUsageDescription": "Allow $(PRODUCT_NAME) to access your camera.", - "NSMicrophoneUsageDescription": "Allow $(PRODUCT_NAME) to access your microphone." - } - }, - } -} -``` - - - - -Ensure `Info.plist` contains camera and microphone usage description entries: - -```xml title='Info.plist' - NSCameraUsageDescription - Allow $(PRODUCT_NAME) to access your camera. - NSMicrophoneUsageDescription - Allow $(PRODUCT_NAME) to access your microphone. -``` - - - diff --git a/versioned_docs/version-0.22.0/how-to/react-native/_components/install-package.mdx b/versioned_docs/version-0.22.0/how-to/react-native/_components/install-package.mdx deleted file mode 100644 index 356da871..00000000 --- a/versioned_docs/version-0.22.0/how-to/react-native/_components/install-package.mdx +++ /dev/null @@ -1,27 +0,0 @@ -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - - - - -```bash npm2yarn -npm install @fishjam-cloud/react-native-client -``` - - - - - -### Install Expo dependencies - -Follow instructions from official [Expo documentation](https://docs.expo.dev/bare/installing-expo-modules/). - -### Install Fishjam - - ```sh - npx expo install @fishjam-cloud/react-native-client - ``` - - - - diff --git a/versioned_docs/version-0.22.0/how-to/react-native/connecting.mdx b/versioned_docs/version-0.22.0/how-to/react-native/connecting.mdx deleted file mode 100644 index 42c6388f..00000000 --- a/versioned_docs/version-0.22.0/how-to/react-native/connecting.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -sidebar_position: 2 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# Connecting - -This article will guide you through the process of connecting to a Fishjam room. - -## Getting URL and token - -In order to connect, you need to obtain a **Peer Token** (the token that will authenticate the peer in -your Room). - - - - - -Once you create your account on [Fishjam](https://fishjam.io), you will have access to the Sandbox environment as part of the Mini Jar plan. -While using the Sandbox environment, [you can use the Sandbox API](../../how-to/features/sandbox-api-testing) to generate peer tokens for testing or development purposes. -This is basically a service that will create a Room, add your app as -the Room's Peer, and return the token required to use that Room. - -```ts -import { useSandbox } from "@fishjam-cloud/react-native-client"; -const SANDBOX_FISHJAM_ID = "..."; -const roomName = "room"; -const peerName = "user"; -// ---cut--- - -// The `useSandbox` hook will work ONLY with the FISHJAM_ID of the Sandbox environment -const { getSandboxPeerToken } = useSandbox({ fishjamId: SANDBOX_FISHJAM_ID }); -const peerToken = await getSandboxPeerToken(roomName, peerName); -``` - - - - -For the production app, you need to implement your own backend service that will provide the user with a **Peer Token**. To do that, -follow our [server setup instructions](../../how-to/backend/server-setup). - - - - -## Connecting - -In order to connect, call [`joinRoom`](../../api/mobile/functions/useConnection#joinroom) method with the `peerToken` and the fishjam ID: - -```tsx -import React, { useCallback } from "react"; -import { Button } from "react-native"; -import { useConnection, useSandbox } from "@fishjam-cloud/react-native-client"; - -// Check https://fishjam.io/app/ for your Fishjam ID -const FISHJAM_ID = "..."; - -export function JoinRoomButton() { - const { joinRoom } = useConnection(); // [!code highlight] - const { getSandboxPeerToken } = useSandbox({ fishjamId: FISHJAM_ID }); - - const onPressJoin = useCallback(async () => { - // in production environment, get the peerToken from your backend - const peerToken = await getSandboxPeerToken("Room", "User"); - - await joinRoom({ fishjamId: FISHJAM_ID, peerToken }); // [!code highlight] - }, [joinRoom]); - - return ; -} -``` - -## Disconnecting - -In order to close connection, use the [`leaveRoom`](../../api/web/functions/useConnection#leaveroom) method -from [`useConnection`](../../api/web/functions/useConnection) hook. - -```tsx -import { useConnection } from "@fishjam-cloud/react-client"; -import React, { useCallback } from "react"; - -export function LeaveRoomButton() { - const { leaveRoom } = useConnection(); // [!code highlight] - - return ; -} -``` diff --git a/versioned_docs/version-0.22.0/how-to/react/installation.mdx b/versioned_docs/version-0.22.0/how-to/react/installation.mdx deleted file mode 100644 index ce903bb7..00000000 --- a/versioned_docs/version-0.22.0/how-to/react/installation.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -sidebar_position: 1 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# Installation - -## 1. Install the package - -```bash npm2yarn -npm install @fishjam-cloud/react-client -``` - -## 2. Setup Fishjam context - -Wrap your app in our [`FishjamProvider`](../../api/web/functions/FishjamProvider) component. Get your Fishjam ID from [Fishjam Dashboard](https://fishjam.io/app) and pass it to the provider. - -```tsx -const App = () => { - return
Hello world
; -}; - -// ---cut--- -import React from "react"; -import ReactDOM from "react-dom/client"; -// import App from "./App"; -import { FishjamProvider } from "@fishjam-cloud/react-client"; - -// Check https://fishjam.io/app/ for your Fishjam ID -const FISHJAM_ID = "your-fishjam-id"; - -ReactDOM.createRoot(document.getElementById("root")!).render( - // [!code highlight:5] - - - - - , -); -``` - -:::tip - -It's possible to have many independent Fishjam contexts in one app. -Just render many [`FishjamProvider`](../../api/web/functions/FishjamProvider) components and make sure they don't overlap. - -::: diff --git a/versioned_docs/version-0.22.0/how-to/react/list-other-peers.mdx b/versioned_docs/version-0.22.0/how-to/react/list-other-peers.mdx deleted file mode 100644 index ad5536df..00000000 --- a/versioned_docs/version-0.22.0/how-to/react/list-other-peers.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Display media of other peers - -To access data and media of other peers, use the [`usePeers`](../../api/web/functions/usePeers) hook. -It returns two properties, [`remotePeers`](../../api/web/functions/usePeers) and [`localPeer`](../../api/web/functions/usePeers). -They contain all the tracks of other peers and all the tracks of the local user, respectively. - -### Example of playing other peers' available media - -```tsx -import React, { FC } from "react"; - -const VideoRenderer: FC<{ stream?: MediaStream | null }> = (_) =>