Skip to content

Commit db39fb9

Browse files
authored
Update documented packages (#87)
## Description Update git modules with latest versions of web and mobile packages Updated packages contains new typedoc comments
1 parent 757f38e commit db39fb9

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

docs/react/connecting.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ In order to connect, you need a `PEER_TOKEN` and the `FISHJAM_URL`.
1111
## Connecting
1212

1313
Use the [`useConnection`](/api/web/functions/useConnection) hook to get
14-
the [`joinRoom`](/api/web/interfaces/UseConnectionResult#joinroom) function.
14+
the [`joinRoom`](/api/web/functions/useConnection#joinroom) function.
1515

1616
```tsx
1717
import { useConnection } from "@fishjam-cloud/react-client";
@@ -35,7 +35,7 @@ export function JoinRoomButton() {
3535

3636
## Disconnecting
3737

38-
In order to close connection, use the [`leaveRoom`](/api/web/interfaces/UseConnectionResult#leaveroom) method
38+
In order to close connection, use the [`leaveRoom`](/api/web/functions/useConnection#leaveroom) method
3939
from [`useConnection`](/api/web/functions/useConnection) hook.
4040

4141
```ts

docs/react/managing-devices.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ sidebar_position: 4
66

77
The Fishjam SDK provides functions for dynamically controlling media device streams. This includes selecting desired cameras and microphones, turning them on and off, as well as muting and unmuting microphones.
88

9-
### Selecting Camera and Microphone - [`selectCamera()`](/api/web/type-aliases/UseCameraResult#selectcamera) and [`selectMicrophone()`](/api/web/type-aliases/UseMicrophoneResult#selectmicrophone)
9+
### Selecting Camera and Microphone - [`selectCamera()`](/api/web/functions/useCamera#selectcamera) and [`selectMicrophone()`](/api/web/functions/useMicrophone#selectmicrophone)
1010

11-
To select the desired camera or microphone, use the [`selectCamera()`](/api/web/type-aliases/UseCameraResult#selectcamera) and [`selectMicrophone()`](/api/web/type-aliases/UseMicrophoneResult#listmicrophones) functions.
12-
Lists of the available devices are available via the [`cameraDevices`](/api/web/type-aliases/UseCameraResult#cameradevices) and [`microphoneDevices`](/api/web/type-aliases/UseMicrophoneResult#microphonedevices) properties.
11+
To select the desired camera or microphone, use the [`selectCamera()`](/api/web/functions/useCamera#selectcamera) and [`selectMicrophone()`](/api/web/functions/useMicrophone#selectmicrophone) functions.
12+
Lists of the available devices are available via the [`cameraDevices`](/api/web/functions/useCamera#cameradevices) and [`microphoneDevices`](/api/web/functions/useMicrophone#microphonedevices) properties.
1313

1414
#### Usage Example
1515

@@ -31,7 +31,7 @@ export function CameraControl() {
3131
}
3232
```
3333

34-
### Turning Camera On and Off - [`toggleCamera()`](/api/web/type-aliases/UseCameraResult#togglecamera)
34+
### Turning Camera On and Off - [`toggleCamera()`](/api/web/functions/useCamera#togglecamera)
3535

3636
This function controls the physical operational state of the camera.
3737

@@ -50,14 +50,14 @@ export function CameraControl() {
5050
}
5151
```
5252

53-
### Turning Microphone On and Off - [`toggleMicrophone()`](/api/web/type-aliases/UseMicrophoneResult#togglemicrophone)
53+
### Turning Microphone On and Off - [`toggleMicrophone()`](/api/web/functions/useMicrophone#togglemicrophone)
5454

5555
This function toggles the microphone's physical operational state. The function interacts with a physical device, so it might take a noticeable amount of time.
5656

5757
- **Turning the microphone off**: Turns the microphone off, disables the media stream, and pauses any audio transmission.
5858
- **Turning the microphone on**: Turns the microphone on and resumes audio streaming.
5959

60-
### Muting and Unmuting Microphone - [`toggleMicrophoneMute()`](/api/web/type-aliases/UseMicrophoneResult#togglemicrophonemute)
60+
### Muting and Unmuting Microphone - [`toggleMicrophoneMute()`](/api/web/functions/useMicrophone#togglemicrophonemute)
6161

6262
This function manages the audio stream's operational status without affecting the microphone's hardware state.
6363
Muting and unmuting is faster, but a muted device still uses resources. This is useful, as it is common to mute and unmute during a meeting. Unmuting needs to be quick to capture the first word of a sentence.

docs/react/start-streaming.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_position: 3
88

99
Fishjam provides an API to browse and manage media devices you can use.
1010
To ask the browser for permission to list the available devices,
11-
call the [`initializeDevices`](/api/web/type-aliases/UseInitializeDevicesResult#initializedevices)
11+
call the [`initializeDevices`](/api/web/functions/useInitializeDevices#initializedevices)
1212
function from [`useInitializeDevices`](/api/web/functions/useInitializeDevices) hook.
1313

1414
```ts

packages/mobile-client-sdk

Submodule mobile-client-sdk updated 72 files

packages/web-client-sdk

Submodule web-client-sdk updated 53 files

0 commit comments

Comments
 (0)