From c8281c8b550857d4040f39fc27bc66491a5690b4 Mon Sep 17 00:00:00 2001 From: Release Automation Bot Date: Thu, 14 May 2026 11:21:16 +0000 Subject: [PATCH 1/3] chore: bump version to 0.27.0 --- api/fishjam-server | 2 +- api/protos | 2 +- api/room-manager | 2 +- packages/js-server-sdk | 2 +- packages/python-server-sdk | 2 +- packages/web-client-sdk | 2 +- .../api/protobuf/server_notifications.proto | 18 + .../_common/agents/definition.mdx | 6 + .../_common/agents/remember-to-disconnect.mdx | 3 + .../_common/agents/subscriptions.mdx | 4 + .../version-0.27.0/api/_category_.json | 12 + .../api/mobile/enumerations/Variant.md | 43 ++ .../api/mobile/functions/FishjamProvider.md | 15 + .../api/mobile/functions/RTCPIPView.md | 15 + .../api/mobile/functions/RTCView.md | 15 + .../api/mobile/functions/useCallKit.md | 9 + .../api/mobile/functions/useCallKitEvent.md | 22 + .../api/mobile/functions/useCallKitService.md | 15 + .../api/mobile/functions/useCamera.md | 118 ++++ .../mobile/functions/useCameraPermissions.md | 28 + .../api/mobile/functions/useConnection.md | 53 ++ .../api/mobile/functions/useCustomSource.md | 39 ++ .../api/mobile/functions/useDataChannel.md | 11 + .../mobile/functions/useInitializeDevices.md | 23 + .../mobile/functions/useLivestreamStreamer.md | 9 + .../mobile/functions/useLivestreamViewer.md | 9 + .../api/mobile/functions/useMicrophone.md | 124 ++++ .../functions/useMicrophonePermissions.md | 28 + .../api/mobile/functions/usePeers.md | 28 + .../api/mobile/functions/useScreenShare.md | 77 +++ .../version-0.27.0/api/mobile/index.md | 85 +++ .../mobile/interfaces/DataChannelOptions.md | 16 + .../api/mobile/interfaces/JoinRoomConfig.md | 29 + .../api/mobile/interfaces/SimulcastConfig.md | 27 + .../mobile/type-aliases/AuthErrorReason.md | 5 + .../mobile/type-aliases/BandwidthLimits.md | 21 + .../api/mobile/type-aliases/Brand.md | 18 + .../type-aliases/ConnectStreamerConfig.md | 21 + .../type-aliases/ConnectViewerConfig.md | 5 + .../api/mobile/type-aliases/CustomSource.md | 17 + .../api/mobile/type-aliases/DataCallback.md | 17 + .../api/mobile/type-aliases/DeviceError.md | 5 + .../api/mobile/type-aliases/DeviceItem.md | 21 + .../type-aliases/FishjamProviderProps.md | 5 + .../type-aliases/ForegroundServiceConfig.md | 79 +++ .../type-aliases/InitializeDevicesResult.md | 11 + .../type-aliases/InitializeDevicesSettings.md | 21 + .../type-aliases/InitializeDevicesStatus.md | 5 + .../mobile/type-aliases/JoinErrorReason.md | 5 + .../api/mobile/type-aliases/Metadata.md | 28 + .../mobile/type-aliases/MiddlewareResult.md | 25 + .../api/mobile/type-aliases/PeerId.md | 5 + .../api/mobile/type-aliases/PeerStatus.md | 12 + .../api/mobile/type-aliases/PeerWithTracks.md | 43 ++ .../mobile/type-aliases/PermissionStatus.md | 11 + .../type-aliases/PersistLastDeviceHandlers.md | 42 ++ .../mobile/type-aliases/RTCPIPViewProps.md | 11 + .../mobile/type-aliases/RTCVideoViewProps.md | 11 + .../mobile/type-aliases/ReconnectConfig.md | 37 ++ .../mobile/type-aliases/ReconnectionStatus.md | 5 + .../api/mobile/type-aliases/RemoteTrack.md | 11 + .../api/mobile/type-aliases/RoomType.md | 5 + .../type-aliases/SimulcastBandwidthLimit.md | 9 + .../type-aliases/SimulcastBandwidthLimits.md | 29 + .../api/mobile/type-aliases/StreamConfig.md | 13 + .../api/mobile/type-aliases/StreamerInputs.md | 5 + .../api/mobile/type-aliases/Track.md | 11 + .../type-aliases/TrackBandwidthLimit.md | 8 + .../api/mobile/type-aliases/TrackFields.md | 5 + .../api/mobile/type-aliases/TrackId.md | 5 + .../mobile/type-aliases/TrackMiddleware.md | 5 + .../mobile/type-aliases/TracksMiddleware.md | 16 + .../type-aliases/TracksMiddlewareResult.md | 33 + .../mobile/type-aliases/UseCameraResult.md | 11 + .../type-aliases/UseCustomSourceResult.md | 25 + .../type-aliases/UseDataChannelResult.md | 101 +++ .../UseInitializeDevicesParams.md | 21 + .../UseInitializeDevicesReturn.md | 23 + .../UseLivestreamStreamerResult.md | 22 + .../type-aliases/UseLivestreamViewerResult.md | 11 + .../type-aliases/UseMicrophoneResult.md | 11 + .../mobile/type-aliases/UseSandboxProps.md | 13 + .../type-aliases/UseScreenShareResult.md | 11 + .../api/mobile/typedoc-sidebar.cjs | 4 + .../api/mobile/variables/SimulcastConfig.md | 5 + .../mobile/variables/useForegroundService.md | 20 + .../api/mobile/variables/useSandbox.md | 60 ++ .../mobile/variables/useUpdatePeerMetadata.md | 31 + .../api/mobile/variables/useVAD.md | 25 + .../version-0.27.0/api/reference.md | 50 ++ .../api/server/classes/BadRequestException.md | 65 ++ .../api/server/classes/FishjamAgent.md | 169 +++++ .../server/classes/FishjamBaseException.md | 64 ++ .../api/server/classes/FishjamClient.md | 329 ++++++++++ .../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 + .../version-0.27.0/api/server/index.md | 77 +++ .../api/server/interfaces/MoqToken.md | 23 + .../api/server/interfaces/MoqTokenConfig.md | 37 ++ .../api/server/interfaces/PeerOptionsAgent.md | 33 + .../api/server/interfaces/PeerOptionsVapi.md | 49 ++ .../server/interfaces/PeerOptionsWebRTC.md | 39 ++ .../api/server/interfaces/RoomConfig.md | 89 +++ .../api/server/interfaces/ServerMessage.md | 275 ++++++++ .../api/server/interfaces/StreamerToken.md | 23 + .../api/server/interfaces/ViewerToken.md | 23 + .../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 | 20 + .../api/server/type-aliases/ChannelAdded.md | 5 + .../api/server/type-aliases/ChannelRemoved.md | 5 + .../server/type-aliases/CloseEventHandler.md | 16 + .../server/type-aliases/ErrorEventHandler.md | 15 + .../type-aliases/ExpectedAgentEvents.md | 5 + .../api/server/type-aliases/ExpectedEvents.md | 5 + .../api/server/type-aliases/FishjamConfig.md | 21 + .../api/server/type-aliases/IgnoredEvents.md | 5 + .../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 | 7 + .../type-aliases/PeerMetadataUpdated.md | 5 + .../api/server/type-aliases/PeerOptions.md | 7 + .../api/server/type-aliases/PeerType.md | 8 + .../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/StreamerConnected.md | 5 + .../type-aliases/StreamerDisconnected.md | 5 + .../api/server/type-aliases/Track.md | 31 + .../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 | 8 + .../server/type-aliases/ViewerConnected.md | 5 + .../server/type-aliases/ViewerDisconnected.md | 5 + .../api/server/typedoc-sidebar.cjs | 4 + .../api/server/variables/ServerMessage.md | 5 + .../api/web/enumerations/Variant.md | 43 ++ .../api/web/functions/FishjamProvider.md | 17 + .../api/web/functions/useCamera.md | 122 ++++ .../api/web/functions/useConnection.md | 53 ++ .../api/web/functions/useCustomSource.md | 44 ++ .../api/web/functions/useDataChannel.md | 11 + .../api/web/functions/useInitializeDevices.md | 25 + .../web/functions/useLivestreamStreamer.md | 11 + .../api/web/functions/useLivestreamViewer.md | 11 + .../api/web/functions/useMicrophone.md | 138 ++++ .../api/web/functions/usePeers.md | 56 ++ .../api/web/functions/useSandbox.md | 60 ++ .../api/web/functions/useScreenShare.md | 81 +++ .../web/functions/useUpdatePeerMetadata.md | 31 + .../api/web/functions/useVAD.md | 25 + .../version-0.27.0/api/web/index.md | 76 +++ .../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 | 82 +++ .../api/web/type-aliases/AuthErrorReason.md | 5 + .../api/web/type-aliases/BandwidthLimits.md | 21 + .../api/web/type-aliases/Brand.md | 18 + .../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 | 12 + .../api/web/type-aliases/PeerWithTracks.md | 85 +++ .../type-aliases/PersistLastDeviceHandlers.md | 42 ++ .../api/web/type-aliases/ReconnectConfig.md | 37 ++ .../web/type-aliases/ReconnectionStatus.md | 5 + .../api/web/type-aliases/RemoteTrack.md | 21 + .../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 | 31 + .../api/web/type-aliases/Track.md | 45 ++ .../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 | 13 + .../api/web/typedoc-sidebar.cjs | 4 + .../api/web/variables/SimulcastConfig.md | 5 + .../version-0.27.0/examples/_category_.json | 10 + .../version-0.27.0/examples/react-native.mdx | 181 ++++++ .../version-0.27.0/examples/react.mdx | 193 ++++++ .../explanation/_category_.json | 11 + .../explanation/agent-internals.mdx | 107 +++ .../explanation/architecture.mdx | 91 +++ .../explanation/data-channels.mdx | 67 ++ .../version-0.27.0/explanation/glossary.md | 39 ++ .../explanation/livestreams.mdx | 217 ++++++ .../version-0.27.0/explanation/rooms.mdx | 143 ++++ .../explanation/sandbox-api-concept.mdx | 92 +++ .../explanation/security-tokens.mdx | 116 ++++ .../version-0.27.0/explanation/simulcast.mdx | 83 +++ .../explanation/what-is-fishjam.mdx | 67 ++ .../version-0.27.0/how-to/_category_.json | 11 + .../how-to/_common/metadata/header.mdx | 10 + .../how-to/_common/metadata/joining_room.mdx | 5 + .../how-to/_common/metadata/reading.mdx | 9 + .../how-to/_common/metadata/updating.mdx | 5 + .../how-to/backend/_category_.json | 4 + .../how-to/backend/audio-only-calls.mdx | 100 +++ .../how-to/backend/fastapi-example.mdx | 100 +++ .../how-to/backend/fastify-example.mdx | 240 +++++++ .../how-to/backend/production-deployment.mdx | 301 +++++++++ .../how-to/backend/sandbox-api-testing.mdx | 333 ++++++++++ .../backend/selective-subscriptions.mdx | 331 ++++++++++ .../how-to/backend/server-setup.mdx | 303 +++++++++ .../how-to/backend/whip-whep.mdx | 229 +++++++ .../how-to/client/_category_.json | 8 + .../how-to/client/background-streaming.mdx | 229 +++++++ .../how-to/client/connecting.mdx | 178 +++++ .../how-to/client/custom-sources.mdx | 182 ++++++ .../how-to/client/debug-logging.mdx | 73 +++ .../how-to/client/installation.mdx | 231 +++++++ .../how-to/client/list-other-peers.mdx | 104 +++ .../how-to/client/managing-devices.mdx | 310 +++++++++ .../version-0.27.0/how-to/client/metadata.mdx | 211 ++++++ .../how-to/client/migration-guide.mdx | 449 +++++++++++++ .../how-to/client/picture-in-picture.mdx | 615 ++++++++++++++++++ .../how-to/client/reconnection-handling.mdx | 45 ++ .../how-to/client/screensharing.mdx | 257 ++++++++ .../how-to/client/simulcast.mdx | 285 ++++++++ .../how-to/client/start-streaming.mdx | 135 ++++ .../how-to/client/stream-middleware.mdx | 105 +++ .../how-to/client/text-chat.mdx | 360 ++++++++++ .../react-native/assets/ios-new-folder.png | Bin 0 -> 32047 bytes .../react-native/assets/ios-new-group.png | Bin 0 -> 117421 bytes .../react-native/assets/ios-new-target.png | Bin 0 -> 55333 bytes versioned_docs/version-0.27.0/index.mdx | 155 +++++ .../integrations/_category_.json | 11 + .../integrations/gemini-live-integration.mdx | 277 ++++++++ .../integrations/vapi-integration.mdx | 191 ++++++ .../version-0.27.0/tutorials/_category_.json | 11 + .../version-0.27.0/tutorials/agents.mdx | 401 ++++++++++++ .../tutorials/backend-quick-start.mdx | 572 ++++++++++++++++ .../tutorials/livestreaming.mdx | 470 +++++++++++++ .../tutorials/react-native-quick-start.mdx | 460 +++++++++++++ .../tutorials/react-quick-start.mdx | 298 +++++++++ .../version-0.27.0-sidebars.json | 8 + versions.json | 7 +- 280 files changed, 16257 insertions(+), 7 deletions(-) create mode 100644 versioned_docs/version-0.27.0/_common/agents/definition.mdx create mode 100644 versioned_docs/version-0.27.0/_common/agents/remember-to-disconnect.mdx create mode 100644 versioned_docs/version-0.27.0/_common/agents/subscriptions.mdx create mode 100644 versioned_docs/version-0.27.0/api/_category_.json create mode 100644 versioned_docs/version-0.27.0/api/mobile/enumerations/Variant.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/FishjamProvider.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/RTCPIPView.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/RTCView.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useCallKit.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useCallKitEvent.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useCallKitService.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useCamera.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useCameraPermissions.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useConnection.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useCustomSource.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useDataChannel.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useInitializeDevices.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useLivestreamStreamer.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useLivestreamViewer.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useMicrophone.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useMicrophonePermissions.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/usePeers.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/functions/useScreenShare.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/index.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/interfaces/DataChannelOptions.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/interfaces/JoinRoomConfig.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/interfaces/SimulcastConfig.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/AuthErrorReason.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/BandwidthLimits.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/Brand.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/ConnectStreamerConfig.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/ConnectViewerConfig.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/CustomSource.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/DataCallback.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/DeviceError.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/DeviceItem.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/FishjamProviderProps.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/ForegroundServiceConfig.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesResult.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesSettings.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesStatus.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/JoinErrorReason.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/Metadata.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/MiddlewareResult.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/PeerId.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/PeerStatus.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/PeerWithTracks.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/PermissionStatus.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/PersistLastDeviceHandlers.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCPIPViewProps.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCVideoViewProps.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/ReconnectConfig.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/ReconnectionStatus.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/RemoteTrack.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/RoomType.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/SimulcastBandwidthLimit.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/SimulcastBandwidthLimits.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/StreamConfig.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/StreamerInputs.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/Track.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackBandwidthLimit.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackFields.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackId.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackMiddleware.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/TracksMiddleware.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/TracksMiddlewareResult.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/UseCameraResult.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/UseCustomSourceResult.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/UseDataChannelResult.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/UseInitializeDevicesParams.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/UseInitializeDevicesReturn.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/UseLivestreamStreamerResult.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/UseLivestreamViewerResult.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/UseMicrophoneResult.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/UseSandboxProps.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/type-aliases/UseScreenShareResult.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/typedoc-sidebar.cjs create mode 100644 versioned_docs/version-0.27.0/api/mobile/variables/SimulcastConfig.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/variables/useForegroundService.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/variables/useSandbox.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/variables/useUpdatePeerMetadata.md create mode 100644 versioned_docs/version-0.27.0/api/mobile/variables/useVAD.md create mode 100644 versioned_docs/version-0.27.0/api/reference.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/BadRequestException.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/FishjamAgent.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/FishjamBaseException.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/FishjamClient.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/FishjamNotFoundException.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/FishjamWSNotifier.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/ForbiddenException.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/MissingFishjamIdException.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/PeerNotFoundException.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/RoomNotFoundException.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/ServiceUnavailableException.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/UnauthorizedException.md create mode 100644 versioned_docs/version-0.27.0/api/server/classes/UnknownException.md create mode 100644 versioned_docs/version-0.27.0/api/server/enumerations/PeerStatus.md create mode 100644 versioned_docs/version-0.27.0/api/server/enumerations/RoomType.md create mode 100644 versioned_docs/version-0.27.0/api/server/enumerations/VideoCodec.md create mode 100644 versioned_docs/version-0.27.0/api/server/index.md create mode 100644 versioned_docs/version-0.27.0/api/server/interfaces/MoqToken.md create mode 100644 versioned_docs/version-0.27.0/api/server/interfaces/MoqTokenConfig.md create mode 100644 versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsAgent.md create mode 100644 versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsVapi.md create mode 100644 versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsWebRTC.md create mode 100644 versioned_docs/version-0.27.0/api/server/interfaces/RoomConfig.md create mode 100644 versioned_docs/version-0.27.0/api/server/interfaces/ServerMessage.md create mode 100644 versioned_docs/version-0.27.0/api/server/interfaces/StreamerToken.md create mode 100644 versioned_docs/version-0.27.0/api/server/interfaces/ViewerToken.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/AgentCallbacks.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/AgentEvents.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/AgentTrack.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/AudioCodecParameters.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/Brand.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/ChannelAdded.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/ChannelRemoved.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/CloseEventHandler.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/ErrorEventHandler.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/ExpectedAgentEvents.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/ExpectedEvents.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/FishjamConfig.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/IgnoredEvents.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/IncomingTrackData.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/IncomingTrackImage.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/NotificationEvents.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/OutgoingTrackData.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/Peer.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/PeerAdded.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/PeerConnected.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/PeerCrashed.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/PeerDeleted.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/PeerDisconnected.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/PeerId.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/PeerMetadataUpdated.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/PeerOptions.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/PeerType.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/Room.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/RoomCrashed.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/RoomCreated.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/RoomDeleted.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/RoomId.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/StreamerConnected.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/StreamerDisconnected.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/Track.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/TrackAdded.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/TrackId.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/TrackMetadataUpdated.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/TrackRemoved.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/TrackType.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/ViewerConnected.md create mode 100644 versioned_docs/version-0.27.0/api/server/type-aliases/ViewerDisconnected.md create mode 100644 versioned_docs/version-0.27.0/api/server/typedoc-sidebar.cjs create mode 100644 versioned_docs/version-0.27.0/api/server/variables/ServerMessage.md create mode 100644 versioned_docs/version-0.27.0/api/web/enumerations/Variant.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/FishjamProvider.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/useCamera.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/useConnection.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/useCustomSource.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/useDataChannel.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/useInitializeDevices.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/useLivestreamStreamer.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/useLivestreamViewer.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/useMicrophone.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/usePeers.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/useSandbox.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/useScreenShare.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/useUpdatePeerMetadata.md create mode 100644 versioned_docs/version-0.27.0/api/web/functions/useVAD.md create mode 100644 versioned_docs/version-0.27.0/api/web/index.md create mode 100644 versioned_docs/version-0.27.0/api/web/interfaces/DataChannelOptions.md create mode 100644 versioned_docs/version-0.27.0/api/web/interfaces/FishjamProviderProps.md create mode 100644 versioned_docs/version-0.27.0/api/web/interfaces/JoinRoomConfig.md create mode 100644 versioned_docs/version-0.27.0/api/web/interfaces/SimulcastConfig.md create mode 100644 versioned_docs/version-0.27.0/api/web/interfaces/UseLivestreamStreamerResult.md create mode 100644 versioned_docs/version-0.27.0/api/web/interfaces/UseLivestreamViewerResult.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/AuthErrorReason.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/BandwidthLimits.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/Brand.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/ConnectStreamerConfig.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/ConnectViewerConfig.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/CustomSource.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/DataCallback.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/DeviceError.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/DeviceItem.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesResult.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesSettings.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesStatus.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/JoinErrorReason.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/Metadata.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/MiddlewareResult.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/PeerId.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/PeerStatus.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/PeerWithTracks.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/PersistLastDeviceHandlers.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/ReconnectConfig.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/ReconnectionStatus.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/RemoteTrack.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/RoomType.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/SimulcastBandwidthLimit.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/SimulcastBandwidthLimits.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/StreamConfig.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/StreamerInputs.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/Track.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/TrackBandwidthLimit.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/TrackId.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/TrackMiddleware.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/TracksMiddleware.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/TracksMiddlewareResult.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/UseDataChannelResult.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/UseInitializeDevicesParams.md create mode 100644 versioned_docs/version-0.27.0/api/web/type-aliases/UseSandboxProps.md create mode 100644 versioned_docs/version-0.27.0/api/web/typedoc-sidebar.cjs create mode 100644 versioned_docs/version-0.27.0/api/web/variables/SimulcastConfig.md create mode 100644 versioned_docs/version-0.27.0/examples/_category_.json create mode 100644 versioned_docs/version-0.27.0/examples/react-native.mdx create mode 100644 versioned_docs/version-0.27.0/examples/react.mdx create mode 100644 versioned_docs/version-0.27.0/explanation/_category_.json create mode 100644 versioned_docs/version-0.27.0/explanation/agent-internals.mdx create mode 100644 versioned_docs/version-0.27.0/explanation/architecture.mdx create mode 100644 versioned_docs/version-0.27.0/explanation/data-channels.mdx create mode 100644 versioned_docs/version-0.27.0/explanation/glossary.md create mode 100644 versioned_docs/version-0.27.0/explanation/livestreams.mdx create mode 100644 versioned_docs/version-0.27.0/explanation/rooms.mdx create mode 100644 versioned_docs/version-0.27.0/explanation/sandbox-api-concept.mdx create mode 100644 versioned_docs/version-0.27.0/explanation/security-tokens.mdx create mode 100644 versioned_docs/version-0.27.0/explanation/simulcast.mdx create mode 100644 versioned_docs/version-0.27.0/explanation/what-is-fishjam.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/_category_.json create mode 100644 versioned_docs/version-0.27.0/how-to/_common/metadata/header.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/_common/metadata/joining_room.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/_common/metadata/reading.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/_common/metadata/updating.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/backend/_category_.json create mode 100644 versioned_docs/version-0.27.0/how-to/backend/audio-only-calls.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/backend/fastapi-example.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/backend/fastify-example.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/backend/production-deployment.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/backend/sandbox-api-testing.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/backend/selective-subscriptions.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/backend/server-setup.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/backend/whip-whep.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/_category_.json create mode 100644 versioned_docs/version-0.27.0/how-to/client/background-streaming.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/connecting.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/custom-sources.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/debug-logging.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/installation.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/list-other-peers.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/managing-devices.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/metadata.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/migration-guide.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/picture-in-picture.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/reconnection-handling.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/screensharing.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/simulcast.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/start-streaming.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/stream-middleware.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/client/text-chat.mdx create mode 100644 versioned_docs/version-0.27.0/how-to/react-native/assets/ios-new-folder.png create mode 100644 versioned_docs/version-0.27.0/how-to/react-native/assets/ios-new-group.png create mode 100644 versioned_docs/version-0.27.0/how-to/react-native/assets/ios-new-target.png create mode 100644 versioned_docs/version-0.27.0/index.mdx create mode 100644 versioned_docs/version-0.27.0/integrations/_category_.json create mode 100644 versioned_docs/version-0.27.0/integrations/gemini-live-integration.mdx create mode 100644 versioned_docs/version-0.27.0/integrations/vapi-integration.mdx create mode 100644 versioned_docs/version-0.27.0/tutorials/_category_.json create mode 100644 versioned_docs/version-0.27.0/tutorials/agents.mdx create mode 100644 versioned_docs/version-0.27.0/tutorials/backend-quick-start.mdx create mode 100644 versioned_docs/version-0.27.0/tutorials/livestreaming.mdx create mode 100644 versioned_docs/version-0.27.0/tutorials/react-native-quick-start.mdx create mode 100644 versioned_docs/version-0.27.0/tutorials/react-quick-start.mdx create mode 100644 versioned_sidebars/version-0.27.0-sidebars.json diff --git a/api/fishjam-server b/api/fishjam-server index 62073a78..339220ff 160000 --- a/api/fishjam-server +++ b/api/fishjam-server @@ -1 +1 @@ -Subproject commit 62073a78d3b6e176a37f52c32cacfc38681bc7f2 +Subproject commit 339220ff517c5be2e1e54fce8d1b415b59a5f67c diff --git a/api/protos b/api/protos index 1a8a029d..85ccd2bb 160000 --- a/api/protos +++ b/api/protos @@ -1 +1 @@ -Subproject commit 1a8a029d4ee99664ba5990c77df688e7bfe81ef5 +Subproject commit 85ccd2bbb82ed5a5528c2dba836b05e64f62424f diff --git a/api/room-manager b/api/room-manager index 31836f4e..d9f04532 160000 --- a/api/room-manager +++ b/api/room-manager @@ -1 +1 @@ -Subproject commit 31836f4ed6c8551b3892cea50d2872cdf2292e71 +Subproject commit d9f0453266d9619f7789f3a0aa3e00b1d978c8c9 diff --git a/packages/js-server-sdk b/packages/js-server-sdk index 0007dea8..078f2496 160000 --- a/packages/js-server-sdk +++ b/packages/js-server-sdk @@ -1 +1 @@ -Subproject commit 0007dea898b99b6923059b364584054cf1580b02 +Subproject commit 078f24967485d472cccb3de0de191adb81509a38 diff --git a/packages/python-server-sdk b/packages/python-server-sdk index 2f18378a..c66f08f3 160000 --- a/packages/python-server-sdk +++ b/packages/python-server-sdk @@ -1 +1 @@ -Subproject commit 2f18378a2339b3bf5870939864e0fff94f2e5a76 +Subproject commit c66f08f330f95b1648076acd63fe4f178dc52ba4 diff --git a/packages/web-client-sdk b/packages/web-client-sdk index 9aaba434..9a4ad327 160000 --- a/packages/web-client-sdk +++ b/packages/web-client-sdk @@ -1 +1 @@ -Subproject commit 9aaba43453840299099c2f9b84dc6505d0ccd395 +Subproject commit 9a4ad3270ef2456354c48b507c3cc9c08d58a0c7 diff --git a/static/api/protobuf/server_notifications.proto b/static/api/protobuf/server_notifications.proto index 79d81cc3..80a7948c 100644 --- a/static/api/protobuf/server_notifications.proto +++ b/static/api/protobuf/server_notifications.proto @@ -233,6 +233,21 @@ message ServerMessage { string streamer_id = 2; } + // Carries multiple notifications in a single wire frame. + // + // Constraints (documented, not schema-enforced): + // - Each element's `content` MUST be a notification variant — never + // Authenticated, AuthRequest, SubscribeRequest, or SubscribeResponse. + // - NotificationBatch MUST NOT be nested inside another NotificationBatch. + // The schema technically permits this, but senders must not emit + // recursive batches and receivers may treat them as a protocol violation. + // - Notifications are delivered in array order; consumers must process + // them in order. + // - Sent only for webhooks, for peers that . + message NotificationBatch { + repeated ServerMessage notifications = 1; + } + reserved 12; oneof content { @@ -273,6 +288,9 @@ message ServerMessage { StreamerConnected streamer_connected = 26; StreamerDisconnected streamer_disconnected = 27; + // Batch + NotificationBatch notification_batch = 33; + // Deprecated StreamConnected stream_connected = 22 [deprecated = true]; diff --git a/versioned_docs/version-0.27.0/_common/agents/definition.mdx b/versioned_docs/version-0.27.0/_common/agents/definition.mdx new file mode 100644 index 00000000..c6de7300 --- /dev/null +++ b/versioned_docs/version-0.27.0/_common/agents/definition.mdx @@ -0,0 +1,6 @@ +## What is an Agent? + +An agent is a piece of software that allows your backend server to participate in a Fishjam room, similar to how the Fishjam client SDKs allow your client-side application to participate in a Fishjam room. +They can be used to implement features such as real-time audio transcription, real-time content moderation, conversations with AI agents and more. + +You can simply think of an agent as a peer running within your backend application. diff --git a/versioned_docs/version-0.27.0/_common/agents/remember-to-disconnect.mdx b/versioned_docs/version-0.27.0/_common/agents/remember-to-disconnect.mdx new file mode 100644 index 00000000..4960eed1 --- /dev/null +++ b/versioned_docs/version-0.27.0/_common/agents/remember-to-disconnect.mdx @@ -0,0 +1,3 @@ +:::danger Remember to disconnect your agents! +It's important to disconnect agents, because **every connected agent generates usage** just as a normal peer. +::: diff --git a/versioned_docs/version-0.27.0/_common/agents/subscriptions.mdx b/versioned_docs/version-0.27.0/_common/agents/subscriptions.mdx new file mode 100644 index 00000000..f4aaa318 --- /dev/null +++ b/versioned_docs/version-0.27.0/_common/agents/subscriptions.mdx @@ -0,0 +1,4 @@ +By default, agents **won't** receive peers' audio streams. +This is by design and aims to prevent unnecessary resource usage by the agents. + +For an agent to start receiving a peer's audio, the peer must be **created** with the **subscribe** option set. diff --git a/versioned_docs/version-0.27.0/api/_category_.json b/versioned_docs/version-0.27.0/api/_category_.json new file mode 100644 index 00000000..d38385d4 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/_category_.json @@ -0,0 +1,12 @@ +{ + "label": "API", + "position": 7, + "link": { + "type": "generated-index", + "description": "API documentation for Client and Server SDKs.", + "slug": "/api" + }, + "customProps": { + "id": "generated-api" + } +} diff --git a/versioned_docs/version-0.27.0/api/mobile/enumerations/Variant.md b/versioned_docs/version-0.27.0/api/mobile/enumerations/Variant.md new file mode 100644 index 00000000..9907848e --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/enumerations/Variant.md @@ -0,0 +1,43 @@ +# Enumeration: Variant + +Defined in: packages/ts-client/dist/index.d.mts:51 + +## Enumeration Members + +### UNRECOGNIZED + +> **UNRECOGNIZED**: `-1` + +Defined in: packages/ts-client/dist/index.d.mts:56 + +*** + +### VARIANT\_HIGH + +> **VARIANT\_HIGH**: `3` + +Defined in: packages/ts-client/dist/index.d.mts:55 + +*** + +### VARIANT\_LOW + +> **VARIANT\_LOW**: `1` + +Defined in: packages/ts-client/dist/index.d.mts:53 + +*** + +### VARIANT\_MEDIUM + +> **VARIANT\_MEDIUM**: `2` + +Defined in: packages/ts-client/dist/index.d.mts:54 + +*** + +### VARIANT\_UNSPECIFIED + +> **VARIANT\_UNSPECIFIED**: `0` + +Defined in: packages/ts-client/dist/index.d.mts:52 diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/FishjamProvider.md b/versioned_docs/version-0.27.0/api/mobile/functions/FishjamProvider.md new file mode 100644 index 00000000..9493859a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/FishjamProvider.md @@ -0,0 +1,15 @@ +# Function: FishjamProvider() + +> **FishjamProvider**(`props`): `FunctionComponentElement`\<`FishjamProviderProps`\> + +Defined in: [packages/mobile-client/src/index.ts:118](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/index.ts#L118) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`FishjamProviderProps`](../type-aliases/FishjamProviderProps.md) | + +## Returns + +`FunctionComponentElement`\<`FishjamProviderProps`\> diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/RTCPIPView.md b/versioned_docs/version-0.27.0/api/mobile/functions/RTCPIPView.md new file mode 100644 index 00000000..0aa00a66 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/RTCPIPView.md @@ -0,0 +1,15 @@ +# Function: RTCPIPView() + +> **RTCPIPView**(`__namedParameters`): `Element` + +Defined in: [packages/mobile-client/src/overrides/RTCView.tsx:31](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/RTCView.tsx#L31) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | [`RTCPIPViewProps`](../type-aliases/RTCPIPViewProps.md) | + +## Returns + +`Element` diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/RTCView.md b/versioned_docs/version-0.27.0/api/mobile/functions/RTCView.md new file mode 100644 index 00000000..2067bb86 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/RTCView.md @@ -0,0 +1,15 @@ +# Function: RTCView() + +> **RTCView**(`__namedParameters`): `Element` + +Defined in: [packages/mobile-client/src/overrides/RTCView.tsx:26](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/RTCView.tsx#L26) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | [`RTCVideoViewProps`](../type-aliases/RTCVideoViewProps.md) | + +## Returns + +`Element` diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useCallKit.md b/versioned_docs/version-0.27.0/api/mobile/functions/useCallKit.md new file mode 100644 index 00000000..9a05ee75 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useCallKit.md @@ -0,0 +1,9 @@ +# Function: useCallKit() + +> **useCallKit**(): `object` + +Defined in: [packages/mobile-client/src/overrides/hooks.ts:100](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L100) + +## Returns + +`object` diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useCallKitEvent.md b/versioned_docs/version-0.27.0/api/mobile/functions/useCallKitEvent.md new file mode 100644 index 00000000..9677f458 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useCallKitEvent.md @@ -0,0 +1,22 @@ +# Function: useCallKitEvent() + +> **useCallKitEvent**\<`T`\>(`action`, `callback`): `void` + +Defined in: [packages/mobile-client/src/overrides/hooks.ts:109](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L109) + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* keyof `CallKitAction` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `action` | `T` | +| `callback` | (`event`) => `void` | + +## Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useCallKitService.md b/versioned_docs/version-0.27.0/api/mobile/functions/useCallKitService.md new file mode 100644 index 00000000..d4651b27 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useCallKitService.md @@ -0,0 +1,15 @@ +# Function: useCallKitService() + +> **useCallKitService**(`config`): `void` + +Defined in: [packages/mobile-client/src/overrides/hooks.ts:105](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L105) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | `CallKitConfig` | + +## Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useCamera.md b/versioned_docs/version-0.27.0/api/mobile/functions/useCamera.md new file mode 100644 index 00000000..ef615ec7 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useCamera.md @@ -0,0 +1,118 @@ +# Function: useCamera() + +> **useCamera**(): `object` + +Defined in: [packages/mobile-client/src/overrides/hooks.ts:28](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L28) + +## Returns + +### ~~activeCamera~~ + +> **activeCamera**: `null` \| [`DeviceItem`](../type-aliases/DeviceItem.md) + +#### Deprecated + +Use `currentCamera` and `isCameraOn` instead +Indicates which camera is now turned on and streaming + +### cameraDeviceError + +> **cameraDeviceError**: `null` \| [`DeviceError`](../type-aliases/DeviceError.md) + +Possible error thrown while setting up the camera + +### cameraDevices + +> **cameraDevices**: [`DeviceItem`](../type-aliases/DeviceItem.md)[] + +List of available camera devices + +### cameraStream + +> **cameraStream**: `null` \| `MediaStream` + +### currentCamera + +> **currentCamera**: `null` \| `MediaDeviceInfo` + +Indicates which camera is now selected + +### currentCameraMiddleware + +> **currentCameraMiddleware**: [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) + +The currently set camera middleware function + +### isCameraOn + +> **isCameraOn**: `boolean` + +Indicates whether the camera is streaming video + +### selectCamera() + +> **selectCamera**: (`deviceId`) => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> + +Selects the camera device + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceId` | `string` | + +#### Returns + +`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> + +### setCameraTrackMiddleware() + +> **setCameraTrackMiddleware**: (`middleware`) => `Promise`\<`void`\> + +Sets the camera middleware + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `middleware` | [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) | + +#### Returns + +`Promise`\<`void`\> + +### startCamera() + +> **startCamera**: (`deviceId?`) => `Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> + +Starts the camera + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceId?` | `null` \| `string` | + +#### Returns + +`Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> + +### stopCamera() + +> **stopCamera**: () => `void` + +Stops the camera + +#### Returns + +`void` + +### toggleCamera() + +> **toggleCamera**: () => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> + +Toggles current camera on/off + +#### Returns + +`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useCameraPermissions.md b/versioned_docs/version-0.27.0/api/mobile/functions/useCameraPermissions.md new file mode 100644 index 00000000..bcaa177e --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useCameraPermissions.md @@ -0,0 +1,28 @@ +# Function: useCameraPermissions() + +> **useCameraPermissions**(): \[() => `Promise`\<[`PermissionStatus`](../type-aliases/PermissionStatus.md)\>, () => `Promise`\<[`PermissionStatus`](../type-aliases/PermissionStatus.md)\>\] + +Defined in: [packages/mobile-client/src/hooks/usePermissions.ts:47](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/hooks/usePermissions.ts#L47) + +Hook for querying and requesting camera permission on the device. + +## Returns + +\[() => `Promise`\<[`PermissionStatus`](../type-aliases/PermissionStatus.md)\>, () => `Promise`\<[`PermissionStatus`](../type-aliases/PermissionStatus.md)\>\] + +A tuple of `[query, request]`: +- `query` – checks the current camera permission status without prompting the user. +- `request` – triggers the native permission dialog and returns the resulting status. + +## Example + +```tsx +import { useCameraPermissions } from "@fishjam-cloud/react-native-client"; +// ---cut--- +const [queryCameraPermission, requestCameraPermission] = useCameraPermissions(); + +const status = await queryCameraPermission(); +if (status !== 'granted') { + await requestCameraPermission(); +} +``` diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useConnection.md b/versioned_docs/version-0.27.0/api/mobile/functions/useConnection.md new file mode 100644 index 00000000..0d2b4d8f --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useConnection.md @@ -0,0 +1,53 @@ +# Function: useConnection() + +> **useConnection**(): `object` + +Defined in: packages/react-client/dist/hooks/useConnection.d.ts:17 + +Hook allows to join or leave a room and check the current connection status. + +## Returns + +### joinRoom() + +> **joinRoom**: \<`PeerMetadata`\>(`__namedParameters`) => `Promise`\<`void`\> + +Join room and start streaming camera and microphone + +#### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | [`JoinRoomConfig`](../interfaces/JoinRoomConfig.md)\<`PeerMetadata`\> | + +#### Returns + +`Promise`\<`void`\> + +### leaveRoom() + +> **leaveRoom**: () => `void` + +Leave room and stop streaming + +#### Returns + +`void` + +### peerStatus + +> **peerStatus**: [`PeerStatus`](../type-aliases/PeerStatus.md) + +Current peer connection status + +### reconnectionStatus + +> **reconnectionStatus**: [`ReconnectionStatus`](../type-aliases/ReconnectionStatus.md) + +Current reconnection status diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useCustomSource.md b/versioned_docs/version-0.27.0/api/mobile/functions/useCustomSource.md new file mode 100644 index 00000000..26714c52 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useCustomSource.md @@ -0,0 +1,39 @@ +# Function: useCustomSource() + +> **useCustomSource**\<`T`\>(`sourceId`): `object` + +Defined in: [packages/mobile-client/src/overrides/hooks.ts:52](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L52) + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `string` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `sourceId` | `T` | + +## Returns + +`object` + +### setStream() + +> **setStream**: (`newStream`) => `Promise`\<`void`\> + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `newStream` | `null` \| `MediaStream` | + +#### Returns + +`Promise`\<`void`\> + +### stream + +> **stream**: `undefined` \| `MediaStream` diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useDataChannel.md b/versioned_docs/version-0.27.0/api/mobile/functions/useDataChannel.md new file mode 100644 index 00000000..d709ded8 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useDataChannel.md @@ -0,0 +1,11 @@ +# Function: useDataChannel() + +> **useDataChannel**(): [`UseDataChannelResult`](../type-aliases/UseDataChannelResult.md) + +Defined in: packages/react-client/dist/hooks/useDataChannel.d.ts:8 + +Hook for data channel operations - publish and subscribe to data. + +## Returns + +[`UseDataChannelResult`](../type-aliases/UseDataChannelResult.md) diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useInitializeDevices.md b/versioned_docs/version-0.27.0/api/mobile/functions/useInitializeDevices.md new file mode 100644 index 00000000..3e939b55 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useInitializeDevices.md @@ -0,0 +1,23 @@ +# Function: useInitializeDevices() + +> **useInitializeDevices**(): `object` + +Defined in: [packages/mobile-client/src/overrides/hooks.ts:83](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L83) + +## Returns + +`object` + +### initializeDevices() + +> **initializeDevices**: (...`args`) => `Promise`\<[`InitializeDevicesResult`](../type-aliases/InitializeDevicesResult.md)\> + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`args` | \[[`InitializeDevicesSettings`](../type-aliases/InitializeDevicesSettings.md)\] | + +#### Returns + +`Promise`\<[`InitializeDevicesResult`](../type-aliases/InitializeDevicesResult.md)\> diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useLivestreamStreamer.md b/versioned_docs/version-0.27.0/api/mobile/functions/useLivestreamStreamer.md new file mode 100644 index 00000000..fe5d10c0 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useLivestreamStreamer.md @@ -0,0 +1,9 @@ +# Function: useLivestreamStreamer() + +> **useLivestreamStreamer**(): [`UseLivestreamStreamerResult`](../type-aliases/UseLivestreamStreamerResult.md) + +Defined in: [packages/mobile-client/src/overrides/hooks.ts:61](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L61) + +## Returns + +[`UseLivestreamStreamerResult`](../type-aliases/UseLivestreamStreamerResult.md) diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useLivestreamViewer.md b/versioned_docs/version-0.27.0/api/mobile/functions/useLivestreamViewer.md new file mode 100644 index 00000000..07dfe1c1 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useLivestreamViewer.md @@ -0,0 +1,9 @@ +# Function: useLivestreamViewer() + +> **useLivestreamViewer**(): [`UseLivestreamViewerResult`](../type-aliases/UseLivestreamViewerResult.md) + +Defined in: [packages/mobile-client/src/overrides/hooks.ts:75](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L75) + +## Returns + +[`UseLivestreamViewerResult`](../type-aliases/UseLivestreamViewerResult.md) diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useMicrophone.md b/versioned_docs/version-0.27.0/api/mobile/functions/useMicrophone.md new file mode 100644 index 00000000..00c5b134 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useMicrophone.md @@ -0,0 +1,124 @@ +# Function: useMicrophone() + +> **useMicrophone**(): `object` + +Defined in: [packages/mobile-client/src/overrides/hooks.ts:36](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L36) + +## Returns + +### ~~activeMicrophone~~ + +> **activeMicrophone**: `null` \| [`DeviceItem`](../type-aliases/DeviceItem.md) + +#### Deprecated + +Use `currentMicrophone` and `isMicrophoneOn` instead +Indicates which microphone is now turned on and streaming audio + +### currentMicrophone + +> **currentMicrophone**: `null` \| `MediaDeviceInfo` + +Indicates which microphone is now selected + +### currentMicrophoneMiddleware + +> **currentMicrophoneMiddleware**: [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) + +The currently set microphone middleware function + +### isMicrophoneMuted + +> **isMicrophoneMuted**: `boolean` + +Indicates whether the microphone is muted + +### isMicrophoneOn + +> **isMicrophoneOn**: `boolean` + +Indicates whether the microphone is streaming audio + +### microphoneDeviceError + +> **microphoneDeviceError**: `null` \| [`DeviceError`](../type-aliases/DeviceError.md) + +Possible error thrown while setting up the microphone + +### microphoneDevices + +> **microphoneDevices**: [`DeviceItem`](../type-aliases/DeviceItem.md)[] + +List of available microphone devices + +### microphoneStream + +> **microphoneStream**: `null` \| `MediaStream` + +### selectMicrophone() + +> **selectMicrophone**: (`deviceId`) => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> + +Selects the microphone device + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceId` | `string` | + +#### Returns + +`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> + +### setMicrophoneTrackMiddleware() + +> **setMicrophoneTrackMiddleware**: (`middleware`) => `Promise`\<`void`\> + +Sets the microphone middleware + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `middleware` | [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) | + +#### Returns + +`Promise`\<`void`\> + +### startMicrophone() + +> **startMicrophone**: (`deviceId?`) => `Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> + +Starts the microphone + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceId?` | `null` \| `string` | + +#### Returns + +`Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> + +### stopMicrophone() + +> **stopMicrophone**: () => `void` + +Stops the microphone + +#### Returns + +`void` + +### toggleMicrophone() + +> **toggleMicrophone**: () => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> + +Toggles current microphone on/off + +#### Returns + +`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useMicrophonePermissions.md b/versioned_docs/version-0.27.0/api/mobile/functions/useMicrophonePermissions.md new file mode 100644 index 00000000..e2660249 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useMicrophonePermissions.md @@ -0,0 +1,28 @@ +# Function: useMicrophonePermissions() + +> **useMicrophonePermissions**(): \[() => `Promise`\<[`PermissionStatus`](../type-aliases/PermissionStatus.md)\>, () => `Promise`\<[`PermissionStatus`](../type-aliases/PermissionStatus.md)\>\] + +Defined in: [packages/mobile-client/src/hooks/usePermissions.ts:70](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/hooks/usePermissions.ts#L70) + +Hook for querying and requesting microphone permission on the device. + +## Returns + +\[() => `Promise`\<[`PermissionStatus`](../type-aliases/PermissionStatus.md)\>, () => `Promise`\<[`PermissionStatus`](../type-aliases/PermissionStatus.md)\>\] + +A tuple of `[query, request]`: +- `query` – checks the current microphone permission status without prompting the user. +- `request` – triggers the native permission dialog and returns the resulting status. + +## Example + +```tsx +import { useMicrophonePermissions } from "@fishjam-cloud/react-native-client"; +// ---cut--- +const [queryMicPermission, requestMicPermission] = useMicrophonePermissions(); + +const status = await queryMicPermission(); +if (status !== 'granted') { + await requestMicPermission(); +} +``` diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/usePeers.md b/versioned_docs/version-0.27.0/api/mobile/functions/usePeers.md new file mode 100644 index 00000000..d49d4420 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/usePeers.md @@ -0,0 +1,28 @@ +# Function: usePeers() + +> **usePeers**\<`P`, `S`\>(): `object` + +Defined in: [packages/mobile-client/src/overrides/hooks.ts:92](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L92) + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `P` | `Record`\<`string`, `unknown`\> | +| `S` | `Record`\<`string`, `unknown`\> | + +## Returns + +`object` + +### localPeer + +> **localPeer**: `null` \| [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`P`, `S`\> + +### peers + +> **peers**: [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`P`, `S`, [`RemoteTrack`](../type-aliases/RemoteTrack.md)\>[] + +### remotePeers + +> **remotePeers**: [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`P`, `S`, [`RemoteTrack`](../type-aliases/RemoteTrack.md)\>[] diff --git a/versioned_docs/version-0.27.0/api/mobile/functions/useScreenShare.md b/versioned_docs/version-0.27.0/api/mobile/functions/useScreenShare.md new file mode 100644 index 00000000..a506f089 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/functions/useScreenShare.md @@ -0,0 +1,77 @@ +# Function: useScreenShare() + +> **useScreenShare**(): `object` + +Defined in: [packages/mobile-client/src/overrides/hooks.ts:44](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/hooks.ts#L44) + +## Returns + +### audioTrack + +> **audioTrack**: `null` \| `MediaStreamTrack` + +The separate audio MediaStreamTrack. + +### currentTracksMiddleware + +> **currentTracksMiddleware**: `null` \| [`TracksMiddleware`](../type-aliases/TracksMiddleware.md) + +The middleware currently assigned to process the tracks. +A screenshare may include both audio and video tracks, and this middleware is capable of processing +each track type. + +### setTracksMiddleware() + +> **setTracksMiddleware**: (`middleware`) => `Promise`\<`void`\> + +Sets the middleware responsible for processing the tracks. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `middleware` | `null` \| [`TracksMiddleware`](../type-aliases/TracksMiddleware.md) | The middleware to set, which can be a TracksMiddleware instance or null to remove the middleware. | + +#### Returns + +`Promise`\<`void`\> + +A Promise that resolves once the middleware is successfully set. + +### startStreaming() + +> **startStreaming**: (`props?`) => `Promise`\<`void`\> + +Invokes the screen sharing prompt in the user's browser and starts streaming upon approval. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `props?` | \{ `audioConstraints?`: `boolean` \| `MediaTrackConstraints`; `videoConstraints?`: `boolean` \| `MediaTrackConstraints`; \} | +| `props.audioConstraints?` | `boolean` \| `MediaTrackConstraints` | +| `props.videoConstraints?` | `boolean` \| `MediaTrackConstraints` | + +#### Returns + +`Promise`\<`void`\> + +### stopStreaming() + +> **stopStreaming**: () => `Promise`\<`void`\> + +Stops the stream and cancels browser screen sharing. + +#### Returns + +`Promise`\<`void`\> + +### stream + +> **stream**: `null` \| `MediaStream` + +### videoTrack + +> **videoTrack**: `null` \| `MediaStreamTrack` + +The separate video MediaStreamTrack. diff --git a/versioned_docs/version-0.27.0/api/mobile/index.md b/versioned_docs/version-0.27.0/api/mobile/index.md new file mode 100644 index 00000000..de8312a0 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/index.md @@ -0,0 +1,85 @@ +# @fishjam-cloud/react-native-client + +React Native client SDK for building mobile video and audio apps with Fishjam. + +## Connection + +- [useConnection](functions/useConnection.md) +- [useDataChannel](functions/useDataChannel.md) +- [Metadata](type-aliases/Metadata.md) +- [useUpdatePeerMetadata](variables/useUpdatePeerMetadata.md) +- [useVAD](variables/useVAD.md) + +## Other + +- [FishjamProvider](functions/FishjamProvider.md) +- [RTCPIPView](functions/RTCPIPView.md) +- [RTCView](functions/RTCView.md) +- [useCallKit](functions/useCallKit.md) +- [useCallKitEvent](functions/useCallKitEvent.md) +- [useCallKitService](functions/useCallKitService.md) +- [useCamera](functions/useCamera.md) +- [useCameraPermissions](functions/useCameraPermissions.md) +- [useCustomSource](functions/useCustomSource.md) +- [useInitializeDevices](functions/useInitializeDevices.md) +- [useLivestreamStreamer](functions/useLivestreamStreamer.md) +- [useLivestreamViewer](functions/useLivestreamViewer.md) +- [useMicrophone](functions/useMicrophone.md) +- [useMicrophonePermissions](functions/useMicrophonePermissions.md) +- [usePeers](functions/usePeers.md) +- [useScreenShare](functions/useScreenShare.md) +- [Variant](enumerations/Variant.md) +- [DataChannelOptions](interfaces/DataChannelOptions.md) +- [JoinRoomConfig](interfaces/JoinRoomConfig.md) +- [SimulcastConfig](interfaces/SimulcastConfig.md) +- [AuthErrorReason](type-aliases/AuthErrorReason.md) +- [BandwidthLimits](type-aliases/BandwidthLimits.md) +- [Brand](type-aliases/Brand.md) +- [ConnectStreamerConfig](type-aliases/ConnectStreamerConfig.md) +- [ConnectViewerConfig](type-aliases/ConnectViewerConfig.md) +- [CustomSource](type-aliases/CustomSource.md) +- [DataCallback](type-aliases/DataCallback.md) +- [DeviceError](type-aliases/DeviceError.md) +- [DeviceItem](type-aliases/DeviceItem.md) +- [FishjamProviderProps](type-aliases/FishjamProviderProps.md) +- [ForegroundServiceConfig](type-aliases/ForegroundServiceConfig.md) +- [InitializeDevicesResult](type-aliases/InitializeDevicesResult.md) +- [InitializeDevicesSettings](type-aliases/InitializeDevicesSettings.md) +- [InitializeDevicesStatus](type-aliases/InitializeDevicesStatus.md) +- [JoinErrorReason](type-aliases/JoinErrorReason.md) +- [MiddlewareResult](type-aliases/MiddlewareResult.md) +- [PeerId](type-aliases/PeerId.md) +- [PeerStatus](type-aliases/PeerStatus.md) +- [PeerWithTracks](type-aliases/PeerWithTracks.md) +- [PermissionStatus](type-aliases/PermissionStatus.md) +- [PersistLastDeviceHandlers](type-aliases/PersistLastDeviceHandlers.md) +- [ReconnectConfig](type-aliases/ReconnectConfig.md) +- [ReconnectionStatus](type-aliases/ReconnectionStatus.md) +- [RemoteTrack](type-aliases/RemoteTrack.md) +- [RoomType](type-aliases/RoomType.md) +- [RTCPIPViewProps](type-aliases/RTCPIPViewProps.md) +- [RTCVideoViewProps](type-aliases/RTCVideoViewProps.md) +- [SimulcastBandwidthLimit](type-aliases/SimulcastBandwidthLimit.md) +- [SimulcastBandwidthLimits](type-aliases/SimulcastBandwidthLimits.md) +- [StreamConfig](type-aliases/StreamConfig.md) +- [StreamerInputs](type-aliases/StreamerInputs.md) +- [Track](type-aliases/Track.md) +- [TrackBandwidthLimit](type-aliases/TrackBandwidthLimit.md) +- [TrackFields](type-aliases/TrackFields.md) +- [TrackId](type-aliases/TrackId.md) +- [TrackMiddleware](type-aliases/TrackMiddleware.md) +- [TracksMiddleware](type-aliases/TracksMiddleware.md) +- [TracksMiddlewareResult](type-aliases/TracksMiddlewareResult.md) +- [UseCameraResult](type-aliases/UseCameraResult.md) +- [UseCustomSourceResult](type-aliases/UseCustomSourceResult.md) +- [UseDataChannelResult](type-aliases/UseDataChannelResult.md) +- [UseInitializeDevicesParams](type-aliases/UseInitializeDevicesParams.md) +- [UseInitializeDevicesReturn](type-aliases/UseInitializeDevicesReturn.md) +- [UseLivestreamStreamerResult](type-aliases/UseLivestreamStreamerResult.md) +- [UseLivestreamViewerResult](type-aliases/UseLivestreamViewerResult.md) +- [UseMicrophoneResult](type-aliases/UseMicrophoneResult.md) +- [UseSandboxProps](type-aliases/UseSandboxProps.md) +- [UseScreenShareResult](type-aliases/UseScreenShareResult.md) +- [SimulcastConfig](variables/SimulcastConfig.md) +- [useForegroundService](variables/useForegroundService.md) +- [useSandbox](variables/useSandbox.md) diff --git a/versioned_docs/version-0.27.0/api/mobile/interfaces/DataChannelOptions.md b/versioned_docs/version-0.27.0/api/mobile/interfaces/DataChannelOptions.md new file mode 100644 index 00000000..9694abab --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/interfaces/DataChannelOptions.md @@ -0,0 +1,16 @@ +# Interface: DataChannelOptions + +Defined in: packages/ts-client/dist/index.d.mts:501 + +Options for publishing or subscribing to data. + +## Properties + +### reliable + +> **reliable**: `boolean` + +Defined in: packages/ts-client/dist/index.d.mts:506 + +If true, uses the reliable data channel (ordered, guaranteed delivery). +If false, uses the lossy data channel (unordered, low latency). diff --git a/versioned_docs/version-0.27.0/api/mobile/interfaces/JoinRoomConfig.md b/versioned_docs/version-0.27.0/api/mobile/interfaces/JoinRoomConfig.md new file mode 100644 index 00000000..230755f8 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/interfaces/JoinRoomConfig.md @@ -0,0 +1,29 @@ +# Interface: JoinRoomConfig\ + +Defined in: packages/react-client/dist/hooks/useConnection.d.ts:2 + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | + +## Properties + +### peerMetadata? + +> `optional` **peerMetadata**: `PeerMetadata` + +Defined in: packages/react-client/dist/hooks/useConnection.d.ts:10 + +String indexed record with metadata, that will be available to all other peers + +*** + +### peerToken + +> **peerToken**: `string` + +Defined in: packages/react-client/dist/hooks/useConnection.d.ts:6 + +Token received from server (or Room Manager) diff --git a/versioned_docs/version-0.27.0/api/mobile/interfaces/SimulcastConfig.md b/versioned_docs/version-0.27.0/api/mobile/interfaces/SimulcastConfig.md new file mode 100644 index 00000000..dbec162b --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/interfaces/SimulcastConfig.md @@ -0,0 +1,27 @@ +# Interface: SimulcastConfig + +Defined in: packages/ts-client/dist/index.d.mts:197 + +## Properties + +### disabledVariants + +> **disabledVariants**: [`Variant`](../enumerations/Variant.md)[] + +Defined in: packages/ts-client/dist/index.d.mts:200 + +*** + +### enabled + +> **enabled**: `boolean` + +Defined in: packages/ts-client/dist/index.d.mts:198 + +*** + +### enabledVariants + +> **enabledVariants**: [`Variant`](../enumerations/Variant.md)[] + +Defined in: packages/ts-client/dist/index.d.mts:199 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/AuthErrorReason.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/AuthErrorReason.md new file mode 100644 index 00000000..5d7ef8f5 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/AuthErrorReason.md @@ -0,0 +1,5 @@ +# Type Alias: AuthErrorReason + +> **AuthErrorReason** = *typeof* `AUTH_ERROR_REASONS`\[`number`\] + +Defined in: packages/ts-client/dist/index.d.mts:5 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/BandwidthLimits.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/BandwidthLimits.md new file mode 100644 index 00000000..2ce1bf63 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/BandwidthLimits.md @@ -0,0 +1,21 @@ +# Type Alias: BandwidthLimits + +> **BandwidthLimits** = `object` + +Defined in: packages/react-client/dist/types/public.d.ts:59 + +## Properties + +### simulcast + +> **simulcast**: [`SimulcastBandwidthLimits`](SimulcastBandwidthLimits.md) + +Defined in: packages/react-client/dist/types/public.d.ts:61 + +*** + +### singleStream + +> **singleStream**: `number` + +Defined in: packages/react-client/dist/types/public.d.ts:60 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/Brand.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/Brand.md new file mode 100644 index 00000000..f77a606b --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/Brand.md @@ -0,0 +1,18 @@ +# Type Alias: Brand\ + +> **Brand**\<`T`, `TBrand`\> = `T` & `object` + +Defined in: packages/react-client/dist/types/public.d.ts:74 + +## Type declaration + +### \[brand\] + +> **\[brand\]**: `TBrand` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | +| `TBrand` *extends* `string` | diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/ConnectStreamerConfig.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/ConnectStreamerConfig.md new file mode 100644 index 00000000..d907d189 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/ConnectStreamerConfig.md @@ -0,0 +1,21 @@ +# Type Alias: ConnectStreamerConfig + +> **ConnectStreamerConfig** = `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L21) + +## Properties + +### inputs + +> **inputs**: [`StreamerInputs`](StreamerInputs.md) + +Defined in: [packages/mobile-client/src/overrides/types.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L22) + +*** + +### token + +> **token**: `string` + +Defined in: [packages/mobile-client/src/overrides/types.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L23) diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/ConnectViewerConfig.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/ConnectViewerConfig.md new file mode 100644 index 00000000..09c7fa34 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/ConnectViewerConfig.md @@ -0,0 +1,5 @@ +# Type Alias: ConnectViewerConfig + +> **ConnectViewerConfig** = \{ `streamId?`: `never`; `token`: `string`; \} \| \{ `streamId`: `string`; `token?`: `never`; \} + +Defined in: packages/react-client/dist/hooks/useLivestreamViewer.d.ts:2 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/CustomSource.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/CustomSource.md new file mode 100644 index 00000000..738a0ef6 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/CustomSource.md @@ -0,0 +1,17 @@ +# Type Alias: CustomSource\ + +> **CustomSource**\<`T`\> = `Omit`\<`ReactClientCustomSource`\<`T`\>, `"stream"`\> & `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:64](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L64) + +## Type declaration + +### stream? + +> `optional` **stream**: `RNMediaStream` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `string` | diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/DataCallback.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/DataCallback.md new file mode 100644 index 00000000..08f6d1a0 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/DataCallback.md @@ -0,0 +1,17 @@ +# Type Alias: DataCallback() + +> **DataCallback** = (`data`) => `void` + +Defined in: packages/ts-client/dist/index.d.mts:512 + +Callback type for receiving data from a data channel. + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `data` | `Uint8Array` | The received data as a Uint8Array | + +## Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/DeviceError.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/DeviceError.md new file mode 100644 index 00000000..60ad1a3a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/DeviceError.md @@ -0,0 +1,5 @@ +# Type Alias: DeviceError + +> **DeviceError** = \{ `name`: `"OverconstrainedError"`; \} \| \{ `name`: `"NotAllowedError"`; \} \| \{ `name`: `"NotFoundError"`; \} \| \{ `name`: `"UNHANDLED_ERROR"`; \} + +Defined in: packages/react-client/dist/types/public.d.ts:64 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/DeviceItem.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/DeviceItem.md new file mode 100644 index 00000000..4c55e211 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/DeviceItem.md @@ -0,0 +1,21 @@ +# Type Alias: DeviceItem + +> **DeviceItem** = `object` + +Defined in: packages/react-client/dist/types/public.d.ts:43 + +## Properties + +### deviceId + +> **deviceId**: `string` + +Defined in: packages/react-client/dist/types/public.d.ts:44 + +*** + +### label + +> **label**: `string` + +Defined in: packages/react-client/dist/types/public.d.ts:45 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/FishjamProviderProps.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/FishjamProviderProps.md new file mode 100644 index 00000000..fafa5471 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/FishjamProviderProps.md @@ -0,0 +1,5 @@ +# Type Alias: FishjamProviderProps + +> **FishjamProviderProps** = `Omit`\<`ReactClientFishjamProviderProps`, `"persistLastDevice"` \| `"fishjamClient"`\> + +Defined in: [packages/mobile-client/src/index.ts:117](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/index.ts#L117) diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/ForegroundServiceConfig.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/ForegroundServiceConfig.md new file mode 100644 index 00000000..66857656 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/ForegroundServiceConfig.md @@ -0,0 +1,79 @@ +# Type Alias: ForegroundServiceConfig + +> **ForegroundServiceConfig** = `object` + +Defined in: [packages/mobile-client/src/useForegroundService.ts:8](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L8) + +Configuration options for foreground service permissions. + +A type representing the configuration for foreground service permissions. + +## Properties + +### channelId? + +> `optional` **channelId**: `string` + +Defined in: [packages/mobile-client/src/useForegroundService.ts:24](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L24) + +The id of the channel. Must be unique per package. + +*** + +### channelName? + +> `optional` **channelName**: `string` + +Defined in: [packages/mobile-client/src/useForegroundService.ts:28](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L28) + +The user visible name of the channel. + +*** + +### enableCamera? + +> `optional` **enableCamera**: `boolean` + +Defined in: [packages/mobile-client/src/useForegroundService.ts:12](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L12) + +Indicates whether the camera is enabled for the foreground service. + +*** + +### enableMicrophone? + +> `optional` **enableMicrophone**: `boolean` + +Defined in: [packages/mobile-client/src/useForegroundService.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L16) + +Indicates whether the microphone is enabled for the foreground service. + +*** + +### enableScreenSharing? + +> `optional` **enableScreenSharing**: `boolean` + +Defined in: [packages/mobile-client/src/useForegroundService.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L20) + +Indicates whether screen sharing is enabled for the foreground service. + +*** + +### notificationContent? + +> `optional` **notificationContent**: `string` + +Defined in: [packages/mobile-client/src/useForegroundService.ts:36](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L36) + +The text (second row) of the notification, in a standard notification. + +*** + +### notificationTitle? + +> `optional` **notificationTitle**: `string` + +Defined in: [packages/mobile-client/src/useForegroundService.ts:32](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L32) + +The title (first row) of the notification, in a standard notification. diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesResult.md new file mode 100644 index 00000000..da3eee2d --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesResult.md @@ -0,0 +1,11 @@ +# Type Alias: InitializeDevicesResult + +> **InitializeDevicesResult** = `Omit`\<`ReactClientInitializeDevicesResult`, `"stream"`\> & `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:66](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L66) + +## Type declaration + +### stream + +> **stream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesSettings.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesSettings.md new file mode 100644 index 00000000..f85d28a2 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesSettings.md @@ -0,0 +1,21 @@ +# Type Alias: InitializeDevicesSettings + +> **InitializeDevicesSettings** = `object` + +Defined in: packages/react-client/dist/hooks/internal/devices/useMediaDevices.d.ts:9 + +## Properties + +### enableAudio? + +> `optional` **enableAudio**: `boolean` + +Defined in: packages/react-client/dist/hooks/internal/devices/useMediaDevices.d.ts:11 + +*** + +### enableVideo? + +> `optional` **enableVideo**: `boolean` + +Defined in: packages/react-client/dist/hooks/internal/devices/useMediaDevices.d.ts:10 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesStatus.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesStatus.md new file mode 100644 index 00000000..b3efe444 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/InitializeDevicesStatus.md @@ -0,0 +1,5 @@ +# Type Alias: InitializeDevicesStatus + +> **InitializeDevicesStatus** = `"initialized"` \| `"failed"` \| `"initialized_with_errors"` \| `"already_initialized"` + +Defined in: packages/react-client/dist/types/public.d.ts:2 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/JoinErrorReason.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/JoinErrorReason.md new file mode 100644 index 00000000..3ac0d9d6 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/JoinErrorReason.md @@ -0,0 +1,5 @@ +# Type Alias: JoinErrorReason + +> **JoinErrorReason** = *typeof* `JOIN_ERRORS`\[`number`\] + +Defined in: packages/ts-client/dist/index.d.mts:941 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/Metadata.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/Metadata.md new file mode 100644 index 00000000..a262c005 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/Metadata.md @@ -0,0 +1,28 @@ +# Type Alias: Metadata\ + +> **Metadata**\<`PeerMetadata`, `ServerMetadata`\> = `object` + +Defined in: packages/ts-client/dist/index.d.mts:972 + +## Type Parameters + +| Type Parameter | Default type | Description | +| ------ | ------ | ------ | +| `PeerMetadata` | `GenericMetadata` | Type of metadata set by peer while connecting to a room. | +| `ServerMetadata` | `GenericMetadata` | Type of metadata set by the server while creating a peer. | + +## Properties + +### peer + +> **peer**: `PeerMetadata` + +Defined in: packages/ts-client/dist/index.d.mts:973 + +*** + +### server + +> **server**: `ServerMetadata` + +Defined in: packages/ts-client/dist/index.d.mts:974 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/MiddlewareResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/MiddlewareResult.md new file mode 100644 index 00000000..34d3c29a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/MiddlewareResult.md @@ -0,0 +1,25 @@ +# Type Alias: MiddlewareResult + +> **MiddlewareResult** = `object` + +Defined in: packages/react-client/dist/types/public.d.ts:23 + +## Properties + +### onClear()? + +> `optional` **onClear**: () => `void` + +Defined in: packages/react-client/dist/types/public.d.ts:25 + +#### Returns + +`void` + +*** + +### track + +> **track**: `MediaStreamTrack` + +Defined in: packages/react-client/dist/types/public.d.ts:24 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/PeerId.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/PeerId.md new file mode 100644 index 00000000..2fc229ef --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/PeerId.md @@ -0,0 +1,5 @@ +# Type Alias: PeerId + +> **PeerId** = [`Brand`](Brand.md)\<`string`, `"PeerId"`\> + +Defined in: packages/react-client/dist/types/public.d.ts:12 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/PeerStatus.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/PeerStatus.md new file mode 100644 index 00000000..ae00a192 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/PeerStatus.md @@ -0,0 +1,12 @@ +# Type Alias: PeerStatus + +> **PeerStatus** = `"connecting"` \| `"connected"` \| `"error"` \| `"idle"` + +Defined in: packages/react-client/dist/types/public.d.ts:42 + +Represents the possible statuses of a peer connection. + +- `idle` - Peer is not connected, either never connected or successfully disconnected. +- `connecting` - Peer is in the process of connecting. +- `connected` - Peer has successfully connected. +- `error` - There was an error in the connection process. diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/PeerWithTracks.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/PeerWithTracks.md new file mode 100644 index 00000000..2cda40da --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/PeerWithTracks.md @@ -0,0 +1,43 @@ +# Type Alias: PeerWithTracks\ + +> **PeerWithTracks**\<`P`, `S`, `T`\> = `Omit`\<`ReactClientPeerWithTracks`\<`P`, `S`\>, [`TrackFields`](TrackFields.md)\> & `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:79](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L79) + +## Type declaration + +### cameraTrack? + +> `optional` **cameraTrack**: `T` + +### customAudioTracks + +> **customAudioTracks**: `T`[] + +### customVideoTracks + +> **customVideoTracks**: `T`[] + +### microphoneTrack? + +> `optional` **microphoneTrack**: `T` + +### screenShareAudioTrack? + +> `optional` **screenShareAudioTrack**: `T` + +### screenShareVideoTrack? + +> `optional` **screenShareVideoTrack**: `T` + +### tracks + +> **tracks**: `T`[] + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `P` | - | +| `S` | - | +| `T` *extends* [`Track`](Track.md) | [`Track`](Track.md) | diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/PermissionStatus.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/PermissionStatus.md new file mode 100644 index 00000000..31b46acc --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/PermissionStatus.md @@ -0,0 +1,11 @@ +# Type Alias: PermissionStatus + +> **PermissionStatus** = `"granted"` \| `"denied"` \| `"prompt"` + +Defined in: [packages/mobile-client/src/hooks/usePermissions.ts:11](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/hooks/usePermissions.ts#L11) + +The current status of a device permission. + +- `'granted'` – the user has granted the permission. +- `'denied'` – the user has denied the permission. +- `'prompt'` – the user has not yet been asked (or the permission can be requested again). diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/PersistLastDeviceHandlers.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/PersistLastDeviceHandlers.md new file mode 100644 index 00000000..f2492589 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/PersistLastDeviceHandlers.md @@ -0,0 +1,42 @@ +# Type Alias: PersistLastDeviceHandlers + +> **PersistLastDeviceHandlers** = `object` + +Defined in: packages/react-client/dist/types/public.d.ts:47 + +## Properties + +### getLastDevice() + +> **getLastDevice**: (`deviceType`) => `MediaDeviceInfo` \| `null` + +Defined in: packages/react-client/dist/types/public.d.ts:48 + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceType` | `"audio"` \| `"video"` | + +#### Returns + +`MediaDeviceInfo` \| `null` + +*** + +### saveLastDevice() + +> **saveLastDevice**: (`info`, `deviceType`) => `void` + +Defined in: packages/react-client/dist/types/public.d.ts:49 + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `info` | `MediaDeviceInfo` | +| `deviceType` | `"audio"` \| `"video"` | + +#### Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCPIPViewProps.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCPIPViewProps.md new file mode 100644 index 00000000..8fcf33c5 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCPIPViewProps.md @@ -0,0 +1,11 @@ +# Type Alias: RTCPIPViewProps + +> **RTCPIPViewProps** = `Omit`\<`React.ComponentPropsWithRef`\<*typeof* `OriginalRTCPIPView`\>, `"streamURL"`\> & `object` + +Defined in: [packages/mobile-client/src/overrides/RTCView.tsx:10](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/RTCView.tsx#L10) + +## Type declaration + +### mediaStream + +> **mediaStream**: `RNMediaStream` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCVideoViewProps.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCVideoViewProps.md new file mode 100644 index 00000000..c4f490b1 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/RTCVideoViewProps.md @@ -0,0 +1,11 @@ +# Type Alias: RTCVideoViewProps + +> **RTCVideoViewProps** = `Omit`\<`React.ComponentPropsWithRef`\<*typeof* `OriginalRTCView`\>, `"streamURL"`\> & `object` + +Defined in: [packages/mobile-client/src/overrides/RTCView.tsx:6](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/RTCView.tsx#L6) + +## Type declaration + +### mediaStream + +> **mediaStream**: `RNMediaStream` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/ReconnectConfig.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/ReconnectConfig.md new file mode 100644 index 00000000..27624f92 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/ReconnectConfig.md @@ -0,0 +1,37 @@ +# Type Alias: ReconnectConfig + +> **ReconnectConfig** = `object` + +Defined in: packages/ts-client/dist/index.d.mts:945 + +## Properties + +### addTracksOnReconnect? + +> `optional` **addTracksOnReconnect**: `boolean` + +Defined in: packages/ts-client/dist/index.d.mts:949 + +*** + +### delay? + +> `optional` **delay**: `number` + +Defined in: packages/ts-client/dist/index.d.mts:948 + +*** + +### initialDelay? + +> `optional` **initialDelay**: `number` + +Defined in: packages/ts-client/dist/index.d.mts:947 + +*** + +### maxAttempts? + +> `optional` **maxAttempts**: `number` + +Defined in: packages/ts-client/dist/index.d.mts:946 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/ReconnectionStatus.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/ReconnectionStatus.md new file mode 100644 index 00000000..aa00eb32 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/ReconnectionStatus.md @@ -0,0 +1,5 @@ +# Type Alias: ReconnectionStatus + +> **ReconnectionStatus** = `"reconnecting"` \| `"idle"` \| `"error"` + +Defined in: packages/ts-client/dist/index.d.mts:944 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/RemoteTrack.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/RemoteTrack.md new file mode 100644 index 00000000..07218564 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/RemoteTrack.md @@ -0,0 +1,11 @@ +# Type Alias: RemoteTrack + +> **RemoteTrack** = `Omit`\<`ReactClientRemoteTrack`, `"stream"`\> & `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:62](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L62) + +## Type declaration + +### stream + +> **stream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/RoomType.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/RoomType.md new file mode 100644 index 00000000..2d11237f --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/RoomType.md @@ -0,0 +1,5 @@ +# Type Alias: RoomType + +> **RoomType** = `"conference"` \| `"livestream"` \| `"audio_only"` + +Defined in: packages/react-client/dist/hooks/useSandbox.d.ts:4 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/SimulcastBandwidthLimit.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/SimulcastBandwidthLimit.md new file mode 100644 index 00000000..f812c466 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/SimulcastBandwidthLimit.md @@ -0,0 +1,9 @@ +# Type Alias: SimulcastBandwidthLimit + +> **SimulcastBandwidthLimit** = `Map`\<[`Variant`](../enumerations/Variant.md), `BandwidthLimit`\> + +Defined in: packages/ts-client/dist/index.d.mts:252 + +Type describing bandwidth limit for simulcast track. +It is a mapping (encoding => BandwidthLimit). +If encoding isn't present in this mapping, it will be assumed that this particular encoding shouldn't have any bandwidth limit diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/SimulcastBandwidthLimits.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/SimulcastBandwidthLimits.md new file mode 100644 index 00000000..5209ee64 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/SimulcastBandwidthLimits.md @@ -0,0 +1,29 @@ +# Type Alias: SimulcastBandwidthLimits + +> **SimulcastBandwidthLimits** = `object` + +Defined in: packages/react-client/dist/types/public.d.ts:51 + +## Properties + +### 1 + +> **1**: `number` + +Defined in: packages/react-client/dist/types/public.d.ts:52 + +*** + +### 2 + +> **2**: `number` + +Defined in: packages/react-client/dist/types/public.d.ts:53 + +*** + +### 3 + +> **3**: `number` + +Defined in: packages/react-client/dist/types/public.d.ts:54 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/StreamConfig.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/StreamConfig.md new file mode 100644 index 00000000..9915e8c7 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/StreamConfig.md @@ -0,0 +1,13 @@ +# Type Alias: StreamConfig + +> **StreamConfig** = `object` + +Defined in: packages/react-client/dist/types/public.d.ts:56 + +## Properties + +### sentQualities? + +> `optional` **sentQualities**: [`Variant`](../enumerations/Variant.md)[] \| `false` + +Defined in: packages/react-client/dist/types/public.d.ts:57 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/StreamerInputs.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/StreamerInputs.md new file mode 100644 index 00000000..7b5b087f --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/StreamerInputs.md @@ -0,0 +1,5 @@ +# Type Alias: StreamerInputs + +> **StreamerInputs** = \{ `audio?`: `RNMediaStream` \| `null`; `video`: `RNMediaStream`; \} \| \{ `audio`: `RNMediaStream`; `video?`: `null`; \} + +Defined in: [packages/mobile-client/src/overrides/types.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L17) diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/Track.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/Track.md new file mode 100644 index 00000000..52ed9928 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/Track.md @@ -0,0 +1,11 @@ +# Type Alias: Track + +> **Track** = `Omit`\<`ReactClientTrack`, `"stream"`\> & `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:60](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L60) + +## Type declaration + +### stream + +> **stream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackBandwidthLimit.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackBandwidthLimit.md new file mode 100644 index 00000000..80ee870a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackBandwidthLimit.md @@ -0,0 +1,8 @@ +# Type Alias: TrackBandwidthLimit + +> **TrackBandwidthLimit** = `BandwidthLimit` \| [`SimulcastBandwidthLimit`](SimulcastBandwidthLimit.md) + +Defined in: packages/ts-client/dist/index.d.mts:257 + +Type describing bandwidth limitation of a Track, including simulcast and non-simulcast tracks. +A sum type of `BandwidthLimit` and `SimulcastBandwidthLimit` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackFields.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackFields.md new file mode 100644 index 00000000..64978bae --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackFields.md @@ -0,0 +1,5 @@ +# Type Alias: TrackFields + +> **TrackFields** = `"tracks"` \| `"cameraTrack"` \| `"microphoneTrack"` \| `"screenShareVideoTrack"` \| `"screenShareAudioTrack"` \| `"customVideoTracks"` \| `"customAudioTracks"` + +Defined in: [packages/mobile-client/src/overrides/types.ts:70](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L70) diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackId.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackId.md new file mode 100644 index 00000000..ffa28500 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackId.md @@ -0,0 +1,5 @@ +# Type Alias: TrackId + +> **TrackId** = [`Brand`](Brand.md)\<`string`, `"TrackId"`\> + +Defined in: packages/react-client/dist/types/public.d.ts:11 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackMiddleware.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackMiddleware.md new file mode 100644 index 00000000..e6fec9f2 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TrackMiddleware.md @@ -0,0 +1,5 @@ +# Type Alias: TrackMiddleware + +> **TrackMiddleware** = (`track`) => [`MiddlewareResult`](MiddlewareResult.md) \| `Promise`\<[`MiddlewareResult`](MiddlewareResult.md)\> \| `null` + +Defined in: packages/react-client/dist/types/public.d.ts:27 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/TracksMiddleware.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TracksMiddleware.md new file mode 100644 index 00000000..1f74a941 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TracksMiddleware.md @@ -0,0 +1,16 @@ +# Type Alias: TracksMiddleware() + +> **TracksMiddleware** = (`videoTrack`, `audioTrack`) => [`TracksMiddlewareResult`](TracksMiddlewareResult.md) \| `Promise`\<[`TracksMiddlewareResult`](TracksMiddlewareResult.md)\> + +Defined in: packages/react-client/dist/types/public.d.ts:33 + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `videoTrack` | `MediaStreamTrack` | +| `audioTrack` | `MediaStreamTrack` \| `null` | + +## Returns + +[`TracksMiddlewareResult`](TracksMiddlewareResult.md) \| `Promise`\<[`TracksMiddlewareResult`](TracksMiddlewareResult.md)\> diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/TracksMiddlewareResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TracksMiddlewareResult.md new file mode 100644 index 00000000..fd95b8bb --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/TracksMiddlewareResult.md @@ -0,0 +1,33 @@ +# Type Alias: TracksMiddlewareResult + +> **TracksMiddlewareResult** = `object` + +Defined in: packages/react-client/dist/types/public.d.ts:28 + +## Properties + +### audioTrack + +> **audioTrack**: `MediaStreamTrack` \| `null` + +Defined in: packages/react-client/dist/types/public.d.ts:30 + +*** + +### onClear() + +> **onClear**: () => `void` + +Defined in: packages/react-client/dist/types/public.d.ts:31 + +#### Returns + +`void` + +*** + +### videoTrack + +> **videoTrack**: `MediaStreamTrack` + +Defined in: packages/react-client/dist/types/public.d.ts:29 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseCameraResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseCameraResult.md new file mode 100644 index 00000000..8c67e8bd --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseCameraResult.md @@ -0,0 +1,11 @@ +# Type Alias: UseCameraResult + +> **UseCameraResult** = `Omit`\<`ReturnType`\<*typeof* `useCameraReactClient`\>, `"cameraStream"`\> & `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:34](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L34) + +## Type declaration + +### cameraStream + +> **cameraStream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseCustomSourceResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseCustomSourceResult.md new file mode 100644 index 00000000..78c470ce --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseCustomSourceResult.md @@ -0,0 +1,25 @@ +# Type Alias: UseCustomSourceResult + +> **UseCustomSourceResult** = `Omit`\<`ReturnType`\<*typeof* `useCustomSourceReactClient`\>, `"stream"` \| `"setStream"`\> & `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:49](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L49) + +## Type declaration + +### setStream() + +> **setStream**: (`newStream`) => `Promise`\<`void`\> + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `newStream` | `RNMediaStream` \| `null` | + +#### Returns + +`Promise`\<`void`\> + +### stream + +> **stream**: `RNMediaStream` \| `undefined` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseDataChannelResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseDataChannelResult.md new file mode 100644 index 00000000..2c90c9b0 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseDataChannelResult.md @@ -0,0 +1,101 @@ +# Type Alias: UseDataChannelResult + +> **UseDataChannelResult** = `object` + +Defined in: packages/react-client/dist/types/public.d.ts:85 + +## Properties + +### dataChannelError + +> **dataChannelError**: `Error` \| `null` + +Defined in: packages/react-client/dist/types/public.d.ts:118 + +Error that occurred during data publisher operations, or null if no error. + +*** + +### dataChannelLoading + +> **dataChannelLoading**: `boolean` + +Defined in: packages/react-client/dist/types/public.d.ts:114 + +Whether data channels are being initialized. + +*** + +### dataChannelReady + +> **dataChannelReady**: `boolean` + +Defined in: packages/react-client/dist/types/public.d.ts:110 + +Whether data channels are connected and ready to send data. +Resets to false on disconnect. + +*** + +### initializeDataChannel() + +> **initializeDataChannel**: () => `void` + +Defined in: packages/react-client/dist/types/public.d.ts:91 + +Initializes the data channel. + +Requires that the fishjam client is already connected. + +#### Returns + +`void` + +*** + +### publishData() + +> **publishData**: (`payload`, `options`) => `void` + +Defined in: packages/react-client/dist/types/public.d.ts:97 + +Sends binary data through a data channel. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `payload` | `Uint8Array` | The Uint8Array payload to send (first positional argument) | +| `options` | [`DataChannelOptions`](../interfaces/DataChannelOptions.md) | Data channel options; specify `reliable: true` for guaranteed delivery or `reliable: false` for low latency | + +#### Returns + +`void` + +*** + +### subscribeData() + +> **subscribeData**: (`callback`, `options`) => () => `void` + +Defined in: packages/react-client/dist/types/public.d.ts:105 + +Subscribe to incoming data on a data channel. +Can be called before or after channel creation. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `callback` | [`DataCallback`](DataCallback.md) | Function called when data is received | +| `options` | [`DataChannelOptions`](../interfaces/DataChannelOptions.md) | Specify `reliable: true` or `reliable: false` to choose channel | + +#### Returns + +Unsubscribe function - call to cancel the subscription + +> (): `void` + +##### Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseInitializeDevicesParams.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseInitializeDevicesParams.md new file mode 100644 index 00000000..7243935b --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseInitializeDevicesParams.md @@ -0,0 +1,21 @@ +# Type Alias: UseInitializeDevicesParams + +> **UseInitializeDevicesParams** = `object` + +Defined in: packages/react-client/dist/hooks/devices/useInitializeDevices.d.ts:1 + +## Properties + +### enableAudio? + +> `optional` **enableAudio**: `boolean` + +Defined in: packages/react-client/dist/hooks/devices/useInitializeDevices.d.ts:3 + +*** + +### enableVideo? + +> `optional` **enableVideo**: `boolean` + +Defined in: packages/react-client/dist/hooks/devices/useInitializeDevices.d.ts:2 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseInitializeDevicesReturn.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseInitializeDevicesReturn.md new file mode 100644 index 00000000..fe47af55 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseInitializeDevicesReturn.md @@ -0,0 +1,23 @@ +# Type Alias: UseInitializeDevicesReturn + +> **UseInitializeDevicesReturn** = `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:54](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L54) + +## Properties + +### initializeDevices() + +> **initializeDevices**: (...`args`) => `Promise`\<[`InitializeDevicesResult`](InitializeDevicesResult.md)\> + +Defined in: [packages/mobile-client/src/overrides/types.ts:55](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L55) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`args` | `Parameters`\<`ReturnType`\<*typeof* `useInitializeDevicesReactClient`\>\[`"initializeDevices"`\]\> | + +#### Returns + +`Promise`\<[`InitializeDevicesResult`](InitializeDevicesResult.md)\> diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseLivestreamStreamerResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseLivestreamStreamerResult.md new file mode 100644 index 00000000..b8d27044 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseLivestreamStreamerResult.md @@ -0,0 +1,22 @@ +# Type Alias: UseLivestreamStreamerResult + +> **UseLivestreamStreamerResult** = `Omit`\<`ReactClientUseLivestreamStreamerResult`, `"connect"`\> & `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:26](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L26) + +## Type declaration + +### connect() + +> **connect**: (`config`, `urlOverride?`) => `Promise`\<`void`\> + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | [`ConnectStreamerConfig`](ConnectStreamerConfig.md) | +| `urlOverride?` | `string` | + +#### Returns + +`Promise`\<`void`\> diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseLivestreamViewerResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseLivestreamViewerResult.md new file mode 100644 index 00000000..fca6e679 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseLivestreamViewerResult.md @@ -0,0 +1,11 @@ +# Type Alias: UseLivestreamViewerResult + +> **UseLivestreamViewerResult** = `Omit`\<`ReactClientUseLivestreamViewerResult`, `"stream"`\> & `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:30](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L30) + +## Type declaration + +### stream + +> **stream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseMicrophoneResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseMicrophoneResult.md new file mode 100644 index 00000000..ac869b81 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseMicrophoneResult.md @@ -0,0 +1,11 @@ +# Type Alias: UseMicrophoneResult + +> **UseMicrophoneResult** = `Omit`\<`ReturnType`\<*typeof* `useMicrophoneReactClient`\>, `"toggleMicrophoneMute"` \| `"microphoneStream"`\> & `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:38](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L38) + +## Type declaration + +### microphoneStream + +> **microphoneStream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseSandboxProps.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseSandboxProps.md new file mode 100644 index 00000000..e4e45066 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseSandboxProps.md @@ -0,0 +1,13 @@ +# Type Alias: UseSandboxProps + +> **UseSandboxProps** = `object` + +Defined in: packages/react-client/dist/hooks/useSandbox.d.ts:1 + +## Properties + +### sandboxApiUrl + +> **sandboxApiUrl**: `string` + +Defined in: packages/react-client/dist/hooks/useSandbox.d.ts:2 diff --git a/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseScreenShareResult.md b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseScreenShareResult.md new file mode 100644 index 00000000..788f204a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/type-aliases/UseScreenShareResult.md @@ -0,0 +1,11 @@ +# Type Alias: UseScreenShareResult + +> **UseScreenShareResult** = `Omit`\<`ReturnType`\<*typeof* `useScreenShareReactClient`\>, `"stream"`\> & `object` + +Defined in: [packages/mobile-client/src/overrides/types.ts:45](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/overrides/types.ts#L45) + +## Type declaration + +### stream + +> **stream**: `RNMediaStream` \| `null` diff --git a/versioned_docs/version-0.27.0/api/mobile/typedoc-sidebar.cjs b/versioned_docs/version-0.27.0/api/mobile/typedoc-sidebar.cjs new file mode 100644 index 00000000..262c3655 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ +const typedocSidebar = {items:[{type:"category",label:"Connection",items:[{type:"doc",id:"api/mobile/functions/useConnection",label:"useConnection"},{type:"doc",id:"api/mobile/functions/useDataChannel",label:"useDataChannel"},{type:"doc",id:"api/mobile/type-aliases/Metadata",label:"Metadata"},{type:"doc",id:"api/mobile/variables/useUpdatePeerMetadata",label:"useUpdatePeerMetadata"},{type:"doc",id:"api/mobile/variables/useVAD",label:"useVAD"}]},{type:"category",label:"Other",items:[{type:"doc",id:"api/mobile/functions/FishjamProvider",label:"FishjamProvider"},{type:"doc",id:"api/mobile/functions/RTCPIPView",label:"RTCPIPView"},{type:"doc",id:"api/mobile/functions/RTCView",label:"RTCView"},{type:"doc",id:"api/mobile/functions/useCallKit",label:"useCallKit"},{type:"doc",id:"api/mobile/functions/useCallKitEvent",label:"useCallKitEvent"},{type:"doc",id:"api/mobile/functions/useCallKitService",label:"useCallKitService"},{type:"doc",id:"api/mobile/functions/useCamera",label:"useCamera"},{type:"doc",id:"api/mobile/functions/useCameraPermissions",label:"useCameraPermissions"},{type:"doc",id:"api/mobile/functions/useCustomSource",label:"useCustomSource"},{type:"doc",id:"api/mobile/functions/useInitializeDevices",label:"useInitializeDevices"},{type:"doc",id:"api/mobile/functions/useLivestreamStreamer",label:"useLivestreamStreamer"},{type:"doc",id:"api/mobile/functions/useLivestreamViewer",label:"useLivestreamViewer"},{type:"doc",id:"api/mobile/functions/useMicrophone",label:"useMicrophone"},{type:"doc",id:"api/mobile/functions/useMicrophonePermissions",label:"useMicrophonePermissions"},{type:"doc",id:"api/mobile/functions/usePeers",label:"usePeers"},{type:"doc",id:"api/mobile/functions/useScreenShare",label:"useScreenShare"},{type:"doc",id:"api/mobile/enumerations/Variant",label:"Variant"},{type:"doc",id:"api/mobile/interfaces/DataChannelOptions",label:"DataChannelOptions"},{type:"doc",id:"api/mobile/interfaces/JoinRoomConfig",label:"JoinRoomConfig"},{type:"doc",id:"api/mobile/interfaces/SimulcastConfig",label:"SimulcastConfig"},{type:"doc",id:"api/mobile/type-aliases/AuthErrorReason",label:"AuthErrorReason"},{type:"doc",id:"api/mobile/type-aliases/BandwidthLimits",label:"BandwidthLimits"},{type:"doc",id:"api/mobile/type-aliases/Brand",label:"Brand"},{type:"doc",id:"api/mobile/type-aliases/ConnectStreamerConfig",label:"ConnectStreamerConfig"},{type:"doc",id:"api/mobile/type-aliases/ConnectViewerConfig",label:"ConnectViewerConfig"},{type:"doc",id:"api/mobile/type-aliases/CustomSource",label:"CustomSource"},{type:"doc",id:"api/mobile/type-aliases/DataCallback",label:"DataCallback"},{type:"doc",id:"api/mobile/type-aliases/DeviceError",label:"DeviceError"},{type:"doc",id:"api/mobile/type-aliases/DeviceItem",label:"DeviceItem"},{type:"doc",id:"api/mobile/type-aliases/FishjamProviderProps",label:"FishjamProviderProps"},{type:"doc",id:"api/mobile/type-aliases/ForegroundServiceConfig",label:"ForegroundServiceConfig"},{type:"doc",id:"api/mobile/type-aliases/InitializeDevicesResult",label:"InitializeDevicesResult"},{type:"doc",id:"api/mobile/type-aliases/InitializeDevicesSettings",label:"InitializeDevicesSettings"},{type:"doc",id:"api/mobile/type-aliases/InitializeDevicesStatus",label:"InitializeDevicesStatus"},{type:"doc",id:"api/mobile/type-aliases/JoinErrorReason",label:"JoinErrorReason"},{type:"doc",id:"api/mobile/type-aliases/MiddlewareResult",label:"MiddlewareResult"},{type:"doc",id:"api/mobile/type-aliases/PeerId",label:"PeerId"},{type:"doc",id:"api/mobile/type-aliases/PeerStatus",label:"PeerStatus"},{type:"doc",id:"api/mobile/type-aliases/PeerWithTracks",label:"PeerWithTracks"},{type:"doc",id:"api/mobile/type-aliases/PermissionStatus",label:"PermissionStatus"},{type:"doc",id:"api/mobile/type-aliases/PersistLastDeviceHandlers",label:"PersistLastDeviceHandlers"},{type:"doc",id:"api/mobile/type-aliases/ReconnectConfig",label:"ReconnectConfig"},{type:"doc",id:"api/mobile/type-aliases/ReconnectionStatus",label:"ReconnectionStatus"},{type:"doc",id:"api/mobile/type-aliases/RemoteTrack",label:"RemoteTrack"},{type:"doc",id:"api/mobile/type-aliases/RoomType",label:"RoomType"},{type:"doc",id:"api/mobile/type-aliases/RTCPIPViewProps",label:"RTCPIPViewProps"},{type:"doc",id:"api/mobile/type-aliases/RTCVideoViewProps",label:"RTCVideoViewProps"},{type:"doc",id:"api/mobile/type-aliases/SimulcastBandwidthLimit",label:"SimulcastBandwidthLimit"},{type:"doc",id:"api/mobile/type-aliases/SimulcastBandwidthLimits",label:"SimulcastBandwidthLimits"},{type:"doc",id:"api/mobile/type-aliases/StreamConfig",label:"StreamConfig"},{type:"doc",id:"api/mobile/type-aliases/StreamerInputs",label:"StreamerInputs"},{type:"doc",id:"api/mobile/type-aliases/Track",label:"Track"},{type:"doc",id:"api/mobile/type-aliases/TrackBandwidthLimit",label:"TrackBandwidthLimit"},{type:"doc",id:"api/mobile/type-aliases/TrackFields",label:"TrackFields"},{type:"doc",id:"api/mobile/type-aliases/TrackId",label:"TrackId"},{type:"doc",id:"api/mobile/type-aliases/TrackMiddleware",label:"TrackMiddleware"},{type:"doc",id:"api/mobile/type-aliases/TracksMiddleware",label:"TracksMiddleware"},{type:"doc",id:"api/mobile/type-aliases/TracksMiddlewareResult",label:"TracksMiddlewareResult"},{type:"doc",id:"api/mobile/type-aliases/UseCameraResult",label:"UseCameraResult"},{type:"doc",id:"api/mobile/type-aliases/UseCustomSourceResult",label:"UseCustomSourceResult"},{type:"doc",id:"api/mobile/type-aliases/UseDataChannelResult",label:"UseDataChannelResult"},{type:"doc",id:"api/mobile/type-aliases/UseInitializeDevicesParams",label:"UseInitializeDevicesParams"},{type:"doc",id:"api/mobile/type-aliases/UseInitializeDevicesReturn",label:"UseInitializeDevicesReturn"},{type:"doc",id:"api/mobile/type-aliases/UseLivestreamStreamerResult",label:"UseLivestreamStreamerResult"},{type:"doc",id:"api/mobile/type-aliases/UseLivestreamViewerResult",label:"UseLivestreamViewerResult"},{type:"doc",id:"api/mobile/type-aliases/UseMicrophoneResult",label:"UseMicrophoneResult"},{type:"doc",id:"api/mobile/type-aliases/UseSandboxProps",label:"UseSandboxProps"},{type:"doc",id:"api/mobile/type-aliases/UseScreenShareResult",label:"UseScreenShareResult"},{type:"doc",id:"api/mobile/variables/SimulcastConfig",label:"SimulcastConfig"},{type:"doc",id:"api/mobile/variables/useForegroundService",label:"useForegroundService"},{type:"doc",id:"api/mobile/variables/useSandbox",label:"useSandbox"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/versioned_docs/version-0.27.0/api/mobile/variables/SimulcastConfig.md b/versioned_docs/version-0.27.0/api/mobile/variables/SimulcastConfig.md new file mode 100644 index 00000000..89dcedd7 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/variables/SimulcastConfig.md @@ -0,0 +1,5 @@ +# Variable: SimulcastConfig + +> **SimulcastConfig**: `MessageFns`\<[`SimulcastConfig`](../interfaces/SimulcastConfig.md)\> + +Defined in: packages/ts-client/dist/index.d.mts:197 diff --git a/versioned_docs/version-0.27.0/api/mobile/variables/useForegroundService.md b/versioned_docs/version-0.27.0/api/mobile/variables/useForegroundService.md new file mode 100644 index 00000000..20fb0f4f --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/variables/useForegroundService.md @@ -0,0 +1,20 @@ +# Variable: useForegroundService() + +> `const` **useForegroundService**: (`config`) => `void` = `externalUseForegroundService` + +Defined in: [packages/mobile-client/src/useForegroundService.ts:47](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/mobile-client/src/useForegroundService.ts#L47) + +Hook for managing a foreground service on Android. + +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` | Configuration options for the foreground service. | + +## Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/mobile/variables/useSandbox.md b/versioned_docs/version-0.27.0/api/mobile/variables/useSandbox.md new file mode 100644 index 00000000..54c955fa --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/variables/useSandbox.md @@ -0,0 +1,60 @@ +# Variable: useSandbox() + +> `const` **useSandbox**: (`props`) => `object` + +Defined in: packages/react-client/dist/hooks/useSandbox.d.ts:5 + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`UseSandboxProps`](../type-aliases/UseSandboxProps.md) | + +## Returns + +`object` + +### getSandboxLivestream() + +> **getSandboxLivestream**: (`roomName`, `isPublic?`) => `Promise`\<\{ `room`: \{ `id`: `string`; `name`: `string`; \}; `streamerToken`: `string`; \}\> + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomName` | `string` | +| `isPublic?` | `boolean` | + +#### Returns + +`Promise`\<\{ `room`: \{ `id`: `string`; `name`: `string`; \}; `streamerToken`: `string`; \}\> + +### getSandboxPeerToken() + +> **getSandboxPeerToken**: (`roomName`, `peerName`, `roomType?`) => `Promise`\<`string`\> + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomName` | `string` | +| `peerName` | `string` | +| `roomType?` | [`RoomType`](../type-aliases/RoomType.md) | + +#### Returns + +`Promise`\<`string`\> + +### getSandboxViewerToken() + +> **getSandboxViewerToken**: (`roomName`) => `Promise`\<`string`\> + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomName` | `string` | + +#### Returns + +`Promise`\<`string`\> diff --git a/versioned_docs/version-0.27.0/api/mobile/variables/useUpdatePeerMetadata.md b/versioned_docs/version-0.27.0/api/mobile/variables/useUpdatePeerMetadata.md new file mode 100644 index 00000000..16732fb2 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/variables/useUpdatePeerMetadata.md @@ -0,0 +1,31 @@ +# Variable: useUpdatePeerMetadata() + +> `const` **useUpdatePeerMetadata**: \<`PeerMetadata`\>() => `object` + +Defined in: packages/react-client/dist/hooks/useUpdatePeerMetadata.d.ts:8 + +Hook provides a method to update the metadata of the local peer. + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | + +## Returns + +### updatePeerMetadata() + +> **updatePeerMetadata**: (`peerMetadata`) => `void` + +Updates metadata visible to other peers + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `peerMetadata` | `PeerMetadata` | + +#### Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/mobile/variables/useVAD.md b/versioned_docs/version-0.27.0/api/mobile/variables/useVAD.md new file mode 100644 index 00000000..4af3ce5b --- /dev/null +++ b/versioned_docs/version-0.27.0/api/mobile/variables/useVAD.md @@ -0,0 +1,25 @@ +# Variable: useVAD() + +> `const` **useVAD**: (`options`) => `Record`\<[`PeerId`](../type-aliases/PeerId.md), `boolean`\> + +Defined in: packages/react-client/dist/hooks/useVAD.d.ts:29 + +Voice activity detection. Use this hook to check if voice is detected in the audio track for given peer(s). + +Remote peer VAD is driven by `vadNotification` messages from the backend. +If the local peer's id is included in `peerIds`, local VAD is determined client-side +by polling the microphone's audio level (see `useLocalVAD`). + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `options` | \{ `peerIds`: `ReadonlyArray`\<[`PeerId`](../type-aliases/PeerId.md)\>; \} | Options object. | +| `options.peerIds` | `ReadonlyArray`\<[`PeerId`](../type-aliases/PeerId.md)\> | List of peer ids to subscribe to for VAD notifications. Include the local peer's id to also track whether the local user is speaking. Example usage: `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(", "); }` | + +## Returns + +`Record`\<[`PeerId`](../type-aliases/PeerId.md), `boolean`\> + +A record where each key is a peer id and the boolean value indicates +whether voice activity is currently detected for that peer. diff --git a/versioned_docs/version-0.27.0/api/reference.md b/versioned_docs/version-0.27.0/api/reference.md new file mode 100644 index 00000000..a9ea6f47 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/reference.md @@ -0,0 +1,50 @@ +--- +type: reference +--- + +# Reference + +Describes APIs for direct interaction with Fishjam. + +Fishjam publishes documentation for the Sandbox API and Fishjam Server APIs. + +## Sandbox API + +[Sandbox API OpenAPI](https://github.com/fishjam-cloud/documentation/tree/main/static/api/room-manager-openapi.yaml) + +See also: [What is the Sandbox API?](../explanation/sandbox-api-concept) + +## Server + +Fishjam Server provides a REST API for managing rooms and peers, and +[Protobufs](https://protobuf.dev) for +receiving structured live updates from the server. +The notifications can be configured using Webhook or Websocket. + +### REST API + +[Server REST API Reference](/api/rest) + +### Protobufs + +- [Server Notification Protobufs](https://github.com/fishjam-cloud/documentation/tree/main/static/api/protobuf/server_notifications.proto) +- [Agent Message Protobufs](https://github.com/fishjam-cloud/documentation/tree/main/static/api/protobuf/agent_notifications.proto) + +#### Webhook + +When using webhooks for receiving notifications, the `webhookUrl` must be passed +in the `RoomConfig` options when creating a room. + +The HTTP POST to the `webhookUrl` uses "application/x-protobuf" content type. +The body is binary data, that represents encoded `ServerMessage`. + +For more information see also [server setup documentation](../how-to/backend/server-setup#webhooks) + +#### Websocket + +After opening the Websocket connection to +`https://fishjam.io/api/v1/connect/{fishjamId}/socket/server/websocket`, +the first message that must be sent is an `AuthRequest`, +with a valid Management Token. + +Next, you can should subscribe to notifications by sending `SubscribeRequest` event with `SERVER_NOTIFICATION` event type. diff --git a/versioned_docs/version-0.27.0/api/server/classes/BadRequestException.md b/versioned_docs/version-0.27.0/api/server/classes/BadRequestException.md new file mode 100644 index 00000000..de9f6ed7 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/BadRequestException.md @@ -0,0 +1,65 @@ +# Class: BadRequestException + +Defined in: [js-server-sdk/src/exceptions/index.ts:21](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L21) + +## Extends + +- [`FishjamBaseException`](FishjamBaseException.md) + +## Constructors + +### Constructor + +> **new BadRequestException**(`error`): `BadRequestException` + +Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L13) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`BadRequestException` + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) + +## Properties + +### axiosCode? + +> `optional` **axiosCode**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) + +*** + +### details? + +> `optional` **details**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) + +*** + +### statusCode + +> **statusCode**: `number` + +Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/FishjamAgent.md b/versioned_docs/version-0.27.0/api/server/classes/FishjamAgent.md new file mode 100644 index 00000000..3564b040 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/FishjamAgent.md @@ -0,0 +1,169 @@ +# Class: FishjamAgent + +Defined in: [js-server-sdk/src/agent.ts:49](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L49) + +## Extends + +- `TypedEventEmitter`\<[`AgentEvents`](../type-aliases/AgentEvents.md), `this`\> + +## Constructors + +### Constructor + +> **new FishjamAgent**(`config`, `agentToken`, `callbacks?`): `FishjamAgent` + +Defined in: [js-server-sdk/src/agent.ts:56](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L56) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | [`FishjamConfig`](../type-aliases/FishjamConfig.md) | +| `agentToken` | `string` | +| `callbacks?` | [`AgentCallbacks`](../type-aliases/AgentCallbacks.md) | + +#### Returns + +`FishjamAgent` + +#### Overrides + +`(EventEmitter as new () => TypedEmitter).constructor` + +## Methods + +### awaitConnected() + +> **awaitConnected**(): `Promise`\<`void`\> + +Defined in: [js-server-sdk/src/agent.ts:83](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L83) + +Await Agent connection to Fishjam. + +#### Returns + +`Promise`\<`void`\> + +*** + +### captureImage() + +> **captureImage**(`trackId`, `timeoutMs`): `Promise`\<`AgentResponse_TrackImage`\> + +Defined in: [js-server-sdk/src/agent.ts:144](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L144) + +Request a captured image from the given track + +#### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `trackId` | [`TrackId`](../type-aliases/TrackId.md) | `undefined` | the track to capture an image from | +| `timeoutMs` | `number` | `5000` | timeout in milliseconds (default: 5000) | + +#### Returns + +`Promise`\<`AgentResponse_TrackImage`\> + +a promise that resolves with the captured image data + +*** + +### createTrack() + +> **createTrack**(`codecParameters`, `metadata`): [`AgentTrack`](../type-aliases/AgentTrack.md) + +Defined in: [js-server-sdk/src/agent.ts:91](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L91) + +Creates an outgoing audio track for the agent + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `codecParameters` | [`AudioCodecParameters`](../type-aliases/AudioCodecParameters.md) | +| `metadata` | `object` | + +#### Returns + +[`AgentTrack`](../type-aliases/AgentTrack.md) + +a new audio track + +*** + +### deleteTrack() + +> **deleteTrack**(`trackId`): `void` + +Defined in: [js-server-sdk/src/agent.ts:123](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L123) + +Deletes an outgoing audio track for the agent + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `trackId` | [`TrackId`](../type-aliases/TrackId.md) | + +#### Returns + +`void` + +*** + +### disconnect() + +> **disconnect**(): `void` + +Defined in: [js-server-sdk/src/agent.ts:169](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L169) + +#### Returns + +`void` + +*** + +### interruptTrack() + +> **interruptTrack**(`trackId`): `void` + +Defined in: [js-server-sdk/src/agent.ts:114](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L114) + +Interrupt track identified by `trackId`. + +Any audio that has been sent by the agent, but not played +by Fishjam will be cleared and be prevented from playing. + +Audio sent after the interrupt will be played normally. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `trackId` | [`TrackId`](../type-aliases/TrackId.md) | + +#### Returns + +`void` + +*** + +### sendData() + +> **sendData**(`trackId`, `data`): `void` + +Defined in: [js-server-sdk/src/agent.ts:132](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L132) + +Send audio data for the given track + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `trackId` | [`TrackId`](../type-aliases/TrackId.md) | +| `data` | `Uint8Array` | + +#### Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/server/classes/FishjamBaseException.md b/versioned_docs/version-0.27.0/api/server/classes/FishjamBaseException.md new file mode 100644 index 00000000..1bcebbb5 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/FishjamBaseException.md @@ -0,0 +1,64 @@ +# Class: FishjamBaseException + +Defined in: [js-server-sdk/src/exceptions/index.ts:9](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L9) + +## Extends + +- `Error` + +## Extended by + +- [`BadRequestException`](BadRequestException.md) +- [`UnauthorizedException`](UnauthorizedException.md) +- [`ForbiddenException`](ForbiddenException.md) +- [`RoomNotFoundException`](RoomNotFoundException.md) +- [`FishjamNotFoundException`](FishjamNotFoundException.md) +- [`PeerNotFoundException`](PeerNotFoundException.md) +- [`ServiceUnavailableException`](ServiceUnavailableException.md) +- [`UnknownException`](UnknownException.md) + +## Constructors + +### Constructor + +> **new FishjamBaseException**(`error`): `FishjamBaseException` + +Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L13) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`FishjamBaseException` + +#### Overrides + +`Error.constructor` + +## Properties + +### axiosCode? + +> `optional` **axiosCode**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) + +*** + +### details? + +> `optional` **details**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) + +*** + +### statusCode + +> **statusCode**: `number` + +Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) diff --git a/versioned_docs/version-0.27.0/api/server/classes/FishjamClient.md b/versioned_docs/version-0.27.0/api/server/classes/FishjamClient.md new file mode 100644 index 00000000..a046142a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/FishjamClient.md @@ -0,0 +1,329 @@ +# Class: FishjamClient + +Defined in: [js-server-sdk/src/client.ts:24](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L24) + +Client class that allows to manage Rooms and Peers for a Fishjam App. +It requires the Fishjam ID and management token that can be retrieved from the Fishjam Dashboard. + +## Constructors + +### Constructor + +> **new FishjamClient**(`config`): `FishjamClient` + +Defined in: [js-server-sdk/src/client.ts:43](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L43) + +Create new instance of Fishjam Client. + +Example usage: +``` +const fishjamClient = new FishjamClient({ + fishjamId: fastify.config.FISHJAM_ID, + managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN, +}); +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | [`FishjamConfig`](../type-aliases/FishjamConfig.md) | + +#### Returns + +`FishjamClient` + +## Methods + +### createAgent() + +> **createAgent**(`roomId`, `options`, `callbacks?`): `Promise`\<\{ `agent`: [`FishjamAgent`](FishjamAgent.md); `peer`: [`Peer`](../type-aliases/Peer.md); \}\> + +Defined in: [js-server-sdk/src/client.ts:147](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L147) + +Create a new agent assigned to a room. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | +| `options` | [`PeerOptionsAgent`](../interfaces/PeerOptionsAgent.md) | +| `callbacks?` | [`AgentCallbacks`](../type-aliases/AgentCallbacks.md) | + +#### Returns + +`Promise`\<\{ `agent`: [`FishjamAgent`](FishjamAgent.md); `peer`: [`Peer`](../type-aliases/Peer.md); \}\> + +*** + +### createLivestreamStreamerToken() + +> **createLivestreamStreamerToken**(`roomId`): `Promise`\<[`StreamerToken`](../interfaces/StreamerToken.md)\> + +Defined in: [js-server-sdk/src/client.ts:268](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L268) + +Creates a livestream streamer token for the given room. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | + +#### Returns + +`Promise`\<[`StreamerToken`](../interfaces/StreamerToken.md)\> + +a livestream streamer token + +*** + +### createLivestreamViewerToken() + +> **createLivestreamViewerToken**(`roomId`): `Promise`\<[`ViewerToken`](../interfaces/ViewerToken.md)\> + +Defined in: [js-server-sdk/src/client.ts:255](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L255) + +Creates a livestream viewer token for the given room. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | + +#### Returns + +`Promise`\<[`ViewerToken`](../interfaces/ViewerToken.md)\> + +a livestream viewer token + +*** + +### createMoqToken() + +> **createMoqToken**(`config?`): `Promise`\<[`MoqToken`](../interfaces/MoqToken.md)\> + +Defined in: [js-server-sdk/src/client.ts:281](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L281) + +Creates a MoQ token. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config?` | [`MoqTokenConfig`](../interfaces/MoqTokenConfig.md) | + +#### Returns + +`Promise`\<[`MoqToken`](../interfaces/MoqToken.md)\> + +a MoQ token + +*** + +### createPeer() + +> **createPeer**(`roomId`, `options`): `Promise`\<\{ `peer`: [`Peer`](../type-aliases/Peer.md); `peerToken`: `string`; \}\> + +Defined in: [js-server-sdk/src/client.ts:127](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L127) + +Create a new peer assigned to a room. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | +| `options` | [`PeerOptionsWebRTC`](../interfaces/PeerOptionsWebRTC.md) | + +#### Returns + +`Promise`\<\{ `peer`: [`Peer`](../type-aliases/Peer.md); `peerToken`: `string`; \}\> + +*** + +### createRoom() + +> **createRoom**(`config`): `Promise`\<[`Room`](../type-aliases/Room.md)\> + +Defined in: [js-server-sdk/src/client.ts:85](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L85) + +Create a new room. All peers connected to the same room will be able to send/receive streams to each other. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | [`RoomConfig`](../interfaces/RoomConfig.md) | + +#### Returns + +`Promise`\<[`Room`](../type-aliases/Room.md)\> + +*** + +### createVapiAgent() + +> **createVapiAgent**(`roomId`, `options`): `Promise`\<\{ `peer`: [`Peer`](../type-aliases/Peer.md); \}\> + +Defined in: [js-server-sdk/src/client.ts:173](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L173) + +Create a new VAPI agent assigned to a room. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | +| `options` | [`PeerOptionsVapi`](../interfaces/PeerOptionsVapi.md) | + +#### Returns + +`Promise`\<\{ `peer`: [`Peer`](../type-aliases/Peer.md); \}\> + +*** + +### deletePeer() + +> **deletePeer**(`roomId`, `peerId`): `Promise`\<`void`\> + +Defined in: [js-server-sdk/src/client.ts:205](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L205) + +Delete a peer - this will also disconnect the peer from the room. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | +| `peerId` | [`PeerId`](../type-aliases/PeerId.md) | + +#### Returns + +`Promise`\<`void`\> + +*** + +### deleteRoom() + +> **deleteRoom**(`roomId`): `Promise`\<`void`\> + +Defined in: [js-server-sdk/src/client.ts:104](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L104) + +Delete an existing room. All peers connected to this room will be disconnected and removed. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | + +#### Returns + +`Promise`\<`void`\> + +*** + +### getAllRooms() + +> **getAllRooms**(): `Promise`\<[`Room`](../type-aliases/Room.md)[]\> + +Defined in: [js-server-sdk/src/client.ts:115](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L115) + +Get a list of all existing rooms. + +#### Returns + +`Promise`\<[`Room`](../type-aliases/Room.md)[]\> + +*** + +### getRoom() + +> **getRoom**(`roomId`): `Promise`\<[`Room`](../type-aliases/Room.md)\> + +Defined in: [js-server-sdk/src/client.ts:193](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L193) + +Get details about a given room. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | + +#### Returns + +`Promise`\<[`Room`](../type-aliases/Room.md)\> + +*** + +### refreshPeerToken() + +> **refreshPeerToken**(`roomId`, `peerId`): `Promise`\<`string`\> + +Defined in: [js-server-sdk/src/client.ts:242](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L242) + +Refresh the peer token for an already existing peer. +If an already created peer has not been connected to the room for more than 24 hours, the token will become invalid. This method can be used to generate a new peer token for the existing peer. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | +| `peerId` | [`PeerId`](../type-aliases/PeerId.md) | + +#### Returns + +`Promise`\<`string`\> + +refreshed peer token + +*** + +### subscribePeer() + +> **subscribePeer**(`roomId`, `subscriberPeerId`, `publisherPeerId`): `Promise`\<`void`\> + +Defined in: [js-server-sdk/src/client.ts:217](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L217) + +Subscribe a peer to another peer - this will make all tracks from the publisher available to the subscriber. +Using this function only makes sense if subscribeMode is set to manual + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | +| `subscriberPeerId` | [`PeerId`](../type-aliases/PeerId.md) | +| `publisherPeerId` | [`PeerId`](../type-aliases/PeerId.md) | + +#### Returns + +`Promise`\<`void`\> + +*** + +### subscribeTracks() + +> **subscribeTracks**(`roomId`, `subscriberPeerId`, `tracks`): `Promise`\<`void`\> + +Defined in: [js-server-sdk/src/client.ts:229](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/client.ts#L229) + +Subscribe a peer to specific tracks from another peer - this will make only the specified tracks from the publisher available to the subscriber. +Using this function only makes sense if subscribeMode is set to manual + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomId` | [`RoomId`](../type-aliases/RoomId.md) | +| `subscriberPeerId` | [`PeerId`](../type-aliases/PeerId.md) | +| `tracks` | [`TrackId`](../type-aliases/TrackId.md)[] | + +#### Returns + +`Promise`\<`void`\> diff --git a/versioned_docs/version-0.27.0/api/server/classes/FishjamNotFoundException.md b/versioned_docs/version-0.27.0/api/server/classes/FishjamNotFoundException.md new file mode 100644 index 00000000..71677daa --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/FishjamNotFoundException.md @@ -0,0 +1,65 @@ +# Class: FishjamNotFoundException + +Defined in: [js-server-sdk/src/exceptions/index.ts:29](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L29) + +## Extends + +- [`FishjamBaseException`](FishjamBaseException.md) + +## Constructors + +### Constructor + +> **new FishjamNotFoundException**(`error`): `FishjamNotFoundException` + +Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L13) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`FishjamNotFoundException` + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) + +## Properties + +### axiosCode? + +> `optional` **axiosCode**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) + +*** + +### details? + +> `optional` **details**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) + +*** + +### statusCode + +> **statusCode**: `number` + +Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/FishjamWSNotifier.md b/versioned_docs/version-0.27.0/api/server/classes/FishjamWSNotifier.md new file mode 100644 index 00000000..82ec8d65 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/FishjamWSNotifier.md @@ -0,0 +1,33 @@ +# Class: FishjamWSNotifier + +Defined in: [js-server-sdk/src/ws\_notifier.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/ws_notifier.ts#L12) + +Notifier object that can be used to get notified about various events related to the Fishjam App. + +## Extends + +- `TypedEventEmitter`\<[`NotificationEvents`](../type-aliases/NotificationEvents.md), `this`\> + +## Constructors + +### Constructor + +> **new FishjamWSNotifier**(`config`, `onError`, `onClose`): `FishjamWSNotifier` + +Defined in: [js-server-sdk/src/ws\_notifier.ts:15](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/ws_notifier.ts#L15) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | [`FishjamConfig`](../type-aliases/FishjamConfig.md) | +| `onError` | [`ErrorEventHandler`](../type-aliases/ErrorEventHandler.md) | +| `onClose` | [`CloseEventHandler`](../type-aliases/CloseEventHandler.md) | + +#### Returns + +`FishjamWSNotifier` + +#### Overrides + +`(EventEmitter as new () => TypedEmitter).constructor` diff --git a/versioned_docs/version-0.27.0/api/server/classes/ForbiddenException.md b/versioned_docs/version-0.27.0/api/server/classes/ForbiddenException.md new file mode 100644 index 00000000..df69275a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/ForbiddenException.md @@ -0,0 +1,65 @@ +# Class: ForbiddenException + +Defined in: [js-server-sdk/src/exceptions/index.ts:25](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L25) + +## Extends + +- [`FishjamBaseException`](FishjamBaseException.md) + +## Constructors + +### Constructor + +> **new ForbiddenException**(`error`): `ForbiddenException` + +Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L13) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`ForbiddenException` + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) + +## Properties + +### axiosCode? + +> `optional` **axiosCode**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) + +*** + +### details? + +> `optional` **details**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) + +*** + +### statusCode + +> **statusCode**: `number` + +Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/MissingFishjamIdException.md b/versioned_docs/version-0.27.0/api/server/classes/MissingFishjamIdException.md new file mode 100644 index 00000000..00f759be --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/MissingFishjamIdException.md @@ -0,0 +1,23 @@ +# Class: MissingFishjamIdException + +Defined in: [js-server-sdk/src/exceptions/index.ts:3](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L3) + +## Extends + +- `Error` + +## Constructors + +### Constructor + +> **new MissingFishjamIdException**(): `MissingFishjamIdException` + +Defined in: [js-server-sdk/src/exceptions/index.ts:4](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L4) + +#### Returns + +`MissingFishjamIdException` + +#### Overrides + +`Error.constructor` diff --git a/versioned_docs/version-0.27.0/api/server/classes/PeerNotFoundException.md b/versioned_docs/version-0.27.0/api/server/classes/PeerNotFoundException.md new file mode 100644 index 00000000..9c49bd2c --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/PeerNotFoundException.md @@ -0,0 +1,65 @@ +# Class: PeerNotFoundException + +Defined in: [js-server-sdk/src/exceptions/index.ts:31](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L31) + +## Extends + +- [`FishjamBaseException`](FishjamBaseException.md) + +## Constructors + +### Constructor + +> **new PeerNotFoundException**(`error`): `PeerNotFoundException` + +Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L13) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`PeerNotFoundException` + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) + +## Properties + +### axiosCode? + +> `optional` **axiosCode**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) + +*** + +### details? + +> `optional` **details**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) + +*** + +### statusCode + +> **statusCode**: `number` + +Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/RoomNotFoundException.md b/versioned_docs/version-0.27.0/api/server/classes/RoomNotFoundException.md new file mode 100644 index 00000000..e81dfdd2 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/RoomNotFoundException.md @@ -0,0 +1,65 @@ +# Class: RoomNotFoundException + +Defined in: [js-server-sdk/src/exceptions/index.ts:27](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L27) + +## Extends + +- [`FishjamBaseException`](FishjamBaseException.md) + +## Constructors + +### Constructor + +> **new RoomNotFoundException**(`error`): `RoomNotFoundException` + +Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L13) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`RoomNotFoundException` + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) + +## Properties + +### axiosCode? + +> `optional` **axiosCode**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) + +*** + +### details? + +> `optional` **details**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) + +*** + +### statusCode + +> **statusCode**: `number` + +Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/ServiceUnavailableException.md b/versioned_docs/version-0.27.0/api/server/classes/ServiceUnavailableException.md new file mode 100644 index 00000000..1f397b24 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/ServiceUnavailableException.md @@ -0,0 +1,65 @@ +# Class: ServiceUnavailableException + +Defined in: [js-server-sdk/src/exceptions/index.ts:33](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L33) + +## Extends + +- [`FishjamBaseException`](FishjamBaseException.md) + +## Constructors + +### Constructor + +> **new ServiceUnavailableException**(`error`): `ServiceUnavailableException` + +Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L13) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`ServiceUnavailableException` + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) + +## Properties + +### axiosCode? + +> `optional` **axiosCode**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) + +*** + +### details? + +> `optional` **details**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) + +*** + +### statusCode + +> **statusCode**: `number` + +Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/UnauthorizedException.md b/versioned_docs/version-0.27.0/api/server/classes/UnauthorizedException.md new file mode 100644 index 00000000..63849a9a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/UnauthorizedException.md @@ -0,0 +1,65 @@ +# Class: UnauthorizedException + +Defined in: [js-server-sdk/src/exceptions/index.ts:23](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L23) + +## Extends + +- [`FishjamBaseException`](FishjamBaseException.md) + +## Constructors + +### Constructor + +> **new UnauthorizedException**(`error`): `UnauthorizedException` + +Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L13) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`UnauthorizedException` + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) + +## Properties + +### axiosCode? + +> `optional` **axiosCode**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) + +*** + +### details? + +> `optional` **details**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) + +*** + +### statusCode + +> **statusCode**: `number` + +Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/classes/UnknownException.md b/versioned_docs/version-0.27.0/api/server/classes/UnknownException.md new file mode 100644 index 00000000..41a35917 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/classes/UnknownException.md @@ -0,0 +1,65 @@ +# Class: UnknownException + +Defined in: [js-server-sdk/src/exceptions/index.ts:35](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L35) + +## Extends + +- [`FishjamBaseException`](FishjamBaseException.md) + +## Constructors + +### Constructor + +> **new UnknownException**(`error`): `UnknownException` + +Defined in: [js-server-sdk/src/exceptions/index.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L13) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `AxiosError`\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`UnknownException` + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`constructor`](FishjamBaseException.md#constructor) + +## Properties + +### axiosCode? + +> `optional` **axiosCode**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:11](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L11) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`axiosCode`](FishjamBaseException.md#axioscode) + +*** + +### details? + +> `optional` **details**: `string` + +Defined in: [js-server-sdk/src/exceptions/index.ts:12](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L12) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`details`](FishjamBaseException.md#details) + +*** + +### statusCode + +> **statusCode**: `number` + +Defined in: [js-server-sdk/src/exceptions/index.ts:10](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/exceptions/index.ts#L10) + +#### Inherited from + +[`FishjamBaseException`](FishjamBaseException.md).[`statusCode`](FishjamBaseException.md#statuscode) diff --git a/versioned_docs/version-0.27.0/api/server/enumerations/PeerStatus.md b/versioned_docs/version-0.27.0/api/server/enumerations/PeerStatus.md new file mode 100644 index 00000000..b65c395e --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/enumerations/PeerStatus.md @@ -0,0 +1,23 @@ +# Enumeration: PeerStatus + +Defined in: fishjam-openapi/dist/index.d.ts:439 + +Informs about the peer status + +## Export + +## Enumeration Members + +### Connected + +> **Connected**: `"connected"` + +Defined in: fishjam-openapi/dist/index.d.ts:440 + +*** + +### Disconnected + +> **Disconnected**: `"disconnected"` + +Defined in: fishjam-openapi/dist/index.d.ts:441 diff --git a/versioned_docs/version-0.27.0/api/server/enumerations/RoomType.md b/versioned_docs/version-0.27.0/api/server/enumerations/RoomType.md new file mode 100644 index 00000000..f922b904 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/enumerations/RoomType.md @@ -0,0 +1,55 @@ +# Enumeration: RoomType + +Defined in: fishjam-openapi/dist/index.d.ts:573 + +The use-case of the room. If not provided, this defaults to conference. + +## Export + +## Enumeration Members + +### AudioOnly + +> **AudioOnly**: `"audio_only"` + +Defined in: fishjam-openapi/dist/index.d.ts:575 + +*** + +### AudioOnlyLivestream + +> **AudioOnlyLivestream**: `"audio_only_livestream"` + +Defined in: fishjam-openapi/dist/index.d.ts:579 + +*** + +### Broadcaster + +> **Broadcaster**: `"broadcaster"` + +Defined in: fishjam-openapi/dist/index.d.ts:576 + +*** + +### Conference + +> **Conference**: `"conference"` + +Defined in: fishjam-openapi/dist/index.d.ts:578 + +*** + +### FullFeature + +> **FullFeature**: `"full_feature"` + +Defined in: fishjam-openapi/dist/index.d.ts:574 + +*** + +### Livestream + +> **Livestream**: `"livestream"` + +Defined in: fishjam-openapi/dist/index.d.ts:577 diff --git a/versioned_docs/version-0.27.0/api/server/enumerations/VideoCodec.md b/versioned_docs/version-0.27.0/api/server/enumerations/VideoCodec.md new file mode 100644 index 00000000..450a4b5e --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/enumerations/VideoCodec.md @@ -0,0 +1,23 @@ +# Enumeration: VideoCodec + +Defined in: fishjam-openapi/dist/index.d.ts:877 + +Enforces video codec for each peer in the room + +## Export + +## Enumeration Members + +### H264 + +> **H264**: `"h264"` + +Defined in: fishjam-openapi/dist/index.d.ts:878 + +*** + +### Vp8 + +> **Vp8**: `"vp8"` + +Defined in: fishjam-openapi/dist/index.d.ts:879 diff --git a/versioned_docs/version-0.27.0/api/server/index.md b/versioned_docs/version-0.27.0/api/server/index.md new file mode 100644 index 00000000..8c2c2065 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/index.md @@ -0,0 +1,77 @@ +# @fishjam-cloud/js-server-sdk + +Server-side Node.js SDK for creating and managing Fishjam rooms, peers, agents, and receiving real-time server notifications. + +## Client + +- [FishjamClient](classes/FishjamClient.md) +- [FishjamWSNotifier](classes/FishjamWSNotifier.md) + +## Other + +- [PeerStatus](enumerations/PeerStatus.md) +- [RoomType](enumerations/RoomType.md) +- [VideoCodec](enumerations/VideoCodec.md) +- [BadRequestException](classes/BadRequestException.md) +- [FishjamAgent](classes/FishjamAgent.md) +- [FishjamBaseException](classes/FishjamBaseException.md) +- [FishjamNotFoundException](classes/FishjamNotFoundException.md) +- [ForbiddenException](classes/ForbiddenException.md) +- [MissingFishjamIdException](classes/MissingFishjamIdException.md) +- [PeerNotFoundException](classes/PeerNotFoundException.md) +- [RoomNotFoundException](classes/RoomNotFoundException.md) +- [ServiceUnavailableException](classes/ServiceUnavailableException.md) +- [UnauthorizedException](classes/UnauthorizedException.md) +- [UnknownException](classes/UnknownException.md) +- [MoqToken](interfaces/MoqToken.md) +- [MoqTokenConfig](interfaces/MoqTokenConfig.md) +- [PeerOptionsAgent](interfaces/PeerOptionsAgent.md) +- [PeerOptionsVapi](interfaces/PeerOptionsVapi.md) +- [PeerOptionsWebRTC](interfaces/PeerOptionsWebRTC.md) +- [RoomConfig](interfaces/RoomConfig.md) +- [ServerMessage](interfaces/ServerMessage.md) +- [StreamerToken](interfaces/StreamerToken.md) +- [ViewerToken](interfaces/ViewerToken.md) +- [AgentCallbacks](type-aliases/AgentCallbacks.md) +- [AgentEvents](type-aliases/AgentEvents.md) +- [AgentTrack](type-aliases/AgentTrack.md) +- [AudioCodecParameters](type-aliases/AudioCodecParameters.md) +- [Brand](type-aliases/Brand.md) +- [ChannelAdded](type-aliases/ChannelAdded.md) +- [ChannelRemoved](type-aliases/ChannelRemoved.md) +- [CloseEventHandler](type-aliases/CloseEventHandler.md) +- [ErrorEventHandler](type-aliases/ErrorEventHandler.md) +- [ExpectedAgentEvents](type-aliases/ExpectedAgentEvents.md) +- [ExpectedEvents](type-aliases/ExpectedEvents.md) +- [FishjamConfig](type-aliases/FishjamConfig.md) +- [IgnoredEvents](type-aliases/IgnoredEvents.md) +- [IncomingTrackData](type-aliases/IncomingTrackData.md) +- [IncomingTrackImage](type-aliases/IncomingTrackImage.md) +- [NotificationEvents](type-aliases/NotificationEvents.md) +- [OutgoingTrackData](type-aliases/OutgoingTrackData.md) +- [Peer](type-aliases/Peer.md) +- [PeerAdded](type-aliases/PeerAdded.md) +- [PeerConnected](type-aliases/PeerConnected.md) +- [PeerCrashed](type-aliases/PeerCrashed.md) +- [PeerDeleted](type-aliases/PeerDeleted.md) +- [PeerDisconnected](type-aliases/PeerDisconnected.md) +- [PeerId](type-aliases/PeerId.md) +- [PeerMetadataUpdated](type-aliases/PeerMetadataUpdated.md) +- [PeerOptions](type-aliases/PeerOptions.md) +- [PeerType](type-aliases/PeerType.md) +- [Room](type-aliases/Room.md) +- [RoomCrashed](type-aliases/RoomCrashed.md) +- [RoomCreated](type-aliases/RoomCreated.md) +- [RoomDeleted](type-aliases/RoomDeleted.md) +- [RoomId](type-aliases/RoomId.md) +- [StreamerConnected](type-aliases/StreamerConnected.md) +- [StreamerDisconnected](type-aliases/StreamerDisconnected.md) +- [Track](type-aliases/Track.md) +- [TrackAdded](type-aliases/TrackAdded.md) +- [TrackId](type-aliases/TrackId.md) +- [TrackMetadataUpdated](type-aliases/TrackMetadataUpdated.md) +- [TrackRemoved](type-aliases/TrackRemoved.md) +- [TrackType](type-aliases/TrackType.md) +- [ViewerConnected](type-aliases/ViewerConnected.md) +- [ViewerDisconnected](type-aliases/ViewerDisconnected.md) +- [ServerMessage](variables/ServerMessage.md) diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/MoqToken.md b/versioned_docs/version-0.27.0/api/server/interfaces/MoqToken.md new file mode 100644 index 00000000..68d38070 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/interfaces/MoqToken.md @@ -0,0 +1,23 @@ +# Interface: MoqToken + +Defined in: fishjam-openapi/dist/index.d.ts:204 + +Token for authorizing a MoQ relay connection + +## Export + +MoqToken + +## Properties + +### token + +> **token**: `string` + +Defined in: fishjam-openapi/dist/index.d.ts:210 + +JWT token for MoQ relay + +#### Memberof + +MoqToken diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/MoqTokenConfig.md b/versioned_docs/version-0.27.0/api/server/interfaces/MoqTokenConfig.md new file mode 100644 index 00000000..e0f23431 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/interfaces/MoqTokenConfig.md @@ -0,0 +1,37 @@ +# Interface: MoqTokenConfig + +Defined in: fishjam-openapi/dist/index.d.ts:217 + +MoQ token configuration + +## Export + +MoqTokenConfig + +## Properties + +### publishPath? + +> `optional` **publishPath**: `null` \| `string` + +Defined in: fishjam-openapi/dist/index.d.ts:223 + +Path under the root the token grants publish access to + +#### Memberof + +MoqTokenConfig + +*** + +### subscribePath? + +> `optional` **subscribePath**: `null` \| `string` + +Defined in: fishjam-openapi/dist/index.d.ts:229 + +Path under the root the token grants subscribe access to + +#### Memberof + +MoqTokenConfig diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsAgent.md b/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsAgent.md new file mode 100644 index 00000000..1fb3a246 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsAgent.md @@ -0,0 +1,33 @@ +# Interface: PeerOptionsAgent + +Defined in: fishjam-openapi/dist/index.d.ts:348 + +Options specific to the Agent peer + +## Export + +PeerOptionsAgent + +## Properties + +### output? + +> `optional` **output**: `AgentOutput` + +Defined in: fishjam-openapi/dist/index.d.ts:354 + +#### Memberof + +PeerOptionsAgent + +*** + +### subscribeMode? + +> `optional` **subscribeMode**: `SubscribeMode` + +Defined in: fishjam-openapi/dist/index.d.ts:360 + +#### Memberof + +PeerOptionsAgent diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsVapi.md b/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsVapi.md new file mode 100644 index 00000000..de8f1622 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsVapi.md @@ -0,0 +1,49 @@ +# Interface: PeerOptionsVapi + +Defined in: fishjam-openapi/dist/index.d.ts:367 + +Options specific to the VAPI peer + +## Export + +PeerOptionsVapi + +## Properties + +### apiKey + +> **apiKey**: `string` + +Defined in: fishjam-openapi/dist/index.d.ts:373 + +VAPI API key + +#### Memberof + +PeerOptionsVapi + +*** + +### callId + +> **callId**: `string` + +Defined in: fishjam-openapi/dist/index.d.ts:379 + +VAPI call ID + +#### Memberof + +PeerOptionsVapi + +*** + +### subscribeMode? + +> `optional` **subscribeMode**: `SubscribeMode` + +Defined in: fishjam-openapi/dist/index.d.ts:385 + +#### Memberof + +PeerOptionsVapi diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsWebRTC.md b/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsWebRTC.md new file mode 100644 index 00000000..4972960a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/interfaces/PeerOptionsWebRTC.md @@ -0,0 +1,39 @@ +# Interface: PeerOptionsWebRTC + +Defined in: fishjam-openapi/dist/index.d.ts:392 + +Options specific to the WebRTC peer + +## Export + +PeerOptionsWebRTC + +## Properties + +### metadata? + +> `optional` **metadata**: `object` + +Defined in: fishjam-openapi/dist/index.d.ts:398 + +Custom peer metadata + +#### Index Signature + +\[`key`: `string`\]: `any` + +#### Memberof + +PeerOptionsWebRTC + +*** + +### subscribeMode? + +> `optional` **subscribeMode**: `SubscribeMode` + +Defined in: fishjam-openapi/dist/index.d.ts:406 + +#### Memberof + +PeerOptionsWebRTC diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/RoomConfig.md b/versioned_docs/version-0.27.0/api/server/interfaces/RoomConfig.md new file mode 100644 index 00000000..90a2fa92 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/interfaces/RoomConfig.md @@ -0,0 +1,89 @@ +# Interface: RoomConfig + +Defined in: fishjam-openapi/dist/index.d.ts:491 + +Room configuration + +## Export + +RoomConfig + +## Properties + +### batchWebhookNotifications? + +> `optional` **batchWebhookNotifications**: `boolean` + +Defined in: fishjam-openapi/dist/index.d.ts:497 + +If true, webhook notifications for this room are coalesced into a single NotificationBatch per HTTP send instead of one request per notification. VAD notifications are unaffected. + +#### Memberof + +RoomConfig + +*** + +### maxPeers? + +> `optional` **maxPeers**: `null` \| `number` + +Defined in: fishjam-openapi/dist/index.d.ts:503 + +Maximum amount of peers allowed into the room + +#### Memberof + +RoomConfig + +*** + +### public? + +> `optional` **public**: `boolean` + +Defined in: fishjam-openapi/dist/index.d.ts:509 + +True if livestream viewers can omit specifying a token. + +#### Memberof + +RoomConfig + +*** + +### roomType? + +> `optional` **roomType**: [`RoomType`](../enumerations/RoomType.md) + +Defined in: fishjam-openapi/dist/index.d.ts:515 + +#### Memberof + +RoomConfig + +*** + +### videoCodec? + +> `optional` **videoCodec**: [`VideoCodec`](../enumerations/VideoCodec.md) + +Defined in: fishjam-openapi/dist/index.d.ts:521 + +#### Memberof + +RoomConfig + +*** + +### webhookUrl? + +> `optional` **webhookUrl**: `null` \| `string` + +Defined in: fishjam-openapi/dist/index.d.ts:527 + +URL where Fishjam notifications will be sent + +#### Memberof + +RoomConfig diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/ServerMessage.md b/versioned_docs/version-0.27.0/api/server/interfaces/ServerMessage.md new file mode 100644 index 00000000..4ebe4f81 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/interfaces/ServerMessage.md @@ -0,0 +1,275 @@ +# Interface: ServerMessage + +Defined in: fishjam-proto/dist/index.d.ts:72 + +Defines any type of message passed between FJ and server peer + +## Properties + +### authenticated? + +> `optional` **authenticated**: `ServerMessage_Authenticated` + +Defined in: fishjam-proto/dist/index.d.ts:73 + +*** + +### authRequest? + +> `optional` **authRequest**: `ServerMessage_AuthRequest` + +Defined in: fishjam-proto/dist/index.d.ts:74 + +*** + +### channelAdded? + +> `optional` **channelAdded**: `ServerMessage_ChannelAdded` + +Defined in: fishjam-proto/dist/index.d.ts:89 + +*** + +### channelRemoved? + +> `optional` **channelRemoved**: `ServerMessage_ChannelRemoved` + +Defined in: fishjam-proto/dist/index.d.ts:90 + +*** + +### ~~componentCrashed?~~ + +> `optional` **componentCrashed**: `ServerMessage_ComponentCrashed` + +Defined in: fishjam-proto/dist/index.d.ts:111 + +#### Deprecated + +*** + +### ~~hlsPlayable?~~ + +> `optional` **hlsPlayable**: `ServerMessage_HlsPlayable` + +Defined in: fishjam-proto/dist/index.d.ts:105 + +#### Deprecated + +*** + +### ~~hlsUploadCrashed?~~ + +> `optional` **hlsUploadCrashed**: `ServerMessage_HlsUploadCrashed` + +Defined in: fishjam-proto/dist/index.d.ts:109 + +#### Deprecated + +*** + +### ~~hlsUploaded?~~ + +> `optional` **hlsUploaded**: `ServerMessage_HlsUploaded` + +Defined in: fishjam-proto/dist/index.d.ts:107 + +#### Deprecated + +*** + +### notificationBatch? + +> `optional` **notificationBatch**: `ServerMessage_NotificationBatch` + +Defined in: fishjam-proto/dist/index.d.ts:99 + +Batch + +*** + +### peerAdded? + +> `optional` **peerAdded**: `ServerMessage_PeerAdded` + +Defined in: fishjam-proto/dist/index.d.ts:87 + +*** + +### peerConnected? + +> `optional` **peerConnected**: `ServerMessage_PeerConnected` + +Defined in: fishjam-proto/dist/index.d.ts:80 + +*** + +### peerCrashed? + +> `optional` **peerCrashed**: `ServerMessage_PeerCrashed` + +Defined in: fishjam-proto/dist/index.d.ts:82 + +*** + +### peerDeleted? + +> `optional` **peerDeleted**: `ServerMessage_PeerDeleted` + +Defined in: fishjam-proto/dist/index.d.ts:88 + +*** + +### peerDisconnected? + +> `optional` **peerDisconnected**: `ServerMessage_PeerDisconnected` + +Defined in: fishjam-proto/dist/index.d.ts:81 + +*** + +### peerMetadataUpdated? + +> `optional` **peerMetadataUpdated**: `ServerMessage_PeerMetadataUpdated` + +Defined in: fishjam-proto/dist/index.d.ts:83 + +*** + +### roomCrashed? + +> `optional` **roomCrashed**: `ServerMessage_RoomCrashed` + +Defined in: fishjam-proto/dist/index.d.ts:79 + +*** + +### roomCreated? + +> `optional` **roomCreated**: `ServerMessage_RoomCreated` + +Defined in: fishjam-proto/dist/index.d.ts:77 + +*** + +### roomDeleted? + +> `optional` **roomDeleted**: `ServerMessage_RoomDeleted` + +Defined in: fishjam-proto/dist/index.d.ts:78 + +*** + +### ~~streamConnected?~~ + +> `optional` **streamConnected**: `ServerMessage_StreamConnected` + +Defined in: fishjam-proto/dist/index.d.ts:101 + +#### Deprecated + +*** + +### ~~streamDisconnected?~~ + +> `optional` **streamDisconnected**: `ServerMessage_StreamDisconnected` + +Defined in: fishjam-proto/dist/index.d.ts:103 + +#### Deprecated + +*** + +### streamerConnected? + +> `optional` **streamerConnected**: `ServerMessage_StreamerConnected` + +Defined in: fishjam-proto/dist/index.d.ts:96 + +*** + +### streamerDisconnected? + +> `optional` **streamerDisconnected**: `ServerMessage_StreamerDisconnected` + +Defined in: fishjam-proto/dist/index.d.ts:97 + +*** + +### subscribeRequest? + +> `optional` **subscribeRequest**: `ServerMessage_SubscribeRequest` + +Defined in: fishjam-proto/dist/index.d.ts:75 + +*** + +### subscribeResponse? + +> `optional` **subscribeResponse**: `ServerMessage_SubscribeResponse` + +Defined in: fishjam-proto/dist/index.d.ts:76 + +*** + +### trackAdded? + +> `optional` **trackAdded**: `ServerMessage_TrackAdded` + +Defined in: fishjam-proto/dist/index.d.ts:84 + +*** + +### trackForwarding? + +> `optional` **trackForwarding**: `ServerMessage_TrackForwarding` + +Defined in: fishjam-proto/dist/index.d.ts:91 + +*** + +### trackForwardingRemoved? + +> `optional` **trackForwardingRemoved**: `ServerMessage_TrackForwardingRemoved` + +Defined in: fishjam-proto/dist/index.d.ts:92 + +*** + +### trackMetadataUpdated? + +> `optional` **trackMetadataUpdated**: `ServerMessage_TrackMetadataUpdated` + +Defined in: fishjam-proto/dist/index.d.ts:86 + +*** + +### trackRemoved? + +> `optional` **trackRemoved**: `ServerMessage_TrackRemoved` + +Defined in: fishjam-proto/dist/index.d.ts:85 + +*** + +### vadNotification? + +> `optional` **vadNotification**: `ServerMessage_VadNotification` + +Defined in: fishjam-proto/dist/index.d.ts:93 + +*** + +### viewerConnected? + +> `optional` **viewerConnected**: `ServerMessage_ViewerConnected` + +Defined in: fishjam-proto/dist/index.d.ts:94 + +*** + +### viewerDisconnected? + +> `optional` **viewerDisconnected**: `ServerMessage_ViewerDisconnected` + +Defined in: fishjam-proto/dist/index.d.ts:95 diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/StreamerToken.md b/versioned_docs/version-0.27.0/api/server/interfaces/StreamerToken.md new file mode 100644 index 00000000..e3d331a8 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/interfaces/StreamerToken.md @@ -0,0 +1,23 @@ +# Interface: StreamerToken + +Defined in: fishjam-openapi/dist/index.d.ts:724 + +Streamer authorization token + +## Export + +StreamerToken + +## Properties + +### token + +> **token**: `string` + +Defined in: fishjam-openapi/dist/index.d.ts:730 + +Token streamer should authorize with + +#### Memberof + +StreamerToken diff --git a/versioned_docs/version-0.27.0/api/server/interfaces/ViewerToken.md b/versioned_docs/version-0.27.0/api/server/interfaces/ViewerToken.md new file mode 100644 index 00000000..2549f32b --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/interfaces/ViewerToken.md @@ -0,0 +1,23 @@ +# Interface: ViewerToken + +Defined in: fishjam-openapi/dist/index.d.ts:919 + +Viewer authorization token + +## Export + +ViewerToken + +## Properties + +### token + +> **token**: `string` + +Defined in: fishjam-openapi/dist/index.d.ts:925 + +Token viewer should authorize with + +#### Memberof + +ViewerToken diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/AgentCallbacks.md b/versioned_docs/version-0.27.0/api/server/type-aliases/AgentCallbacks.md new file mode 100644 index 00000000..4d265047 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/AgentCallbacks.md @@ -0,0 +1,21 @@ +# Type Alias: AgentCallbacks + +> **AgentCallbacks** = `object` + +Defined in: [js-server-sdk/src/types.ts:63](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L63) + +## Properties + +### onClose? + +> `optional` **onClose**: [`CloseEventHandler`](CloseEventHandler.md) + +Defined in: [js-server-sdk/src/types.ts:65](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L65) + +*** + +### onError? + +> `optional` **onError**: [`ErrorEventHandler`](ErrorEventHandler.md) + +Defined in: [js-server-sdk/src/types.ts:64](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L64) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/AgentEvents.md b/versioned_docs/version-0.27.0/api/server/type-aliases/AgentEvents.md new file mode 100644 index 00000000..4b863efd --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/AgentEvents.md @@ -0,0 +1,5 @@ +# Type Alias: AgentEvents + +> **AgentEvents** = `{ [K in ExpectedAgentEvents]: (message: NonNullable<{ authenticated?: AgentResponse_Authenticated; trackData?: Omit & { peerId: PeerId }; trackImage?: AgentResponse_TrackImage }[K]>) => void }` + +Defined in: [js-server-sdk/src/agent.ts:47](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L47) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/AgentTrack.md b/versioned_docs/version-0.27.0/api/server/type-aliases/AgentTrack.md new file mode 100644 index 00000000..c2183594 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/AgentTrack.md @@ -0,0 +1,11 @@ +# Type Alias: AgentTrack + +> **AgentTrack** = `Omit`\<`ProtoTrack`, `"id"`\> & `object` + +Defined in: [js-server-sdk/src/agent.ts:28](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L28) + +## Type declaration + +### id + +> **id**: [`TrackId`](TrackId.md) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/AudioCodecParameters.md b/versioned_docs/version-0.27.0/api/server/type-aliases/AudioCodecParameters.md new file mode 100644 index 00000000..102fc388 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/AudioCodecParameters.md @@ -0,0 +1,29 @@ +# Type Alias: AudioCodecParameters + +> **AudioCodecParameters** = `object` + +Defined in: [js-server-sdk/src/agent.ts:30](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L30) + +## Properties + +### channels + +> **channels**: `1` + +Defined in: [js-server-sdk/src/agent.ts:33](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L33) + +*** + +### encoding + +> **encoding**: `"opus"` \| `"pcm16"` + +Defined in: [js-server-sdk/src/agent.ts:31](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L31) + +*** + +### sampleRate + +> **sampleRate**: `16000` \| `24000` \| `48000` + +Defined in: [js-server-sdk/src/agent.ts:32](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L32) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/Brand.md b/versioned_docs/version-0.27.0/api/server/type-aliases/Brand.md new file mode 100644 index 00000000..af8dfb4b --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/Brand.md @@ -0,0 +1,20 @@ +# Type Alias: Brand\ + +> **Brand**\<`T`, `TBrand`\> = `T` & `object` + +Defined in: [js-server-sdk/src/types.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L13) + +Branded type helper + +## Type declaration + +### \[brand\] + +> **\[brand\]**: `TBrand` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | +| `TBrand` *extends* `string` | diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ChannelAdded.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ChannelAdded.md new file mode 100644 index 00000000..351afa70 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/ChannelAdded.md @@ -0,0 +1,5 @@ +# Type Alias: ChannelAdded + +> **ChannelAdded** = `object`\[`"channelAdded"`\] + +Defined in: [js-server-sdk/src/notifications.ts:136](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L136) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ChannelRemoved.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ChannelRemoved.md new file mode 100644 index 00000000..43f5d51f --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/ChannelRemoved.md @@ -0,0 +1,5 @@ +# Type Alias: ChannelRemoved + +> **ChannelRemoved** = `object`\[`"channelRemoved"`\] + +Defined in: [js-server-sdk/src/notifications.ts:137](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L137) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/CloseEventHandler.md b/versioned_docs/version-0.27.0/api/server/type-aliases/CloseEventHandler.md new file mode 100644 index 00000000..8c4937c5 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/CloseEventHandler.md @@ -0,0 +1,16 @@ +# Type Alias: CloseEventHandler() + +> **CloseEventHandler** = (`code`, `reason`) => `void` + +Defined in: [js-server-sdk/src/types.ts:61](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L61) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `code` | `number` | +| `reason` | `string` | + +## Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ErrorEventHandler.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ErrorEventHandler.md new file mode 100644 index 00000000..aa74a7d4 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/ErrorEventHandler.md @@ -0,0 +1,15 @@ +# Type Alias: ErrorEventHandler() + +> **ErrorEventHandler** = (`msg`) => `void` + +Defined in: [js-server-sdk/src/types.ts:60](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L60) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `msg` | `Event` | + +## Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ExpectedAgentEvents.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ExpectedAgentEvents.md new file mode 100644 index 00000000..4faf22fb --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/ExpectedAgentEvents.md @@ -0,0 +1,5 @@ +# Type Alias: ExpectedAgentEvents + +> **ExpectedAgentEvents** = `"trackData"` + +Defined in: [js-server-sdk/src/agent.ts:22](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L22) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ExpectedEvents.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ExpectedEvents.md new file mode 100644 index 00000000..1adca6db --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/ExpectedEvents.md @@ -0,0 +1,5 @@ +# Type Alias: ExpectedEvents + +> **ExpectedEvents** = *typeof* `expectedEventsList`\[`number`\] + +Defined in: [js-server-sdk/src/notifications.ts:55](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L55) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/FishjamConfig.md b/versioned_docs/version-0.27.0/api/server/type-aliases/FishjamConfig.md new file mode 100644 index 00000000..bc213ac2 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/FishjamConfig.md @@ -0,0 +1,21 @@ +# Type Alias: FishjamConfig + +> **FishjamConfig** = `object` + +Defined in: [js-server-sdk/src/types.ts:45](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L45) + +## Properties + +### fishjamId + +> **fishjamId**: `string` + +Defined in: [js-server-sdk/src/types.ts:50](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L50) + +*** + +### managementToken + +> **managementToken**: `string` + +Defined in: [js-server-sdk/src/types.ts:56](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L56) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/IgnoredEvents.md b/versioned_docs/version-0.27.0/api/server/type-aliases/IgnoredEvents.md new file mode 100644 index 00000000..956f2157 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/IgnoredEvents.md @@ -0,0 +1,5 @@ +# Type Alias: IgnoredEvents + +> **IgnoredEvents** = *typeof* `ignoredEventsList`\[`number`\] + +Defined in: [js-server-sdk/src/notifications.ts:83](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L83) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/IncomingTrackData.md b/versioned_docs/version-0.27.0/api/server/type-aliases/IncomingTrackData.md new file mode 100644 index 00000000..b4ce6802 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/IncomingTrackData.md @@ -0,0 +1,11 @@ +# Type Alias: IncomingTrackData + +> **IncomingTrackData** = `Omit`\<`NonNullable`\<`AgentResponse_TrackData`\>, `"peerId"`\> & `object` + +Defined in: [js-server-sdk/src/agent.ts:24](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L24) + +## Type declaration + +### peerId + +> **peerId**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/IncomingTrackImage.md b/versioned_docs/version-0.27.0/api/server/type-aliases/IncomingTrackImage.md new file mode 100644 index 00000000..49c5ca6b --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/IncomingTrackImage.md @@ -0,0 +1,5 @@ +# Type Alias: IncomingTrackImage + +> **IncomingTrackImage** = `NonNullable`\<`AgentResponse_TrackImage`\> + +Defined in: [js-server-sdk/src/agent.ts:25](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L25) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/NotificationEvents.md b/versioned_docs/version-0.27.0/api/server/type-aliases/NotificationEvents.md new file mode 100644 index 00000000..d0bafc30 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/NotificationEvents.md @@ -0,0 +1,5 @@ +# Type Alias: NotificationEvents + +> **NotificationEvents** = \{ \[K in ExpectedEvents\]: (message: \{ channelAdded: Omit\ & \{ roomId: RoomId \}; channelRemoved: Omit\ & \{ roomId: RoomId \}; peerAdded: Omit\ & \{ roomId: RoomId \}, "peerId"\> & \{ peerId: PeerId \}, "peerType"\> & \{ peerType: PeerType \}; peerConnected: Omit\ & \{ roomId: RoomId \}, "peerId"\> & \{ peerId: PeerId \}, "peerType"\> & \{ peerType: PeerType \}; peerCrashed: Omit\ & \{ roomId: RoomId \}, "peerId"\> & \{ peerId: PeerId \}, "peerType"\> & \{ peerType: PeerType \}; peerDeleted: Omit\ & \{ roomId: RoomId \}, "peerId"\> & \{ peerId: PeerId \}, "peerType"\> & \{ peerType: PeerType \}; peerDisconnected: Omit\ & \{ roomId: RoomId \}, "peerId"\> & \{ peerId: PeerId \}, "peerType"\> & \{ peerType: PeerType \}; peerMetadataUpdated: Omit\ & \{ roomId: RoomId \}, "peerId"\> & \{ peerId: PeerId \}, "peerType"\> & \{ peerType: PeerType \}; roomCrashed: Omit\ & \{ roomId: RoomId \}; roomCreated: Omit\ & \{ roomId: RoomId \}; roomDeleted: Omit\ & \{ roomId: RoomId \}; streamerConnected: ServerMessage\_StreamerConnected; streamerDisconnected: ServerMessage\_StreamerDisconnected; trackAdded: Omit\ & \{ roomId: RoomId \}, "track"\> & \{ track: undefined \| Track \}; trackMetadataUpdated: Omit\ & \{ roomId: RoomId \}, "track"\> & \{ track: undefined \| Track \}; trackRemoved: Omit\ & \{ roomId: RoomId \}, "track"\> & \{ track: undefined \| Track \}; viewerConnected: ServerMessage\_ViewerConnected; viewerDisconnected: ServerMessage\_ViewerDisconnected \}\[K\]) =\> void \} + +Defined in: [js-server-sdk/src/notifications.ts:165](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L165) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/OutgoingTrackData.md b/versioned_docs/version-0.27.0/api/server/type-aliases/OutgoingTrackData.md new file mode 100644 index 00000000..e777539a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/OutgoingTrackData.md @@ -0,0 +1,11 @@ +# Type Alias: OutgoingTrackData + +> **OutgoingTrackData** = `Omit`\<`NonNullable`\<`AgentRequest_TrackData`\>, `"peerId"`\> & `object` + +Defined in: [js-server-sdk/src/agent.ts:26](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L26) + +## Type declaration + +### peerId + +> **peerId**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/Peer.md b/versioned_docs/version-0.27.0/api/server/type-aliases/Peer.md new file mode 100644 index 00000000..a3a441c3 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/Peer.md @@ -0,0 +1,11 @@ +# Type Alias: Peer + +> **Peer** = `Omit`\<`OpenApiPeer`, `"id"`\> & `object` + +Defined in: [js-server-sdk/src/types.ts:25](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L25) + +## Type declaration + +### id + +> **id**: [`PeerId`](PeerId.md) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerAdded.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerAdded.md new file mode 100644 index 00000000..f5b2e198 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerAdded.md @@ -0,0 +1,5 @@ +# Type Alias: PeerAdded + +> **PeerAdded** = `object`\[`"peerAdded"`\] + +Defined in: [js-server-sdk/src/notifications.ts:123](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L123) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerConnected.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerConnected.md new file mode 100644 index 00000000..d4b5c4c7 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerConnected.md @@ -0,0 +1,5 @@ +# Type Alias: PeerConnected + +> **PeerConnected** = `object`\[`"peerConnected"`\] + +Defined in: [js-server-sdk/src/notifications.ts:125](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L125) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerCrashed.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerCrashed.md new file mode 100644 index 00000000..9962c489 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerCrashed.md @@ -0,0 +1,5 @@ +# Type Alias: PeerCrashed + +> **PeerCrashed** = `object`\[`"peerCrashed"`\] + +Defined in: [js-server-sdk/src/notifications.ts:128](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L128) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerDeleted.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerDeleted.md new file mode 100644 index 00000000..2a20ac48 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerDeleted.md @@ -0,0 +1,5 @@ +# Type Alias: PeerDeleted + +> **PeerDeleted** = `object`\[`"peerDeleted"`\] + +Defined in: [js-server-sdk/src/notifications.ts:124](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L124) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerDisconnected.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerDisconnected.md new file mode 100644 index 00000000..48a8a1bc --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerDisconnected.md @@ -0,0 +1,5 @@ +# Type Alias: PeerDisconnected + +> **PeerDisconnected** = `object`\[`"peerDisconnected"`\] + +Defined in: [js-server-sdk/src/notifications.ts:126](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L126) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerId.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerId.md new file mode 100644 index 00000000..09053f2e --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerId.md @@ -0,0 +1,7 @@ +# Type Alias: PeerId + +> **PeerId** = [`Brand`](Brand.md)\<`string`, `"PeerId"`\> + +Defined in: [js-server-sdk/src/types.ts:23](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L23) + +ID of Peer. Peer is associated with Room and can be created with [FishjamClient.createPeer](../classes/FishjamClient.md#createpeer). diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerMetadataUpdated.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerMetadataUpdated.md new file mode 100644 index 00000000..87fe78c6 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerMetadataUpdated.md @@ -0,0 +1,5 @@ +# Type Alias: PeerMetadataUpdated + +> **PeerMetadataUpdated** = `object`\[`"peerMetadataUpdated"`\] + +Defined in: [js-server-sdk/src/notifications.ts:127](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L127) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerOptions.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerOptions.md new file mode 100644 index 00000000..e3477862 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerOptions.md @@ -0,0 +1,7 @@ +# Type Alias: PeerOptions + +> **PeerOptions** = [`PeerOptionsAgent`](../interfaces/PeerOptionsAgent.md) \| [`PeerOptionsVapi`](../interfaces/PeerOptionsVapi.md) \| [`PeerOptionsWebRTC`](../interfaces/PeerOptionsWebRTC.md) + +Defined in: fishjam-openapi/dist/index.d.ts:342 + +## Export diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/PeerType.md b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerType.md new file mode 100644 index 00000000..5dffba55 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/PeerType.md @@ -0,0 +1,8 @@ +# Type Alias: PeerType + +> **PeerType** = `OpenApiPeerType` \| `"unspecified"` + +Defined in: [js-server-sdk/src/types.ts:31](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L31) + +Peer type as emitted by [FishjamWSNotifier](../classes/FishjamWSNotifier.md). Matches the REST API's `PeerType`, +with the addition of `'unspecified'` for messages whose peer type is not set on the wire. diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/Room.md b/versioned_docs/version-0.27.0/api/server/type-aliases/Room.md new file mode 100644 index 00000000..936ffcb5 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/Room.md @@ -0,0 +1,29 @@ +# Type Alias: Room + +> **Room** = `object` + +Defined in: [js-server-sdk/src/types.ts:39](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L39) + +## Properties + +### config + +> **config**: [`RoomConfig`](../interfaces/RoomConfig.md) + +Defined in: [js-server-sdk/src/types.ts:42](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L42) + +*** + +### id + +> **id**: [`RoomId`](RoomId.md) + +Defined in: [js-server-sdk/src/types.ts:40](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L40) + +*** + +### peers + +> **peers**: [`Peer`](Peer.md)[] + +Defined in: [js-server-sdk/src/types.ts:41](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L41) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/RoomCrashed.md b/versioned_docs/version-0.27.0/api/server/type-aliases/RoomCrashed.md new file mode 100644 index 00000000..c9275f6d --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/RoomCrashed.md @@ -0,0 +1,5 @@ +# Type Alias: RoomCrashed + +> **RoomCrashed** = `object`\[`"roomCrashed"`\] + +Defined in: [js-server-sdk/src/notifications.ts:122](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L122) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/RoomCreated.md b/versioned_docs/version-0.27.0/api/server/type-aliases/RoomCreated.md new file mode 100644 index 00000000..8f6fc25a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/RoomCreated.md @@ -0,0 +1,5 @@ +# Type Alias: RoomCreated + +> **RoomCreated** = `object`\[`"roomCreated"`\] + +Defined in: [js-server-sdk/src/notifications.ts:120](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L120) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/RoomDeleted.md b/versioned_docs/version-0.27.0/api/server/type-aliases/RoomDeleted.md new file mode 100644 index 00000000..05f17729 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/RoomDeleted.md @@ -0,0 +1,5 @@ +# Type Alias: RoomDeleted + +> **RoomDeleted** = `object`\[`"roomDeleted"`\] + +Defined in: [js-server-sdk/src/notifications.ts:121](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L121) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/RoomId.md b/versioned_docs/version-0.27.0/api/server/type-aliases/RoomId.md new file mode 100644 index 00000000..647b7637 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/RoomId.md @@ -0,0 +1,8 @@ +# Type Alias: RoomId + +> **RoomId** = [`Brand`](Brand.md)\<`string`, `"RoomId"`\> + +Defined in: [js-server-sdk/src/types.ts:19](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L19) + +ID of the Room. +Room can be created with [FishjamClient.createRoom](../classes/FishjamClient.md#createroom). diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/StreamerConnected.md b/versioned_docs/version-0.27.0/api/server/type-aliases/StreamerConnected.md new file mode 100644 index 00000000..2b741922 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/StreamerConnected.md @@ -0,0 +1,5 @@ +# Type Alias: StreamerConnected + +> **StreamerConnected** = `object`\[`"streamerConnected"`\] + +Defined in: [js-server-sdk/src/notifications.ts:129](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L129) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/StreamerDisconnected.md b/versioned_docs/version-0.27.0/api/server/type-aliases/StreamerDisconnected.md new file mode 100644 index 00000000..4a7fdaa7 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/StreamerDisconnected.md @@ -0,0 +1,5 @@ +# Type Alias: StreamerDisconnected + +> **StreamerDisconnected** = `object`\[`"streamerDisconnected"`\] + +Defined in: [js-server-sdk/src/notifications.ts:130](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L130) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/Track.md b/versioned_docs/version-0.27.0/api/server/type-aliases/Track.md new file mode 100644 index 00000000..daec4c76 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/Track.md @@ -0,0 +1,31 @@ +# Type Alias: Track + +> **Track** = `object` + +Defined in: [js-server-sdk/src/notifications.ts:13](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L13) + +Track payload embedded in [TrackAdded](TrackAdded.md), [TrackRemoved](TrackRemoved.md), [TrackMetadataUpdated](TrackMetadataUpdated.md). + +## Properties + +### id + +> **id**: `string` + +Defined in: [js-server-sdk/src/notifications.ts:14](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L14) + +*** + +### metadata + +> **metadata**: `string` + +Defined in: [js-server-sdk/src/notifications.ts:16](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L16) + +*** + +### type + +> **type**: [`TrackType`](TrackType.md) + +Defined in: [js-server-sdk/src/notifications.ts:15](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L15) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/TrackAdded.md b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackAdded.md new file mode 100644 index 00000000..0468b2d3 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackAdded.md @@ -0,0 +1,5 @@ +# Type Alias: TrackAdded + +> **TrackAdded** = `object`\[`"trackAdded"`\] + +Defined in: [js-server-sdk/src/notifications.ts:133](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L133) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/TrackId.md b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackId.md new file mode 100644 index 00000000..3e6eca48 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackId.md @@ -0,0 +1,5 @@ +# Type Alias: TrackId + +> **TrackId** = [`Brand`](Brand.md)\<`string`, `"TrackId"`\> + +Defined in: [js-server-sdk/src/agent.ts:35](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/agent.ts#L35) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/TrackMetadataUpdated.md b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackMetadataUpdated.md new file mode 100644 index 00000000..7892b08c --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackMetadataUpdated.md @@ -0,0 +1,5 @@ +# Type Alias: TrackMetadataUpdated + +> **TrackMetadataUpdated** = `object`\[`"trackMetadataUpdated"`\] + +Defined in: [js-server-sdk/src/notifications.ts:135](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L135) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/TrackRemoved.md b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackRemoved.md new file mode 100644 index 00000000..a46a12ea --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackRemoved.md @@ -0,0 +1,5 @@ +# Type Alias: TrackRemoved + +> **TrackRemoved** = `object`\[`"trackRemoved"`\] + +Defined in: [js-server-sdk/src/notifications.ts:134](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L134) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/TrackType.md b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackType.md new file mode 100644 index 00000000..042876f8 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/TrackType.md @@ -0,0 +1,8 @@ +# Type Alias: TrackType + +> **TrackType** = `OpenApiTrackType` \| `"unspecified"` + +Defined in: [js-server-sdk/src/types.ts:37](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/types.ts#L37) + +Track type as emitted by [FishjamWSNotifier](../classes/FishjamWSNotifier.md). Matches the REST API's `TrackType`, +with the addition of `'unspecified'` for messages whose track type is not set on the wire. diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ViewerConnected.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ViewerConnected.md new file mode 100644 index 00000000..c6998489 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/ViewerConnected.md @@ -0,0 +1,5 @@ +# Type Alias: ViewerConnected + +> **ViewerConnected** = `object`\[`"viewerConnected"`\] + +Defined in: [js-server-sdk/src/notifications.ts:131](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L131) diff --git a/versioned_docs/version-0.27.0/api/server/type-aliases/ViewerDisconnected.md b/versioned_docs/version-0.27.0/api/server/type-aliases/ViewerDisconnected.md new file mode 100644 index 00000000..9787af9a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/type-aliases/ViewerDisconnected.md @@ -0,0 +1,5 @@ +# Type Alias: ViewerDisconnected + +> **ViewerDisconnected** = `object`\[`"viewerDisconnected"`\] + +Defined in: [js-server-sdk/src/notifications.ts:132](https://github.com/fishjam-cloud/js-server-sdk/blob/078f24967485d472cccb3de0de191adb81509a38/packages/js-server-sdk/src/notifications.ts#L132) diff --git a/versioned_docs/version-0.27.0/api/server/typedoc-sidebar.cjs b/versioned_docs/version-0.27.0/api/server/typedoc-sidebar.cjs new file mode 100644 index 00000000..b258ce4a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ +const typedocSidebar = {items:[{type:"category",label:"Client",items:[{type:"doc",id:"api/server/classes/FishjamClient",label:"FishjamClient"},{type:"doc",id:"api/server/classes/FishjamWSNotifier",label:"FishjamWSNotifier"}]},{type:"category",label:"Other",items:[{type:"doc",id:"api/server/enumerations/PeerStatus",label:"PeerStatus"},{type:"doc",id:"api/server/enumerations/RoomType",label:"RoomType"},{type:"doc",id:"api/server/enumerations/VideoCodec",label:"VideoCodec"},{type:"doc",id:"api/server/classes/BadRequestException",label:"BadRequestException"},{type:"doc",id:"api/server/classes/FishjamAgent",label:"FishjamAgent"},{type:"doc",id:"api/server/classes/FishjamBaseException",label:"FishjamBaseException"},{type:"doc",id:"api/server/classes/FishjamNotFoundException",label:"FishjamNotFoundException"},{type:"doc",id:"api/server/classes/ForbiddenException",label:"ForbiddenException"},{type:"doc",id:"api/server/classes/MissingFishjamIdException",label:"MissingFishjamIdException"},{type:"doc",id:"api/server/classes/PeerNotFoundException",label:"PeerNotFoundException"},{type:"doc",id:"api/server/classes/RoomNotFoundException",label:"RoomNotFoundException"},{type:"doc",id:"api/server/classes/ServiceUnavailableException",label:"ServiceUnavailableException"},{type:"doc",id:"api/server/classes/UnauthorizedException",label:"UnauthorizedException"},{type:"doc",id:"api/server/classes/UnknownException",label:"UnknownException"},{type:"doc",id:"api/server/interfaces/MoqToken",label:"MoqToken"},{type:"doc",id:"api/server/interfaces/MoqTokenConfig",label:"MoqTokenConfig"},{type:"doc",id:"api/server/interfaces/PeerOptionsAgent",label:"PeerOptionsAgent"},{type:"doc",id:"api/server/interfaces/PeerOptionsVapi",label:"PeerOptionsVapi"},{type:"doc",id:"api/server/interfaces/PeerOptionsWebRTC",label:"PeerOptionsWebRTC"},{type:"doc",id:"api/server/interfaces/RoomConfig",label:"RoomConfig"},{type:"doc",id:"api/server/interfaces/ServerMessage",label:"ServerMessage"},{type:"doc",id:"api/server/interfaces/StreamerToken",label:"StreamerToken"},{type:"doc",id:"api/server/interfaces/ViewerToken",label:"ViewerToken"},{type:"doc",id:"api/server/type-aliases/AgentCallbacks",label:"AgentCallbacks"},{type:"doc",id:"api/server/type-aliases/AgentEvents",label:"AgentEvents"},{type:"doc",id:"api/server/type-aliases/AgentTrack",label:"AgentTrack"},{type:"doc",id:"api/server/type-aliases/AudioCodecParameters",label:"AudioCodecParameters"},{type:"doc",id:"api/server/type-aliases/Brand",label:"Brand"},{type:"doc",id:"api/server/type-aliases/ChannelAdded",label:"ChannelAdded"},{type:"doc",id:"api/server/type-aliases/ChannelRemoved",label:"ChannelRemoved"},{type:"doc",id:"api/server/type-aliases/CloseEventHandler",label:"CloseEventHandler"},{type:"doc",id:"api/server/type-aliases/ErrorEventHandler",label:"ErrorEventHandler"},{type:"doc",id:"api/server/type-aliases/ExpectedAgentEvents",label:"ExpectedAgentEvents"},{type:"doc",id:"api/server/type-aliases/ExpectedEvents",label:"ExpectedEvents"},{type:"doc",id:"api/server/type-aliases/FishjamConfig",label:"FishjamConfig"},{type:"doc",id:"api/server/type-aliases/IgnoredEvents",label:"IgnoredEvents"},{type:"doc",id:"api/server/type-aliases/IncomingTrackData",label:"IncomingTrackData"},{type:"doc",id:"api/server/type-aliases/IncomingTrackImage",label:"IncomingTrackImage"},{type:"doc",id:"api/server/type-aliases/NotificationEvents",label:"NotificationEvents"},{type:"doc",id:"api/server/type-aliases/OutgoingTrackData",label:"OutgoingTrackData"},{type:"doc",id:"api/server/type-aliases/Peer",label:"Peer"},{type:"doc",id:"api/server/type-aliases/PeerAdded",label:"PeerAdded"},{type:"doc",id:"api/server/type-aliases/PeerConnected",label:"PeerConnected"},{type:"doc",id:"api/server/type-aliases/PeerCrashed",label:"PeerCrashed"},{type:"doc",id:"api/server/type-aliases/PeerDeleted",label:"PeerDeleted"},{type:"doc",id:"api/server/type-aliases/PeerDisconnected",label:"PeerDisconnected"},{type:"doc",id:"api/server/type-aliases/PeerId",label:"PeerId"},{type:"doc",id:"api/server/type-aliases/PeerMetadataUpdated",label:"PeerMetadataUpdated"},{type:"doc",id:"api/server/type-aliases/PeerOptions",label:"PeerOptions"},{type:"doc",id:"api/server/type-aliases/PeerType",label:"PeerType"},{type:"doc",id:"api/server/type-aliases/Room",label:"Room"},{type:"doc",id:"api/server/type-aliases/RoomCrashed",label:"RoomCrashed"},{type:"doc",id:"api/server/type-aliases/RoomCreated",label:"RoomCreated"},{type:"doc",id:"api/server/type-aliases/RoomDeleted",label:"RoomDeleted"},{type:"doc",id:"api/server/type-aliases/RoomId",label:"RoomId"},{type:"doc",id:"api/server/type-aliases/StreamerConnected",label:"StreamerConnected"},{type:"doc",id:"api/server/type-aliases/StreamerDisconnected",label:"StreamerDisconnected"},{type:"doc",id:"api/server/type-aliases/Track",label:"Track"},{type:"doc",id:"api/server/type-aliases/TrackAdded",label:"TrackAdded"},{type:"doc",id:"api/server/type-aliases/TrackId",label:"TrackId"},{type:"doc",id:"api/server/type-aliases/TrackMetadataUpdated",label:"TrackMetadataUpdated"},{type:"doc",id:"api/server/type-aliases/TrackRemoved",label:"TrackRemoved"},{type:"doc",id:"api/server/type-aliases/TrackType",label:"TrackType"},{type:"doc",id:"api/server/type-aliases/ViewerConnected",label:"ViewerConnected"},{type:"doc",id:"api/server/type-aliases/ViewerDisconnected",label:"ViewerDisconnected"},{type:"doc",id:"api/server/variables/ServerMessage",label:"ServerMessage"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/versioned_docs/version-0.27.0/api/server/variables/ServerMessage.md b/versioned_docs/version-0.27.0/api/server/variables/ServerMessage.md new file mode 100644 index 00000000..7102fbee --- /dev/null +++ b/versioned_docs/version-0.27.0/api/server/variables/ServerMessage.md @@ -0,0 +1,5 @@ +# Variable: ServerMessage + +> **ServerMessage**: `MessageFns$1`\<[`ServerMessage`](../interfaces/ServerMessage.md)\> + +Defined in: fishjam-proto/dist/index.d.ts:72 diff --git a/versioned_docs/version-0.27.0/api/web/enumerations/Variant.md b/versioned_docs/version-0.27.0/api/web/enumerations/Variant.md new file mode 100644 index 00000000..fc4e6cfa --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/enumerations/Variant.md @@ -0,0 +1,43 @@ +# Enumeration: Variant + +Defined in: ts-client/dist/index.d.mts:51 + +## Enumeration Members + +### UNRECOGNIZED + +> **UNRECOGNIZED**: `-1` + +Defined in: ts-client/dist/index.d.mts:56 + +*** + +### VARIANT\_HIGH + +> **VARIANT\_HIGH**: `3` + +Defined in: ts-client/dist/index.d.mts:55 + +*** + +### VARIANT\_LOW + +> **VARIANT\_LOW**: `1` + +Defined in: ts-client/dist/index.d.mts:53 + +*** + +### VARIANT\_MEDIUM + +> **VARIANT\_MEDIUM**: `2` + +Defined in: ts-client/dist/index.d.mts:54 + +*** + +### VARIANT\_UNSPECIFIED + +> **VARIANT\_UNSPECIFIED**: `0` + +Defined in: ts-client/dist/index.d.mts:52 diff --git a/versioned_docs/version-0.27.0/api/web/functions/FishjamProvider.md b/versioned_docs/version-0.27.0/api/web/functions/FishjamProvider.md new file mode 100644 index 00000000..d6f90496 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/FishjamProvider.md @@ -0,0 +1,17 @@ +# Function: FishjamProvider() + +> **FishjamProvider**(`props`): `Element` + +Defined in: [react-client/src/FishjamProvider.tsx:74](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/FishjamProvider.tsx#L74) + +Provides the Fishjam Context + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`FishjamProviderProps`](../interfaces/FishjamProviderProps.md) | + +## Returns + +`Element` diff --git a/versioned_docs/version-0.27.0/api/web/functions/useCamera.md b/versioned_docs/version-0.27.0/api/web/functions/useCamera.md new file mode 100644 index 00000000..179685a5 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/useCamera.md @@ -0,0 +1,122 @@ +# Function: useCamera() + +> **useCamera**(): `object` + +Defined in: [react-client/src/hooks/devices/useCamera.ts:9](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/devices/useCamera.ts#L9) + +This hook can toggle camera on/off, change camera, provides current camera and other. + +## Returns + +### ~~activeCamera~~ + +> **activeCamera**: `null` \| [`DeviceItem`](../type-aliases/DeviceItem.md) = `cameraManager.activeDevice` + +#### Deprecated + +Use `currentCamera` and `isCameraOn` instead +Indicates which camera is now turned on and streaming + +### cameraDeviceError + +> **cameraDeviceError**: `null` \| [`DeviceError`](../type-aliases/DeviceError.md) = `cameraManager.deviceError` + +Possible error thrown while setting up the camera + +### cameraDevices + +> **cameraDevices**: [`DeviceItem`](../type-aliases/DeviceItem.md)[] = `cameraManager.deviceList` + +List of available camera devices + +### cameraStream + +> **cameraStream**: `null` \| `MediaStream` + +The MediaStream object containing the current stream + +### currentCamera + +> **currentCamera**: `null` \| `MediaDeviceInfo` = `cameraManager.selectedDevice` + +Indicates which camera is now selected + +### currentCameraMiddleware + +> **currentCameraMiddleware**: [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) = `videoTrackManager.currentMiddleware` + +The currently set camera middleware function + +### isCameraOn + +> **isCameraOn**: `boolean` = `!!cameraStream` + +Indicates whether the camera is streaming video + +### selectCamera() + +> **selectCamera**: (`deviceId`) => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> = `videoTrackManager.selectDevice` + +Selects the camera device + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceId` | `string` | + +#### Returns + +`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> + +### setCameraTrackMiddleware() + +> **setCameraTrackMiddleware**: (`middleware`) => `Promise`\<`void`\> = `videoTrackManager.setTrackMiddleware` + +Sets the camera middleware + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `middleware` | [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) | + +#### Returns + +`Promise`\<`void`\> + +### startCamera() + +> **startCamera**: (`deviceId?`) => `Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> = `videoTrackManager.startDevice` + +Starts the camera + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceId?` | `null` \| `string` | + +#### Returns + +`Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> + +### stopCamera() + +> **stopCamera**: () => `void` = `videoTrackManager.stopDevice` + +Stops the camera + +#### Returns + +`void` + +### toggleCamera() + +> **toggleCamera**: () => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> = `videoTrackManager.toggleDevice` + +Toggles current camera on/off + +#### Returns + +`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> diff --git a/versioned_docs/version-0.27.0/api/web/functions/useConnection.md b/versioned_docs/version-0.27.0/api/web/functions/useConnection.md new file mode 100644 index 00000000..6fa10e90 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/useConnection.md @@ -0,0 +1,53 @@ +# Function: useConnection() + +> **useConnection**(): `object` + +Defined in: [react-client/src/hooks/useConnection.ts:26](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useConnection.ts#L26) + +Hook allows to join or leave a room and check the current connection status. + +## Returns + +### joinRoom() + +> **joinRoom**: \<`PeerMetadata`\>(`__namedParameters`) => `Promise`\<`void`\> + +Join room and start streaming camera and microphone + +#### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | [`JoinRoomConfig`](../interfaces/JoinRoomConfig.md)\<`PeerMetadata`\> | + +#### Returns + +`Promise`\<`void`\> + +### leaveRoom() + +> **leaveRoom**: () => `void` + +Leave room and stop streaming + +#### Returns + +`void` + +### peerStatus + +> **peerStatus**: [`PeerStatus`](../type-aliases/PeerStatus.md) + +Current peer connection status + +### reconnectionStatus + +> **reconnectionStatus**: [`ReconnectionStatus`](../type-aliases/ReconnectionStatus.md) + +Current reconnection status diff --git a/versioned_docs/version-0.27.0/api/web/functions/useCustomSource.md b/versioned_docs/version-0.27.0/api/web/functions/useCustomSource.md new file mode 100644 index 00000000..6eccb209 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/useCustomSource.md @@ -0,0 +1,44 @@ +# Function: useCustomSource() + +> **useCustomSource**\<`T`\>(`sourceId`): `object` + +Defined in: [react-client/src/hooks/useCustomSource.ts:9](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useCustomSource.ts#L9) + +This hook can register/deregister a custom MediaStream with Fishjam. + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `string` | + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `sourceId` | `T` | + +## Returns + +### setStream() + +> **setStream**: (`newStream`) => `Promise`\<`void`\> + +Associates the given stream with the custom source. +This stream will be sent to Fishjam after startStreaming has been called. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `newStream` | `null` \| `MediaStream` | + +#### Returns + +`Promise`\<`void`\> + +### stream + +> **stream**: `undefined` \| `MediaStream` + +The MediaStream currently associated with the custom source diff --git a/versioned_docs/version-0.27.0/api/web/functions/useDataChannel.md b/versioned_docs/version-0.27.0/api/web/functions/useDataChannel.md new file mode 100644 index 00000000..a47ffb78 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/useDataChannel.md @@ -0,0 +1,11 @@ +# Function: useDataChannel() + +> **useDataChannel**(): [`UseDataChannelResult`](../type-aliases/UseDataChannelResult.md) + +Defined in: [react-client/src/hooks/useDataChannel.ts:15](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useDataChannel.ts#L15) + +Hook for data channel operations - publish and subscribe to data. + +## Returns + +[`UseDataChannelResult`](../type-aliases/UseDataChannelResult.md) diff --git a/versioned_docs/version-0.27.0/api/web/functions/useInitializeDevices.md b/versioned_docs/version-0.27.0/api/web/functions/useInitializeDevices.md new file mode 100644 index 00000000..744d92a3 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/useInitializeDevices.md @@ -0,0 +1,25 @@ +# Function: useInitializeDevices() + +> **useInitializeDevices**(): `object` + +Defined in: [react-client/src/hooks/devices/useInitializeDevices.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L14) + +Hook allows you to initialize access to the devices before joining the room. + +## Returns + +### initializeDevices() + +> **initializeDevices**: (`settings?`) => `Promise`\<[`InitializeDevicesResult`](../type-aliases/InitializeDevicesResult.md)\> + +Initialize access to the devices before joining the room + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `settings?` | [`InitializeDevicesSettings`](../type-aliases/InitializeDevicesSettings.md) | + +#### Returns + +`Promise`\<[`InitializeDevicesResult`](../type-aliases/InitializeDevicesResult.md)\> diff --git a/versioned_docs/version-0.27.0/api/web/functions/useLivestreamStreamer.md b/versioned_docs/version-0.27.0/api/web/functions/useLivestreamStreamer.md new file mode 100644 index 00000000..8e7858c6 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/useLivestreamStreamer.md @@ -0,0 +1,11 @@ +# Function: useLivestreamStreamer() + +> **useLivestreamStreamer**(): [`UseLivestreamStreamerResult`](../interfaces/UseLivestreamStreamerResult.md) + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:52](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamStreamer.ts#L52) + +Hook for publishing a livestream, which can be then received with [useLivestreamViewer](useLivestreamViewer.md) + +## Returns + +[`UseLivestreamStreamerResult`](../interfaces/UseLivestreamStreamerResult.md) diff --git a/versioned_docs/version-0.27.0/api/web/functions/useLivestreamViewer.md b/versioned_docs/version-0.27.0/api/web/functions/useLivestreamViewer.md new file mode 100644 index 00000000..958aff99 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/useLivestreamViewer.md @@ -0,0 +1,11 @@ +# Function: useLivestreamViewer() + +> **useLivestreamViewer**(): [`UseLivestreamViewerResult`](../interfaces/UseLivestreamViewerResult.md) + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:43](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamViewer.ts#L43) + +Hook for receiving a published livestream. + +## Returns + +[`UseLivestreamViewerResult`](../interfaces/UseLivestreamViewerResult.md) diff --git a/versioned_docs/version-0.27.0/api/web/functions/useMicrophone.md b/versioned_docs/version-0.27.0/api/web/functions/useMicrophone.md new file mode 100644 index 00000000..0a2d4642 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/useMicrophone.md @@ -0,0 +1,138 @@ +# Function: useMicrophone() + +> **useMicrophone**(): `object` + +Defined in: [react-client/src/hooks/devices/useMicrophone.ts:9](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/devices/useMicrophone.ts#L9) + +Manage microphone + +## Returns + +### ~~activeMicrophone~~ + +> **activeMicrophone**: `null` \| [`DeviceItem`](../type-aliases/DeviceItem.md) = `microphoneManager.activeDevice` + +#### Deprecated + +Use `currentMicrophone` and `isMicrophoneOn` instead +Indicates which microphone is now turned on and streaming audio + +### currentMicrophone + +> **currentMicrophone**: `null` \| `MediaDeviceInfo` = `microphoneManager.selectedDevice` + +Indicates which microphone is now selected + +### currentMicrophoneMiddleware + +> **currentMicrophoneMiddleware**: [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) = `audioTrackManager.currentMiddleware` + +The currently set microphone middleware function + +### isMicrophoneMuted + +> **isMicrophoneMuted**: `boolean` = `!microphoneManager.deviceEnabled` + +Indicates whether the microphone is muted + +### isMicrophoneOn + +> **isMicrophoneOn**: `boolean` = `!!microphoneStream` + +Indicates whether the microphone is streaming audio + +### microphoneDeviceError + +> **microphoneDeviceError**: `null` \| [`DeviceError`](../type-aliases/DeviceError.md) = `microphoneManager.deviceError` + +Possible error thrown while setting up the microphone + +### microphoneDevices + +> **microphoneDevices**: [`DeviceItem`](../type-aliases/DeviceItem.md)[] = `microphoneManager.deviceList` + +List of available microphone devices + +### microphoneStream + +> **microphoneStream**: `null` \| `MediaStream` + +The MediaStream object containing the current audio stream + +### selectMicrophone() + +> **selectMicrophone**: (`deviceId`) => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> = `audioTrackManager.selectDevice` + +Selects the microphone device + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceId` | `string` | + +#### Returns + +`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> + +### setMicrophoneTrackMiddleware() + +> **setMicrophoneTrackMiddleware**: (`middleware`) => `Promise`\<`void`\> = `audioTrackManager.setTrackMiddleware` + +Sets the microphone middleware + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `middleware` | [`TrackMiddleware`](../type-aliases/TrackMiddleware.md) | + +#### Returns + +`Promise`\<`void`\> + +### startMicrophone() + +> **startMicrophone**: (`deviceId?`) => `Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> = `audioTrackManager.startDevice` + +Starts the microphone + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceId?` | `null` \| `string` | + +#### Returns + +`Promise`\<\[`MediaStreamTrack`, `null`\] \| \[`null`, [`DeviceError`](../type-aliases/DeviceError.md)\]\> + +### stopMicrophone() + +> **stopMicrophone**: () => `void` = `audioTrackManager.stopDevice` + +Stops the microphone + +#### Returns + +`void` + +### toggleMicrophone() + +> **toggleMicrophone**: () => `Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> = `audioTrackManager.toggleDevice` + +Toggles current microphone on/off + +#### Returns + +`Promise`\<`undefined` \| [`DeviceError`](../type-aliases/DeviceError.md)\> + +### toggleMicrophoneMute() + +> **toggleMicrophoneMute**: () => `Promise`\<`void`\> = `audioTrackManager.toggleMute` + +Mutes/unmutes the microphone + +#### Returns + +`Promise`\<`void`\> diff --git a/versioned_docs/version-0.27.0/api/web/functions/usePeers.md b/versioned_docs/version-0.27.0/api/web/functions/usePeers.md new file mode 100644 index 00000000..8fa1ccfb --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/usePeers.md @@ -0,0 +1,56 @@ +# Function: usePeers() + +> **usePeers**\<`PeerMetadata`, `ServerMetadata`\>(): `object` + +Defined in: [react-client/src/hooks/usePeers.ts:103](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L103) + +Hook allows to access id, tracks and metadata of the local and remote peers. + +## Type Parameters + +| Type Parameter | Default type | Description | +| ------ | ------ | ------ | +| `PeerMetadata` | `Record`\<`string`, `unknown`\> | Type of metadata set by peer while connecting to a room. | +| `ServerMetadata` | `Record`\<`string`, `unknown`\> | Type of metadata set by the server while creating a peer. | + +## Returns + +### localPeer + +> **localPeer**: `null` \| [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`, [`Track`](../type-aliases/Track.md)\> + +The local peer with distinguished tracks (camera, microphone, screen share). +Will be null if the local peer is not found. + +### ~~peers~~ + +> **peers**: [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`, [`RemoteTrack`](../type-aliases/RemoteTrack.md)\>[] = `remotePeers` + +#### Deprecated + +Use remotePeers instead +Legacy array containing remote peers. +This property will be removed in future versions. + +### remotePeers + +> **remotePeers**: [`PeerWithTracks`](../type-aliases/PeerWithTracks.md)\<`PeerMetadata`, `ServerMetadata`, [`RemoteTrack`](../type-aliases/RemoteTrack.md)\>[] + +Array of remote peers with distinguished tracks (camera, microphone, screen share). + +### setReceivedTracksQuality() + +> **setReceivedTracksQuality**: (`trackIds`, `quality`) => `void` + +This function allows to set the quality of tracks received from remote peers. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `trackIds` | `string`[] | The array of the track ids to set the quality for. | +| `quality` | [`Variant`](../enumerations/Variant.md) | The quality to set for the track. | + +#### Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/web/functions/useSandbox.md b/versioned_docs/version-0.27.0/api/web/functions/useSandbox.md new file mode 100644 index 00000000..5312c3b6 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/useSandbox.md @@ -0,0 +1,60 @@ +# Function: useSandbox() + +> **useSandbox**(`props`): `object` + +Defined in: [react-client/src/hooks/useSandbox.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useSandbox.ts#L19) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `props` | [`UseSandboxProps`](../type-aliases/UseSandboxProps.md) | + +## Returns + +`object` + +### getSandboxLivestream() + +> **getSandboxLivestream**: (`roomName`, `isPublic`) => `Promise`\<\{ `room`: \{ `id`: `string`; `name`: `string`; \}; `streamerToken`: `string`; \}\> + +#### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `roomName` | `string` | `undefined` | +| `isPublic` | `boolean` | `false` | + +#### Returns + +`Promise`\<\{ `room`: \{ `id`: `string`; `name`: `string`; \}; `streamerToken`: `string`; \}\> + +### getSandboxPeerToken() + +> **getSandboxPeerToken**: (`roomName`, `peerName`, `roomType`) => `Promise`\<`string`\> + +#### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `roomName` | `string` | `undefined` | +| `peerName` | `string` | `undefined` | +| `roomType` | [`RoomType`](../type-aliases/RoomType.md) | `"conference"` | + +#### Returns + +`Promise`\<`string`\> + +### getSandboxViewerToken() + +> **getSandboxViewerToken**: (`roomName`) => `Promise`\<`string`\> + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `roomName` | `string` | + +#### Returns + +`Promise`\<`string`\> diff --git a/versioned_docs/version-0.27.0/api/web/functions/useScreenShare.md b/versioned_docs/version-0.27.0/api/web/functions/useScreenShare.md new file mode 100644 index 00000000..e1acdc88 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/useScreenShare.md @@ -0,0 +1,81 @@ +# Function: useScreenShare() + +> **useScreenShare**(): `object` + +Defined in: [react-client/src/hooks/useScreenShare.ts:10](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useScreenShare.ts#L10) + +Hook to enable screen sharing within a room and manage the existing stream. + +## Returns + +### audioTrack + +> **audioTrack**: `null` \| `MediaStreamTrack` = `screenShareManager.audioTrack` + +The separate audio MediaStreamTrack. + +### currentTracksMiddleware + +> **currentTracksMiddleware**: `null` \| [`TracksMiddleware`](../type-aliases/TracksMiddleware.md) = `screenShareManager.currentTracksMiddleware` + +The middleware currently assigned to process the tracks. +A screenshare may include both audio and video tracks, and this middleware is capable of processing +each track type. + +### setTracksMiddleware() + +> **setTracksMiddleware**: (`middleware`) => `Promise`\<`void`\> = `screenShareManager.setTracksMiddleware` + +Sets the middleware responsible for processing the tracks. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `middleware` | `null` \| [`TracksMiddleware`](../type-aliases/TracksMiddleware.md) | The middleware to set, which can be a TracksMiddleware instance or null to remove the middleware. | + +#### Returns + +`Promise`\<`void`\> + +A Promise that resolves once the middleware is successfully set. + +### startStreaming() + +> **startStreaming**: (`props?`) => `Promise`\<`void`\> = `screenShareManager.startStreaming` + +Invokes the screen sharing prompt in the user's browser and starts streaming upon approval. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `props?` | \{ `audioConstraints?`: `boolean` \| `MediaTrackConstraints`; `videoConstraints?`: `boolean` \| `MediaTrackConstraints`; \} | +| `props.audioConstraints?` | `boolean` \| `MediaTrackConstraints` | +| `props.videoConstraints?` | `boolean` \| `MediaTrackConstraints` | + +#### Returns + +`Promise`\<`void`\> + +### stopStreaming() + +> **stopStreaming**: () => `Promise`\<`void`\> = `screenShareManager.stopStreaming` + +Stops the stream and cancels browser screen sharing. + +#### Returns + +`Promise`\<`void`\> + +### stream + +> **stream**: `null` \| `MediaStream` = `screenShareManager.stream` + +The MediaStream object containing both tracks. + +### videoTrack + +> **videoTrack**: `null` \| `MediaStreamTrack` = `screenShareManager.videoTrack` + +The separate video MediaStreamTrack. diff --git a/versioned_docs/version-0.27.0/api/web/functions/useUpdatePeerMetadata.md b/versioned_docs/version-0.27.0/api/web/functions/useUpdatePeerMetadata.md new file mode 100644 index 00000000..a5b89f04 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/useUpdatePeerMetadata.md @@ -0,0 +1,31 @@ +# Function: useUpdatePeerMetadata() + +> **useUpdatePeerMetadata**\<`PeerMetadata`\>(): `object` + +Defined in: [react-client/src/hooks/useUpdatePeerMetadata.ts:12](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useUpdatePeerMetadata.ts#L12) + +Hook provides a method to update the metadata of the local peer. + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | + +## Returns + +### updatePeerMetadata() + +> **updatePeerMetadata**: (`peerMetadata`) => `void` + +Updates metadata visible to other peers + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `peerMetadata` | `PeerMetadata` | + +#### Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/web/functions/useVAD.md b/versioned_docs/version-0.27.0/api/web/functions/useVAD.md new file mode 100644 index 00000000..79f9d9ef --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/functions/useVAD.md @@ -0,0 +1,25 @@ +# Function: useVAD() + +> **useVAD**(`options`): `Record`\<[`PeerId`](../type-aliases/PeerId.md), `boolean`\> + +Defined in: [react-client/src/hooks/useVAD.ts:34](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useVAD.ts#L34) + +Voice activity detection. Use this hook to check if voice is detected in the audio track for given peer(s). + +Remote peer VAD is driven by `vadNotification` messages from the backend. +If the local peer's id is included in `peerIds`, local VAD is determined client-side +by polling the microphone's audio level (see `useLocalVAD`). + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `options` | \{ `peerIds`: readonly [`PeerId`](../type-aliases/PeerId.md)[]; \} | Options object. | +| `options.peerIds` | readonly [`PeerId`](../type-aliases/PeerId.md)[] | List of peer ids to subscribe to for VAD notifications. Include the local peer's id to also track whether the local user is speaking. Example usage: `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(", "); }` | + +## Returns + +`Record`\<[`PeerId`](../type-aliases/PeerId.md), `boolean`\> + +A record where each key is a peer id and the boolean value indicates +whether voice activity is currently detected for that peer. diff --git a/versioned_docs/version-0.27.0/api/web/index.md b/versioned_docs/version-0.27.0/api/web/index.md new file mode 100644 index 00000000..dabe879b --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/index.md @@ -0,0 +1,76 @@ +# @fishjam-cloud/react-client + +React client SDK for building web video and audio apps with Fishjam. + +## Connection + +- [useConnection](functions/useConnection.md) +- [useDataChannel](functions/useDataChannel.md) +- [usePeers](functions/usePeers.md) +- [useUpdatePeerMetadata](functions/useUpdatePeerMetadata.md) +- [useVAD](functions/useVAD.md) +- [Metadata](type-aliases/Metadata.md) + +## Devices + +- [useCamera](functions/useCamera.md) +- [useInitializeDevices](functions/useInitializeDevices.md) +- [useMicrophone](functions/useMicrophone.md) +- [useScreenShare](functions/useScreenShare.md) + +## Components + +- [FishjamProvider](functions/FishjamProvider.md) +- [FishjamProviderProps](interfaces/FishjamProviderProps.md) + +## Livestream + +- [useLivestreamStreamer](functions/useLivestreamStreamer.md) +- [useLivestreamViewer](functions/useLivestreamViewer.md) +- [UseLivestreamStreamerResult](interfaces/UseLivestreamStreamerResult.md) +- [UseLivestreamViewerResult](interfaces/UseLivestreamViewerResult.md) +- [ConnectStreamerConfig](type-aliases/ConnectStreamerConfig.md) +- [StreamerInputs](type-aliases/StreamerInputs.md) + +## Other + +- [useCustomSource](functions/useCustomSource.md) +- [useSandbox](functions/useSandbox.md) +- [Variant](enumerations/Variant.md) +- [DataChannelOptions](interfaces/DataChannelOptions.md) +- [JoinRoomConfig](interfaces/JoinRoomConfig.md) +- [SimulcastConfig](interfaces/SimulcastConfig.md) +- [AuthErrorReason](type-aliases/AuthErrorReason.md) +- [BandwidthLimits](type-aliases/BandwidthLimits.md) +- [Brand](type-aliases/Brand.md) +- [ConnectViewerConfig](type-aliases/ConnectViewerConfig.md) +- [CustomSource](type-aliases/CustomSource.md) +- [DataCallback](type-aliases/DataCallback.md) +- [DeviceError](type-aliases/DeviceError.md) +- [DeviceItem](type-aliases/DeviceItem.md) +- [InitializeDevicesResult](type-aliases/InitializeDevicesResult.md) +- [InitializeDevicesSettings](type-aliases/InitializeDevicesSettings.md) +- [InitializeDevicesStatus](type-aliases/InitializeDevicesStatus.md) +- [JoinErrorReason](type-aliases/JoinErrorReason.md) +- [MiddlewareResult](type-aliases/MiddlewareResult.md) +- [PeerId](type-aliases/PeerId.md) +- [PeerStatus](type-aliases/PeerStatus.md) +- [PeerWithTracks](type-aliases/PeerWithTracks.md) +- [PersistLastDeviceHandlers](type-aliases/PersistLastDeviceHandlers.md) +- [ReconnectConfig](type-aliases/ReconnectConfig.md) +- [ReconnectionStatus](type-aliases/ReconnectionStatus.md) +- [RemoteTrack](type-aliases/RemoteTrack.md) +- [RoomType](type-aliases/RoomType.md) +- [SimulcastBandwidthLimit](type-aliases/SimulcastBandwidthLimit.md) +- [SimulcastBandwidthLimits](type-aliases/SimulcastBandwidthLimits.md) +- [StreamConfig](type-aliases/StreamConfig.md) +- [Track](type-aliases/Track.md) +- [TrackBandwidthLimit](type-aliases/TrackBandwidthLimit.md) +- [TrackId](type-aliases/TrackId.md) +- [TrackMiddleware](type-aliases/TrackMiddleware.md) +- [TracksMiddleware](type-aliases/TracksMiddleware.md) +- [TracksMiddlewareResult](type-aliases/TracksMiddlewareResult.md) +- [UseDataChannelResult](type-aliases/UseDataChannelResult.md) +- [UseInitializeDevicesParams](type-aliases/UseInitializeDevicesParams.md) +- [UseSandboxProps](type-aliases/UseSandboxProps.md) +- [SimulcastConfig](variables/SimulcastConfig.md) diff --git a/versioned_docs/version-0.27.0/api/web/interfaces/DataChannelOptions.md b/versioned_docs/version-0.27.0/api/web/interfaces/DataChannelOptions.md new file mode 100644 index 00000000..3ac150b4 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/interfaces/DataChannelOptions.md @@ -0,0 +1,16 @@ +# Interface: DataChannelOptions + +Defined in: ts-client/dist/index.d.mts:501 + +Options for publishing or subscribing to data. + +## Properties + +### reliable + +> **reliable**: `boolean` + +Defined in: ts-client/dist/index.d.mts:506 + +If true, uses the reliable data channel (ordered, guaranteed delivery). +If false, uses the lossy data channel (unordered, low latency). diff --git a/versioned_docs/version-0.27.0/api/web/interfaces/FishjamProviderProps.md b/versioned_docs/version-0.27.0/api/web/interfaces/FishjamProviderProps.md new file mode 100644 index 00000000..ca56a3fb --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/interfaces/FishjamProviderProps.md @@ -0,0 +1,107 @@ +# Interface: FishjamProviderProps + +Defined in: [react-client/src/FishjamProvider.tsx:27](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/FishjamProvider.tsx#L27) + +## Extends + +- `PropsWithChildren` + +## Properties + +### audioConfig? + +> `optional` **audioConfig**: [`StreamConfig`](../type-aliases/StreamConfig.md) + +Defined in: [react-client/src/FishjamProvider.tsx:55](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/FishjamProvider.tsx#L55) + +Configure whether to use audio simulcast and which quality layers to send if so. + +*** + +### bandwidthLimits? + +> `optional` **bandwidthLimits**: `Partial`\<[`BandwidthLimits`](../type-aliases/BandwidthLimits.md)\> + +Defined in: [react-client/src/FishjamProvider.tsx:47](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/FishjamProvider.tsx#L47) + +Adjust max bandwidth limit for a single stream and simulcast. + +*** + +### constraints? + +> `optional` **constraints**: `Pick`\<`MediaStreamConstraints`, `"audio"` \| `"video"`\> + +Defined in: [react-client/src/FishjamProvider.tsx:38](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/FishjamProvider.tsx#L38) + +Set preferred constraints. + +#### Param + +The media stream constraints as defined by the Web API. + +#### See + +[MediaStreamConstraints](https://udn.realityripple.com/docs/Web/API/MediaStreamConstraints) + +*** + +### debug? + +> `optional` **debug**: `boolean` + +Defined in: [react-client/src/FishjamProvider.tsx:63](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/FishjamProvider.tsx#L63) + +Enables Fishjam SDK's debug logs in the console. + +*** + +### fishjamClient? + +> `optional` **fishjamClient**: `FishjamClient`\<`GenericMetadata`, `GenericMetadata`\> + +Defined in: [react-client/src/FishjamProvider.tsx:67](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/FishjamProvider.tsx#L67) + +Allows to provide your own FishjamClient instance from ts-client. + +*** + +### fishjamId + +> **fishjamId**: `string` + +Defined in: [react-client/src/FishjamProvider.tsx:59](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/FishjamProvider.tsx#L59) + +You can get you Fishjam ID at https://fishjam.io/app + +*** + +### persistLastDevice? + +> `optional` **persistLastDevice**: `boolean` \| [`PersistLastDeviceHandlers`](../type-aliases/PersistLastDeviceHandlers.md) + +Defined in: [react-client/src/FishjamProvider.tsx:43](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/FishjamProvider.tsx#L43) + +Decide if you want Fishjam SDK to persist last used device in the local storage. +You can also provide your getter and setter by using the [PersistLastDeviceHandlers](../type-aliases/PersistLastDeviceHandlers.md) interface. + +*** + +### reconnect? + +> `optional` **reconnect**: `boolean` \| [`ReconnectConfig`](../type-aliases/ReconnectConfig.md) + +Defined in: [react-client/src/FishjamProvider.tsx:32](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/FishjamProvider.tsx#L32) + +Use [ReconnectConfig](../type-aliases/ReconnectConfig.md) to adjust reconnection policy to your needs or set false it. +Set to true by default. + +*** + +### videoConfig? + +> `optional` **videoConfig**: [`StreamConfig`](../type-aliases/StreamConfig.md) + +Defined in: [react-client/src/FishjamProvider.tsx:51](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/FishjamProvider.tsx#L51) + +Configure whether to use video simulcast and which quality layers to send if so. diff --git a/versioned_docs/version-0.27.0/api/web/interfaces/JoinRoomConfig.md b/versioned_docs/version-0.27.0/api/web/interfaces/JoinRoomConfig.md new file mode 100644 index 00000000..c136553d --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/interfaces/JoinRoomConfig.md @@ -0,0 +1,29 @@ +# Interface: JoinRoomConfig\ + +Defined in: [react-client/src/hooks/useConnection.ts:10](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useConnection.ts#L10) + +## Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `PeerMetadata` *extends* `GenericMetadata` | `GenericMetadata` | + +## Properties + +### peerMetadata? + +> `optional` **peerMetadata**: `PeerMetadata` + +Defined in: [react-client/src/hooks/useConnection.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useConnection.ts#L18) + +String indexed record with metadata, that will be available to all other peers + +*** + +### peerToken + +> **peerToken**: `string` + +Defined in: [react-client/src/hooks/useConnection.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useConnection.ts#L14) + +Token received from server (or Room Manager) diff --git a/versioned_docs/version-0.27.0/api/web/interfaces/SimulcastConfig.md b/versioned_docs/version-0.27.0/api/web/interfaces/SimulcastConfig.md new file mode 100644 index 00000000..953fa22c --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/interfaces/SimulcastConfig.md @@ -0,0 +1,27 @@ +# Interface: SimulcastConfig + +Defined in: ts-client/dist/index.d.mts:197 + +## Properties + +### disabledVariants + +> **disabledVariants**: [`Variant`](../enumerations/Variant.md)[] + +Defined in: ts-client/dist/index.d.mts:200 + +*** + +### enabled + +> **enabled**: `boolean` + +Defined in: ts-client/dist/index.d.mts:198 + +*** + +### enabledVariants + +> **enabledVariants**: [`Variant`](../enumerations/Variant.md)[] + +Defined in: ts-client/dist/index.d.mts:199 diff --git a/versioned_docs/version-0.27.0/api/web/interfaces/UseLivestreamStreamerResult.md b/versioned_docs/version-0.27.0/api/web/interfaces/UseLivestreamStreamerResult.md new file mode 100644 index 00000000..0983091e --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/interfaces/UseLivestreamStreamerResult.md @@ -0,0 +1,62 @@ +# Interface: UseLivestreamStreamerResult + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:28](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamStreamer.ts#L28) + +## Properties + +### connect() + +> **connect**: (`inputs`, `urlOverride?`) => `Promise`\<`void`\> + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:35](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamStreamer.ts#L35) + +Callback used to start publishing the selected audio and video media streams. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `inputs` | [`ConnectStreamerConfig`](../type-aliases/ConnectStreamerConfig.md) | +| `urlOverride?` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Remarks + +Calling [connect](#connect) multiple times will have the effect of only publishing the **last** specified inputs. + +*** + +### disconnect() + +> **disconnect**: () => `void` + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:37](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamStreamer.ts#L37) + +Callback to stop publishing anything previously published with [connect](#connect) + +#### Returns + +`void` + +*** + +### error + +> **error**: `null` \| `LivestreamError` + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:39](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamStreamer.ts#L39) + +Any errors encountered in [connect](#connect) will populate this field + +*** + +### isConnected + +> **isConnected**: `boolean` + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:41](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamStreamer.ts#L41) + +Utility flag which indicates the current connection status diff --git a/versioned_docs/version-0.27.0/api/web/interfaces/UseLivestreamViewerResult.md b/versioned_docs/version-0.27.0/api/web/interfaces/UseLivestreamViewerResult.md new file mode 100644 index 00000000..4fef4d3e --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/interfaces/UseLivestreamViewerResult.md @@ -0,0 +1,82 @@ +# Interface: UseLivestreamViewerResult + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:12](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamViewer.ts#L12) + +## Properties + +### connect() + +> **connect**: (`config`, `url?`) => `Promise`\<`void`\> + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamViewer.ts#L20) + +Callback to start receiving a livestream. +If the livestream is private, provide `token`. +If the livestream is public, provide `streamId`. + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `config` | [`ConnectViewerConfig`](../type-aliases/ConnectViewerConfig.md) | +| `url?` | `string` | + +#### Returns + +`Promise`\<`void`\> + +*** + +### disconnect() + +> **disconnect**: () => `void` + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamViewer.ts#L22) + +Callback used to disconnect from a stream previously connected to with [connect](#connect) + +#### Returns + +`void` + +*** + +### error + +> **error**: `null` \| `LivestreamError` + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:24](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamViewer.ts#L24) + +Any errors encountered in [connect](#connect) will be present in this field. + +*** + +### getStatistics() + +> **getStatistics**: () => `Promise`\<`undefined` \| `RTCStatsReport`\> + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:27](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamViewer.ts#L27) + +#### Returns + +`Promise`\<`undefined` \| `RTCStatsReport`\> + +*** + +### isConnected + +> **isConnected**: `boolean` + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:26](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamViewer.ts#L26) + +Utility flag which indicates the current connection status + +*** + +### stream + +> **stream**: `null` \| `MediaStream` + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamViewer.ts#L14) + +The received livestream media diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/AuthErrorReason.md b/versioned_docs/version-0.27.0/api/web/type-aliases/AuthErrorReason.md new file mode 100644 index 00000000..5ce791b0 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/AuthErrorReason.md @@ -0,0 +1,5 @@ +# Type Alias: AuthErrorReason + +> **AuthErrorReason** = *typeof* `AUTH_ERROR_REASONS`\[`number`\] + +Defined in: ts-client/dist/index.d.mts:5 diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/BandwidthLimits.md b/versioned_docs/version-0.27.0/api/web/type-aliases/BandwidthLimits.md new file mode 100644 index 00000000..3a0b77cd --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/BandwidthLimits.md @@ -0,0 +1,21 @@ +# Type Alias: BandwidthLimits + +> **BandwidthLimits** = `object` + +Defined in: [react-client/src/types/public.ts:70](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L70) + +## Properties + +### simulcast + +> **simulcast**: [`SimulcastBandwidthLimits`](SimulcastBandwidthLimits.md) + +Defined in: [react-client/src/types/public.ts:70](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L70) + +*** + +### singleStream + +> **singleStream**: `number` + +Defined in: [react-client/src/types/public.ts:70](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L70) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/Brand.md b/versioned_docs/version-0.27.0/api/web/type-aliases/Brand.md new file mode 100644 index 00000000..60902924 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/Brand.md @@ -0,0 +1,18 @@ +# Type Alias: Brand\ + +> **Brand**\<`T`, `TBrand`\> = `T` & `object` + +Defined in: [react-client/src/types/public.ts:81](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L81) + +## Type declaration + +### \[brand\] + +> **\[brand\]**: `TBrand` + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | +| `TBrand` *extends* `string` | diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/ConnectStreamerConfig.md b/versioned_docs/version-0.27.0/api/web/type-aliases/ConnectStreamerConfig.md new file mode 100644 index 00000000..5eba7c99 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/ConnectStreamerConfig.md @@ -0,0 +1,23 @@ +# Type Alias: ConnectStreamerConfig + +> **ConnectStreamerConfig** = `object` + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamStreamer.ts#L21) + +## Properties + +### inputs + +> **inputs**: [`StreamerInputs`](StreamerInputs.md) + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamStreamer.ts#L22) + +*** + +### token + +> **token**: `string` + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:24](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamStreamer.ts#L24) + +Streamer token used to authenticate with Fishjam diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/ConnectViewerConfig.md b/versioned_docs/version-0.27.0/api/web/type-aliases/ConnectViewerConfig.md new file mode 100644 index 00000000..3c6239b3 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/ConnectViewerConfig.md @@ -0,0 +1,5 @@ +# Type Alias: ConnectViewerConfig + +> **ConnectViewerConfig** = \{ `streamId?`: `never`; `token`: `string`; \} \| \{ `streamId`: `string`; `token?`: `never`; \} + +Defined in: [react-client/src/hooks/useLivestreamViewer.ts:7](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamViewer.ts#L7) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/CustomSource.md b/versioned_docs/version-0.27.0/api/web/type-aliases/CustomSource.md new file mode 100644 index 00000000..7f96610d --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/CustomSource.md @@ -0,0 +1,40 @@ +# Type Alias: CustomSource\ + +> **CustomSource**\<`T`\> = `object` + +Defined in: [react-client/src/types/public.ts:83](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L83) + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `string` | + +## Properties + +### id + +> **id**: `T` + +Defined in: [react-client/src/types/public.ts:84](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L84) + +*** + +### stream? + +> `optional` **stream**: `MediaStream` + +Defined in: [react-client/src/types/public.ts:86](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L86) + +*** + +### trackIds? + +> `optional` **trackIds**: `object` + +Defined in: [react-client/src/types/public.ts:85](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L85) + +| Name | Type | +| ------ | ------ | +| `audioId?` | `string` | +| `videoId?` | `string` | diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/DataCallback.md b/versioned_docs/version-0.27.0/api/web/type-aliases/DataCallback.md new file mode 100644 index 00000000..2625caca --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/DataCallback.md @@ -0,0 +1,17 @@ +# Type Alias: DataCallback() + +> **DataCallback** = (`data`) => `void` + +Defined in: ts-client/dist/index.d.mts:512 + +Callback type for receiving data from a data channel. + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `data` | `Uint8Array` | The received data as a Uint8Array | + +## Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/DeviceError.md b/versioned_docs/version-0.27.0/api/web/type-aliases/DeviceError.md new file mode 100644 index 00000000..b939dfbd --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/DeviceError.md @@ -0,0 +1,5 @@ +# Type Alias: DeviceError + +> **DeviceError** = \{ `name`: `"OverconstrainedError"`; \} \| \{ `name`: `"NotAllowedError"`; \} \| \{ `name`: `"NotFoundError"`; \} \| \{ `name`: `"UNHANDLED_ERROR"`; \} + +Defined in: [react-client/src/types/public.ts:74](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L74) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/DeviceItem.md b/versioned_docs/version-0.27.0/api/web/type-aliases/DeviceItem.md new file mode 100644 index 00000000..31dc61f6 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/DeviceItem.md @@ -0,0 +1,21 @@ +# Type Alias: DeviceItem + +> **DeviceItem** = `object` + +Defined in: [react-client/src/types/public.ts:55](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L55) + +## Properties + +### deviceId + +> **deviceId**: `string` + +Defined in: [react-client/src/types/public.ts:55](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L55) + +*** + +### label + +> **label**: `string` + +Defined in: [react-client/src/types/public.ts:55](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L55) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesResult.md b/versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesResult.md new file mode 100644 index 00000000..82a6a241 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesResult.md @@ -0,0 +1,29 @@ +# Type Alias: InitializeDevicesResult + +> **InitializeDevicesResult** = `object` + +Defined in: [react-client/src/types/public.ts:11](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L11) + +## Properties + +### errors + +> **errors**: \{ `audio`: [`DeviceError`](DeviceError.md) \| `null`; `video`: [`DeviceError`](DeviceError.md) \| `null`; \} \| `null` + +Defined in: [react-client/src/types/public.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L14) + +*** + +### status + +> **status**: [`InitializeDevicesStatus`](InitializeDevicesStatus.md) + +Defined in: [react-client/src/types/public.ts:12](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L12) + +*** + +### stream + +> **stream**: `MediaStream` \| `null` + +Defined in: [react-client/src/types/public.ts:13](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L13) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesSettings.md b/versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesSettings.md new file mode 100644 index 00000000..17f2a893 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesSettings.md @@ -0,0 +1,21 @@ +# Type Alias: InitializeDevicesSettings + +> **InitializeDevicesSettings** = `object` + +Defined in: [react-client/src/hooks/internal/devices/useMediaDevices.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/internal/devices/useMediaDevices.ts#L16) + +## Properties + +### enableAudio? + +> `optional` **enableAudio**: `boolean` + +Defined in: [react-client/src/hooks/internal/devices/useMediaDevices.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/internal/devices/useMediaDevices.ts#L16) + +*** + +### enableVideo? + +> `optional` **enableVideo**: `boolean` + +Defined in: [react-client/src/hooks/internal/devices/useMediaDevices.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/internal/devices/useMediaDevices.ts#L16) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesStatus.md b/versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesStatus.md new file mode 100644 index 00000000..b40e1125 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/InitializeDevicesStatus.md @@ -0,0 +1,5 @@ +# Type Alias: InitializeDevicesStatus + +> **InitializeDevicesStatus** = `"initialized"` \| `"failed"` \| `"initialized_with_errors"` \| `"already_initialized"` + +Defined in: [react-client/src/types/public.ts:9](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L9) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/JoinErrorReason.md b/versioned_docs/version-0.27.0/api/web/type-aliases/JoinErrorReason.md new file mode 100644 index 00000000..16f20741 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/JoinErrorReason.md @@ -0,0 +1,5 @@ +# Type Alias: JoinErrorReason + +> **JoinErrorReason** = *typeof* `JOIN_ERRORS`\[`number`\] + +Defined in: ts-client/dist/index.d.mts:941 diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/Metadata.md b/versioned_docs/version-0.27.0/api/web/type-aliases/Metadata.md new file mode 100644 index 00000000..956ea26c --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/Metadata.md @@ -0,0 +1,28 @@ +# Type Alias: Metadata\ + +> **Metadata**\<`PeerMetadata`, `ServerMetadata`\> = `object` + +Defined in: ts-client/dist/index.d.mts:972 + +## Type Parameters + +| Type Parameter | Default type | Description | +| ------ | ------ | ------ | +| `PeerMetadata` | `GenericMetadata` | Type of metadata set by peer while connecting to a room. | +| `ServerMetadata` | `GenericMetadata` | Type of metadata set by the server while creating a peer. | + +## Properties + +### peer + +> **peer**: `PeerMetadata` + +Defined in: ts-client/dist/index.d.mts:973 + +*** + +### server + +> **server**: `ServerMetadata` + +Defined in: ts-client/dist/index.d.mts:974 diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/MiddlewareResult.md b/versioned_docs/version-0.27.0/api/web/type-aliases/MiddlewareResult.md new file mode 100644 index 00000000..ca0294f4 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/MiddlewareResult.md @@ -0,0 +1,25 @@ +# Type Alias: MiddlewareResult + +> **MiddlewareResult** = `object` + +Defined in: [react-client/src/types/public.ts:32](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L32) + +## Properties + +### onClear()? + +> `optional` **onClear**: () => `void` + +Defined in: [react-client/src/types/public.ts:32](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L32) + +#### Returns + +`void` + +*** + +### track + +> **track**: `MediaStreamTrack` + +Defined in: [react-client/src/types/public.ts:32](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L32) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/PeerId.md b/versioned_docs/version-0.27.0/api/web/type-aliases/PeerId.md new file mode 100644 index 00000000..527f04c7 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/PeerId.md @@ -0,0 +1,5 @@ +# Type Alias: PeerId + +> **PeerId** = [`Brand`](Brand.md)\<`string`, `"PeerId"`\> + +Defined in: [react-client/src/types/public.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L18) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/PeerStatus.md b/versioned_docs/version-0.27.0/api/web/type-aliases/PeerStatus.md new file mode 100644 index 00000000..946a252e --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/PeerStatus.md @@ -0,0 +1,12 @@ +# Type Alias: PeerStatus + +> **PeerStatus** = `"connecting"` \| `"connected"` \| `"error"` \| `"idle"` + +Defined in: [react-client/src/types/public.ts:53](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L53) + +Represents the possible statuses of a peer connection. + +- `idle` - Peer is not connected, either never connected or successfully disconnected. +- `connecting` - Peer is in the process of connecting. +- `connected` - Peer has successfully connected. +- `error` - There was an error in the connection process. diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/PeerWithTracks.md b/versioned_docs/version-0.27.0/api/web/type-aliases/PeerWithTracks.md new file mode 100644 index 00000000..c85d7c5a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/PeerWithTracks.md @@ -0,0 +1,85 @@ +# Type Alias: PeerWithTracks\ + +> **PeerWithTracks**\<`PeerMetadata`, `ServerMetadata`, `T`\> = `object` + +Defined in: [react-client/src/hooks/usePeers.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L14) + +## Type Parameters + +| Type Parameter | Default type | Description | +| ------ | ------ | ------ | +| `PeerMetadata` | - | Type of metadata set by peer while connecting to a room. | +| `ServerMetadata` | - | Type of metadata set by the server while creating a peer. | +| `T` *extends* [`Track`](Track.md) | [`Track`](Track.md) | - | + +## Properties + +### cameraTrack? + +> `optional` **cameraTrack**: `T` + +Defined in: [react-client/src/hooks/usePeers.ts:18](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L18) + +*** + +### customAudioTracks + +> **customAudioTracks**: `T`[] + +Defined in: [react-client/src/hooks/usePeers.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L23) + +*** + +### customVideoTracks + +> **customVideoTracks**: `T`[] + +Defined in: [react-client/src/hooks/usePeers.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L22) + +*** + +### id + +> **id**: [`PeerId`](PeerId.md) + +Defined in: [react-client/src/hooks/usePeers.ts:15](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L15) + +*** + +### metadata? + +> `optional` **metadata**: [`Metadata`](Metadata.md)\<`PeerMetadata`, `ServerMetadata`\> + +Defined in: [react-client/src/hooks/usePeers.ts:16](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L16) + +*** + +### microphoneTrack? + +> `optional` **microphoneTrack**: `T` + +Defined in: [react-client/src/hooks/usePeers.ts:19](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L19) + +*** + +### screenShareAudioTrack? + +> `optional` **screenShareAudioTrack**: `T` + +Defined in: [react-client/src/hooks/usePeers.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L21) + +*** + +### screenShareVideoTrack? + +> `optional` **screenShareVideoTrack**: `T` + +Defined in: [react-client/src/hooks/usePeers.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L20) + +*** + +### tracks + +> **tracks**: `T`[] + +Defined in: [react-client/src/hooks/usePeers.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/usePeers.ts#L17) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/PersistLastDeviceHandlers.md b/versioned_docs/version-0.27.0/api/web/type-aliases/PersistLastDeviceHandlers.md new file mode 100644 index 00000000..1082c622 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/PersistLastDeviceHandlers.md @@ -0,0 +1,42 @@ +# Type Alias: PersistLastDeviceHandlers + +> **PersistLastDeviceHandlers** = `object` + +Defined in: [react-client/src/types/public.ts:57](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L57) + +## Properties + +### getLastDevice() + +> **getLastDevice**: (`deviceType`) => `MediaDeviceInfo` \| `null` + +Defined in: [react-client/src/types/public.ts:58](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L58) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deviceType` | `"audio"` \| `"video"` | + +#### Returns + +`MediaDeviceInfo` \| `null` + +*** + +### saveLastDevice() + +> **saveLastDevice**: (`info`, `deviceType`) => `void` + +Defined in: [react-client/src/types/public.ts:59](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L59) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `info` | `MediaDeviceInfo` | +| `deviceType` | `"audio"` \| `"video"` | + +#### Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/ReconnectConfig.md b/versioned_docs/version-0.27.0/api/web/type-aliases/ReconnectConfig.md new file mode 100644 index 00000000..ef54d500 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/ReconnectConfig.md @@ -0,0 +1,37 @@ +# Type Alias: ReconnectConfig + +> **ReconnectConfig** = `object` + +Defined in: ts-client/dist/index.d.mts:945 + +## Properties + +### addTracksOnReconnect? + +> `optional` **addTracksOnReconnect**: `boolean` + +Defined in: ts-client/dist/index.d.mts:949 + +*** + +### delay? + +> `optional` **delay**: `number` + +Defined in: ts-client/dist/index.d.mts:948 + +*** + +### initialDelay? + +> `optional` **initialDelay**: `number` + +Defined in: ts-client/dist/index.d.mts:947 + +*** + +### maxAttempts? + +> `optional` **maxAttempts**: `number` + +Defined in: ts-client/dist/index.d.mts:946 diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/ReconnectionStatus.md b/versioned_docs/version-0.27.0/api/web/type-aliases/ReconnectionStatus.md new file mode 100644 index 00000000..344a388a --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/ReconnectionStatus.md @@ -0,0 +1,5 @@ +# Type Alias: ReconnectionStatus + +> **ReconnectionStatus** = `"reconnecting"` \| `"idle"` \| `"error"` + +Defined in: ts-client/dist/index.d.mts:944 diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/RemoteTrack.md b/versioned_docs/version-0.27.0/api/web/type-aliases/RemoteTrack.md new file mode 100644 index 00000000..e235fe2d --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/RemoteTrack.md @@ -0,0 +1,21 @@ +# Type Alias: RemoteTrack + +> **RemoteTrack** = [`Track`](Track.md) & `object` + +Defined in: [react-client/src/types/public.ts:28](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L28) + +## Type declaration + +### setReceivedQuality() + +> **setReceivedQuality**: (`quality`) => `void` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `quality` | [`Variant`](../enumerations/Variant.md) | + +#### Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/RoomType.md b/versioned_docs/version-0.27.0/api/web/type-aliases/RoomType.md new file mode 100644 index 00000000..e429483e --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/RoomType.md @@ -0,0 +1,5 @@ +# Type Alias: RoomType + +> **RoomType** = `"conference"` \| `"livestream"` \| `"audio_only"` + +Defined in: [react-client/src/hooks/useSandbox.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useSandbox.ts#L17) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/SimulcastBandwidthLimit.md b/versioned_docs/version-0.27.0/api/web/type-aliases/SimulcastBandwidthLimit.md new file mode 100644 index 00000000..91b20381 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/SimulcastBandwidthLimit.md @@ -0,0 +1,9 @@ +# Type Alias: SimulcastBandwidthLimit + +> **SimulcastBandwidthLimit** = `Map`\<[`Variant`](../enumerations/Variant.md), `BandwidthLimit`\> + +Defined in: ts-client/dist/index.d.mts:252 + +Type describing bandwidth limit for simulcast track. +It is a mapping (encoding => BandwidthLimit). +If encoding isn't present in this mapping, it will be assumed that this particular encoding shouldn't have any bandwidth limit diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/SimulcastBandwidthLimits.md b/versioned_docs/version-0.27.0/api/web/type-aliases/SimulcastBandwidthLimits.md new file mode 100644 index 00000000..026cfb51 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/SimulcastBandwidthLimits.md @@ -0,0 +1,29 @@ +# Type Alias: SimulcastBandwidthLimits + +> **SimulcastBandwidthLimits** = `object` + +Defined in: [react-client/src/types/public.ts:62](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L62) + +## Properties + +### 1 + +> **1**: `number` + +Defined in: [react-client/src/types/public.ts:63](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L63) + +*** + +### 2 + +> **2**: `number` + +Defined in: [react-client/src/types/public.ts:64](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L64) + +*** + +### 3 + +> **3**: `number` + +Defined in: [react-client/src/types/public.ts:65](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L65) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/StreamConfig.md b/versioned_docs/version-0.27.0/api/web/type-aliases/StreamConfig.md new file mode 100644 index 00000000..45164c3e --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/StreamConfig.md @@ -0,0 +1,13 @@ +# Type Alias: StreamConfig + +> **StreamConfig** = `object` + +Defined in: [react-client/src/types/public.ts:68](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L68) + +## Properties + +### sentQualities? + +> `optional` **sentQualities**: [`Variant`](../enumerations/Variant.md)[] \| `false` + +Defined in: [react-client/src/types/public.ts:68](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L68) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/StreamerInputs.md b/versioned_docs/version-0.27.0/api/web/type-aliases/StreamerInputs.md new file mode 100644 index 00000000..5412a014 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/StreamerInputs.md @@ -0,0 +1,31 @@ +# Type Alias: StreamerInputs + +> **StreamerInputs** = \{ `audio?`: `MediaStream` \| `null`; `video`: `MediaStream`; \} \| \{ `audio`: `MediaStream`; `video?`: `null`; \} + +Defined in: [react-client/src/hooks/useLivestreamStreamer.ts:8](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useLivestreamStreamer.ts#L8) + +## Type declaration + +\{ `audio?`: `MediaStream` \| `null`; `video`: `MediaStream`; \} + +### audio? + +> `optional` **audio**: `MediaStream` \| `null` + +The audio source to publish. e.g. `microphoneStream` from [useMicrophone](../functions/useMicrophone.md) or `stream` from [useScreenShare](../functions/useScreenShare.md) + +### video + +> **video**: `MediaStream` + +The video source to publish. e.g. `cameraStream` from [useCamera](../functions/useCamera.md) or `stream` from [useScreenShare](../functions/useScreenShare.md) + +\{ `audio`: `MediaStream`; `video?`: `null`; \} + +### audio + +> **audio**: `MediaStream` + +### video? + +> `optional` **video**: `null` diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/Track.md b/versioned_docs/version-0.27.0/api/web/type-aliases/Track.md new file mode 100644 index 00000000..c7a10ad4 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/Track.md @@ -0,0 +1,45 @@ +# Type Alias: Track + +> **Track** = `object` + +Defined in: [react-client/src/types/public.ts:20](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L20) + +## Properties + +### metadata? + +> `optional` **metadata**: `TrackMetadata` + +Defined in: [react-client/src/types/public.ts:23](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L23) + +*** + +### simulcastConfig + +> **simulcastConfig**: [`SimulcastConfig`](../interfaces/SimulcastConfig.md) \| `null` + +Defined in: [react-client/src/types/public.ts:24](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L24) + +*** + +### stream + +> **stream**: `MediaStream` \| `null` + +Defined in: [react-client/src/types/public.ts:21](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L21) + +*** + +### track + +> **track**: `MediaStreamTrack` \| `null` + +Defined in: [react-client/src/types/public.ts:25](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L25) + +*** + +### trackId + +> **trackId**: [`TrackId`](TrackId.md) + +Defined in: [react-client/src/types/public.ts:22](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L22) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/TrackBandwidthLimit.md b/versioned_docs/version-0.27.0/api/web/type-aliases/TrackBandwidthLimit.md new file mode 100644 index 00000000..8ae1c104 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/TrackBandwidthLimit.md @@ -0,0 +1,8 @@ +# Type Alias: TrackBandwidthLimit + +> **TrackBandwidthLimit** = `BandwidthLimit` \| [`SimulcastBandwidthLimit`](SimulcastBandwidthLimit.md) + +Defined in: ts-client/dist/index.d.mts:257 + +Type describing bandwidth limitation of a Track, including simulcast and non-simulcast tracks. +A sum type of `BandwidthLimit` and `SimulcastBandwidthLimit` diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/TrackId.md b/versioned_docs/version-0.27.0/api/web/type-aliases/TrackId.md new file mode 100644 index 00000000..5053a276 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/TrackId.md @@ -0,0 +1,5 @@ +# Type Alias: TrackId + +> **TrackId** = [`Brand`](Brand.md)\<`string`, `"TrackId"`\> + +Defined in: [react-client/src/types/public.ts:17](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L17) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/TrackMiddleware.md b/versioned_docs/version-0.27.0/api/web/type-aliases/TrackMiddleware.md new file mode 100644 index 00000000..2bca6ee3 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/TrackMiddleware.md @@ -0,0 +1,5 @@ +# Type Alias: TrackMiddleware + +> **TrackMiddleware** = (`track`) => [`MiddlewareResult`](MiddlewareResult.md) \| `Promise`\<[`MiddlewareResult`](MiddlewareResult.md)\> \| `null` + +Defined in: [react-client/src/types/public.ts:33](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L33) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/TracksMiddleware.md b/versioned_docs/version-0.27.0/api/web/type-aliases/TracksMiddleware.md new file mode 100644 index 00000000..e3737216 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/TracksMiddleware.md @@ -0,0 +1,16 @@ +# Type Alias: TracksMiddleware() + +> **TracksMiddleware** = (`videoTrack`, `audioTrack`) => [`TracksMiddlewareResult`](TracksMiddlewareResult.md) \| `Promise`\<[`TracksMiddlewareResult`](TracksMiddlewareResult.md)\> + +Defined in: [react-client/src/types/public.ts:40](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L40) + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `videoTrack` | `MediaStreamTrack` | +| `audioTrack` | `MediaStreamTrack` \| `null` | + +## Returns + +[`TracksMiddlewareResult`](TracksMiddlewareResult.md) \| `Promise`\<[`TracksMiddlewareResult`](TracksMiddlewareResult.md)\> diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/TracksMiddlewareResult.md b/versioned_docs/version-0.27.0/api/web/type-aliases/TracksMiddlewareResult.md new file mode 100644 index 00000000..06f353cc --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/TracksMiddlewareResult.md @@ -0,0 +1,33 @@ +# Type Alias: TracksMiddlewareResult + +> **TracksMiddlewareResult** = `object` + +Defined in: [react-client/src/types/public.ts:35](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L35) + +## Properties + +### audioTrack + +> **audioTrack**: `MediaStreamTrack` \| `null` + +Defined in: [react-client/src/types/public.ts:37](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L37) + +*** + +### onClear() + +> **onClear**: () => `void` + +Defined in: [react-client/src/types/public.ts:38](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L38) + +#### Returns + +`void` + +*** + +### videoTrack + +> **videoTrack**: `MediaStreamTrack` + +Defined in: [react-client/src/types/public.ts:36](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L36) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/UseDataChannelResult.md b/versioned_docs/version-0.27.0/api/web/type-aliases/UseDataChannelResult.md new file mode 100644 index 00000000..bbd22712 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/UseDataChannelResult.md @@ -0,0 +1,101 @@ +# Type Alias: UseDataChannelResult + +> **UseDataChannelResult** = `object` + +Defined in: [react-client/src/types/public.ts:89](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L89) + +## Properties + +### dataChannelError + +> **dataChannelError**: `Error` \| `null` + +Defined in: [react-client/src/types/public.ts:122](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L122) + +Error that occurred during data publisher operations, or null if no error. + +*** + +### dataChannelLoading + +> **dataChannelLoading**: `boolean` + +Defined in: [react-client/src/types/public.ts:118](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L118) + +Whether data channels are being initialized. + +*** + +### dataChannelReady + +> **dataChannelReady**: `boolean` + +Defined in: [react-client/src/types/public.ts:114](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L114) + +Whether data channels are connected and ready to send data. +Resets to false on disconnect. + +*** + +### initializeDataChannel() + +> **initializeDataChannel**: () => `void` + +Defined in: [react-client/src/types/public.ts:95](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L95) + +Initializes the data channel. + +Requires that the fishjam client is already connected. + +#### Returns + +`void` + +*** + +### publishData() + +> **publishData**: (`payload`, `options`) => `void` + +Defined in: [react-client/src/types/public.ts:101](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L101) + +Sends binary data through a data channel. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `payload` | `Uint8Array` | The Uint8Array payload to send (first positional argument) | +| `options` | [`DataChannelOptions`](../interfaces/DataChannelOptions.md) | Data channel options; specify `reliable: true` for guaranteed delivery or `reliable: false` for low latency | + +#### Returns + +`void` + +*** + +### subscribeData() + +> **subscribeData**: (`callback`, `options`) => () => `void` + +Defined in: [react-client/src/types/public.ts:109](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/types/public.ts#L109) + +Subscribe to incoming data on a data channel. +Can be called before or after channel creation. + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `callback` | [`DataCallback`](DataCallback.md) | Function called when data is received | +| `options` | [`DataChannelOptions`](../interfaces/DataChannelOptions.md) | Specify `reliable: true` or `reliable: false` to choose channel | + +#### Returns + +Unsubscribe function - call to cancel the subscription + +> (): `void` + +##### Returns + +`void` diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/UseInitializeDevicesParams.md b/versioned_docs/version-0.27.0/api/web/type-aliases/UseInitializeDevicesParams.md new file mode 100644 index 00000000..f2580cd7 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/UseInitializeDevicesParams.md @@ -0,0 +1,21 @@ +# Type Alias: UseInitializeDevicesParams + +> **UseInitializeDevicesParams** = `object` + +Defined in: [react-client/src/hooks/devices/useInitializeDevices.ts:5](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L5) + +## Properties + +### enableAudio? + +> `optional` **enableAudio**: `boolean` + +Defined in: [react-client/src/hooks/devices/useInitializeDevices.ts:7](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L7) + +*** + +### enableVideo? + +> `optional` **enableVideo**: `boolean` + +Defined in: [react-client/src/hooks/devices/useInitializeDevices.ts:6](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/devices/useInitializeDevices.ts#L6) diff --git a/versioned_docs/version-0.27.0/api/web/type-aliases/UseSandboxProps.md b/versioned_docs/version-0.27.0/api/web/type-aliases/UseSandboxProps.md new file mode 100644 index 00000000..9b1e3061 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/type-aliases/UseSandboxProps.md @@ -0,0 +1,13 @@ +# Type Alias: UseSandboxProps + +> **UseSandboxProps** = `object` + +Defined in: [react-client/src/hooks/useSandbox.ts:13](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useSandbox.ts#L13) + +## Properties + +### sandboxApiUrl + +> **sandboxApiUrl**: `string` + +Defined in: [react-client/src/hooks/useSandbox.ts:14](https://github.com/fishjam-cloud/web-client-sdk/blob/9a4ad3270ef2456354c48b507c3cc9c08d58a0c7/packages/react-client/src/hooks/useSandbox.ts#L14) diff --git a/versioned_docs/version-0.27.0/api/web/typedoc-sidebar.cjs b/versioned_docs/version-0.27.0/api/web/typedoc-sidebar.cjs new file mode 100644 index 00000000..f8afae72 --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ +const typedocSidebar = {items:[{type:"category",label:"Connection",items:[{type:"doc",id:"api/web/functions/useConnection",label:"useConnection"},{type:"doc",id:"api/web/functions/useDataChannel",label:"useDataChannel"},{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/DataChannelOptions",label:"DataChannelOptions"},{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/DataCallback",label:"DataCallback"},{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/RemoteTrack",label:"RemoteTrack"},{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/UseDataChannelResult",label:"UseDataChannelResult"},{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.27.0/api/web/variables/SimulcastConfig.md b/versioned_docs/version-0.27.0/api/web/variables/SimulcastConfig.md new file mode 100644 index 00000000..e8dbd27d --- /dev/null +++ b/versioned_docs/version-0.27.0/api/web/variables/SimulcastConfig.md @@ -0,0 +1,5 @@ +# Variable: SimulcastConfig + +> **SimulcastConfig**: `MessageFns`\<[`SimulcastConfig`](../interfaces/SimulcastConfig.md)\> + +Defined in: ts-client/dist/index.d.mts:197 diff --git a/versioned_docs/version-0.27.0/examples/_category_.json b/versioned_docs/version-0.27.0/examples/_category_.json new file mode 100644 index 00000000..085a6d37 --- /dev/null +++ b/versioned_docs/version-0.27.0/examples/_category_.json @@ -0,0 +1,10 @@ +{ + "label": "Examples", + "position": 6, + "link": { + "type": "generated-index", + "title": "Examples", + "description": "Real-world code examples and use cases.", + "slug": "/examples" + } +} diff --git a/versioned_docs/version-0.27.0/examples/react-native.mdx b/versioned_docs/version-0.27.0/examples/react-native.mdx new file mode 100644 index 00000000..762dc616 --- /dev/null +++ b/versioned_docs/version-0.27.0/examples/react-native.mdx @@ -0,0 +1,181 @@ +--- +type: explanation +sidebar_position: 0 +--- + +# React Native Examples + +_Runnable reference apps demonstrating common Fishjam use cases in React Native_ + +Each example is a standalone Expo application you can run locally and use as a starting point for your own project. +All examples use `@fishjam-cloud/react-native-client`. You need a Fishjam ID to connect to the media server, and a Sandbox API URL to create rooms and get peer tokens. Get your Fishjam ID from the [Fishjam Dashboard](https://fishjam.io/app), and your Sandbox API URL from the [Sandbox tab](https://fishjam.io/app/sandbox). See [What is the Sandbox API?](../explanation/sandbox-api-concept) for an in-depth explanation. + +| Example | What it demonstrates | +| ----------------------------------------- | --------------------------------------------------------------------- | +| [Minimal Video Room](#minimal-video-room) | Simplest possible video call — the baseline for all other examples | +| [Fishjam Chat](#fishjam-chat) | Full-featured video conferencing and livestreaming app with simulcast | +| [Background Blur](#background-blur) | Applying real-time video effects via camera track middleware | +| [Text Chat](#text-chat) | Peer-to-peer text messaging with WebRTC data channels | +| [Video Player](#video-player) | Livestream broadcaster and viewer with separate UI modes | + +--- + +## Minimal Video Room + +The simplest way to get video calling working — joining a room, displaying your own camera feed, and showing remote participants. Start here if you're new to Fishjam. + +**Demonstrates:** + +- Wrapping your app in `FishjamProvider` +- Connecting to a room with `useConnection` +- Accessing local and remote peers with `usePeers` +- Rendering video streams with `RTCView` + +### Running the example + +```bash +cd minimal-react-native +yarn install +npx expo prebuild +npx expo run:android # or run:ios +``` + +:::important +This won't work on the iOS Simulator — the Simulator can't access the camera. Test on a real device. +::: + +The room screen uses `usePeers` to retrieve all participants and renders their camera streams in a two-column grid with `RTCView`. + +Browse the full source: [minimal-react-native on GitHub](https://github.com/fishjam-cloud/examples/tree/main/mobile-react-native/minimal-react-native) + +--- + +## Fishjam Chat + +A full-featured application covering two distinct room types: a video conferencing room (conference call with multiple participants) and a livestream room (one broadcaster, many viewers). It is the most complete example and the best reference for production-like architecture. + +**Demonstrates:** + +- Tab-based navigation between VideoRoom and Livestream features +- Pre-call room preview before joining +- Environment switching between staging and production +- Screen sharing from a livestream broadcaster +- Permission handling with a reusable `useMediaPermissions` hook +- Selecting received video quality with simulcast (`setReceivedQuality`) + +### Running the example + +```bash +cd fishjam-chat +yarn install +npx expo prebuild +npx expo run:android # or run:ios +``` + +:::important +Before prebuilding, replace the bundle identifier `io.fishjam.example.fishjamchat` with your own in `app.json` (both the Android package name and iOS bundle identifier fields). +::: + +The app uses Expo Router with a bottom tab navigator. Each tab handles its own connection flow independently using `useConnection`. + +Browse the full source: [fishjam-chat on GitHub](https://github.com/fishjam-cloud/examples/tree/main/mobile-react-native/fishjam-chat) + +--- + +## Background Blur + +Demonstrates how to apply real-time background blur to a local camera feed using camera track middleware. Blur can be toggled on and off during an active call without reconnecting. + +**Demonstrates:** + +- Installing and using `@fishjam-cloud/react-native-webrtc-background-blur` +- Applying a video effect with `setCameraTrackMiddleware` +- Removing an effect by passing `null` to `setCameraTrackMiddleware` + +### Running the example + +Install the additional blur package first: + +```bash npm2yarn +npm install @fishjam-cloud/react-native-webrtc-background-blur +``` + +```bash +cd blur-example +yarn install +npx expo prebuild +npx expo run:android # or run:ios +``` + +:::info +Blur applies only to the local camera feed sent to other participants. Remote participants' video is unaffected. +::: + +The blur hook from `useBackgroundBlur` provides a `middleware` function that is passed directly to `setCameraTrackMiddleware`. Passing `null` disables the effect. + +Browse the full source: [blur-example on GitHub](https://github.com/fishjam-cloud/examples/tree/main/mobile-react-native/blur-example) + +--- + +## Text Chat + +Demonstrates peer-to-peer text messaging over WebRTC data channels — no separate messaging server required. Messages are sent directly between peers inside the Fishjam room. + +**Demonstrates:** + +- Initializing a data channel with `useDataChannel` +- Publishing messages with `publishData` +- Receiving incoming messages via the `onDataReceived` callback +- Encoding and decoding message payloads with JSON + +### Running the example + +```bash +cd text-chat +yarn install +npx expo prebuild +npx expo run:android # or run:ios +``` + +:::info +Data channels use `reliable` mode by default, which guarantees message delivery and ordering — similar to TCP. +::: + +Messages are `Uint8Array` payloads encoded and decoded with JSON and `TextEncoder`/`TextDecoder`. The `useDataChannel` hook wires together `publishData` for sending and `onDataReceived` for receiving. + +Browse the full source: [text-chat on GitHub](https://github.com/fishjam-cloud/examples/tree/main/mobile-react-native/text-chat) + +--- + +## Video Player + +A focused livestreaming example with two separate modes: a streamer who broadcasts video and audio, and a viewer who watches the stream. Unlike Fishjam Chat, this example uses a single `App.tsx` entry point with a simple role selector screen. + +**Demonstrates:** + +- Broadcasting with `useLivestreamStreamer` +- Watching a stream with `useLivestreamViewer` +- Initializing camera and microphone with `useInitializeDevices` +- Toggling camera and microphone tracks during an active stream + +### Running the example + +```bash +cd video-player +yarn install +npx expo prebuild +npx expo run:android # or run:ios +``` + +The streamer side uses `useLivestreamStreamer` and `useInitializeDevices` to start broadcasting, while the viewer side uses `useLivestreamViewer` to connect and render the incoming stream with `RTCView`. + +Browse the full source: [video-player on GitHub](https://github.com/fishjam-cloud/examples/tree/main/mobile-react-native/video-player) + +--- + +## Next steps + +- Follow the [React Native Quick Start](../tutorials/react-native-quick-start) if you haven't set up a project yet +- Learn how to [handle screen sharing](../how-to/client/screensharing) +- Learn how to [implement background streaming](../how-to/client/background-streaming) +- Learn how to [work with data channels](../how-to/client/text-chat) diff --git a/versioned_docs/version-0.27.0/examples/react.mdx b/versioned_docs/version-0.27.0/examples/react.mdx new file mode 100644 index 00000000..1666097a --- /dev/null +++ b/versioned_docs/version-0.27.0/examples/react.mdx @@ -0,0 +1,193 @@ +--- +type: explanation +sidebar_position: 1 +--- + +# React Examples + +_Runnable reference apps demonstrating common Fishjam use cases in React_ + +Each example is a standalone React application you can run locally and use as a starting point for your own project. +All examples use `@fishjam-cloud/react-client`. You need a Fishjam ID to connect to the media server, and a Sandbox API URL to create rooms and get peer tokens. Get your Fishjam ID from the [Fishjam Dashboard](https://fishjam.io/app), and your Sandbox API URL from the [Sandbox tab](https://fishjam.io/app/sandbox). See [What is the Sandbox API?](../explanation/sandbox-api-concept) for an in-depth explanation. + +| Example | What it demonstrates | +| ----------------------------------- | ----------------------------------------------------------------------- | +| [Minimal React](#minimal-react) | Simplest video call — join a room, camera, mic, screen share, simulcast | +| [Audio Only](#audio-only) | Voice chat with no video and microphone device selection | +| [Text Chat](#text-chat) | Peer-to-peer messaging over WebRTC data channels | +| [Livestreaming](#livestreaming) | One broadcaster, many viewers with separate streamer/viewer UIs | +| [Minimal Smelter](#minimal-smelter) | Custom video overlays using the Smelter rendering engine | +| [Fishjam Chat](#fishjam-chat) | Full-featured conferencing app with background blur and screen sharing | + +--- + +## Minimal React + +The simplest way to get a video call working in the browser — joining a room, displaying your own camera feed, and showing remote participants. Start here if you're new to Fishjam on the web. + +**Demonstrates:** + +- Wrapping your app in `FishjamProvider` +- Connecting to a room with `useConnection` +- Accessing local and remote peers with `usePeers` +- Enabling camera and microphone with `useCamera` and `useMicrophone` +- Starting screen sharing with `useScreenShare` +- Rendering streams with `VideoPlayer` and `AudioPlayer` components +- Selecting received video quality with simulcast (`setReceivedQuality`) + +### Running the example + +```bash +cd minimal-react +yarn install +yarn dev +``` + +The room component uses `usePeers` to retrieve all participants and renders their video streams using `VideoPlayer` and audio with `AudioPlayer`. + +:::note +This example requires a **peer token** to connect. You need to obtain one yourself — either via the [Sandbox API](../how-to/backend/sandbox-api-testing#step-2-create-a-room-and-get-peer-tokens) for quick testing, or by setting up your own backend with the [Fishjam Server SDK](../tutorials/backend-quick-start). +::: + +Browse the full source: [minimal-react on GitHub](https://github.com/fishjam-cloud/examples/tree/main/web-react/minimal-react) + +--- + +## Audio Only + +A voice-only room with no video — demonstrates how to initialize Fishjam with audio exclusively and let users pick their microphone device before joining. + +**Demonstrates:** + +- Audio-only initialization with `useInitializeDevices` (`enableVideo: false`) +- Microphone device selection from available inputs +- Rendering a peer list with audio playback via `AudioPlayer` + +### Running the example + +```bash +cd audio-only +yarn install +yarn dev +``` + +Setting `enableVideo: false` in `useInitializeDevices` skips camera initialization entirely, keeping the session lightweight for voice-only use cases. + +Browse the full source: [audio-only on GitHub](https://github.com/fishjam-cloud/examples/tree/main/web-react/audio-only) + +--- + +## Text Chat + +Demonstrates peer-to-peer text messaging over WebRTC data channels — no separate messaging server required. Messages are sent directly between peers inside the Fishjam room. + +**Demonstrates:** + +- Initializing a data channel with `useDataChannel` +- Publishing messages with `publishData` +- Receiving incoming messages with `subscribeData` +- Encoding and decoding message payloads with `TextEncoder` and `TextDecoder` + +### Running the example + +```bash +cd text-chat +yarn install +yarn dev +``` + +Messages are `Uint8Array` payloads encoded and decoded with JSON and `TextEncoder`/`TextDecoder`. The `useDataChannel` hook wires together `publishData` for sending and `subscribeData` for receiving. + +Browse the full source: [text-chat on GitHub](https://github.com/fishjam-cloud/examples/tree/main/web-react/text-chat) + +--- + +## Livestreaming + +A focused livestreaming example with two separate modes: a streamer who broadcasts video and audio, and a viewer who watches the stream. Token management is handled via the `useSandbox` hook. + +**Demonstrates:** + +- Broadcasting with `useLivestreamStreamer` +- Watching a stream with `useLivestreamViewer` +- Separate broadcaster and viewer UIs within one application +- Obtaining peer tokens with `useSandbox` + +### Running the example + +```bash +cd livestreaming +yarn install +yarn dev +``` + +The streamer side uses `useLivestreamStreamer` to publish camera and audio tracks, while the viewer side uses `useLivestreamViewer` to connect and render the incoming stream. + +Browse the full source: [livestreaming on GitHub](https://github.com/fishjam-cloud/examples/tree/main/web-react/livestreaming) + +--- + +## Minimal Smelter + +Shows how to apply custom video overlays to a camera feed using the Smelter rendering engine — a text label composited directly onto the outgoing video stream. + +**Demonstrates:** + +- Creating a custom video source with `useCustomSource` +- Initializing the Smelter engine with `useSmelter` +- Registering inputs and outputs with `registerInput`/`registerOutput` +- Compositing a text overlay on top of a live camera feed + +### Running the example + +```bash +cd minimal-smelter +yarn install +yarn dev +``` + +:::important +Smelter requires WebAssembly support — use a modern browser. +::: + +The `useSmelter` hook manages the Smelter engine lifecycle. `registerInput` connects the local camera feed and `registerOutput` routes the composited result back into Fishjam as a custom track. + +:::note +This example requires a **peer token** to connect. You need to obtain one yourself — either via the [Sandbox API](../how-to/backend/sandbox-api-testing#step-2-create-a-room-and-get-peer-tokens) for quick testing, or by setting up your own backend with the [Fishjam Server SDK](../tutorials/backend-quick-start). +::: + +Browse the full source: [minimal-smelter on GitHub](https://github.com/fishjam-cloud/examples/tree/main/web-react/minimal-smelter) + +--- + +## Fishjam Chat + +A full-featured conferencing application covering camera, microphone, screen sharing, background blur via a camera track middleware, and a settings panel for device selection. + +**Demonstrates:** + +- Connecting to a room with `useConnection` +- Managing camera and microphone with `useCamera` and `useMicrophone` +- Screen sharing with `useScreenShare` +- Applying real-time background blur using a MediaPipe camera track middleware +- Device selection in a settings panel + +### Running the example + +```bash +cd fishjam-chat +yarn install +yarn dev +``` + +Background blur is applied as a camera track middleware that processes each video frame with MediaPipe before the track is sent to other participants. Removing the middleware disables the effect without reconnecting. + +Browse the full source: [fishjam-chat on GitHub](https://github.com/fishjam-cloud/examples/tree/main/web-react/fishjam-chat) + +--- + +## Next steps + +- Follow the [React Quick Start](../tutorials/react-quick-start) if you haven't set up a project yet +- Learn how to [work with data channels](../how-to/client/text-chat) +- Learn how to [implement screen sharing](../how-to/client/screensharing) diff --git a/versioned_docs/version-0.27.0/explanation/_category_.json b/versioned_docs/version-0.27.0/explanation/_category_.json new file mode 100644 index 00000000..bf1eb1f9 --- /dev/null +++ b/versioned_docs/version-0.27.0/explanation/_category_.json @@ -0,0 +1,11 @@ +{ + "label": "Concepts", + "position": 5, + "link": { + "type": "generated-index", + "title": "Concepts", + "description": "Big-picture explanations of higher-level Fishjam concepts. Most useful for building understanding of a particular topic.", + "slug": "/explanation" + }, + "collapsible": false +} diff --git a/versioned_docs/version-0.27.0/explanation/agent-internals.mdx b/versioned_docs/version-0.27.0/explanation/agent-internals.mdx new file mode 100644 index 00000000..9f2e49a0 --- /dev/null +++ b/versioned_docs/version-0.27.0/explanation/agent-internals.mdx @@ -0,0 +1,107 @@ +--- +type: explanation +title: Agent Internals +sidebar_position: 6 +description: Deep dive into Fishjam agent architecture, lifecycle, and how to integrate without using a server SDK. +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import AgentDefinition from "../_common/agents/definition.mdx"; +import RememberToDisconnect from "../_common/agents/remember-to-disconnect.mdx"; +import Subscriptions from "../_common/agents/subscriptions.mdx"; + +# Agent Internals + +:::info +This explanation focuses on the inner workings of Fishjam Agents. +If you are looking for a tutorial that shows how to implement an agent, then you may find the [Agent Introduction](../tutorials/agents) more useful. +::: + + + +## Agent lifecycle + +There are four steps to the lifecycle of a Fishjam Agent: + +1. The agent is created in the room `roomId`. + Fishjam generates a token that the agent will use to connect to the room. +2. The agent connects to the room `roomId` via a WebSocket connection. +3. The agent receives audio from **subscribed** peers in the room `roomId`. + Subscriptions are explained in the [Peer subscriptions](#peer-subscriptions) section. +4. The agent disconnects from the room `roomId` by closing the WebSocket connection. + +We describe the steps of an agent's lifecycle in detail below. + +:::tip +The Fishjam [server SDKs](../tutorials/agents#writing-an-agent) provide a simple way to integrate with the APIs described below. +::: + +### Step 1. Creating an Agent in Fishjam + +Agents are created via the `/room/{roomId}/peer` [REST API](../api/reference#rest-api) endpoint, by setting the `type` option to `"agent"`. +An example request with [cURL](https://curl.se/) would look like: + +```bash +# [!code word:{"type"\: "agent"}] +curl -XPOST -H "Authorization: Bearer $FISHJAM_MANAGEMENT_TOKEN" \ +"https://fishjam.io/api/v1/room/$ROOM_ID/peer" \ +--json '{"type": "agent"}' +``` + +### Step 2. Connecting to the Room + +Agents connect to Fishjam by initiating a WebSocket connection on the `/socket/agent/websocket` REST API endpoint. +All communication over the WebSocket between Agent the Fishjam is done using [Protobuf messages](https://protobuf.dev/). +Check [Fishjam Protobuf reference](../api/reference#protobufs) for more info. +Once connected, the agent must authenticate with Fishjam by sending an [`AgentRequest.AuthRequest` protobuf message](../api/reference#protobufs). +An example of initiating a connection using [websocat](https://github.com/vi/websocat) and [Buf CLI](https://buf.build/docs/cli/) would look like: + +```bash +# Get the Fishjam protobuf definitions +git clone https://github.com/fishjam-cloud/protos.git + +echo "{\"authRequest\": {\"token\": \"$AGENT_TOKEN\"}}" \ +| buf convert protos/fishjam/agent_notifications.proto \ + --type="fishjam.AgentRequest" --from="-#format=json" \ +| websocat -vbn wss://fishjam.io/api/v1/connect/$FISHJAM_ID/socket/agent/websocket +``` + +In a backend application, we suggest using the [Protobuf compiler](https://protobuf.dev/installation/) to generate utilities for creating protobuf message from code. + +### Step 3. Receiving Audio + +Once connected, an agent will receive chunks of audio as [`AgentRequest.TrackData` protobuf message](../api/reference#protobufs). + +### Step 4. Sending Audio + +All further steps are done via the WebSocket connection created in [Step 2](#step-2-connecting-to-the-room). + +To send audio to an agent, you need to create an audio track first. +This is done by sending an [`AgentRequest.CreateTrack` protobuf message](../api/reference#protobufs). +Once the track is created, you can send audio to it using [`AgentRequest.TrackData` protobuf message](../api/reference#protobufs). + +### Step 5. Disconnecting from the Room + +An agent disconnects from the room by closing the WebSocket connection created in [Step 2](#step-2-connecting-to-the-room). +It may reconnect using the same token it provided in [Step 2](#step-2-connecting-to-the-room). + + + +## Peer subscriptions + + + +The subscribe option contains parameters describing the desired output format of the peer's audio stream. +This output format will be sent to connected agents. + +### Output format + +Currently, only **16-bit PCM** (raw) audio output is supported. + +### Output sample rate + +The output can have either a sample rate of **16kHz** or **24kHz**. + +The above values aim to be compatible with popular real-time AI audio APIs. +If you require a different output format, then make sure to contact us at `contact@fishjam.io`. diff --git a/versioned_docs/version-0.27.0/explanation/architecture.mdx b/versioned_docs/version-0.27.0/explanation/architecture.mdx new file mode 100644 index 00000000..911ea297 --- /dev/null +++ b/versioned_docs/version-0.27.0/explanation/architecture.mdx @@ -0,0 +1,91 @@ +--- +type: explanation +sidebar_position: 2 +--- + +# Fishjam Architecture + +_Understanding how Fishjam works under the hood_ + +This document explains the technical architecture of Fishjam and how data flows through the system. + +## High-level Architecture + +Streaming with Fishjam is simple: you create a room, add peers to it, and start streaming. Below is a high-level overview of how Fishjam works. + +![Fishjam Data Flow](@site/static/img/architecture.svg) + +## Components Overview + +### 1. Your Backend Server + +Your application's backend server is responsible for: + +- Authenticating users +- Creating rooms using Fishjam Server SDKs +- Generating peer tokens for clients +- Managing room lifecycle and permissions + +### 2. Fishjam Media Server + +The Fishjam Media Server is the core infrastructure component that: + +- Routes audio and video streams between participants +- Handles WebRTC negotiations and connections +- Manages different room types (conference, audio-only, livestream) +- Processes and transcodes media when needed +- Enforces security policies and token validation + +### 3. Client Applications + +Client applications (React Native, React) use Fishjam Client SDKs to: + +- Connect to rooms using peer tokens +- Send and receive audio/video streams +- Handle device management (cameras, microphones) +- Manage connection state and reconnections + +## Data Flow + +### 1. Room Creation Flow + +```mermaid +sequenceDiagram + participant FM as Fishjam Media Server + participant BE as Your Backend + participant Client as Client App + + Client->>BE: Request to join room + BE->>FM: Create room (Server SDK) + FM->>BE: Return room ID + BE->>FM: Create peer (Server SDK) + FM->>BE: Return peer token + BE->>Client: Send peer token + Fishjam ID +``` + +### 2. Media Streaming Flow + +```mermaid +sequenceDiagram + participant C1 as Client 1 + participant FM as Fishjam Media Server + participant C2 as Client 2 + + C1->>FM: Connect with peer token + C2->>FM: Connect with peer token + C1->>FM: Send video/audio stream + FM->>C2: Route stream to other peers + C2->>FM: Send video/audio stream + FM->>C1: Route stream to other peers +``` + +## Next Steps + +To understand different room types in detail, see [Rooms](../explanation/rooms). + +To learn about security and token management, see [Security & Token Model](../explanation/security-tokens). + +Ready to implement? Start with our tutorials: + +- [React Native Quick Start](../tutorials/react-native-quick-start) +- [Backend Quick Start](../tutorials/backend-quick-start) diff --git a/versioned_docs/version-0.27.0/explanation/data-channels.mdx b/versioned_docs/version-0.27.0/explanation/data-channels.mdx new file mode 100644 index 00000000..5fed2f19 --- /dev/null +++ b/versioned_docs/version-0.27.0/explanation/data-channels.mdx @@ -0,0 +1,67 @@ +--- +type: explanation +sidebar_position: 7 +description: Send and receive arbitrary binary data between peers using Fishjam data channels. +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Data Channels + +Data channels allow you to send and receive arbitrary binary data between peers in a room. This is useful for implementing features like text chat, file sharing, game state synchronization, or real-time cursor positions. + +## Prerequisites + +Before using data channels, you must be [connected to a room](../how-to/client/connecting). Data channels only work after you have successfully joined a room. + +## Channel Types + +The SDK provides two types of data channels, each optimized for different use cases: + +### Reliable Channel + +- **Ordered delivery**: Messages arrive in the order they were sent +- **Guaranteed delivery**: All messages will be delivered, with automatic retransmission if needed +- **Use cases**: Chat messages, file transfers, commands, or any data that must not be lost + +### Lossy Channel + +- **Unordered delivery**: Messages may arrive out of order +- **No retransmission**: Messages may be dropped if the network is congested +- **Lower latency**: Faster delivery since there's no waiting for retransmissions +- **Use cases**: Real-time cursor positions, game state updates, live sensor data, or any data where the latest value matters more than every value + +## Broadcast Communication + +Data channels work in a **broadcast fashion** - when you publish data, it is sent to all other peers in the room. Additionally: + +- Messages sent on the **reliable channel** are only received by peers subscribed to the **reliable channel** +- Messages sent on the **lossy channel** are only received by peers subscribed to the **lossy channel** + +This separation allows you to use both channels simultaneously for different purposes without interference. + +## Using Data Channels + +Use the `useDataChannel` hook to work with data channels. The hook is available in both the web and mobile SDKs with the same API: + + + + +Use [`useDataChannel`](../api/web/functions/useDataChannel) from `@fishjam-cloud/react-client`. + + + + +Use [`useDataChannel`](../api/mobile/functions/useDataChannel) from `@fishjam-cloud/react-native-client`. + + + + +The typical flow is: + +1. Initialize the data channel after connecting to a room +2. Subscribe to incoming messages +3. Publish messages to other peers + +For a complete step-by-step guide on implementing text chat, see [Text Chat](../how-to/client/text-chat). diff --git a/versioned_docs/version-0.27.0/explanation/glossary.md b/versioned_docs/version-0.27.0/explanation/glossary.md new file mode 100644 index 00000000..14584929 --- /dev/null +++ b/versioned_docs/version-0.27.0/explanation/glossary.md @@ -0,0 +1,39 @@ +--- +type: reference +--- + +# Glossary + +A brief walk-through of the terms we use in the documentation. + +### Room + +A collection of peers that can send and receive video/audio to and from other peers. + +### Peer + +A user that is connected to a room. Each peer has some associated metadata and tracks. + +### Agent + +A program connected to a room using the Fishjam server SDK; a programmatic peer. + +### Track + +A single stream of video or audio from a peer. It could be a camera view, shared screen, or microphone audio. Each peer can stream multiple tracks. + +### Management Token + +A secret token that should be stored on your backend. It allows you to create rooms and add peers. + +### Peer Token + +A token that your backend should pass to end clients to allow access to a specific room. + +### Fishjam ID + +The ID of your Fishjam instance. It is used by your backend server to add peers to rooms (and create rooms). It is also used by end client apps to join rooms. + +### Sandbox API + +A simple testing API allowing you to test Fishjam features without requiring you to add any functionalities to your backend. It is intended for development and testing only, not for production use. You can find more details [here](/how-to/backend/sandbox-api-testing). diff --git a/versioned_docs/version-0.27.0/explanation/livestreams.mdx b/versioned_docs/version-0.27.0/explanation/livestreams.mdx new file mode 100644 index 00000000..d0f7c5d9 --- /dev/null +++ b/versioned_docs/version-0.27.0/explanation/livestreams.mdx @@ -0,0 +1,217 @@ +--- +type: explanation +title: Livestreams +sidebar_position: 4 +description: Understand the difference between private and public livestreams in Fishjam and how to configure them. +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Livestreams + +:::info +This explanation only applies to Fishjam rooms with type `livestream`. +::: + +When livestreaming with Fishjam, you can chose to make your livestream `private` or `public`. +By default, created livestreams are `private`, to prevent possible bugs. + + + + + ```ts + const fishjamId = ''; + const managementToken = ''; + + // ---cut--- + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamClient = new FishjamClient({ + fishjamId, + managementToken, + }); + + const privateRoom = await fishjamClient.createRoom({ roomType: 'livestream' }); // [!code highlight] + const publicRoom = await fishjamClient.createRoom({ roomType: 'livestream', public: true }); // [!code highlight] + ``` + + + + + + ```python + from fishjam import FishjamClient + + fishjam_client = FishjamClient( + fishjam_id=fishjam_id, + management_token=management_token, + ); + + private_room = fishjam_client.create_room(room_type="livestream") # [!code highlight] + public_room = fishjam_client.create_room(room_type="livestream", public=True) # [!code highlight] + ``` + + + + +The choice you make affects how **viewers** connect to the livestream and has no effect on streamers. + +## Private livestreams + +When you create a private livestream, viewers are required to provide a viewer token when connecting to the livestream. + +This aims to provide control over who can view a livestream, but requires you to distribute tokens from your backend application to your frontend applications. + +### Creating a viewer token + +Below we show how you would create a livestream viewer token in a production scenario, with your own backend. +Note that for development purposes, you can [use the Sandbox API to generate a viewer token](../tutorials/livestreaming#obtaining-a-token-1). + + + + + ```ts + const fishjamId = ''; + const managementToken = ''; + + // ---cut--- + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamClient = new FishjamClient({ + fishjamId, + managementToken, + }); + + + const privateRoom = await fishjamClient.createRoom({ roomType: 'livestream' }); + const { token: viewerToken } = await fishjamClient.createLivestreamViewerToken(privateRoom.id); // [!code highlight] + ``` + + + + + + ```python + from fishjam import FishjamClient + + fishjam_client = FishjamClient( + fishjam_id=fishjam_id, + management_token=management_token, + ); + + private_room = fishjam_client.create_room(room_type="livestream") + viewer_token = fishjam_client.create_livestream_viewer_token(private_room.id) # [!code highlight] + ``` + + + + +### Connecting to a private room + +Once you've created a viewer token, you can connect to a room using the Fishjam client SDKs (examples below), or alternatively you can use [WHEP](../how-to/backend/whip-whep#private-livestreams). + + + + + ```tsx + const viewerToken = ''; + + // ---cut--- + import { useLivestreamViewer } from '@fishjam-cloud/react-client'; + + // ... + + const { connect, stream } = useLivestreamViewer(); + + // ... + + await connect({ token: viewerToken }); + // after connecting stream will be available + ``` + + + + + + ```tsx + import React from 'react'; + + const viewerToken = ''; + + // ---cut--- + import { useLivestreamViewer, RTCView } from '@fishjam-cloud/react-native-client'; + + // Inside your component: + const { connect, stream } = useLivestreamViewer(); + + // ... + + await connect({ token: viewerToken }); + + // Render the stream + {stream && } + ``` + + + + +## Public livestreams + +Public livestreams simplify the viewing process by omitting the viewer token. +All a viewer needs to view a public livestream is the ID of the room, so your backend doesn't need to manage the creation and distribution of viewer tokens. + +Note however, that public livestreams are _not suitable for all use-cases_. + +For example, if you are developing an app, which includes exclusive live content that requires a subscription to view, then you will want to authorize viewers before allowing them to view a livestream. +Failing to do so may result in extra costs, as livestreams are billed per-viewer. +Such an application will benefit from the token-based authorization in [private livestreams](#private-livestreams). + +### Connecting to a public room + +Once you've created a room of type `livestream` with the `public` flag enabled, you may start connecting viewers to the stream via the Fishjam client SDKs or [WHEP](../how-to/backend/whip-whep#public-livestreams). + + + + + ```tsx + const roomId = ''; + + // ---cut--- + import { useLivestreamViewer } from '@fishjam-cloud/react-client'; + + // ... + + const { connect, stream } = useLivestreamViewer(); + + // ... + + await connect({ streamId: roomId }); + // after connecting `stream` will be available + ``` + + + + + + ```tsx + import React from 'react'; + + const roomId = ''; + + // ---cut--- + import { useLivestreamViewer, RTCView } from '@fishjam-cloud/react-native-client'; + + // Inside your component: + const { connect, stream } = useLivestreamViewer(); + + // ... + + await connect({ streamId: roomId }); + + // Render the stream + {stream && } + ``` + + + diff --git a/versioned_docs/version-0.27.0/explanation/rooms.mdx b/versioned_docs/version-0.27.0/explanation/rooms.mdx new file mode 100644 index 00000000..128f0432 --- /dev/null +++ b/versioned_docs/version-0.27.0/explanation/rooms.mdx @@ -0,0 +1,143 @@ +--- +type: explanation +sidebar_position: 3 +--- + +# Rooms + +_Understanding different types of rooms and when to use them_ + +Fishjam provides three distinct room types, each optimized for different use cases and scenarios. +Understanding these room types helps you choose the right approach for your application. + +## Conference Rooms (Default) + +### What are Conference Rooms? + +Conference rooms are the default room type designed for multi-participant video conferencing scenarios. They support all Fishjam features and provide the most flexibility. + +### Key Characteristics + +- **Multi-participant**: Support for many participants simultaneously +- **Bidirectional media**: All participants can send and receive video/audio +- **Multiple sources**: Participants can share their camera, screen, microphone and more all at once +- **Flexible track management**: Participants can add/remove tracks dynamically + +### Best Use Cases + +- **Video conferencing applications** +- **Interactive webinars** with participant engagement + +### Cost Considerations + +Conference rooms are priced based on total connection time of all peers. + +## Audio-only Rooms + +### What are Audio-only Rooms? + +Audio-only rooms are optimized specifically for voice communication, removing video capabilities to improve performance and reduce costs. + +### Key Characteristics + +- **Voice-only communication**: No video tracks allowed +- **Cheap pricing**: Audio only rooms cost much less than other room types +- **Optimized network usage**: Works well in degraded network conditions + +### Best Use Cases + +- **Audio chat applications** +- **Podcast recording** with multiple participants +- **Large-scale audio events** (town halls, announcements) + +### Cost Benefits + +Audio-only rooms come at a **75% discount** compared to conference rooms: + +- 2 peers for 30 minutes = 60 minutes total time in conference room +- Same scenario in audio-only room = 15 minutes equivalent cost + +### Video Behavior in Audio-only Rooms + +If you attempt to add video to an audio-only room: + +- Video tracks are ignored (not transmitted) +- SDKs log warnings to help with debugging +- Only audio from screen sharing is transmitted +- No errors thrown, graceful degradation + +## Livestream Rooms + +### What are Livestream Rooms? + +Livestream rooms are designed for one-to-many livestreaming scenarios where a single streamer streams to multiple viewers. + +### Key Characteristics + +- **One sender**: Only one streamer can send media +- **Many receivers**: Unlimited viewers can watch +- **Optimized for scale**: Efficient distribution architecture + +### Livestreaming Limitations + +- **Single video track**: Only one video stream allowed +- **Single audio track**: Only one audio stream allowed +- **Additional tracks ignored**: Extra tracks are not forwarded to viewers + +### Viewer Experience + +- **Configurable access**: Livestreams can either be public, where anyone with the stream's ID can join, or private, where every viewer needs a token +- **Standard compatibility**: Any [WHEP](https://blog.swmansion.com/building-interactive-streaming-apps-webrtc-whip-whep-explained-d38f4825ec90)-compatible player works + +### Best Use Cases + +- **Live events** +- **Streaming platforms** and content distribution +- **Corporate livestreams** and announcements +- **Sports and entertainment** streaming + +### Cost Benefits + +Livestream rooms are **20% cheaper** than conference rooms for equivalent usage. + +## Choosing the Right Room Type + +### Decision Matrix + +| Use Case | Room Type | Why | +| ---------------------- | ---------- | ------------------------------------------- | +| Classic video meetings | Conference | Multiple video sources | +| Voice-only meetings | Audio-only | Cheapest and most performant option | +| Live Podcasts | Audio-only | Cheapest and most performant option | +| Sport streaming | Livestream | Highly scalable and cheaper than conference | +| Interactive workshop | Conference | Multiple video sources | + +## Video Codecs + +Fishjam supports the following video codecs: + +- **H.264** — A hardware-accelerated codec offering superior performance. Used by default. Its availability varies by device, and it may not perform optimally at lower bitrates. +- **VP8** — A software-based codec supported across all devices, ensuring maximum compatibility. Ideal for environments lacking hardware acceleration, such as Android emulators. + +Fishjam uses H.264 by default, however, to solve an issue with Android emulators, VP8 is set when you're using the Sandbox API. + +You can override the default codec by setting the `codec` parameter when [creating a room](../api/server/interfaces/RoomConfig#videocodec) using server SDKs. + +We recommend using H.264 for production and VP8 for development as it works with Android emulators. + +## Next Steps + +To understand how to use each room type: + +- [How to implement livestreaming](../tutorials/livestreaming) +- [How to create audio-only calls](../how-to/backend/audio-only-calls) + +To learn about the underlying architecture: + +- [Fishjam Architecture](../explanation/architecture) +- [Security & Token Model](../explanation/security-tokens) + +Ready to start building? Check our tutorials: + +- [React Native Quick Start](../tutorials/react-native-quick-start) +- [Backend Quick Start](../tutorials/backend-quick-start) diff --git a/versioned_docs/version-0.27.0/explanation/sandbox-api-concept.mdx b/versioned_docs/version-0.27.0/explanation/sandbox-api-concept.mdx new file mode 100644 index 00000000..24a555aa --- /dev/null +++ b/versioned_docs/version-0.27.0/explanation/sandbox-api-concept.mdx @@ -0,0 +1,92 @@ +--- +type: explanation +sidebar_position: 1 +description: A development tool that provides a simple backend for testing Fishjam without building your own server. +--- + +# What is the Sandbox API? + +The Sandbox API is a development tool that simplifies getting started with Fishjam by providing a simple backend for testing, eliminating the need to build your own server initially. + +## What can the Sandbox API do? + +The Sandbox API is an HTTP server provided by us for development and testing. +It provides basic room creation and peer management functionality without requiring you to set up your own backend infrastructure. + +### Key Characteristics + +- **Development-purposed**: Designed for initial development and testing +- **No authentication**: Simplified access for quick prototyping +- **Testing-only**: Not intended for production use; use your own authenticated backend for production + +## Sandbox API URL and Fishjam ID + +You can find your sandbox credentials in the [Sandbox tab](https://fishjam.io/app/sandbox) of the Fishjam Dashboard. + +The **Sandbox API** is a hosted HTTP backend you can use to test Fishjam without writing your own server. It creates [**rooms**](../explanation/rooms) and **peers** for conferencing, and supports [**livestreaming**](../explanation/livestreams) by issuing the streamer and viewer credentials. It's an example implementation of what you need to build using our [**JavaScript server SDK**](../api/server) to go to production. + +You can use your sandbox credentials by passing them to the `useSandbox` hook in the client SDK, which will create rooms and peer tokens for you, or by calling the Sandbox API URL directly from your client and using the returned `peerToken` to connect to Fishjam. + +The **Fishjam ID** from the [Dashboard tab](https://fishjam.io/app) is passed to `FishjamProvider` so the client can connect to the Fishjam media server after it gets a peer token. + +If your Sandbox API URL is exposed or your credentials are compromised, generate a new URL from the Sandbox tab to invalidate the old one. You can also disable the Sandbox API and enable it again when you want to resume sandbox testing. +If you expose your Sandbox API URL in a public deployment, it can leak (for example through client code or network requests). Anyone who obtains that URL can create rooms and peers on your behalf. + +## The Problem Sandbox API Solves + +When starting with videoconferencing or livestreaming development, you typically need: + +1. A **Backend server** to create rooms +2. An **Authentication system** to manage users +3. **Token management** for secure peer access +4. **API endpoints** for your frontend to call + +This creates a problem: to test your frontend, you need a backend, but during prototyping you want to focus on frontend development first. +The Sandbox API mitigates this issue and allows you to start frontend development ASAP. + +## Relationship to Server SDKs + +The Sandbox API is essentially a simplified application built using the Fishjam Server SDKs: + +```typescript +import { FishjamClient, RoomType } from "@fishjam-cloud/js-server-sdk"; +import express from "express"; +const fishjamId = ""; +const managementToken = ""; +const app = express(); + +// ---cut--- +// What Sandbox API does internally (simplified) +const fishjamClient = new FishjamClient({ fishjamId, managementToken }); + +app.get("/", async (req: express.Request, res: express.Response) => { + const { roomName, peerName, roomType } = req.query; + + // Create or get room + const room = await fishjamClient.createRoom({ + roomType: roomType as RoomType, + }); + + // Create or get peer + const { peer, peerToken } = await fishjamClient.createPeer(room.id); + + res.json({ peerToken }); +}); +``` + +This shows you exactly what your production backend needs to do, just with proper authentication and error handling. + +## See also + +To understand how to use The Sandbox API for development: + +- [How to use The Sandbox API for testing](../how-to/backend/sandbox-api-testing) + +To learn about building your own backend: + +- [Backend Quick Start Tutorial](../tutorials/backend-quick-start) +- [How to set up your server](../how-to/backend/server-setup) + +To understand the security model: + +- [Security & Token Model](../explanation/security-tokens) diff --git a/versioned_docs/version-0.27.0/explanation/security-tokens.mdx b/versioned_docs/version-0.27.0/explanation/security-tokens.mdx new file mode 100644 index 00000000..e0e86a54 --- /dev/null +++ b/versioned_docs/version-0.27.0/explanation/security-tokens.mdx @@ -0,0 +1,116 @@ +--- +type: explanation +sidebar_position: 5 +--- + +# Security & Token Model + +_Understanding Fishjam's security architecture and token system_ + +Fishjam uses a token-based security model to ensure secure access control while keeping the developer experience simple. + +## Security Architecture Overview + +Fishjam's security is built on a **two-tier token system**: + +1. **Management Tokens**: For backend-to-Fishjam server communication +2. **Peer Tokens**: For client-to-Fishjam server communication + +This separation ensures that sensitive operations remain on your backend while allowing clients secure, limited access to media streaming. + +## Management Tokens + +### Purpose + +Management tokens provide your backend server with administrative access to Fishjam resources. They allow creating, managing, and deleting rooms and peers. + +### Characteristics + +- **Long-lived**: Management tokens remain valid until manually regenerated +- **High privilege**: Management tokens allow performing administrative operations and should only be used in backend applications. +- **Backend-only**: Management tokens should never be sent to client applications. + +### What Management Tokens Can Do + +Management tokens give permission to: + +- Create and manage rooms and peers +- Setup [webhooks](../how-to/backend/server-setup#webhooks) +- Set [immutable peer metadata](../how-to/backend/server-setup#metadata) + +## Peer Tokens + +### Purpose + +Peer tokens provide client applications with limited, time-bound access to join a specific room as a specific peer. + +### Characteristics + +- **Short-lived**: Peer tokens expire 24h after creation. +- **Scope-limited**: Peer tokens give access to one specific room as one specific peer only. +- **Client-safe**: Peer tokens are safe to send to frontend applications. + +### What Peer Tokens Can Do + +Peer tokens give permission to: + +- Connect to the specific room they were issued for +- Participate in room activities (audio/video/screen sharing) +- Access peer metadata and room state + +### What Peer Tokens Cannot Do + +- Create or delete rooms +- Access multiple rooms +- Add or remove peers + +### Generation Process + +```typescript +import { FishjamClient, RoomId } from "@fishjam-cloud/js-server-sdk"; +import express from "express"; +const res = {} as any; +const managementToken = ""; +const fishjamId = ""; +const roomId = "" as unknown as RoomId; +const fishjamClient = new FishjamClient({ fishjamId, managementToken }); + +// ---cut--- +// Backend generates peer token (using management token) +const { peer, peerToken } = await fishjamClient.createPeer(roomId, { + metadata: { name: "John Doe", userId: "user-123" }, +}); + +// Backend sends peer token to client +res.json({ + peerToken, // Client uses this to connect + roomId, // Room information +}); +``` + +### Client Usage + +```typescript +import { useConnection } from "@fishjam-cloud/react-client"; +const joinRoom = {} as any; +const peerToken = ""; + +// ---cut--- +// Client uses peer token to connect (safe to use in frontend) +await joinRoom({ peerToken }); // This is safe in client code +``` + +## Next Steps + +To implement secure authentication: + +- [Backend Quick Start Tutorial](../tutorials/backend-quick-start) +- [How to set up your server](../how-to/backend/server-setup) + +To understand the broader architecture: + +- [Fishjam Architecture](../explanation/architecture) + +To learn about the Sandbox API's security limitations: + +- [Understanding the Sandbox API](../explanation/sandbox-api-concept) diff --git a/versioned_docs/version-0.27.0/explanation/simulcast.mdx b/versioned_docs/version-0.27.0/explanation/simulcast.mdx new file mode 100644 index 00000000..5cd91431 --- /dev/null +++ b/versioned_docs/version-0.27.0/explanation/simulcast.mdx @@ -0,0 +1,83 @@ +--- +type: explanation +sidebar_position: 8 +description: How simulcast enables adaptive video quality by sending multiple resolution variants simultaneously. +--- + +# Simulcast + +_Multi-quality video streaming for adaptive bandwidth and layout-aware rendering_ + +Simulcast allows a video sender to encode and transmit the same video at multiple quality levels (variants) simultaneously. Each receiver independently chooses which variant to receive, enabling adaptive quality based on network conditions, UI layout, or user preference. + +## Why Simulcast? + +Without simulcast, every receiver gets the same video quality. This creates a trade-off: receive high quality (wastes bandwidth for small thumbnails) or receive low quality (degrades the experience for full-screen viewers). + +Simulcast solves this on the receiver side -- a sender publishes multiple variants, and each receiver requests only the quality it needs. The trade-off is increased upload bandwidth on the sender, since it encodes and transmits multiple variants simultaneously. If this overhead is not acceptable, the sender can [choose which variants to publish](#sender-configuration) or disable simulcast entirely. + +- A **thumbnail grid** can request low quality for all participants +- A **spotlight view** can request high quality for the active speaker and low for everyone else +- A participant on a **slow connection** can request medium quality regardless of UI layout + +## Quality Variants + +Three predefined quality tiers are available via the `Variant` enum: + +| Variant | Meaning | +| ------------------------ | --------------------------- | +| `Variant.VARIANT_LOW` | Low quality / resolution | +| `Variant.VARIANT_MEDIUM` | Medium quality / resolution | +| `Variant.VARIANT_HIGH` | High quality / resolution | + +## How It Works + +```mermaid +sequenceDiagram + participant Sender + participant Server as Fishjam Server + participant ReceiverA as Receiver A (thumbnail) + participant ReceiverB as Receiver B (full-screen) + + Sender->>Server: Video (LOW + MEDIUM + HIGH) + ReceiverA->>Server: setReceivedQuality(LOW) + Server->>ReceiverA: Forwards LOW variant + ReceiverB->>Server: setReceivedQuality(HIGH) + Server->>ReceiverB: Forwards HIGH variant +``` + +1. The **sender** encodes the camera feed into up to three variants and sends all of them to the Fishjam server. +2. The **server** receives all variants but only forwards the one each receiver has requested. +3. Each **receiver** calls `setReceivedQuality` on a remote track to tell the server which variant it wants. The receiver can change this at any time. + +## Sender Configuration + +The sender controls which variants to publish via the `sentQualities` option in `FishjamProvider`'s `videoConfig`: + +- **All variants** (default): Omit `sentQualities` or pass `[Variant.VARIANT_LOW, Variant.VARIANT_MEDIUM, Variant.VARIANT_HIGH]` +- **Subset**: Pass only the variants you need, e.g. `[Variant.VARIANT_LOW, Variant.VARIANT_HIGH]` +- **Disabled**: Pass `false` to send a single quality stream (no simulcast) + +## Receiver Quality Selection + +Remote tracks expose a `setReceivedQuality` method. This is only available on **remote** peer tracks. Your own local tracks don't have it, since you don't "receive" your own video. + +The `RemoteTrack` type (exported from both `@fishjam-cloud/react-client` and `@fishjam-cloud/react-native-client`) extends the base `Track` type with a `setReceivedQuality(quality: Variant)` method. + +When you call `setReceivedQuality`, the server switches which variant it forwards for that track. The change takes effect almost immediately. + +## When to Use Simulcast + +Simulcast is most valuable when: + +- Your app has **multiple layout modes** (grid, spotlight, picture-in-picture) +- Participants have **varying network conditions** +- You want to **reduce bandwidth** for participants viewing many small thumbnails +- You're building **adaptive quality** that responds to UI state + +For simple 1:1 calls where both sides always show full-screen video, simulcast adds encoding overhead without much benefit. Consider disabling it with `sentQualities: false`. + +## See also + +- [Simulcast how-to guide](../how-to/client/simulcast): step-by-step implementation +- [Architecture](./architecture): how Fishjam routes media diff --git a/versioned_docs/version-0.27.0/explanation/what-is-fishjam.mdx b/versioned_docs/version-0.27.0/explanation/what-is-fishjam.mdx new file mode 100644 index 00000000..4567811d --- /dev/null +++ b/versioned_docs/version-0.27.0/explanation/what-is-fishjam.mdx @@ -0,0 +1,67 @@ +--- +type: explanation +sidebar_position: 0 +--- + +# What is Fishjam? + +_Understanding the role and purpose of Fishjam_ + +Fishjam is a multimedia streaming toolkit that allows you to build real-time video and audio streaming applications. +It uses [WebRTC](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API) under the hood to ensure sub-second (in most cases **less than 300ms**) latency. +We provide the infrastructure, media server, and client SDKs so you can focus on building your apps. + +**No WebRTC knowledge is required!** + +## The Problem Fishjam Solves + +Building real-time video and audio applications is complex. Developers typically need to: + +- Set up and manage WebRTC infrastructure +- Handle complex peer-to-peer networking +- Manage media servers and scaling +- Deal with different devices and codec compatibility +- Implement secure token-based authentication + +Fishjam abstracts away this complexity, providing a simple API and managed infrastructure. + +## What Fishjam Provides + +Fishjam consists of several components that work together to provide a seamless multimedia streaming experience: + +| Component | Description | +| --------------------- | ------------------------------------------------------------------------------------------------------- | +| Developer panel | The place to access your credentials and manage your Fishjam usage. | +| Fishjam Media Servers | Media servers route your multimedia traffic. We host and manage them for you. | +| Fishjam Client SDKs | Toolkit used for multimedia integration on endpoint devices. | +| Fishjam Server SDKs | Toolkit for integrating your backend with Fishjam. We currently support Python and NodeJS. | +| Sandbox API | Simple backend for creating test rooms. You can test Fishjam without having to set up your own backend. | + +## Use Cases + +Fishjam is ideal for: + +### Video Conferencing + +Build videoconferencing applications with multiple participants in rooms, screen sharing, and audio/video. + +### Livestreaming + +Stream live content from one streamer to many viewers with low latency. +Perfect for live events or streaming platforms. + +### Audio-only Applications + +Create voice-only experiences like audio conferencing, podcasts, or voice chat applications. + +## Next Steps + +To understand how Fishjam works technically, see [Fishjam Architecture](../explanation/architecture). + +To learn about the different types of rooms available, see [Rooms](../explanation/rooms). + +Ready to start building? Check out our tutorials: + +- [React Native Quick Start](../tutorials/react-native-quick-start) +- [React Quick Start](../tutorials/react-quick-start) +- [Backend Quick Start](../tutorials/backend-quick-start) diff --git a/versioned_docs/version-0.27.0/how-to/_category_.json b/versioned_docs/version-0.27.0/how-to/_category_.json new file mode 100644 index 00000000..a932906d --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/_category_.json @@ -0,0 +1,11 @@ +{ + "label": "How-to Guides", + "position": 3, + "link": { + "type": "generated-index", + "title": "How-to Guides", + "description": "Practical step-by-step guides to help you achieve a specific goal. Most useful when you're trying to get something done.", + "slug": "/how-to" + }, + "collapsible": false +} diff --git a/versioned_docs/version-0.27.0/how-to/_common/metadata/header.mdx b/versioned_docs/version-0.27.0/how-to/_common/metadata/header.mdx new file mode 100644 index 00000000..aafb60c4 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/_common/metadata/header.mdx @@ -0,0 +1,10 @@ +Alongside audio and video, it is possible to send additional metadata with each peer. Metadata is just +JSON that can contain arbitrary information. Its most common use is sending a user name associated with a peer. +However, it can be also used to send the peer's camera type, application information etc. + +:::info + +You can also set metadata on [the server side, when adding user to the room](../../../how-to/backend/server-setup#metadata). This metadata is persistent throughout its lifetime and is useful for attaching information that +can't be overwritten by the peer, like information about real user names or basic permission info. + +::: diff --git a/versioned_docs/version-0.27.0/how-to/_common/metadata/joining_room.mdx b/versioned_docs/version-0.27.0/how-to/_common/metadata/joining_room.mdx new file mode 100644 index 00000000..517a5b30 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/_common/metadata/joining_room.mdx @@ -0,0 +1,5 @@ +## Setting metadata when joining the room + +The `joinRoom` method from the `useConnection` hook has a `peerMetadata` parameter, that can be used for setting object metadata. + +{props.children} diff --git a/versioned_docs/version-0.27.0/how-to/_common/metadata/reading.mdx b/versioned_docs/version-0.27.0/how-to/_common/metadata/reading.mdx new file mode 100644 index 00000000..b0516650 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/_common/metadata/reading.mdx @@ -0,0 +1,9 @@ +## Reading metadata + +Peer metadata is available as the `metadata` property for each peer. Therefore, when you list your peers with the `usePeers` hook, you can read +the metadata associated with them. +Note that the `metadata.peer` property contains only the metadata set by the client SDK (as in the examples examples above). +The metadata set on the server side is available as `metadata.server`. +Learn more about server metadata [here](../backend/server-setup#metadata). + +{props.children} diff --git a/versioned_docs/version-0.27.0/how-to/_common/metadata/updating.mdx b/versioned_docs/version-0.27.0/how-to/_common/metadata/updating.mdx new file mode 100644 index 00000000..97bd1a1b --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/_common/metadata/updating.mdx @@ -0,0 +1,5 @@ +## Updating metadata during connection + +Once you've joined the room, you can update your peer metadata with the `updatePeerMetadata` method of the `useUpdatePeerMetadata` hook: + +{props.children} diff --git a/versioned_docs/version-0.27.0/how-to/backend/_category_.json b/versioned_docs/version-0.27.0/how-to/backend/_category_.json new file mode 100644 index 00000000..2d5af2e1 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/backend/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Backend", + "position": 4 +} diff --git a/versioned_docs/version-0.27.0/how-to/backend/audio-only-calls.mdx b/versioned_docs/version-0.27.0/how-to/backend/audio-only-calls.mdx new file mode 100644 index 00000000..46cb48f4 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/backend/audio-only-calls.mdx @@ -0,0 +1,100 @@ +--- +sidebar_position: 6 +description: Create audio-only rooms and livestreams for voice-only use cases at a discounted cost. +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Audio-only Conferences and Livestreams + +In many use cases, you only need real-time audio, without any video streaming. +If your use case falls into this category, then you can benefit greatly from using audio-only rooms in Fishjam. + +## Why Should I Care? + +Audio-only rooms are heavily discounted compared to normal rooms. +As described in more detail on the [pricing page](https://fishjam.io/#pricing), Fishjam rooms are priced based on the total connection time of peers in them. +Audio-only rooms come at a **75% discount** for both conferencing and livestreaming. + +### Conferencing + +For conferencing, the base price is $1 per 1000 participant minutes. + +For example, if you have a normal room with 10 peers connected for 100 minutes, then the total cost of the room will be $1. +If the same room were audio-only, the final cost of the room would only be $0.25. + +### Livestreaming + +For livestreaming, the base price is $0.8 per 1000 minutes of streamer and each viewer. + +In a livestream with 1 streamer and 9999 viewers, all connected for 100 minutes, the total connection time is 10,000 minutes. +For a normal livestream, this would cost $8.00. +If the same room were audio-only, the final cost would only be $2.00. + +## How Do I Use It? + +Using this feature is as easy as setting the `roomType` field when creating a room using our [Server SDKs](./server-setup). + +:::info +Attempting to stream a video while connected to an `audio_only` or `audio_only_livestream` room will result in only the audio being sent to the other peers. +::: + +### Conferencing + +Set `roomType` to `audio_only` when creating a room: + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + const fishjamClient = new FishjamClient({ + fishjamId: "aaa", + managementToken: "bbb", + }); + // ---cut--- + const audioOnlyRoom = await fishjamClient.createRoom({ roomType: 'audio_only' }); + ``` + + + ```python + options = RoomOptions(room_type="audio_only") + audio_only_room = fishjam_client.create_room(options) + ``` + + + +Now, you can connect peers normally to the room as described in our [Web & Mobile connecting guide](../client/connecting). + +### Livestreaming + +Set `roomType` to `audio_only_livestream` when creating a room: + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + const fishjamClient = new FishjamClient({ + fishjamId: "aaa", + managementToken: "bbb", + }); + // ---cut--- + const audioOnlyRoom = await fishjamClient.createRoom({ roomType: 'audio_only_livestream' }); + ``` + + + ```python + options = RoomOptions(room_type="audio_only_livestream") + audio_only_room = fishjam_client.create_room(options) + ``` + + + +Refer to our [Livestreaming tutorial](../../tutorials/livestreaming.mdx) to learn how to connect streamers and viewers. + +:::info +The React Native and React SDKs will log a warning in the console if any attempt to add video to an audio-only room is made. +This aims to assist in debugging, as adding video to an audio-only room has no effect and is most likely a mistake. +::: diff --git a/versioned_docs/version-0.27.0/how-to/backend/fastapi-example.mdx b/versioned_docs/version-0.27.0/how-to/backend/fastapi-example.mdx new file mode 100644 index 00000000..dd886255 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/backend/fastapi-example.mdx @@ -0,0 +1,100 @@ +--- +sidebar_position: 1 +title: FastAPI +description: Example FastAPI server integration using the Fishjam Python SDK. +--- + +# FastAPI example + +The example assumes you've already installed [**our SDK**](https://github.com/fishjam-cloud/python-server-sdk) and you're ready to go. +If you wish to see more general info, visit [**Set up your server**](../../how-to/backend/server-setup) article. + +## Minimal setup + +The same way as in the [**FastAPI docs**](https://fastapi.tiangolo.com/tutorial/first-steps/), the code below can be copied and run immediately. +Just make sure you set `FISHJAM_ID` and `FISHJAM_MANAGEMENT_TOKEN` environment variables. +The `Depends` function allows the `FishjamClient` to be provided to the route function as a dependency, which avoids code duplication and allows easy mocking. + +```python +import os +from typing import Annotated +from fastapi import Depends, FastAPI +from fishjam import FishjamClient + + +app = FastAPI() + +def fishjam_client(): + fishjam_id = os.environ["FISHJAM_ID"] + management_token = os.environ["FISHJAM_MANAGEMENT_TOKEN"] + return FishjamClient(fishjam_id=fishjam_id, management_token=management_token) + + +@app.get("/") +async def get_rooms(fishjam_client: Annotated[FishjamClient, Depends(fishjam_client)]): + rooms = fishjam_client.get_all_rooms() + return {"rooms": rooms} +``` + +## Listening to events + +Fishjam instance is a stateful server that is emitting messages upon certain events. +You can listen for those messages and react as you prefer. +There are two options for obtaining these. + +### Webhooks + +To receive and parse Fishjam protobuf messages, create a dependable function that parses the request body using the `receive_binary` function from the `fishjam` package. +Then, you will be able to use pattern matching to respond to different kinds of events. + +```python +from fastapi import Depends, FastAPI, HTTPException, Request +from fishjam import receive_binary +from fishjam.events import ServerMessagePeerAdded + +app = FastAPI() + +async def parse_fishjam_message(request: Request): + binary = await request.body() + if message := receive_binary(binary): + return message + raise HTTPException(status_code=400, detail="Invalid Fishjam message") + +@app.post("/fishjam-webhook") +async def fishjam_webhook(fishjam_message = Depends(parse_fishjam_message)): + match fishjam_message: + case ServerMessagePeerAdded(): + print(f"Peer added: {fishjam_message.peer_id}") + case _: + ... +``` + +### SDK Notifier + +Use the `asyncio` library to run the SDK notifier. +It doesn't interact with the FastAPI library per se, just start the event loop and it will run alongside the server. + +```python +import asyncio +from fishjam import FishjamNotifier + +notifier = FishjamNotifier(server_address=fishjam_id, server_api_token=management_token) + +@notifier.on_server_notification +def handle_notification(notification): + match notification: + case ServerMessagePeerAdded(): + print(f"Peer added: {notification.peer_id}") + case _: + ... + +async def run_notifier(): + notifier_task = asyncio.create_task(notifier.connect()) + + # Wait for the notifier to be ready to receive messages + await notifier.wait_ready() + + await notifier_task + +asyncio.run(run_notifier()) +``` diff --git a/versioned_docs/version-0.27.0/how-to/backend/fastify-example.mdx b/versioned_docs/version-0.27.0/how-to/backend/fastify-example.mdx new file mode 100644 index 00000000..5a2dc44a --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/backend/fastify-example.mdx @@ -0,0 +1,240 @@ +--- +sidebar_position: 1 +title: Fastify +description: Example Fastify server integration using the Fishjam Node.js SDK. +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Fastify example + +The example assumes you've already installed [**our SDK**](https://www.npmjs.com/package/@fishjam-cloud/js-server-sdk) and you're ready to go. +If you wish to see more general info, visit [**set up your server**](../../how-to/backend/server-setup) article. + +## Load environment variables to Fastify + +Use [`@fastify/env` package](https://github.com/fastify/fastify-env) to load and set environment variables in your Fastify instance. + +```ts title='main.ts' +import Fastify from "fastify"; +import fastifyEnv from "@fastify/env"; + +const fastify = Fastify(); + +const envSchema = { + type: "object", + required: ["FISHJAM_ID", "FISHJAM_MANAGEMENT_TOKEN"], + properties: { + FISHJAM_ID: { + type: "string", + }, + FISHJAM_MANAGEMENT_TOKEN: { + type: "string", + }, + }, +}; + +await fastify.register(fastifyEnv, { schema: envSchema }); + +fastify.listen({ port: 3000 }); +``` + +## Setup Fishjam Fastify plugin + +Fastify allows you to create plugins to encapsulate functionality in scopes. +Check out [fastify documentation](https://fastify.dev/docs/latest/Reference/Plugins) for a deeper understanding of the concept. + +First, extend the `FastifyInstance` interface with `fishjam` entry. +This will provide types of FishjamClient wherever you access `fastify.fishjam` in the codebase. +Then, declare the plugin by invoking the `fp` function with the setup function with as an argument. + +```ts title='fishjamPlugin.ts' +import fastifyPlugin from "fastify-plugin"; +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; + +declare module "fastify" { + interface FastifyInstance { + fishjam: FishjamClient; + config: { + FISHJAM_ID: string; + FISHJAM_MANAGEMENT_TOKEN: string; + }; + } +} + +export const fishjamPlugin = fastifyPlugin((fastify) => { + const fishjamClient = new FishjamClient({ + fishjamId: fastify.config.FISHJAM_ID, + managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN, + }); + + fastify.decorate("fishjam", fishjamClient); +}); +``` + +Now, after registering the plugin, we will be able to use Fishjam client by accessing the `fastify.fishjam` property. + +```ts title='main.ts' +import fastifyPlugin from "fastify-plugin"; +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; +import Fastify from "fastify"; + +declare module "fastify" { + interface FastifyInstance { + fishjam: FishjamClient; + config: { + FISHJAM_ID: string; + FISHJAM_MANAGEMENT_TOKEN: string; + }; + } +} + +export const fishjamPlugin = fastifyPlugin((fastify) => { + const fishjamClient = new FishjamClient({ + fishjamId: fastify.config.FISHJAM_ID, + managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN, + }); + + fastify.decorate("fishjam", fishjamClient); +}); + +const fastify = Fastify(); + +// ---cut--- +await fastify.register(fishjamPlugin); + +fastify.get("/rooms", () => fastify.fishjam.getAllRooms()); + +fastify.listen({ port: 3000 }); +``` + +## Listening to events + +Fishjam instance is a stateful server that is emitting messages upon certain events. +You can listen for those messages and react as you prefer. +There are two options to obtain these. + +### Webhooks + +To receive and parse the Fishjam protobuf messages, add a content type parser to your global (or scoped) Fastify instance. +Then, you will be able to access the parsed message at `request.Body`. + +```ts title='main.ts' +import Fastify, { FastifyRequest } from "fastify"; +import { ServerMessage } from "@fishjam-cloud/js-server-sdk"; + +const fastify = Fastify(); + +fastify.addContentTypeParser( + "application/x-protobuf", + { parseAs: "buffer" }, + async (_: FastifyRequest, body: Buffer) => + ServerMessage.decode(new Uint8Array(body)), +); + +fastify.post<{ Body: ServerMessage }>("/fishjam-webhook", (request) => { + // handle the message + console.log(request.body); +}); +``` + +### SDK Notifier + +You can also leverage the Fastify plugin mechanism to use websockets to receive messages from Fishjam. +Let's create another plugin in `fishjamNotifierPlugin.ts` file. + +In this case, we don't need to extend the Fastify instance type, because the plugin doesn't decorate the Fastify instance with any properties. It will work in the background. + +```ts title='fishjamNotifierPlugin.ts' +import fastifyPlugin from "fastify-plugin"; +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; +import Fastify from "fastify"; + +declare module "fastify" { + interface FastifyInstance { + fishjam: FishjamClient; + config: { + FISHJAM_ID: string; + FISHJAM_MANAGEMENT_TOKEN: string; + }; + } +} + +export const fishjamPlugin = fastifyPlugin((fastify) => { + const fishjamClient = new FishjamClient({ + fishjamId: fastify.config.FISHJAM_ID, + managementToken: fastify.config.FISHJAM_MANAGEMENT_TOKEN, + }); + + fastify.decorate("fishjam", fishjamClient); +}); + +const fastify = Fastify(); + +// ---cut--- +import { type FastifyInstance } from "fastify"; +import fp from "fastify-plugin"; +import { FishjamWSNotifier } from "@fishjam-cloud/js-server-sdk"; + +export const fishjamNotifierPlugin = fp((fastify) => { + const fishjamId = fastify.config.FISHJAM_ID; + const managementToken = fastify.config.FISHJAM_MANAGEMENT_TOKEN; + + const fishjamNotifier = new FishjamWSNotifier( + { fishjamId, managementToken }, + (err) => fastify.log.error(err), + () => fastify.log.info("Websocket connection to Fishjam closed"), + ); + + // handle the messages + const handleRoomCreated = console.log; + const handlePeerAdded = console.log; + + fishjamNotifier.on("roomCreated", handleRoomCreated); + fishjamNotifier.on("peerAdded", handlePeerAdded); +}); +``` + +Don't forget to register your plugin. + +```ts title='main.ts' +import fastifyPlugin from "fastify-plugin"; +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; +import Fastify from "fastify"; +import { FishjamWSNotifier } from "@fishjam-cloud/js-server-sdk"; + +declare module "fastify" { + interface FastifyInstance { + fishjam: FishjamClient; + config: { + FISHJAM_ID: string; + FISHJAM_MANAGEMENT_TOKEN: string; + }; + } +} + +export const fishjamPlugin = fastifyPlugin((fastify) => { + const fishjamClient = new FishjamClient({ + fishjamId: "aaa", + managementToken: "bbb", + }); + + fastify.decorate("fishjam", fishjamClient); +}); + +const fastify = Fastify(); + +const fishjamNotifierPlugin = fastifyPlugin((fastify) => { + const fishjamNotifier = new FishjamWSNotifier( + { fishjamId: "aaa", managementToken: "bbb" }, + (err) => fastify.log.error(err), + (_code, _reason) => + fastify.log.info("Websocket connection to Fishjam closed"), + ); +}); + +// ---cut--- +await fastify.register(fishjamPlugin); +await fastify.register(fishjamNotifierPlugin); +``` diff --git a/versioned_docs/version-0.27.0/how-to/backend/production-deployment.mdx b/versioned_docs/version-0.27.0/how-to/backend/production-deployment.mdx new file mode 100644 index 00000000..645aff77 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/backend/production-deployment.mdx @@ -0,0 +1,301 @@ +--- +type: how-to +description: Deploy your Fishjam backend safely to production, moving from sandbox to a production-ready setup. +--- + +import TabItem from "@theme/TabItem"; +import Tabs from "@theme/Tabs"; + +# How to Deploy Fishjam to Production + +**How-to Guide** - _Deploy your Fishjam backend safely to production_ + +This guide covers the essential steps to move from development (using the Sandbox API) to a production-ready Fishjam backend deployment. + +## Prerequisites + +- Working Fishjam backend (see [Backend Quick Start](../../tutorials/backend-quick-start)) +- A Fishjam account on the **Standard Jar** plan (recommended for production deployments) +- Domain and SSL certificates for your backend +- Production database and infrastructure + +## Step 1: Get your Fishjam credentials + +### Get credentials from the dashboard + +1. Log in to [Fishjam Dashboard](https://fishjam.io/app) +2. Copy your **Fishjam ID** and **Management Token** from the dashboard + +:::tip +The **Standard Jar** plan is recommended for production deployments. With the **Mini Jar** plan, you can still develop and test using the Sandbox API, but production deployments should use the Standard Jar plan to get full access and reliability guarantees. +::: + +### Environment variables setup + +Create your environment variables: + +```bash +# Fishjam credentials +FISHJAM_ID="your-fishjam-id" +FISHJAM_MANAGEMENT_TOKEN="your-management-token" + +# Your application settings +NODE_ENV="production" +PORT="3000" +DATABASE_URL="your-production-database-url" + +# Security settings +JWT_SECRET="your-secure-jwt-secret" +CORS_ORIGIN="https://yourdomain.com" +``` + +## Step 2: Replace Sandbox API with proper authentication + +### Replace Sandbox API calls + +Remove any Sandbox API dependencies from your client code: + +```typescript +// @noErrors: 2451 +import { useSandbox } from "@fishjam-cloud/react-client"; +import express from "express"; + +const authenticateUser = {} as any; +const app = express(); + +const sandboxApiUrl = "your-sandbox-api-url-here"; +const { getSandboxPeerToken } = useSandbox({ sandboxApiUrl }); + +const userToken = ""; +const roomName = ""; +const userName = ""; + +// ---cut--- +// ❌ Remove: Sandbox API calls +const peerToken = await getSandboxPeerToken(roomName, userName); + +// ✅ Replace with: Your authenticated API +const response = await fetch("https://your-backend.com/api/join-room", { + method: "POST", + headers: { + "Content-Type": "application/json", + Authorization: `Bearer ${userToken}`, + }, + body: JSON.stringify({ roomName, userName }), +}); +``` + +### Implement user authentication + +```typescript +// @noErrors: 2339 +const jwt = {} as any; +import { FishjamClient, Room } from "@fishjam-cloud/js-server-sdk"; +import express from "express"; + +const app = express(); +const getUserById = async (userId: string) => ({ + id: userId, + name: "User", + avatar: "", + role: "user", +}); +const getOrCreateRoom = async (roomName: string) => + ({ id: "room-id" }) as unknown as Room; +const canUserJoinRoom = (user: any, room: any) => true; +process.env.FISHJAM_ID = ""; +process.env.FISHJAM_MANAGEMENT_TOKEN = ""; +process.env.JWT_SECRET = ""; + +// ---cut--- +const fishjamClient = new FishjamClient({ + fishjamId: process.env.FISHJAM_ID!, + managementToken: process.env.FISHJAM_MANAGEMENT_TOKEN!, +}); + +// Authentication middleware +const authenticateUser = async ( + req: express.Request, + res: express.Response, + next: express.NextFunction, +) => { + try { + const token = req.headers.authorization?.replace("Bearer ", ""); + if (!token) { + return res.status(401).json({ error: "Authentication required" }); + } + + const decoded = jwt.verify(token, process.env.JWT_SECRET); + req.user = await getUserById(decoded.userId); + next(); + } catch (error) { + res.status(401).json({ error: "Invalid token" }); + } +}; + +// Protected endpoint for joining rooms +app.post("/api/join-room", authenticateUser, async (req, res) => { + try { + const { roomName } = req.body; + const user = req.user; + + // Create or get room + const room = await getOrCreateRoom(roomName); + + // Verify user has permission to join this room + if (!canUserJoinRoom(user, room)) { + return res.status(403).json({ error: "Access denied" }); + } + + // Create peer with user metadata + const { peer, peerToken } = await fishjamClient.createPeer(room.id, { + metadata: { + userId: user.id, + name: user.name, + avatar: user.avatar, + role: user.role, + }, + }); + + res.json({ peerToken }); + } catch (error) { + console.error("Join room error:", error); + res.status(500).json({ error: "Failed to join room" }); + } +}); +``` + +## (Optional) Step 3: Handle webhooks and events + +You may wish to receive events from Fishjam regarding created rooms and peers. +All you need for this is a single api endpoint: + +### Webhook endpoint + +```typescript +import express from "express"; +const crypto = {} as any; +const app = express(); + +const handlePeerConnected = {} as any; +const handlePeerDisconnected = {} as any; +const handleRoomEmpty = {} as any; + +// ---cut--- +// Webhook signature verification +const verifyWebhookSignature = ( + req: express.Request, + res: express.Response, + next: express.NextFunction, +) => { + const signature = req.headers["x-fishjam-signature"]; + const payload = JSON.stringify(req.body); + + const expectedSignature = crypto + .createHmac("sha256", process.env.WEBHOOK_SECRET) + .update(payload, "utf8") + .digest("hex"); + + if (signature !== expectedSignature) { + return res.status(401).json({ error: "Invalid signature" }); + } + + next(); +}; + +// Webhook handler +app.post( + "/api/webhooks/fishjam", + express.raw({ type: "application/json" }), + verifyWebhookSignature, + (req: express.Request, res: express.Response) => { + const event = req.body; + + switch (event.type) { + case "peer_connected": + handlePeerConnected(event.data); + break; + case "peer_disconnected": + handlePeerDisconnected(event.data); + break; + case "room_empty": + handleRoomEmpty(event.data); + break; + default: + console.log("Unhandled event type:", event.type); + } + + res.status(200).json({ received: true }); + }, +); +``` + +### Enabling webhooks + +Now, with your endpoint setup, all you need to do is supply your webhook endpoint to Fishjam when creating a room: + +```typescript +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; +const fishjamClient = {} as any; + +// ---cut--- +const createRoomWithWebhooks = async ( + roomName: string, + roomType = "conference", +) => { + const room = await fishjamClient.createRoom({ + roomType, + webhookUrl: `${process.env.BASE_URL}/api/webhooks/fishjam`, + }); + + return room; +}; +``` + +## Common production issues + +### Issue: Token expiration handling + +Peer tokens expire 24h after creation. +We encourage keeping room and peer lifetimes as short as possible +(typically a single room corresponds to a single video call or stream). +However, if you wish to reuse a single peer over multiple days, you can make use of token refreshing: + + + + + ```ts + import { FishjamClient, RoomId, PeerId } from "@fishjam-cloud/js-server-sdk"; + const fishjamClient = new FishjamClient({ + fishjamId: "", + managementToken: "", + }); + const roomId = "" as RoomId; + const peerId = "" as PeerId; + + // ---cut--- + const newToken = fishjamClient.refreshPeerToken(roomId, peerId); + ``` + + + + + + ```python + new_token = fishjam_client.refresh_peer_token(room_id, peer_id) + ``` + + + + +## See also + +For scaling considerations: + +- [Understanding Fishjam Architecture](../../explanation/architecture) +- [Security best practices](../../explanation/security-tokens) + +For specific backend frameworks: + +- [FastAPI example](../../how-to/backend/fastapi-example) +- [Fastify example](../../how-to/backend/fastify-example) diff --git a/versioned_docs/version-0.27.0/how-to/backend/sandbox-api-testing.mdx b/versioned_docs/version-0.27.0/how-to/backend/sandbox-api-testing.mdx new file mode 100644 index 00000000..69101006 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/backend/sandbox-api-testing.mdx @@ -0,0 +1,333 @@ +--- +sidebar_position: 5 +description: Use the Sandbox API to create rooms and peers for testing without setting up your own backend server. +--- + +import TabItem from "@theme/TabItem"; +import Tabs from "@theme/Tabs"; + +# Testing with the Sandbox API + +The Sandbox API is a development tool that lets you create rooms and peers for testing without setting up your own backend server. This guide shows you how to use it effectively. + +## Prerequisites + +- Access to [Fishjam Dashboard](https://fishjam.io/app) + +## Step 1: Get your Fishjam ID and Sandbox API URL + +1. Log in to [Fishjam Dashboard](https://fishjam.io/app) +2. Navigate to the [Sandbox tab](https://fishjam.io/app/sandbox) +3. Copy your **Fishjam ID** +4. In the **Sandbox API** section, copy your **Sandbox API URL** + +:::note +You need both values for React/React Native apps: + +- `Sandbox API url` is used to call the Sandbox API to create test rooms and return peer tokens. +- `Fishjam ID` is passed to `FishjamProvider` so the client can connect to the Fishjam media server after it gets a peer token. + +::: + +## Step 2: Create a room and get peer tokens + +### With the `useSandbox` hook + + + + + ```ts + const FISHJAM_ID = "..."; + const roomName = "testRoom"; + const peerName = "testUser"; + // ---cut--- + import { useSandbox } from '@fishjam-cloud/react-native-client'; + + // ... + + const SANDBOX_API_URL = "your-sandbox-api-url-here"; + const { getSandboxPeerToken } = useSandbox({ sandboxApiUrl: SANDBOX_API_URL }); + const peerToken = await getSandboxPeerToken(roomName, peerName); + ``` + + + + + + ```ts + const roomName = "testRoom"; + const peerName = "testUser"; + // ---cut--- + import { useSandbox } from '@fishjam-cloud/react-client'; + + // ... + + const SANDBOX_API_URL = "your-sandbox-api-url-here"; + const { getSandboxPeerToken } = useSandbox({ sandboxApiUrl: SANDBOX_API_URL }); + const peerToken = await getSandboxPeerToken(roomName, peerName); + ``` + + + + +### Required parameters + +- `roomName` - Name of the room to create/join +- `peerName` - Name for the peer joining the room + +### Optional parameters + +- `roomType` - Type of room to create (defaults to `conference`) + +### Room types available + +- `conference` - For video/audio conferencing (default) +- `audio_only` - For audio-only conferencing +- `livestream` - For one-to-many video/audio streaming + +## Step 3: Handle the response + +The Sandbox API returns a JSON response with connection details: + +```json +{ + "peerToken": "", + "room": { + "id": "", + "name": "foo" + }, + "peer": { + "id": "", + "name": "bar" + } +} +``` + +## Step 4: Use the tokens in your client app + +Below are examples on how to use tokens from the Sandbox API in your frontend applications: + + + + + ```tsx + import React, { useEffect, useState } from "react"; + import { Text } from "react-native"; + + const roomName = "testRoom"; + const peerName = `user_${Date.now()}`; + const FISHJAM_ID = "..."; + const SANDBOX_API_URL = "..."; + + const RoomView = (props: {peerToken: string}) => null; + // ---cut--- + import { useSandbox } from "@fishjam-cloud/react-native-client"; + + export default function TestScreen() { + const [peerToken, setPeerToken] = useState(null); + // fishjamId is provided through FishjamProvider + const { getSandboxPeerToken } = useSandbox({ sandboxApiUrl: SANDBOX_API_URL }); + + useEffect(() => { + const fetchPeerToken = async () => { + try { + const token = await getSandboxPeerToken(roomName, peerName); + setPeerToken(token); + } catch (error) { + console.error("Failed to create room:", error); + } + }; + + fetchPeerToken(); + }, []); + + if (!peerToken) { + return Creating room...; + } + + return ( + + ); + } + ``` + + + + + + ```tsx + import React, { useState, useEffect } from "react"; + + const FISHJAM_ID = "your-fishjam-id-here"; + const SANDBOX_API_URL = "your-sandbox-api-url-here"; + // ---cut--- + import { FishjamProvider, useConnection, useSandbox } from "@fishjam-cloud/react-client"; + + function VideoCallComponent() { + const { joinRoom, peerStatus } = useConnection(); + const { getSandboxPeerToken } = useSandbox({ sandboxApiUrl: SANDBOX_API_URL }); + + const handleJoinRoom = async () => { + const roomName = "testRoom"; + const peerName = `user_${Date.now()}`; + + try { + const peerToken = await getSandboxPeerToken(roomName, peerName) + await joinRoom({ peerToken }); + } catch (error) { + console.error("Failed to join room:", error); + } + }; + + const isConnected = peerStatus === "connected"; + + return ( +
+ {isConnected ?

Connected to room!

: } +
+ ); + } + + export default function App() { + return ( + + + + ); + } + ``` + + + + +## Step 5: Test different room types + +### Testing audio-only rooms + +```ts +import { useSandbox } from "@fishjam-cloud/react-client"; +const SANDBOX_API_URL = "your-sandbox-api-url-here"; +const { getSandboxPeerToken } = useSandbox({ sandboxApiUrl: SANDBOX_API_URL }); +// ---cut--- +const audioOnlyPeerToken = await getSandboxPeerToken( + "audioTest", + "user1", + "audio_only", +); +``` + +### Testing livestream rooms + +```ts +import { useSandbox } from "@fishjam-cloud/react-client"; +const SANDBOX_API_URL = "your-sandbox-api-url-here"; +const { getSandboxLivestream, getSandboxViewerToken } = useSandbox({ + sandboxApiUrl: SANDBOX_API_URL, +}); +// ---cut--- + +const livestreamName = "livestream1"; +// For the streamer +const streamerData = await getSandboxLivestream(livestreamName); + +// For viewers, you need a viewer token (different endpoint) +const viewerToken = await getSandboxViewerToken(livestreamName); +``` + +## Step 6: Handle multiple peers + +To test with multiple participants, create multiple peer tokens with different peer names: + +```ts +import { useSandbox } from "@fishjam-cloud/react-client"; +const SANDBOX_API_URL = "your-sandbox-api-url-here"; +const { getSandboxPeerToken } = useSandbox({ sandboxApiUrl: SANDBOX_API_URL }); +// ---cut--- +// First peer +const peer1Response = await getSandboxPeerToken("multiTest", "alice"); + +// Second peer +const peer2Response = await getSandboxPeerToken("multiTest", "bob"); +``` + +Both peers will join the same room (`multiTest`) and can communicate with each other. + +## Common testing patterns + +### Pattern 1: Random room names for isolation + +```ts +const roomName = `test_${Math.random().toString(36).substring(7)}`; +const peerName = `user_${Date.now()}`; +``` + +### Pattern 2: Consistent naming for repeated tests + +```ts +// @noErrors: 2451 +const roomName = "development-room"; +const peerName = `developer_1`; +``` + +### Pattern 3: Feature-specific room names + +```ts +// @noErrors: 2451 +const roomName = `screenshare-test-${Date.now()}`; +const roomName = `audio-only-test`; +const roomName = `livestream-demo`; +``` + +## Troubleshooting + +### Issue: Room not found errors + +**Problem**: Rooms might not persist between requests. + +**Solution**: Always create rooms fresh for each test session. + +### Issue: Connection failures + +**Problem**: Invalid Fishjam ID, invalid Sandbox API URL, disabled Sandbox API, or network issues. + +**Solution**: + +1. Verify your Fishjam ID in the Fishjam Dashboard. +2. Verify your Sandbox API URL in the [Sandbox tab](https://fishjam.io/app/sandbox). +3. Make sure the Sandbox API is enabled. +4. Check network connectivity. + +## Security reminder + +:::danger +**The Sandbox API is not safe for production!** + +- No authentication required +- Anyone with your Sandbox API URL can create rooms and peer tokens +- Identical room/peer names get the same tokens +- No rate limiting or abuse protection + +Only use the Sandbox API for development and testing. +::: + +## Managing your Sandbox API + +Manage the Sandbox API from the [Sandbox tab](https://fishjam.io/app/sandbox): + +- If your Sandbox API URL is exposed or credentials are compromised, click **Generate new URL**. This invalidates the old URL. +- If you want to stop using it, click **Disable Sandbox API**. +- When you want to use it again, click **Enable Sandbox API**. + Your `FISHJAM_ID` is still required by `FishjamProvider` to connect to the Fishjam media server. The Sandbox API URL is only used to request test room and peer tokens. + +## Next steps + +Once you've tested your integration with the Sandbox API: + +- [Set up your own backend](../../tutorials/backend-quick-start) +- [Learn more about the Sandbox API](../../explanation/sandbox-api-concept) +- [Understand security implications](../../explanation/security-tokens) + +For production deployment: + +- [How to set up a production server](./server-setup) +- [How to implement proper authentication](../../explanation/security-tokens) diff --git a/versioned_docs/version-0.27.0/how-to/backend/selective-subscriptions.mdx b/versioned_docs/version-0.27.0/how-to/backend/selective-subscriptions.mdx new file mode 100644 index 00000000..8cbbc386 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/backend/selective-subscriptions.mdx @@ -0,0 +1,331 @@ +--- +title: Selective Subscriptions +sidebar_position: 7 +description: Configure manual subscription mode so your backend controls which peers receive which streams. +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Selective Subscriptions + +In Fishjam, peers in a conferencing room automatically subscribe to every other peer by default. +Selective Subscriptions let you break from that — giving your backend the ability to decide who receives what. + +In **manual subscription mode**, a peer or agent: + +- does not automatically receive **any tracks**, and +- can **explicitly subscribe** to specific tracks from other peers. + +## When to use Selective Subscriptions + +- large-scale rooms with dozens or hundreds of peers, +- “stage & audience” models (viewers only see speakers), +- bandwidth optimization (e.g., audio-only dashboards, or delayed video activation). + +--- + +## Core idea + +- Peers have a `subscribeMode` — either **`auto`** or **`manual`**. +- Peers in **auto** mode subscribe to everyone automatically (default behavior). +- Peers in **manual** mode will **not** receive any media until you explicitly subscribe them using the **Server SDK**. +- Peers in manual mode can subscribe to: + - another **peer** (all of its tracks), or + - specific **tracks** of another peer. + +--- + +## Step 1 — Create a peer with `manual` subscription mode + +When creating a peer, set `subscribeMode` to `"manual"`. +This peer will start with zero subscriptions — it will not receive anyone’s audio or video. + + + + +```ts +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; + +const fishjamClient = new FishjamClient({ + fishjamId: process.env.FISHJAM_ID!, + managementToken: process.env.MANAGEMENT_TOKEN!, +}); + +// ---cut--- + +// Create a conference room +const room = await fishjamClient.createRoom({ + roomType: "conference", +}); + +// Create a normal publisher +const { peer: publisher } = await fishjamClient.createPeer(room.id, { + subscribeMode: "auto", +}); + +// Create a manual subscriber +const { peer: viewer } = await fishjamClient.createPeer(room.id, { + subscribeMode: "manual", +}); +``` + + + + +from fishjam import RoomOptions, PeerOptions + +```python +room_options = RoomOptions(room_type="conference") +room = fishjam_client.create_room(room_options) + +# Create a manual subscriber +peer_options = PeerOptions(subscribe_mode="manual") +publisher = fishjam_client.create_peer(room.id, peer_options) +viewer = fishjam_client.create_peer(room.id, peer_options) + +``` + + + + +--- + +## Step 2 — Subscribe a peer to another peer + +Use this when you want your manual subscriber to receive **all tracks** published by another peer. + + + + +```ts +import { FishjamClient } from "@fishjam-cloud/js-server-sdk"; +const fishjamClient = new FishjamClient({ + fishjamId: process.env.FISHJAM_ID!, + managementToken: process.env.MANAGEMENT_TOKEN!, +}); + +const room = await fishjamClient.createRoom({ + roomType: "conference", +}); + +const { peer: publisher } = await fishjamClient.createPeer(room.id, { + subscribeMode: "auto", +}); + +const { peer: subscriber } = await fishjamClient.createPeer(room.id, { + subscribeMode: "manual", +}); + +// ---cut--- +// Subscribe viewer to everything published by publisher +await fishjamClient.subscribePeer(room.id, subscriber.id, publisher.id); +``` + + + + + +```python +fishjam_client.subscribe_peer(room.id, viewer_id, publisher_id) +``` + + + + +This will make **every current and future track** of the publisher available to the subscriber. +It’s additive — the subscriber can listen to multiple publishers at once. + +--- + +## Step 3 — Subscribe to specific tracks + +Sometimes you only want a subset of a publisher’s tracks, for example: + +- their **screenshare**, but not their camera, +- only **audio**, without video. + + + + +```ts +import { FishjamClient, type TrackId } from "@fishjam-cloud/js-server-sdk"; +const fishjamClient = new FishjamClient({ + fishjamId: process.env.FISHJAM_ID!, + managementToken: process.env.MANAGEMENT_TOKEN!, +}); + +const room = await fishjamClient.createRoom({ + roomType: "conference", +}); + +const { peer: publisher } = await fishjamClient.createPeer(room.id, { + subscribeMode: "auto", +}); + +const { peer: subscriber } = await fishjamClient.createPeer(room.id, { + subscribeMode: "manual", +}); + +// ---cut--- +// Get track IDs from your room state or webhook events +const audioTrackId = "track_audio_abc" as TrackId; +const screenTrackId = "track_screen_xyz" as TrackId; + +// Subscribe to a single track +await fishjamClient.subscribeTracks(room.id, subscriber.id, [audioTrackId]); + +// Or multiple +await fishjamClient.subscribeTracks(room.id, subscriber.id, [ + audioTrackId, + screenTrackId, +]); +``` + + + + + +```python +audio_track_id = "track_audio_abc" +screen_track_id = "track_screen_xyz" + +# Subscribe to one track +fishjam_client.subscribe_tracks(room.id, subscriber_id, [audio_track_id]) + +# Or multiple +fishjam_client.subscribe_tracks(room.id, subscriber_id, [audio_track_id, screen_track_id]) +``` + + + + +:::note +📘 Track IDs are available from [Fishjam’s events in your backend](/how-to/backend/server-setup#listening-to-events). +::: + +--- + +## Step 4 — Combine multiple publishers + +A manual peer can subscribe to **several** publishers at once. +Each call to `subscribePeer` adds more publishers — it doesn’t overwrite the previous ones. + + + + +```ts +import { FishjamClient, type PeerOptions } from "@fishjam-cloud/js-server-sdk"; +const fishjamClient = new FishjamClient({ + fishjamId: process.env.FISHJAM_ID!, + managementToken: process.env.MANAGEMENT_TOKEN!, +}); + +const room = await fishjamClient.createRoom({ + roomType: "conference", +}); + +// ---cut--- +const options = { subscribeMode: "manual" } satisfies PeerOptions; + +const { peer: subscriber } = await fishjamClient.createPeer(room.id, options); +const { peer: publisherA } = await fishjamClient.createPeer(room.id, options); +const { peer: publisherB } = await fishjamClient.createPeer(room.id, options); + +// Subscribe subscriber to two publishers +await fishjamClient.subscribePeer(room.id, subscriber.id, publisherA.id); +await fishjamClient.subscribePeer(room.id, subscriber.id, publisherB.id); +``` + + + + + +```python +fishjam_client.subscribe_peer(room.id, subscriber_id, publisher_a_id) +fishjam_client.subscribe_peer(room.id, subscriber_id, publisher_b_id) +``` + + + + +The subscriber now receives tracks from **both** publishers simultaneously. + +--- + +## Step 5 — Example: curated stage & audience + +You can implement a “stage” system where: + +- speakers are in auto mode (they see/hear each other), +- audience members are manual subscribers (they only see the stage). + + + + +```ts +import { FishjamClient, type Peer } from "@fishjam-cloud/js-server-sdk"; + +const fishjamClient = new FishjamClient({ + fishjamId: process.env.FISHJAM_ID!, + managementToken: process.env.MANAGEMENT_TOKEN!, +}); + +const room = await fishjamClient.createRoom({ + roomType: "conference", +}); + +const { peer: publisher } = await fishjamClient.createPeer(room.id, { + subscribeMode: "auto", +}); + +// ---cut--- + +// fetch room to get actual list of peers +const fetchedRoom = await fishjamClient.getRoom(room.id); +const currentSpeakers = fetchedRoom.peers; + +// audience joins in manual mode +const { peer: audience } = await fishjamClient.createPeer(room.id, { + subscribeMode: "manual", +}); + +// subscribe them to all current speakers +await Promise.all( + currentSpeakers.map((speaker) => + fishjamClient.subscribePeer(room.id, audience.id, speaker.id), + ), +); +``` + + + + + +```python + +audience = fishjam_client.create_peer(room.id, PeerOptions(subscribe_mode="manual")) +current_speakers = fishjam_client.get_room(room.id).peers +# audience peer already exists (manual) +for speaker in current_speakers: + fishjam_client.subscribe_peer(room.id, audience.id, speaker.id) +``` + + + + +As new speakers join, simply call `subscribe_peer` again to add them to the audience’s feed. + +--- + +:::note +Unsubscribe support is not yet implemented (for now, just remove peer sessions when needed). +::: + +## See also + +- [Rooms](../../explanation/rooms) +- [React quick start](../../tutorials/react-quick-start) +- [React Native quick start](../../tutorials/react-native-quick-start) + +> 🗒️ For server-side recording or media processing, see [Agents](../../tutorials/agents.mdx) (documented separately). diff --git a/versioned_docs/version-0.27.0/how-to/backend/server-setup.mdx b/versioned_docs/version-0.27.0/how-to/backend/server-setup.mdx new file mode 100644 index 00000000..8d303cba --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/backend/server-setup.mdx @@ -0,0 +1,303 @@ +--- +sidebar_position: 0 +description: Install and configure a Fishjam server SDK for Node.js or Python, or integrate via the bare REST API. +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Set up your server + +## Install the SDK + +Install the SDK for the language of your choice. We provide libraries for [**Node**](https://github.com/fishjam-cloud/js-server-sdk) and [**Python**](https://github.com/fishjam-cloud/python-server-sdk). +It's also possible to use the bare REST API, in this case you can skip this step. + + + + + ```bash + npm install @fishjam-cloud/js-server-sdk + ``` + + + + + + ```bash + yarn add @fishjam-cloud/js-server-sdk + ``` + + + + + + ```bash + pip install fishjam-server-sdk + ``` + + + + + + ```bash + poetry add fishjam-server-sdk + ``` + + + + + + ```bash + uv add fishjam-server-sdk + ``` + + + + +## Setup your client + +Let's setup everything you need to start communicating with a Fishjam instance. +First of all, view your app in the [**Fishjam developer panel**](https://fishjam.io/app) and copy your **Fishjam ID** and the **Management Token**. +They are required to proceed. Now, we are ready to dive into the code. + + + + + ```ts + process.env.FISHJAM_ID = "aaa"; + process.env.FISHJAM_MANAGEMENT_TOKEN = "bbb"; + + // ---cut--- + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamId = process.env.FISHJAM_ID; + const managementToken = process.env.FISHJAM_MANAGEMENT_TOKEN; + + const fishjamClient = new FishjamClient({ fishjamId, managementToken }); + ``` + + + + + + ```python + import os + from fishjam import FishjamClient + + fishjam_id = os.environ["FISHJAM_ID"] + management_token = os.environ["FISHJAM_MANAGEMENT_TOKEN"] + + fishjam_client = FishjamClient(fishjam_id, management_token) + ``` + + + + +### Managing rooms + +Create a room to get the `roomId` and be able to start adding peers. + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + const fishjamClient = new FishjamClient({ + + fishjamId: "https://fishjam.io", + managementToken: "bbb", + }); + // ---cut--- + const createdRoom = await fishjamClient.createRoom(); + + const theSameRoom = await fishjamClient.getRoom(createdRoom.id); + + await fishjamClient.deleteRoom(theSameRoom.id) + + // puff, it's gone! + ``` + + + + + + ```python + created_room = fishjam_client.create_room() + + the_same_room = fishjam_client.get_room(created_room.id) + + fishjam_client.delete_room(the_same_room.id) + + # puff, it's gone! + ``` + + + + + +### Managing peers + +Create a peer to obtain the peer token allowing your user to join the room. +At any time you can terminate user's access by deleting the peer. + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + const fishjamClient = new FishjamClient({ + fishjamId: "https://fishjam.io", + managementToken: "bbb", + }); + const created_room = await fishjamClient.createRoom(); + // ---cut--- + const { peer, peerToken } = await fishjamClient.createPeer(created_room.id); + + await fishjamClient.deletePeer(created_room.id, peer.id); + ``` + + + + + + ```python + peer, token = fishjam_client.create_peer(room_id) + + fishjam_client.delete_peer(room_id, peer.id) + ``` + + + + + +#### Metadata + +When creating a peer, you can also assign metadata to that peer, which can be read later with the [client SDK](../../how-to/client/metadata). This metadata can be only set when creating the peer and can't be updated later. + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + const fishjamClient = new FishjamClient({ + fishjamId: "https://fishjam.io", + managementToken: "bbb", + }); + const created_room = await fishjamClient.createRoom(); + // ---cut--- + const { peer, peerToken } = await fishjamClient.createPeer(created_room.id, { + metadata: { realName: 'Tom Reeves' }, + }); + ``` + + + + + + ```py + options = PeerOptions( + metadata={"realName": "Tom Reeves"}, + ) + peer, token = self.fishjam_client.create_peer(room_id, options=options) + ``` + + + + +## Listening to events + +Fishjam instance is a stateful server that is emitting messages upon certain events. +You can listen for those messages and react as you prefer. +There are two options to obtain these. + +### Webhooks + +Simply pass the your webhook url as a `webhookUrl` parameter when creating a room. + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamClient = new FishjamClient({ + fishjamId: "https://fishjam.io", + managementToken: "bbb", + }); + // ---cut--- + const webhookUrl = "https://example.com/"; + await fishjamClient.createRoom({ webhookUrl }); + ``` + + + + + + ```python + from fishjam import RoomOptions + + options = RoomOptions(webhook_url="https://example.com/") + + fishjam_client.create_room(options) + ``` + + + + + +### SDK Notifier + +Our SDKs come equipped with a Notifier allowing you to subscribe for messages. +It sets up a websocket connection with a Fishjam instance and provides a simple interface allowing you to handle messages. + + + + + ```ts + const fishjamId = "https://fishjam.io"; + const managementToken = "bbb"; + // ---cut--- + import { FishjamWSNotifier } from '@fishjam-cloud/js-server-sdk'; + + const onClose = console.log; + const onError = console.error; + const onConnectionFailed = console.error; + + const fishjamNotifier = new FishjamWSNotifier({ fishjamId, managementToken }, onError, onClose); + + fishjamNotifier.on('roomCreated', console.log); + ``` + + + + + + ```python + import asyncio + from fishjam import FishjamNotifier + + notifier = FishjamNotifier(fishjam_id, management_token) + + @notifier.on_server_notification + def handle_notification(notification): + match notification: + case ServerMessageRoomCreated(): + print(notification) + case _: + ... + + async def run_notifier(): + notifier_task = asyncio.create_task(notifier.connect()) + + # Wait for notifier to be ready to receive messages + await notifier.wait_ready() + + await notifier_task + + asyncio.run(run_notifier()) + ``` + + + + diff --git a/versioned_docs/version-0.27.0/how-to/backend/whip-whep.mdx b/versioned_docs/version-0.27.0/how-to/backend/whip-whep.mdx new file mode 100644 index 00000000..8c3ef4e4 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/backend/whip-whep.mdx @@ -0,0 +1,229 @@ +--- +title: WHIP/WHEP with Fishjam +sidebar_position: 8 +description: Publish and receive Fishjam livestreams directly using the WHIP and WHEP protocols. +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Livestreaming using WHIP/WHEP + +:::tip +Make sure to read [Livestreaming with Fishjam](../../tutorials/livestreaming) before reading this guide. +This guide focuses on a low-level way to communicate with Fishjam. + +The majority of use-cases should prefer to use the methods described in [Livestreaming with Fishjam](../../tutorials/livestreaming). +::: + +If you've reading this guide, it is more than likely that you've already heard of **WHIP** (WebRTC HTTP Ingress Protocol) and **WHEP** (WebRTC HTTP Egress Protocol). +If not, then we recommend to read our [article about WHIP/WHEP](https://blog.swmansion.com/building-interactive-streaming-apps-webrtc-whip-whep-explained-d38f4825ec90). +In short, these are two protocols which standardize real-time livestreaming. +This prevents vendor lock-in and allows implementations and solutions to be reused in different scenarios. + +Fishjam supports both WHIP and WHEP, so you can choose how to publish and receive streams. +For example, you can use [OBS Studio](https://obsproject.com/) to publish a livestream with WHIP and then receive the stream using any public online WHEP player you like. + +## WHIP with Fishjam + +WHIP is the protocol used by streamers to start publishing. +To use WHIP you need two things: + +1. The URL of an HTTP endpoint implementing the WHIP specification. +2. A token, used by the endpoint to authorize the streamer. + +### Getting the URL + +Fishjam's WHIP endpoint is available at + +```sh +https://fishjam.io/api/v1/live/api/whip +``` + +You can paste this URL in your WHIP client of choice to start streaming. + +### Getting the token + +To authenticate a streamer, you need to first create a room of type `livestream` and a streamer token for that room. +You can read about this in detail in [Production Livestreaming with Server SDKs](../../tutorials/livestreaming#production-livestreaming-with-server-sdks), but the TL;DR is + + + + + ```ts + const fishjamId = ""; + const managementToken = ""; + + // ---cut--- + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamClient = new FishjamClient({ + fishjamId, + managementToken, + }); + + const room = await fishjamClient.createRoom({ roomType: 'livestream' }); + const { token: streamerToken } = await fishjamClient.createLivestreamStreamerToken(room.id); // [!code highlight] + ``` + + + + + + ```python + from fishjam import FishjamClient + + fishjam_client = FishjamClient( + fishjam_id=fishjam_id, + management_token=management_token, + ); + + room = fishjam_client.create_room(room_type="livestream") + streamer_token = fishjam_client.create_livestream_streamer_token(room.id) # [!code highlight] + ``` + + + + +The created streamer token must be supplied in the HTTP headers of the WHIP request: + +```sh +POST https://fishjam.io/api/v1/live/api/whip +Authorization: Bearer [STREAMER-TOKEN] +``` + +## WHEP with Fishjam + +WHEP is the protocol used by viewers to start receiving a published livestream. +The usage of WHEP is very similar to WHIP, as you need the following: + +1. The URL of an HTTP endpoint implementing the WHEP specification. +2. **(Optional)** A token, used by the endpoint to authorize the viewer. + +With Fishjam, if the livestream is private, then the **token is required**. +On the other hand, if the livestream is public, then the **token is omitted**. + +[Livestreams](../../explanation/livestreams) explains private and public livestreams in more detail. +In this guide we demonstrate how to view each livestream type using WHEP directly. + +### Private livestreams + +#### Getting the URL + +For private livestreams, Fishjam's WHEP endpoint is available at + +```sh +https://fishjam.io/api/v1/live/api/whep +``` + +You can paste this URL in your WHEP client of choice to start viewing. + +#### Getting the token + +To authenticate a viewer, you need to create a viewer token for a room of `livestream` type. +You can read about this in detail in [Production Livestreaming with Server SDKs](../../tutorials/livestreaming#production-livestreaming-with-server-sdks), but the TL;DR is + + + + + ```ts + const fishjamId = ""; + const managementToken = ""; + + // ---cut--- + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamClient = new FishjamClient({ + fishjamId, + managementToken, + }); + + const room = await fishjamClient.createRoom({ roomType: 'livestream', public: false }); + + // ... + + const { token: viewerToken } = await fishjamClient.createLivestreamViewerToken(room.id); // [!code highlight] + ``` + + + + + + ```python + from fishjam import FishjamClient + + fishjam_client = FishjamClient( + fishjam_id=fishjam_id, + management_token=management_token, + ); + + room = fishjam_client.create_room(room_type="livestream", public=False) + + # ... + + viewer_token = fishjam_client.create_livestream_viewer_token(room.id) # [!code highlight] + ``` + + + + +The created viewer token must be supplied in the HTTP headers of the WHEP request: + +```sh +POST https://fishjam.io/api/v1/live/api/whep +Authorization: Bearer [VIEWER-TOKEN] +``` + +### Public livestreams + +For public livestreams, you don't need a token, however you still need a room of `livestream` type with the `public` flag enabled. + + + + + ```ts + import { FishjamClient } from '@fishjam-cloud/js-server-sdk'; + + const fishjamId = ""; + const managementToken = ""; + const fishjamClient = new FishjamClient({ + fishjamId, + managementToken, + }); + + // ---cut--- + const room = await fishjamClient.createRoom({ roomType: 'livestream', public: true }); + // now you can use room.id to start viewing + ``` + + + + + + ```python + room = fishjam_client.create_room(room_type="livestream", public=True) + # now you can use room.id to start viewing + ``` + + + + +Once you have such a room, you can view a stream published to that room by supplying the following URL: + +```sh +http://fishjam.io/api/v1/live/api/whep/[ROOM-ID] +``` + +## See also + +More on livestreaming: + +- [Livestreaming tutorial](../../tutorials/livestreaming) +- [Livestreams](../../explanation/livestreams) + +If livestreaming doesn't fit your use case: + +- [Rooms](../../explanation/rooms) +- [Videoconferencing in React Native](../../tutorials/react-native-quick-start) +- [Videoconferencing in React](../../tutorials/react-quick-start) +- [Audio-only calls](./audio-only-calls) diff --git a/versioned_docs/version-0.27.0/how-to/client/_category_.json b/versioned_docs/version-0.27.0/how-to/client/_category_.json new file mode 100644 index 00000000..ce35362b --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/client/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Web & Mobile", + "position": 1, + "link": { + "type": "generated-index", + "description": "Learn how to integrate Fishjam into your web and mobile applications." + } +} diff --git a/versioned_docs/version-0.27.0/how-to/client/background-streaming.mdx b/versioned_docs/version-0.27.0/how-to/client/background-streaming.mdx new file mode 100644 index 00000000..4845d7c7 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/client/background-streaming.mdx @@ -0,0 +1,229 @@ +--- +title: "Background calls" +sidebar_position: 13 +sidebar_label: "Background calls 📱" +description: Enable calls running in the background on Android and iOS in React Native applications. +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Background calls Mobile + +:::note +This guide is exclusively for **Mobile** (React Native) applications. +::: + +Both Android and iOS support calls running in the background, but they use different approaches: + +- **Android**: Uses foreground services to keep the app active in the background +- **iOS**: Uses CallKit integration to maintain VoIP calls in the background + +Below is configuration required to make it work: + + + + + +You need to modify `app.json` file and add our plugin: + +```json +{ + "expo": { + ... + "plugins": { + ... + [ + "@fishjam-cloud/react-native-client", + { + "android": { + "enableForegroundService": true + }, + "ios": { + "enableVoIPBackgroundMode": true + } + } + ], + ... + } + } +} +``` + + + + +**Android Configuration** + +Add the following permissions and services to `AndroidManifest.xml`: + +```xml title='AndroidManifest.xml' + + ... + + + + + + ... + + + + + +``` + +**iOS Configuration** + +You need to add VoIP background mode in `Info.plist`: + +```xml title='Info.plist' +UIBackgroundModes + + voip + +``` + + + + +## Usage + + + + + +You can use [`useForegroundService`](../../api/mobile/variables/useForegroundService) hook to handle how foreground service behaves on Android. + +:::important[Permissions] + +If you want to use [`enableCamera`](../../api/mobile/type-aliases/ForegroundServiceConfig#enablecamera) or [`enableMicrophone`](../../api/mobile/type-aliases/ForegroundServiceConfig#enablemicrophone), +user must first grant permission for this resource. [`useForegroundService`](../../api/mobile/variables/useForegroundService) will check if permission is +granted and only then allow to start a service. + +::: + +```tsx +import { + useForegroundService, + useCamera, + useMicrophone, +} from "@fishjam-cloud/react-native-client"; + +const { isCameraOn } = useCamera(); +const { isMicrophoneOn } = useMicrophone(); + +useForegroundService({ + // [!code highlight] + channelId: "io.fishjam.example.fishjamchat.foregroundservice.channel", + channelName: "Fishjam Chat Notifications", + notificationTitle: "Your video call is ongoing", + notificationContent: "Tap to return to the call.", + enableCamera: isCameraOn, + enableMicrophone: isMicrophoneOn, + // enableScreenSharing: true, +}); +``` + + + + +On iOS, background calls are achieved through CallKit integration. You can use the CallKit hooks to manage VoIP calls that continue running in the background. + +### Manual CallKit Management + +Use the [`useCallKit`](../../api/mobile/functions/useCallKit) hook for fine-grained control over CallKit sessions: + +```tsx +import { useCallKit } from "@fishjam-cloud/react-native-client"; + +const { startCallKitSession, endCallKitSession } = useCallKit(); + +// Start CallKit session when joining a room +const handleJoinRoom = async () => { + await startCallKitSession({ + displayName: "John Doe", + isVideo: true, + }); + // ... join room logic +}; + +// End CallKit session when leaving +const handleLeaveRoom = async () => { + await endCallKitSession(); + // ... leave room logic +}; +``` + +### Automatic CallKit Management + +Use the [`useCallKitService`](../../api/mobile/functions/useCallKitService) hook for automatic session lifecycle management: + +```tsx +import React from "react"; +import { useCallKitService } from "@fishjam-cloud/react-native-client"; +import { View } from "react-native"; + +function CallScreen({ username }: { username: string }) { + // CallKit session automatically starts when component mounts + // and ends when component unmounts + useCallKitService({ + displayName: username, + isVideo: true, + }); + + return ...; +} +``` + +### Listening to CallKit Events + +Use the [`useCallKitEvent`](../../api/mobile/functions/useCallKitEvent) hook to respond to user interactions with the native CallKit interface: + +```tsx +import { + useCallKitEvent, + useCamera, + useMicrophone, + useConnection, +} from "@fishjam-cloud/react-native-client"; + +const { startMicrophone, stopMicrophone } = useMicrophone(); +const { leaveRoom } = useConnection(); + +// Listen for mute toggle from CallKit UI +useCallKitEvent("muted", (isMuted?: boolean) => { + if (isMuted === true) { + stopMicrophone(); + } else if (isMuted === false) { + startMicrophone(); + } +}); + +// Listen for hold state changes +useCallKitEvent("held", (isHeld?: boolean) => { + console.log("Call hold state:", isHeld); + // Handle hold state in your app +}); + +// Listen for call end from CallKit UI +useCallKitEvent("ended", () => { + // Handle call termination + leaveRoom(); +}); +``` + + + + +## See Also + +For an enhanced user experience when your app is in the background, consider enabling [Picture in Picture](./picture-in-picture), which allows users to see video content in a floating window while using other apps. diff --git a/versioned_docs/version-0.27.0/how-to/client/connecting.mdx b/versioned_docs/version-0.27.0/how-to/client/connecting.mdx new file mode 100644 index 00000000..f96524e0 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/client/connecting.mdx @@ -0,0 +1,178 @@ +--- +sidebar_position: 3 +description: Connect to a Fishjam room using a peer token and room URL obtained from your backend. +--- + +import TabItem from "@theme/TabItem"; +import Tabs from "@theme/Tabs"; + +# 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 can [use the Sandbox API](../backend/sandbox-api-testing) to generate peer tokens for testing or development purposes without setting up your own backend. +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. It is available to all accounts, including the free **Mini Jar** plan. +For React/React Native apps, copy both the Fishjam ID from the [Dashboard tab](https://fishjam.io/app) and Sandbox API URL from the [Sandbox tab](https://fishjam.io/app/sandbox): the Sandbox API URL is used to get peer tokens, while the Fishjam ID is passed to `FishjamProvider` for media server access. + + + + +```ts +import { useSandbox } from "@fishjam-cloud/react-client"; +const SANDBOX_API_URL = "your-sandbox-api-url-here"; +const roomName = "room"; +const peerName = "user"; +// ---cut--- + +const { getSandboxPeerToken } = useSandbox({ sandboxApiUrl: SANDBOX_API_URL }); +const peerToken = await getSandboxPeerToken(roomName, peerName); +``` + + + + +```ts +import { useSandbox } from "@fishjam-cloud/react-native-client"; +const SANDBOX_API_URL = "your-sandbox-api-url-here"; +const roomName = "room"; +const peerName = "user"; +// ---cut--- + +const { getSandboxPeerToken } = useSandbox({ sandboxApiUrl: SANDBOX_API_URL }); +const peerToken = await getSandboxPeerToken(roomName, peerName); +``` + + + + + + + +For production, 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](../backend/server-setup). The **Standard Jar** plan is recommended for production deployments. + + + + +## Connecting + +Use the [`useConnection`](../../api/web/functions/useConnection) hook to get +the [`joinRoom`](../../api/web/functions/useConnection#joinroom) function. + + + + +```tsx +const SANDBOX_API_URL = "your-sandbox-api-url-here"; +// ---cut-before--- +import { useConnection, useSandbox } from "@fishjam-cloud/react-client"; +import React, { useCallback } from "react"; + +export function JoinRoomButton() { + const { joinRoom } = useConnection(); // [!code highlight] + // get the peer token from sandbox or your backend + const { getSandboxPeerToken } = useSandbox({ + sandboxApiUrl: SANDBOX_API_URL, + }); + + const onJoinRoomPress = useCallback(async () => { + // [!code highlight:5] + const peerToken = await getSandboxPeerToken("Room", "User"); + await joinRoom({ peerToken }); + }, [joinRoom, getSandboxPeerToken]); + + return ; +} +``` + + + + +```tsx +import React, { useCallback } from "react"; +import { Button } from "react-native"; +import { useConnection, useSandbox } from "@fishjam-cloud/react-native-client"; + +const SANDBOX_API_URL = "your-sandbox-api-url-here"; + +export function JoinRoomButton() { + const { joinRoom } = useConnection(); // [!code highlight] + // get the peer token from sandbox or your backend + const { getSandboxPeerToken } = useSandbox({ + sandboxApiUrl: SANDBOX_API_URL, + }); + + const onPressJoin = useCallback(async () => { + // in production apps, get the peerToken from your own backend instead + const peerToken = await getSandboxPeerToken("Room", "User"); + + await joinRoom({ peerToken }); // [!code highlight] + }, [joinRoom, getSandboxPeerToken]); + + return ; +} +``` + + + + +```tsx +import React, { useCallback } from "react"; +import { Button } from "react-native"; +import { useConnection } from "@fishjam-cloud/react-native-client"; + +export function LeaveRoomButton() { + const { leaveRoom } = useConnection(); // [!code highlight] + + const onPressLeave = useCallback(async () => { + await leaveRoom(); // [!code highlight] + }, [leaveRoom]); + + return + + ))} + + ); +} +``` + + + + +To select the desired camera, use the [`selectCamera`](../../api/mobile/functions/useCamera#selectcamera) method. +The list of the available camera devices is available via the [`cameraDevices`](../../api/mobile/functions/useCamera#cameradevices). + +```tsx +import React, { useCallback, useState } from "react"; +import { Button } from "react-native"; +import { useCamera } from "@fishjam-cloud/react-native-client"; + +export function FlipButton() { + const { cameraDevices, selectCamera } = useCamera(); // [!code highlight] + const [currentIndex, setCurrentIndex] = useState(0); + + const onPressFlipCamera = useCallback(() => { + if (cameraDevices.length === 0) return; + + // Cycle through available cameras + const nextIndex = (currentIndex + 1) % cameraDevices.length; + const nextCamera = cameraDevices[nextIndex]; + if (nextCamera) { + selectCamera(nextCamera.deviceId); // [!code highlight] + setCurrentIndex(nextIndex); + } + }, [cameraDevices, currentIndex, selectCamera]); + + return ; +} +``` + + + + +You can use [`toggleCamera`](../../api/mobile/functions/useCamera#togglecamera) to toggle the camera state, or use [`startCamera`](../../api/mobile/functions/useCamera#startcamera) and [`stopCamera`](../../api/mobile/functions/useCamera#stopcamera) for more explicit control. + +#### Using toggleCamera + +```tsx +import { Button } from "react-native"; +import React from "react"; +import { useCamera } from "@fishjam-cloud/react-native-client"; + +export function ToggleCameraButton() { + const { isCameraOn, toggleCamera } = useCamera(); // [!code highlight] + + return ( + + + + ); +} +``` + +## Managing Permissions (Mobile only) + +The SDK provides built-in hooks for querying and requesting device permissions: `useCameraPermissions` and `useMicrophonePermissions` from `@fishjam-cloud/react-native-client`. + +Both hooks return a `[query, request]` tuple: + +- **`query()`** — checks the current permission status without prompting the user +- **`request()`** — triggers the native permission dialog and returns the resulting status + +The returned `PermissionStatus` is one of: `'granted'`, `'denied'`, or `'prompt'`. + +:::info +Requesting permissions manually is optional — `initializeDevices()` will automatically prompt for any permissions that haven't been granted yet. +However, you must always call `initializeDevices()` to set up camera and microphone devices. +::: + +#### Usage Example + +```tsx +// @noErrors: 2305 +import React, { useEffect } from "react"; +import { + useCameraPermissions, + useMicrophonePermissions, + useInitializeDevices, +} from "@fishjam-cloud/react-native-client"; + +function RoomScreen() { + const [queryCamera, requestCamera] = useCameraPermissions(); // [!code highlight] + const [queryMicrophone, requestMicrophone] = useMicrophonePermissions(); // [!code highlight] + const { initializeDevices } = useInitializeDevices(); // [!code highlight] + + useEffect(() => { + const setup = async () => { + let cam = await queryCamera(); + let mic = await queryMicrophone(); + + if (cam !== "granted") cam = await requestCamera(); + if (mic !== "granted") mic = await requestMicrophone(); + + if (cam === "granted" && mic === "granted") { + await initializeDevices(); // [!code highlight] + } + }; + setup(); + }, [ + queryCamera, + requestCamera, + queryMicrophone, + requestMicrophone, + initializeDevices, + ]); +} +``` diff --git a/versioned_docs/version-0.27.0/how-to/client/metadata.mdx b/versioned_docs/version-0.27.0/how-to/client/metadata.mdx new file mode 100644 index 00000000..a80ae16f --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/client/metadata.mdx @@ -0,0 +1,211 @@ +--- +sidebar_position: 6 +title: "Metadata" +description: "How to use metadata" +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +Alongside audio and video, it is possible to send additional metadata with each peer. Metadata is just +JSON that can contain arbitrary information. Its most common use is sending a user name associated with a peer. +However, it can be also used to send the peer's camera type, application information etc. + +:::info + +You can also set metadata on [the server side, when adding user to the room](../backend/server-setup#metadata). This metadata is persistent throughout its lifetime and is useful for attaching information that +can't be overwritten by the peer, like information about real user names or basic permission info. + +::: + +## Setting metadata when joining the room + +The `joinRoom` method from the `useConnection` hook has a `peerMetadata` parameter, that can be used for setting object metadata. + + + + +```tsx +const PEER_TOKEN = "some-peer-token"; +// ---cut--- +import { useConnection } from "@fishjam-cloud/react-client"; +import React, { useCallback } from "react"; + +type PeerMetadata = { + displayName: string; +}; + +export function JoinRoomButton() { + const { joinRoom } = useConnection(); // [!code highlight] + + const onJoinRoomPress = useCallback(async () => { + await joinRoom({ + peerToken: PEER_TOKEN, + peerMetadata: { displayName: "John Wick" }, // [!code highlight] + }); + }, [joinRoom]); + + return ; +} +``` + + + + +```tsx +const PEER_TOKEN = "some-peer-token"; +// ---cut--- +import React, { useCallback } from "react"; +import { Button } from "react-native"; +import { useConnection } from "@fishjam-cloud/react-native-client"; + +type PeerMetadata = { + displayName: string; +}; + +export function JoinRoomButton() { + const { joinRoom } = useConnection(); + + const onPressJoin = useCallback(async () => { + // Note: fishjamId is passed to FishjamProvider, not joinRoom + await joinRoom({ + peerToken: PEER_TOKEN, + peerMetadata: { displayName: "John Wick" }, // [!code highlight] + }); + }, [joinRoom]); + + return ; +} +``` + + + + +```tsx +import React, { useCallback } from "react"; +import { Button } from "react-native"; +import { useUpdatePeerMetadata } from "@fishjam-cloud/react-native-client"; + +type PeerMetadata = { + displayName: string; +}; + +export function UpdateNameButton() { + const { updatePeerMetadata } = useUpdatePeerMetadata(); // [!code highlight] + + const onPressUpdateName = useCallback(async () => { + await updatePeerMetadata({ displayName: "Thomas A. Anderson" }); // [!code highlight] + }, [updatePeerMetadata]); + + return + ))} + + ); +} +``` + + + + +```tsx +import React from "react"; +import { type RemoteTrack, Variant } from "@fishjam-cloud/react-native-client"; +import { View, Pressable, Text, StyleSheet } from "react-native"; + +// ---cut--- + +const variants = [ + { label: "Low", value: Variant.VARIANT_LOW }, + { label: "Medium", value: Variant.VARIANT_MEDIUM }, + { label: "High", value: Variant.VARIANT_HIGH }, +]; + +function QualitySelector({ track }: { track: RemoteTrack }) { + return ( + + {variants.map(({ label, value }) => ( + track.setReceivedQuality(value)} + > + {label} + + ))} + + ); +} + +const styles = StyleSheet.create({ + row: { flexDirection: "row", gap: 8, marginTop: 4 }, + pill: { + paddingHorizontal: 12, + paddingVertical: 6, + borderRadius: 16, + backgroundColor: "#e0e0e0", + }, +}); +``` + + + + +--- + +## Type differences: `Track` vs `RemoteTrack` + +When using `usePeers`, the track types differ between local and remote peers: + +- **`localPeer.tracks`** are typed as `Track` (no quality selection methods) +- **`remotePeers[].tracks`** are typed as `RemoteTrack` (extends `Track` with `setReceivedQuality`) + +This means `setReceivedQuality` is only available on tracks from remote peers, which is the correct behavior. You don't need to select a quality variant for your own video. + +--- + +## See also + +- [Simulcast explanation](../../explanation/simulcast): conceptual overview of how simulcast works +- [Connecting to a room](./connecting): prerequisite for using simulcast diff --git a/versioned_docs/version-0.27.0/how-to/client/start-streaming.mdx b/versioned_docs/version-0.27.0/how-to/client/start-streaming.mdx new file mode 100644 index 00000000..4bbd1bf8 --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/client/start-streaming.mdx @@ -0,0 +1,135 @@ +--- +sidebar_position: 2 +description: Initialize camera and microphone access and start streaming media in a Fishjam room. +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +# Streaming media + +This guide covers the basics of initializing and using camera and microphone devices. For more advanced device management (selecting specific devices, device switching, muting, etc.), see the [Managing devices](./managing-devices) guide. + +## Initialize access to your devices + + + + +Fishjam provides an API to browse and manage media devices you can use. +To ask the browser for permission to list the available devices, +call the [`initializeDevices`](../../api/web/functions/useInitializeDevices#initializedevices) +function from [`useInitializeDevices`](../../api/web/functions/useInitializeDevices) hook. + +You can choose whether to initialize both camera and microphone devices or just one of them by passing [`InitializeDevicesSettings`](../../api/web/type-aliases/InitializeDevicesSettings) +as an argument. By default, both camera and microphone are initialized. + +The [`initializeDevices`](../../api/web/functions/useInitializeDevices#initializedevices) function will return a [`Promise`](../../api/web/type-aliases/InitializeDevicesResult) object. + +```ts +import React, { useEffect } from "react"; +import { useInitializeDevices } from "@fishjam-cloud/react-client"; + +export function useExample() { + const { initializeDevices } = useInitializeDevices(); + + useEffect(() => { + initializeDevices().then((result) => { + // optionally handle the result + console.log(result); + }); + }, [initializeDevices]); +} +``` + +:::note +The [`useInitializeDevices`](../../api/web/functions/useInitializeDevices) hook gives you the convenience of asking the user for all permissions at once. + +It is not the only way to enable the device. You can just toggle the device using [`useCamera`](../../api/web/functions/useCamera) or [`useMicrophone`](../../api/web/functions/useMicrophone) hooks. +::: + + + + +On mobile, you should use `initializeDevices()` when you first want to stream. This gives your app access to all available devices and automatically requests camera and microphone permissions. The SDK will show the system permission dialog if permissions haven't been granted yet. + +Once devices are initialized, you can manage their state using the methods described in the [Managing devices](./managing-devices) guide. + + + + +## Device API + + + + +To manage users' camera and microphone devices, use the respective [`useCamera`](../../api/web/functions/useCamera) and [`useMicrophone`](../../api/web/functions/useMicrophone) hooks. Both of them have similar API. To keep things simple, we will just use the camera hook. + +```tsx +import React, { useEffect, useRef } from "react"; +import { useCamera } from "@fishjam-cloud/react-client"; + +export function ExampleCameraPreview() { + const videoRef = useRef(null); + + const { activeCamera, selectCamera, cameraStream, cameraDevices } = + useCamera(); // [!code highlight] + + useEffect(() => { + if (!videoRef.current) return; + videoRef.current.srcObject = cameraStream ?? null; + }, [cameraStream]); + + return ( +
+

Active camera: {activeCamera?.label ?? "None"}

+ + {cameraStream &&
+ ); +} +``` + + + + +To manage users' camera and microphone devices, use the respective [`useCamera`](../../api/mobile/functions/useCamera) and [`useMicrophone`](../../api/mobile/functions/useMicrophone) hooks. Both of them have similar API. To keep things simple, we will just use the camera hook. + +You can preview your camera stream using the `RTCView` component. + +```tsx +import React, { useEffect } from "react"; +import { View, Text } from "react-native"; +import { useCamera, RTCView } from "@fishjam-cloud/react-native-client"; + +export function CameraPreview() { + const { startCamera, cameraStream } = useCamera(); // [!code highlight] + + useEffect(() => { + startCamera(); // [!code highlight] + }, [startCamera]); + + return ( + + {cameraStream ? ( + + ) : ( + No camera stream + )} + + ); +} +``` + + + diff --git a/versioned_docs/version-0.27.0/how-to/client/stream-middleware.mdx b/versioned_docs/version-0.27.0/how-to/client/stream-middleware.mdx new file mode 100644 index 00000000..714ab90c --- /dev/null +++ b/versioned_docs/version-0.27.0/how-to/client/stream-middleware.mdx @@ -0,0 +1,105 @@ +--- +title: "Stream middleware" +sidebar_position: 7 +sidebar_label: "Stream middleware 🌐" +description: Intercept and transform media tracks before sending them to Fishjam, enabling effects and custom encodings. +--- + +# Stream middleware Web + +:::note +This guide is exclusively for **Web** (React) applications. +::: + +Stream middleware in Fishjam allows you to intercept and manipulate media tracks before they are sent to the Fishjam server. +This feature is powerful for applying effects, custom encodings, or any other transformations to the media stream. + +## Overview + +Define a [`TrackMiddleware`](../../api/web/type-aliases/TrackMiddleware) function which takes a `MediaStreamTrack` and returns an object containing the modified `MediaStreamTrack` +and an optional `onClear` function, which is called when the middleware needs to be removed or reapplied when a device changes. + +### Type definition + +```typescript +export type TrackMiddleware = ( + track: MediaStreamTrack, +) => { track: MediaStreamTrack; onClear?: () => void } | null; +``` + +### Setting middleware + +You can set the middleware for your media tracks using [`setTrackMiddleware`](../../api/web/functions/useCamera) method. This method accepts a `TrackMiddleware` or `null` for removing previously set middleware. + +### Example: Applying a blur effect + +The following example demonstrates how to apply a custom blur effect to the camera track using the [`useCamera`](../../api/web/functions/useCamera) hook and middleware. + +```tsx +class BlurProcessor { + track: MediaStreamTrack; + + constructor(stream: MediaStream) { + this.track = this.applyBlurEffect(stream); + } + + private applyBlurEffect(stream: MediaStream): MediaStreamTrack { + return stream.getVideoTracks()[0]; + } + + destroy() {} +} + +// ---cut--- +import React, { useCallback, useEffect, useRef } from "react"; +import type { TrackMiddleware } from "@fishjam-cloud/react-client"; +import { useCamera } from "@fishjam-cloud/react-client"; + +export function CameraWithBlurEffect() { + const videoRef = useRef(null); + // [!code highlight:2] + const { cameraStream, currentCameraMiddleware, setCameraTrackMiddleware } = + useCamera(); + + useEffect(() => { + if (!videoRef.current) return; + videoRef.current.srcObject = cameraStream ?? null; + }, [cameraStream]); + + // Define blur middleware + const blurMiddleware: TrackMiddleware = useCallback( + (track: MediaStreamTrack) => { + const streamToBlur = new MediaStream([track]); + // BlurProcessor is just an example, + // process the stream however you need + const blurProcessor = new BlurProcessor(streamToBlur); + + return { + track: blurProcessor.track, + onClear: () => blurProcessor.destroy(), + }; + }, + [], + ); + + // Check if the current middleware is blur + const isBlurEnabled = currentCameraMiddleware === blurMiddleware; + + // Toggle blur effect + const toggleBlur = () => { + setCameraTrackMiddleware(isBlurEnabled ? null : blurMiddleware); // [!code highlight] + }; + + return ( + <> + + + {cameraStream &&