@livekit/components-js-docs 0.0.3 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated-docs/core/encryptionstatusobservable.md +12 -0
- package/generated-docs/core/gettrackreferenceid.md +1 -1
- package/generated-docs/core/gettrackreferencesource.md +1 -1
- package/generated-docs/core/index.md +1 -0
- package/generated-docs/core/ismobilebrowser.md +1 -1
- package/generated-docs/core/isparticipantsourcepinned.md +1 -1
- package/generated-docs/core/istrackreferencepinned.md +1 -1
- package/generated-docs/core/sendmessage.md +1 -1
- package/generated-docs/core/setloglevel.md +1 -1
- package/generated-docs/core/sortparticipants.md +1 -1
- package/generated-docs/core/sorttrackreferences.md +1 -1
- package/generated-docs/core/supportsscreensharing.md +1 -1
- package/generated-docs/core/trackidentifier.md +1 -1
- package/generated-docs/core/updatepages.md +1 -1
- package/generated-docs/react/allowaudioplaybackprops.md +1 -1
- package/generated-docs/react/audioconferenceprops.md +1 -1
- package/generated-docs/react/audiotrackprops.md +1 -1
- package/generated-docs/react/audiotrackprops.volume.md +1 -1
- package/generated-docs/react/audiovisualizerprops.md +1 -1
- package/generated-docs/react/carouselviewprops.md +1 -1
- package/generated-docs/react/carouselviewprops.orientation.md +1 -1
- package/generated-docs/react/chatentryprops.entry.md +1 -1
- package/generated-docs/react/chatentryprops.hidename.md +1 -1
- package/generated-docs/react/chatentryprops.hidetimestamp.md +1 -1
- package/generated-docs/react/chatentryprops.md +1 -1
- package/generated-docs/react/chatentryprops.messageformatter.md +1 -1
- package/generated-docs/react/chatprops.md +1 -1
- package/generated-docs/react/chattoggleprops.md +1 -1
- package/generated-docs/react/clearpinbuttonprops.md +1 -1
- package/generated-docs/react/component/audioconference.md +1 -1
- package/generated-docs/react/component/audiotrack.md +1 -1
- package/generated-docs/react/component/audiovisualizer.md +1 -1
- package/generated-docs/react/component/carouselview.md +1 -1
- package/generated-docs/react/component/chat.md +1 -1
- package/generated-docs/react/component/chatentry.md +1 -1
- package/generated-docs/react/component/chattoggle.md +1 -1
- package/generated-docs/react/component/clearpinbutton.md +1 -1
- package/generated-docs/react/component/connectionqualityindicator.md +1 -1
- package/generated-docs/react/component/connectionstate.md +1 -1
- package/generated-docs/react/component/connectionstatetoast.md +1 -1
- package/generated-docs/react/component/controlbar.md +1 -1
- package/generated-docs/react/component/disconnectbutton.md +1 -1
- package/generated-docs/react/component/focuslayout.md +1 -1
- package/generated-docs/react/component/focuslayoutcontainer.md +1 -1
- package/generated-docs/react/component/focustoggle.md +1 -1
- package/generated-docs/react/component/gridlayout.md +1 -1
- package/generated-docs/react/component/livekitroom.md +1 -1
- package/generated-docs/react/component/mediadevicemenu.md +1 -1
- package/generated-docs/react/component/mediadeviceselect.md +1 -1
- package/generated-docs/react/component/participantaudiotile.md +1 -1
- package/generated-docs/react/component/participantcontextifneeded.md +1 -1
- package/generated-docs/react/component/participantloop.md +1 -1
- package/generated-docs/react/component/participantname.md +1 -1
- package/generated-docs/react/component/participanttile.md +1 -1
- package/generated-docs/react/component/prejoin.md +1 -1
- package/generated-docs/react/component/roomaudiorenderer.md +1 -1
- package/generated-docs/react/component/roomname.md +1 -1
- package/generated-docs/react/component/startaudio.md +1 -1
- package/generated-docs/react/component/toast.md +1 -1
- package/generated-docs/react/component/trackloop.md +1 -1
- package/generated-docs/react/component/trackmutedindicator.md +1 -1
- package/generated-docs/react/component/tracktoggle.md +1 -1
- package/generated-docs/react/component/videoconference.md +1 -1
- package/generated-docs/react/component/videotrack.md +1 -1
- package/generated-docs/react/connectionqualityindicatoroptions.md +1 -1
- package/generated-docs/react/connectionqualityindicatorprops.md +1 -1
- package/generated-docs/react/connectionstatetoastprops.md +1 -1
- package/generated-docs/react/connectionstatusprops.md +1 -1
- package/generated-docs/react/connectionstatusprops.room.md +1 -1
- package/generated-docs/react/controlbarcontrols.md +1 -1
- package/generated-docs/react/controlbarprops.md +1 -1
- package/generated-docs/react/disconnectbuttonprops.md +1 -1
- package/generated-docs/react/focuslayoutcontainerprops.md +1 -1
- package/generated-docs/react/focuslayoutprops.md +1 -1
- package/generated-docs/react/focustoggleprops.md +1 -1
- package/generated-docs/react/formatchatmessagelinks.md +11 -0
- package/generated-docs/react/gridlayoutprops.md +1 -1
- package/generated-docs/react/hook/usechat.md +8 -2
- package/generated-docs/react/hook/usechattoggle.md +11 -2
- package/generated-docs/react/hook/useclearpinbutton.md +10 -2
- package/generated-docs/react/hook/useconnectionqualityindicator.md +64 -2
- package/generated-docs/react/hook/useconnectionstate.md +4 -2
- package/generated-docs/react/hook/usecreatelayoutcontext.md +4 -2
- package/generated-docs/react/hook/usedatachannel.md +4 -2
- package/generated-docs/react/hook/usedatachannel_1.md +4 -2
- package/generated-docs/react/hook/usedisconnectbutton.md +10 -2
- package/generated-docs/react/hook/useensurecreatelayoutcontext.md +4 -2
- package/generated-docs/react/hook/useensurelayoutcontext.md +4 -2
- package/generated-docs/react/hook/useensureparticipant.md +4 -2
- package/generated-docs/react/hook/useensureroom.md +4 -2
- package/generated-docs/react/hook/useensuretrackreference.md +4 -2
- package/generated-docs/react/hook/usefocustoggle.md +10 -2
- package/generated-docs/react/hook/usegridlayout.md +6 -2
- package/generated-docs/react/hook/useismuted.md +4 -2
- package/generated-docs/react/hook/useisspeaking.md +4 -2
- package/generated-docs/react/hook/uselayoutcontext.md +4 -2
- package/generated-docs/react/hook/uselivekitroom.md +7 -2
- package/generated-docs/react/hook/uselocalparticipant.md +13 -2
- package/generated-docs/react/hook/uselocalparticipantpermissions.md +4 -2
- package/generated-docs/react/hook/usemaybelayoutcontext.md +4 -2
- package/generated-docs/react/hook/usemaybeparticipantcontext.md +4 -2
- package/generated-docs/react/hook/usemayberoomcontext.md +4 -2
- package/generated-docs/react/hook/usemaybetrackcontext.md +4 -2
- package/generated-docs/react/hook/usemediadevices.md +4 -2
- package/generated-docs/react/hook/usemediadeviceselect.md +9 -2
- package/generated-docs/react/hook/usemediatrack.md +10 -2
- package/generated-docs/react/hook/usemediatrackbyname.md +10 -2
- package/generated-docs/react/hook/useparticipantcontext.md +4 -2
- package/generated-docs/react/hook/useparticipantinfo.md +8 -2
- package/generated-docs/react/hook/useparticipantpermissions.md +4 -2
- package/generated-docs/react/hook/useparticipants.md +4 -2
- package/generated-docs/react/hook/useparticipanttile.md +6 -2
- package/generated-docs/react/hook/usepinnedtracks.md +4 -2
- package/generated-docs/react/hook/usepreviewdevice.md +8 -2
- package/generated-docs/react/hook/useremoteparticipant.md +4 -2
- package/generated-docs/react/hook/useremoteparticipants.md +4 -2
- package/generated-docs/react/hook/useroomcontext.md +4 -2
- package/generated-docs/react/hook/useroominfo.md +7 -2
- package/generated-docs/react/hook/usesortedparticipants.md +4 -2
- package/generated-docs/react/hook/usespeakingparticipants.md +4 -2
- package/generated-docs/react/hook/usetoken.md +4 -2
- package/generated-docs/react/hook/usetrackcontext.md +4 -2
- package/generated-docs/react/hook/usetrackmutedindicator.md +7 -2
- package/generated-docs/react/hook/usetracks.md +4 -2
- package/generated-docs/react/hook/usetracktoggle.md +10 -2
- package/generated-docs/react/hook/usevisualstableupdate.md +4 -2
- package/generated-docs/react/index.md +1 -1
- package/generated-docs/react/layoutcontext.md +1 -1
- package/generated-docs/react/layoutcontexttype.md +1 -1
- package/generated-docs/react/livekitroomprops.audio.md +1 -1
- package/generated-docs/react/livekitroomprops.connect.md +1 -1
- package/generated-docs/react/livekitroomprops.connectoptions.md +1 -1
- package/generated-docs/react/livekitroomprops.md +1 -1
- package/generated-docs/react/livekitroomprops.options.md +1 -1
- package/generated-docs/react/livekitroomprops.room.md +1 -1
- package/generated-docs/react/livekitroomprops.screen.md +1 -1
- package/generated-docs/react/livekitroomprops.serverurl.md +1 -1
- package/generated-docs/react/livekitroomprops.token.md +1 -1
- package/generated-docs/react/livekitroomprops.video.md +1 -1
- package/generated-docs/react/localuserchoices.md +1 -1
- package/generated-docs/react/mediadevicemenuprops.md +1 -1
- package/generated-docs/react/mediadevicemenuprops.requestpermissions.md +1 -1
- package/generated-docs/react/mediadeviceselectprops.exactmatch.md +1 -1
- package/generated-docs/react/mediadeviceselectprops.md +1 -1
- package/generated-docs/react/mediadeviceselectprops.requestpermissions.md +1 -1
- package/generated-docs/react/messagedecoder.md +1 -1
- package/generated-docs/react/messageencoder.md +1 -1
- package/generated-docs/react/messageformatter.md +1 -1
- package/generated-docs/react/meta-data.json +1 -0
- package/generated-docs/react/participantcontext.md +1 -1
- package/generated-docs/react/participantloopprops.children.md +1 -1
- package/generated-docs/react/participantloopprops.md +1 -1
- package/generated-docs/react/participantloopprops.participants.md +1 -1
- package/generated-docs/react/participantnameprops.md +1 -1
- package/generated-docs/react/participanttileprops.md +1 -1
- package/generated-docs/react/prejoinprops.debug.md +1 -1
- package/generated-docs/react/prejoinprops.defaults.md +1 -1
- package/generated-docs/react/prejoinprops.md +12 -12
- package/generated-docs/react/prejoinprops.onsubmit.md +1 -1
- package/generated-docs/react/prejoinprops.onvalidate.md +1 -1
- package/generated-docs/react/{hook/prejoinprops.userlabel.md → prejoinprops.userlabel.md} +2 -2
- package/generated-docs/react/roomcontext.md +1 -1
- package/generated-docs/react/roomnameprops.md +1 -1
- package/generated-docs/react/trackcontext.md +1 -1
- package/generated-docs/react/trackloopprops.children.md +1 -1
- package/generated-docs/react/trackloopprops.md +1 -1
- package/generated-docs/react/trackloopprops.tracks.md +1 -1
- package/generated-docs/react/trackmutedindicatorprops.md +1 -1
- package/generated-docs/react/tracktoggleprops.md +1 -1
- package/generated-docs/react/usechattoggleprops.md +1 -1
- package/generated-docs/react/usefocustoggleprops.md +1 -1
- package/generated-docs/react/useismutedoptions.md +1 -1
- package/generated-docs/react/uselocalparticipantoptions.md +1 -1
- package/generated-docs/react/uselocalparticipantoptions.room.md +1 -1
- package/generated-docs/react/usemediadeviceselectprops.md +1 -1
- package/generated-docs/react/usemediadeviceselectprops.requestpermissions.md +1 -1
- package/generated-docs/react/usemediatrackoptions.md +1 -1
- package/generated-docs/react/useparticipantinfooptions.md +1 -1
- package/generated-docs/react/useparticipantpermissionsoptions.md +1 -1
- package/generated-docs/react/useparticipantsoptions.md +1 -1
- package/generated-docs/react/useparticipantsoptions.room.md +1 -1
- package/generated-docs/react/useparticipantsoptions.updateonlyon.md +1 -1
- package/generated-docs/react/useparticipanttileprops.md +1 -1
- package/generated-docs/react/useremoteparticipantoptions.md +1 -1
- package/generated-docs/react/useremoteparticipantsoptions.md +1 -1
- package/generated-docs/react/useremoteparticipantsoptions.room.md +1 -1
- package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md +1 -1
- package/generated-docs/react/userinfo.md +1 -1
- package/generated-docs/react/useroominfooptions.md +1 -1
- package/generated-docs/react/usetokenoptions.md +4 -4
- package/generated-docs/react/{hook/usetokenoptions.userinfo.md → usetokenoptions.userinfo.md} +2 -2
- package/generated-docs/react/usetrackmutedindicatoroptions.md +1 -1
- package/generated-docs/react/usetrackshookreturntype.md +1 -1
- package/generated-docs/react/usetracksoptions.md +1 -1
- package/generated-docs/react/usetracktoggleprops.md +1 -1
- package/generated-docs/react/usevisualstableupdateoptions.customsortfunction.md +1 -1
- package/generated-docs/react/usevisualstableupdateoptions.md +1 -1
- package/generated-docs/react/videoconferenceprops.md +1 -1
- package/generated-docs/react/videotrackprops.md +1 -1
- package/package.json +1 -1
- package/generated-docs/react/component/formatchatmessagelinks.md +0 -11
- package/meta-data.json +0 -78
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { useMediaTrack } from '@livekit/components-react';
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
{% partial file="p_usage.md" /%}
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -23,4 +23,12 @@ import { useMediaTrack } from '@livekit/components-react';
|
|
|
23
23
|
|
|
24
24
|
## Returns
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
```typescript
|
|
27
|
+
{
|
|
28
|
+
publication: import('livekit-client').TrackPublication | undefined;
|
|
29
|
+
isMuted: boolean | undefined;
|
|
30
|
+
isSubscribed: boolean | undefined;
|
|
31
|
+
track: import('livekit-client').Track | undefined;
|
|
32
|
+
elementProps: React.HTMLAttributes<HTMLElement>;
|
|
33
|
+
}
|
|
34
|
+
```
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { useMediaTrackByName } from '@livekit/components-react';
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
{% partial file="p_usage.md" /%}
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -23,4 +23,12 @@ import { useMediaTrackByName } from '@livekit/components-react';
|
|
|
23
23
|
|
|
24
24
|
## Returns
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
```typescript
|
|
27
|
+
{
|
|
28
|
+
publication: import('livekit-client').TrackPublication | undefined;
|
|
29
|
+
isMuted: boolean | undefined;
|
|
30
|
+
isSubscribed: boolean | undefined;
|
|
31
|
+
track: import('livekit-client').Track | undefined;
|
|
32
|
+
elementProps: import('react').HTMLAttributes<HTMLElement>;
|
|
33
|
+
}
|
|
34
|
+
```
|
|
@@ -10,8 +10,10 @@ Ensures that a participant is provided via context. If not inside a `Participant
|
|
|
10
10
|
import { useParticipantContext } from '@livekit/components-react';
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
14
14
|
|
|
15
15
|
## Returns
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
```typescript
|
|
18
|
+
Participant;
|
|
19
|
+
```
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { useParticipantInfo } from '@livekit/components-react';
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
{% partial file="p_usage.md" /%}
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -17,4 +17,10 @@ import { useParticipantInfo } from '@livekit/components-react';
|
|
|
17
17
|
|
|
18
18
|
## Returns
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
```typescript
|
|
21
|
+
{
|
|
22
|
+
identity: string;
|
|
23
|
+
name: string | undefined;
|
|
24
|
+
metadata: string | undefined;
|
|
25
|
+
}
|
|
26
|
+
```
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { useParticipantPermissions } from '@livekit/components-react';
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
{% partial file="p_usage.md" /%}
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -17,4 +17,6 @@ import { useParticipantPermissions } from '@livekit/components-react';
|
|
|
17
17
|
|
|
18
18
|
## Returns
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
```typescript
|
|
21
|
+
import('livekit-client/dist/src/proto/livekit_models_pb').ParticipantPermission | undefined;
|
|
22
|
+
```
|
|
@@ -10,7 +10,7 @@ The useParticipants hook returns all participants (local and remote) of the curr
|
|
|
10
10
|
import { useParticipants } from '@livekit/components-react';
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
@@ -19,4 +19,6 @@ import { useParticipants } from '@livekit/components-react';
|
|
|
19
19
|
|
|
20
20
|
## Returns
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
```typescript
|
|
23
|
+
(import("livekit-client").RemoteParticipant | import("livekit-client").LocalParticipant)[]
|
|
24
|
+
```
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { useParticipantTile } from '@livekit/components-react';
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
{% partial file="p_usage.md" /%}
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -17,4 +17,8 @@ import { useParticipantTile } from '@livekit/components-react';
|
|
|
17
17
|
|
|
18
18
|
## Returns
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
```typescript
|
|
21
|
+
{
|
|
22
|
+
elementProps: React.HTMLAttributes<T>;
|
|
23
|
+
}
|
|
24
|
+
```
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { usePinnedTracks } from '@livekit/components-react';
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
{% partial file="p_usage.md" /%}
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -17,4 +17,6 @@ import { usePinnedTracks } from '@livekit/components-react';
|
|
|
17
17
|
|
|
18
18
|
## Returns
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
```typescript
|
|
21
|
+
TrackReferenceOrPlaceholder[]
|
|
22
|
+
```
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { usePreviewDevice } from '@livekit/components-react';
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
{% partial file="p_usage.md" /%}
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -23,4 +23,10 @@ import { usePreviewDevice } from '@livekit/components-react';
|
|
|
23
23
|
|
|
24
24
|
## Returns
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
```typescript
|
|
27
|
+
{
|
|
28
|
+
selectedDevice: MediaDeviceInfo | undefined;
|
|
29
|
+
localTrack: T | undefined;
|
|
30
|
+
deviceError: Error | null;
|
|
31
|
+
}
|
|
32
|
+
```
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { useRemoteParticipant } from '@livekit/components-react';
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
{% partial file="p_usage.md" /%}
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -20,4 +20,6 @@ import { useRemoteParticipant } from '@livekit/components-react';
|
|
|
20
20
|
|
|
21
21
|
## Returns
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
```typescript
|
|
24
|
+
RemoteParticipant | undefined;
|
|
25
|
+
```
|
|
@@ -10,7 +10,7 @@ The useRemoteParticipants
|
|
|
10
10
|
import { useRemoteParticipants } from '@livekit/components-react';
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
@@ -19,4 +19,6 @@ import { useRemoteParticipants } from '@livekit/components-react';
|
|
|
19
19
|
|
|
20
20
|
## Returns
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
```typescript
|
|
23
|
+
RemoteParticipant[]
|
|
24
|
+
```
|
|
@@ -10,8 +10,10 @@ Ensures that a room is provided via context. If no room is provided, an error is
|
|
|
10
10
|
import { useRoomContext } from '@livekit/components-react';
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
14
14
|
|
|
15
15
|
## Returns
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
```typescript
|
|
18
|
+
Room;
|
|
19
|
+
```
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { useRoomInfo } from '@livekit/components-react';
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
{% partial file="p_usage.md" /%}
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -17,4 +17,9 @@ import { useRoomInfo } from '@livekit/components-react';
|
|
|
17
17
|
|
|
18
18
|
## Returns
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
```typescript
|
|
21
|
+
{
|
|
22
|
+
name: string;
|
|
23
|
+
metadata: string | undefined;
|
|
24
|
+
}
|
|
25
|
+
```
|
|
@@ -10,7 +10,7 @@ The useSortedParticipants hook returns the only the active speakers of all parti
|
|
|
10
10
|
import { useSortedParticipants } from '@livekit/components-react';
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
@@ -19,4 +19,6 @@ import { useSortedParticipants } from '@livekit/components-react';
|
|
|
19
19
|
|
|
20
20
|
## Returns
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
```typescript
|
|
23
|
+
Participant[]
|
|
24
|
+
```
|
|
@@ -10,8 +10,10 @@ The useSpeakingParticipants hook returns the only the active speakers of all par
|
|
|
10
10
|
import { useSpeakingParticipants } from '@livekit/components-react';
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
14
14
|
|
|
15
15
|
## Returns
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
```typescript
|
|
18
|
+
import("livekit-client").Participant[]
|
|
19
|
+
```
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { useToken } from '@livekit/components-react';
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
{% partial file="p_usage.md" /%}
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -23,4 +23,6 @@ import { useToken } from '@livekit/components-react';
|
|
|
23
23
|
|
|
24
24
|
## Returns
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
```typescript
|
|
27
|
+
string | undefined;
|
|
28
|
+
```
|
|
@@ -10,8 +10,10 @@ Ensures that a track reference is provided via context. If not inside a `TrackCo
|
|
|
10
10
|
import { useTrackContext } from '@livekit/components-react';
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
14
14
|
|
|
15
15
|
## Returns
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
```typescript
|
|
18
|
+
TrackReferenceOrPlaceholder;
|
|
19
|
+
```
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { useTrackMutedIndicator } from '@livekit/components-react';
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
{% partial file="p_usage.md" /%}
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -20,4 +20,9 @@ import { useTrackMutedIndicator } from '@livekit/components-react';
|
|
|
20
20
|
|
|
21
21
|
## Returns
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
```typescript
|
|
24
|
+
{
|
|
25
|
+
isMuted: boolean;
|
|
26
|
+
className: string;
|
|
27
|
+
}
|
|
28
|
+
```
|
|
@@ -27,7 +27,7 @@ const trackReferencesWithPlaceholders: TrackReferenceOrPlaceholder[] = useTracks
|
|
|
27
27
|
]);
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
{% partial file="p_usage.md" /%}
|
|
30
|
+
{% partial file="p_usage.md" variables={exampleCount: 2} /%}
|
|
31
31
|
|
|
32
32
|
## Parameters
|
|
33
33
|
|
|
@@ -39,4 +39,6 @@ const trackReferencesWithPlaceholders: TrackReferenceOrPlaceholder[] = useTracks
|
|
|
39
39
|
|
|
40
40
|
## Returns
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
```typescript
|
|
43
|
+
UseTracksHookReturnType<T>;
|
|
44
|
+
```
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
import { useTrackToggle } from '@livekit/components-react';
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
{% partial file="p_usage.md" /%}
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -17,4 +17,12 @@ import { useTrackToggle } from '@livekit/components-react';
|
|
|
17
17
|
|
|
18
18
|
## Returns
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
```typescript
|
|
21
|
+
{
|
|
22
|
+
toggle: ((forceState?: boolean | undefined) => void) | ((forceState?: boolean | undefined, captureOptions?: import("@livekit/components-core").CaptureOptionsBySource<T> | undefined) => Promise<void>);
|
|
23
|
+
enabled: boolean;
|
|
24
|
+
pending: boolean;
|
|
25
|
+
track: import("livekit-client").LocalTrackPublication | undefined;
|
|
26
|
+
buttonProps: React.ButtonHTMLAttributes<HTMLButtonElement>;
|
|
27
|
+
}
|
|
28
|
+
```
|
|
@@ -14,7 +14,7 @@ Updating works with pagination. For example, if a participant starts speaking on
|
|
|
14
14
|
import { useVisualStableUpdate } from '@livekit/components-react';
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
{% partial file="p_usage.md" /%}
|
|
17
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
18
18
|
|
|
19
19
|
## Parameters
|
|
20
20
|
|
|
@@ -29,4 +29,6 @@ import { useVisualStableUpdate } from '@livekit/components-react';
|
|
|
29
29
|
|
|
30
30
|
## Returns
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
```typescript
|
|
33
|
+
TrackReferenceOrPlaceholder[]
|
|
34
|
+
```
|
|
@@ -19,7 +19,6 @@
|
|
|
19
19
|
| [FocusLayout({ track, ...htmlProps })](./react/component/focuslayout.md) | |
|
|
20
20
|
| [FocusLayoutContainer(props)](./react/component/focuslayoutcontainer.md) | |
|
|
21
21
|
| [FocusToggle({ trackSource, participant, ...props })](./react/component/focustoggle.md) | The FocusToggle puts the ParticipantTile in focus or removes it from focus. |
|
|
22
|
-
| [formatChatMessageLinks(message)](./react/component/formatchatmessagelinks.md) | |
|
|
23
22
|
| [GridLayout({ tracks, ...props })](./react/component/gridlayout.md) | The GridLayout component displays the nested participants in a grid where every participants has the same size. |
|
|
24
23
|
| [LiveKitRoom(props)](./react/component/livekitroom.md) | The LiveKitRoom component provides the room context to all its child components. It is generally the starting point of your LiveKit app and the root of the LiveKit component tree. It provides the room state as a React context to all child components, so you don't have to pass it yourself. |
|
|
25
24
|
| [MediaDeviceSelect({ kind, initialSelection, onActiveDeviceChange, onDeviceListChange, onDeviceSelectError, exactMatch, track, requestPermissions, ...props })](./react/component/mediadeviceselect.md) | The MediaDeviceSelect list all media devices of one kind. Clicking on one of the listed devices make it the active media device. |
|
|
@@ -125,6 +124,7 @@
|
|
|
125
124
|
| [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md) | |
|
|
126
125
|
| [FocusLayoutProps](./react/focuslayoutprops.md) | |
|
|
127
126
|
| [FocusToggleProps](./react/focustoggleprops.md) | |
|
|
127
|
+
| [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md) | |
|
|
128
128
|
| [GridLayoutProps](./react/gridlayoutprops.md) | |
|
|
129
129
|
| [LayoutContext](./react/layoutcontext.md) | |
|
|
130
130
|
| [LayoutContextType](./react/layoutcontexttype.md) | |
|
|
@@ -10,7 +10,7 @@ export interface LiveKitRoomProps extends Omit<React.HTMLAttributes<HTMLDivEleme
|
|
|
10
10
|
|
|
11
11
|
**Extends:** Omit<React.HTMLAttributes<HTMLDivElement>, 'onError'>
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
14
14
|
|
|
15
15
|
## Properties
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@ export interface MediaDeviceMenuProps extends React.ButtonHTMLAttributes<HTMLBut
|
|
|
10
10
|
|
|
11
11
|
**Extends:** React.ButtonHTMLAttributes<HTMLButtonElement>
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
14
14
|
|
|
15
15
|
## Properties
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@ export interface MediaDeviceSelectProps extends React.HTMLAttributes<HTMLUListEl
|
|
|
10
10
|
|
|
11
11
|
**Extends:** React.HTMLAttributes<HTMLUListElement>
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
14
14
|
|
|
15
15
|
## Properties
|
|
16
16
|
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"carouselview.md","title":"CarouselView"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"}],"hooks":[{"filename":"usechat.md","title":"useChat"},{"filename":"usechattoggle.md","title":"useChatToggle"},{"filename":"useclearpinbutton.md","title":"useClearPinButton"},{"filename":"useconnectionqualityindicator.md","title":"useConnectionQualityIndicator"},{"filename":"useconnectionstate.md","title":"useConnectionState"},{"filename":"usecreatelayoutcontext.md","title":"useCreateLayoutContext"},{"filename":"usedatachannel.md","title":"useDataChannel"},{"filename":"usedatachannel_1.md","title":"useDataChannel"},{"filename":"usedisconnectbutton.md","title":"useDisconnectButton"},{"filename":"useensurecreatelayoutcontext.md","title":"useEnsureCreateLayoutContext"},{"filename":"useensurelayoutcontext.md","title":"useEnsureLayoutContext"},{"filename":"useensureparticipant.md","title":"useEnsureParticipant"},{"filename":"useensureroom.md","title":"useEnsureRoom"},{"filename":"useensuretrackreference.md","title":"useEnsureTrackReference"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"uselayoutcontext.md","title":"useLayoutContext"},{"filename":"uselivekitroom.md","title":"useLiveKitRoom"},{"filename":"uselocalparticipant.md","title":"useLocalParticipant"},{"filename":"uselocalparticipantpermissions.md","title":"useLocalParticipantPermissions"},{"filename":"usemaybelayoutcontext.md","title":"useMaybeLayoutContext"},{"filename":"usemaybeparticipantcontext.md","title":"useMaybeParticipantContext"},{"filename":"usemayberoomcontext.md","title":"useMaybeRoomContext"},{"filename":"usemaybetrackcontext.md","title":"useMaybeTrackContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemediatrack.md","title":"useMediaTrack"},{"filename":"usemediatrackbyname.md","title":"useMediaTrackByName"},{"filename":"useparticipantcontext.md","title":"useParticipantContext"},{"filename":"useparticipantinfo.md","title":"useParticipantInfo"},{"filename":"useparticipantpermissions.md","title":"useParticipantPermissions"},{"filename":"useparticipants.md","title":"useParticipants"},{"filename":"useparticipanttile.md","title":"useParticipantTile"},{"filename":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackcontext.md","title":"useTrackContext"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"}]}
|
|
@@ -10,4 +10,4 @@ export interface ParticipantNameProps extends React.HTMLAttributes<HTMLSpanEleme
|
|
|
10
10
|
|
|
11
11
|
**Extends:** React.HTMLAttributes<HTMLSpanElement>, [UseParticipantInfoOptions](./react/useparticipantinfooptions.md)
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|