@livekit/components-js-docs 0.0.2 → 0.0.3
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/activespeakerobserver.md +1 -1
- package/generated-docs/core/computemenuposition.md +1 -1
- package/generated-docs/core/connectedparticipantobserver.md +1 -1
- package/generated-docs/core/connectedparticipantsobserver.md +1 -1
- package/generated-docs/core/connectionstateobserver.md +1 -1
- package/generated-docs/core/createactivedeviceobservable.md +1 -1
- package/generated-docs/core/createconnectionqualityobserver.md +1 -1
- package/generated-docs/core/createdataobserver.md +1 -1
- package/generated-docs/core/createisspeakingobserver.md +1 -1
- package/generated-docs/core/createmediadeviceobserver.md +1 -1
- package/generated-docs/core/createtrackobserver.md +1 -1
- package/generated-docs/core/gettrackbyidentifier.md +1 -1
- package/generated-docs/core/gettrackreferenceid.md +1 -1
- package/generated-docs/core/gettrackreferencesource.md +1 -1
- package/generated-docs/core/index.md +1 -1
- package/generated-docs/core/isequaltrackref.md +1 -1
- package/generated-docs/core/islocal.md +1 -1
- package/generated-docs/core/ismobilebrowser.md +1 -1
- package/generated-docs/core/isparticipantsourcepinned.md +1 -1
- package/generated-docs/core/isremote.md +1 -1
- package/generated-docs/core/issourceswithoptions.md +1 -1
- package/generated-docs/core/issourcewitoptions.md +1 -1
- package/generated-docs/core/istrackreference.md +1 -1
- package/generated-docs/core/istrackreferencepinned.md +1 -1
- package/generated-docs/core/istrackreferenceplaceholder.md +1 -1
- package/generated-docs/core/mutedobserver.md +1 -1
- package/generated-docs/core/observeparticipantevents.md +1 -1
- package/generated-docs/core/observeparticipantmedia.md +1 -1
- package/generated-docs/core/observeroomevents.md +1 -1
- package/generated-docs/core/observetrackevents.md +1 -1
- package/generated-docs/core/participanteventselector.md +1 -1
- package/generated-docs/core/participantinfoobserver.md +1 -1
- package/generated-docs/core/participantpermissionobserver.md +2 -2
- package/generated-docs/core/roomaudioplaybackallowedobservable.md +1 -1
- package/generated-docs/core/roomeventselector.md +1 -1
- package/generated-docs/core/roominfoobserver.md +1 -1
- package/generated-docs/core/roomobserver.md +1 -1
- package/generated-docs/core/screenshareobserver.md +1 -1
- package/generated-docs/core/selectgridlayout.md +1 -1
- package/generated-docs/core/sendmessage.md +1 -1
- package/generated-docs/core/setdifference.md +1 -1
- package/generated-docs/core/setloglevel.md +1 -1
- package/generated-docs/core/setupchat.md +8 -2
- package/generated-docs/core/setupchattoggle.md +1 -1
- package/generated-docs/core/setupclearpinbutton.md +1 -1
- package/generated-docs/core/setupconnectionqualityindicator.md +1 -1
- package/generated-docs/core/setupdatamessagehandler.md +1 -1
- package/generated-docs/core/setupdeviceselector.md +1 -1
- package/generated-docs/core/setupdisconnectbutton.md +1 -1
- package/generated-docs/core/setupfocustoggle.md +1 -1
- package/generated-docs/core/setuplivekitroom.md +1 -1
- package/generated-docs/core/setupmanualtoggle.md +1 -1
- package/generated-docs/core/setupmediatoggle.md +1 -1
- package/generated-docs/core/setupmediatrack.md +1 -1
- package/generated-docs/core/setupparticipantname.md +1 -1
- package/generated-docs/core/setupparticipanttile.md +1 -1
- package/generated-docs/core/setupstartaudio.md +1 -1
- package/generated-docs/core/setuptrackmutedindicator.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/tokenize.md +1 -1
- package/generated-docs/core/trackobservable.md +1 -1
- package/generated-docs/core/trackreferencesobservable.md +1 -1
- package/generated-docs/core/updatepages.md +1 -1
- package/generated-docs/core/wasclickoutside.md +1 -1
- package/generated-docs/react/chatprops.md +2 -0
- package/generated-docs/react/chatprops.messagedecoder.md +9 -0
- package/generated-docs/react/chatprops.messageencoder.md +9 -0
- package/generated-docs/react/component/audioconference.md +1 -1
- package/generated-docs/react/component/audiotrack.md +28 -9
- package/generated-docs/react/component/audiovisualizer.md +5 -4
- package/generated-docs/react/component/carouselview.md +11 -6
- package/generated-docs/react/component/chat.md +15 -4
- package/generated-docs/react/component/chatentry.md +20 -7
- 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 +5 -4
- package/generated-docs/react/component/connectionstatetoast.md +5 -4
- package/generated-docs/react/component/controlbar.md +10 -5
- package/generated-docs/react/component/disconnectbutton.md +5 -4
- package/generated-docs/react/component/focuslayout.md +10 -5
- package/generated-docs/react/component/focuslayoutcontainer.md +10 -5
- package/generated-docs/react/component/focustoggle.md +8 -5
- package/generated-docs/react/component/formatchatmessagelinks.md +1 -1
- package/generated-docs/react/component/gridlayout.md +6 -5
- package/generated-docs/react/component/livekitroom.md +70 -17
- package/generated-docs/react/component/mediadevicemenu.md +25 -8
- package/generated-docs/react/component/mediadeviceselect.md +38 -11
- package/generated-docs/react/component/participantaudiotile.md +25 -8
- package/generated-docs/react/component/participantcontextifneeded.md +1 -1
- package/generated-docs/react/component/participantloop.md +10 -5
- package/generated-docs/react/component/participantname.md +1 -1
- package/generated-docs/react/component/participanttile.md +25 -8
- package/generated-docs/react/component/prejoin.md +45 -12
- package/generated-docs/react/component/roomaudiorenderer.md +1 -1
- package/generated-docs/react/component/roomname.md +5 -4
- package/generated-docs/react/component/startaudio.md +3 -4
- package/generated-docs/react/component/toast.md +1 -1
- package/generated-docs/react/component/trackloop.md +10 -5
- package/generated-docs/react/component/trackmutedindicator.md +13 -6
- package/generated-docs/react/component/tracktoggle.md +23 -8
- package/generated-docs/react/component/videoconference.md +15 -4
- package/generated-docs/react/component/videotrack.md +33 -9
- package/generated-docs/react/hook/usechat.md +11 -3
- package/generated-docs/react/hook/usechattoggle.md +5 -6
- package/generated-docs/react/hook/useclearpinbutton.md +5 -6
- package/generated-docs/react/hook/useconnectionqualityindicator.md +5 -6
- package/generated-docs/react/hook/useconnectionstate.md +5 -6
- package/generated-docs/react/hook/usecreatelayoutcontext.md +3 -3
- package/generated-docs/react/hook/usedatachannel.md +8 -7
- package/generated-docs/react/hook/usedatachannel_1.md +5 -6
- package/generated-docs/react/hook/usedisconnectbutton.md +5 -6
- package/generated-docs/react/hook/useensurecreatelayoutcontext.md +5 -6
- package/generated-docs/react/hook/useensurelayoutcontext.md +5 -6
- package/generated-docs/react/hook/useensureparticipant.md +5 -6
- package/generated-docs/react/hook/useensureroom.md +5 -6
- package/generated-docs/react/hook/useensuretrackreference.md +5 -6
- package/generated-docs/react/hook/usefocustoggle.md +5 -6
- package/generated-docs/react/hook/usegridlayout.md +8 -7
- package/generated-docs/react/hook/useismuted.md +8 -7
- package/generated-docs/react/hook/useisspeaking.md +5 -6
- package/generated-docs/react/hook/uselayoutcontext.md +3 -3
- package/generated-docs/react/hook/uselivekitroom.md +5 -6
- package/generated-docs/react/hook/uselocalparticipant.md +5 -6
- package/generated-docs/react/hook/uselocalparticipantpermissions.md +3 -3
- package/generated-docs/react/hook/usemaybelayoutcontext.md +3 -3
- package/generated-docs/react/hook/usemaybeparticipantcontext.md +3 -3
- package/generated-docs/react/hook/usemayberoomcontext.md +3 -3
- package/generated-docs/react/hook/usemaybetrackcontext.md +3 -3
- package/generated-docs/react/hook/usemediadevices.md +7 -6
- package/generated-docs/react/hook/usemediadeviceselect.md +5 -6
- package/generated-docs/react/hook/usemediatrack.md +11 -8
- package/generated-docs/react/hook/usemediatrackbyname.md +11 -8
- package/generated-docs/react/hook/useparticipantcontext.md +3 -3
- package/generated-docs/react/hook/useparticipantinfo.md +5 -6
- package/generated-docs/react/hook/useparticipantpermissions.md +5 -6
- package/generated-docs/react/hook/useparticipants.md +5 -6
- package/generated-docs/react/hook/useparticipanttile.md +5 -6
- package/generated-docs/react/hook/usepinnedtracks.md +5 -6
- package/generated-docs/react/hook/usepreviewdevice.md +11 -8
- package/generated-docs/react/hook/useremoteparticipant.md +8 -7
- package/generated-docs/react/hook/useremoteparticipants.md +5 -6
- package/generated-docs/react/hook/useroomcontext.md +3 -3
- package/generated-docs/react/hook/useroominfo.md +5 -6
- package/generated-docs/react/hook/usesortedparticipants.md +5 -6
- package/generated-docs/react/hook/usespeakingparticipants.md +3 -3
- package/generated-docs/react/hook/usetoken.md +11 -8
- package/generated-docs/react/hook/usetrackcontext.md +3 -3
- package/generated-docs/react/hook/usetrackmutedindicator.md +8 -7
- package/generated-docs/react/hook/usetracks.md +8 -7
- package/generated-docs/react/hook/usetracktoggle.md +5 -6
- package/generated-docs/react/hook/usevisualstableupdate.md +11 -8
- package/generated-docs/react/index.md +7 -5
- package/generated-docs/react/messagedecoder.md +13 -0
- package/generated-docs/react/messageencoder.md +13 -0
- package/generated-docs/react/participantloopprops.md +4 -4
- package/generated-docs/react/participantloopprops.participants.md +1 -1
- package/generated-docs/react/trackloopprops.md +4 -4
- package/generated-docs/react/trackloopprops.tracks.md +1 -1
- package/generated-docs/react/videoconferenceprops.chatmessagedecoder.md +9 -0
- package/generated-docs/react/videoconferenceprops.chatmessageencoder.md +9 -0
- package/generated-docs/react/videoconferenceprops.md +2 -0
- package/generated-docs/react/videotrackprops.managesubscription.md +9 -0
- package/generated-docs/react/videotrackprops.md +1 -0
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useParticipantPermissions
|
|
3
|
+
# useParticipantPermissions
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -12,10 +12,9 @@ import { useParticipantPermissions } from '@livekit/components-react';
|
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| options | [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md) | _(Optional)_ |
|
|
15
|
+
{% parameter name="options" type="UseParticipantPermissionsOptions" optional=true %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
import("livekit-client/dist/src/proto/
|
|
20
|
+
`import("livekit-client/dist/src/proto/livekit_models_pb").ParticipantPermission | undefined`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useParticipants
|
|
3
|
+
# useParticipants
|
|
4
4
|
|
|
5
5
|
The useParticipants hook returns all participants (local and remote) of the current room.
|
|
6
6
|
|
|
@@ -14,10 +14,9 @@ import { useParticipants } from '@livekit/components-react';
|
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
| options | [UseParticipantsOptions](./react/useparticipantsoptions.md) | _(Optional)_ |
|
|
17
|
+
{% parameter name="options" type="UseParticipantsOptions" optional=true %}
|
|
18
|
+
{% /parameter %}
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
## Returns
|
|
22
21
|
|
|
23
|
-
(import("livekit-client").RemoteParticipant
|
|
22
|
+
`(import("livekit-client").RemoteParticipant | import("livekit-client").LocalParticipant)[]`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useParticipantTile
|
|
3
|
+
# useParticipantTile
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -12,10 +12,9 @@ import { useParticipantTile } from '@livekit/components-react';
|
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| { participant, source, publication, onParticipantClick, disableSpeakingIndicator, htmlProps, } | [UseParticipantTileProps](./react/useparticipanttileprops.md)<!-- --><T> | |
|
|
15
|
+
{% parameter name="{ participant, source, publication, onParticipantClick, disableSpeakingIndicator, htmlProps, }" type="UseParticipantTileProps<T>" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
{
|
|
20
|
+
`{ elementProps: React.HTMLAttributes<T>; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# usePinnedTracks
|
|
3
|
+
# usePinnedTracks
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -12,10 +12,9 @@ import { usePinnedTracks } from '@livekit/components-react';
|
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| layoutContext | [LayoutContextType](./react/layoutcontexttype.md) | _(Optional)_ |
|
|
15
|
+
{% parameter name="layoutContext" type="LayoutContextType" optional=true %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
`TrackReferenceOrPlaceholder[]`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# usePreviewDevice
|
|
3
|
+
# usePreviewDevice
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -12,12 +12,15 @@ import { usePreviewDevice } from '@livekit/components-react';
|
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| enabled | boolean | |
|
|
18
|
-
| deviceId | string | |
|
|
19
|
-
| kind | 'videoinput' \| 'audioinput' | |
|
|
15
|
+
{% parameter name="deviceId" type="string" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
20
17
|
|
|
21
|
-
|
|
18
|
+
{% parameter name="enabled" type="boolean" optional=false %}
|
|
19
|
+
{% /parameter %}
|
|
22
20
|
|
|
23
|
-
{
|
|
21
|
+
{% parameter name="kind" type="'videoinput' | 'audioinput'" optional=false %}
|
|
22
|
+
{% /parameter %}
|
|
23
|
+
|
|
24
|
+
## Returns
|
|
25
|
+
|
|
26
|
+
`{ selectedDevice: MediaDeviceInfo | undefined; localTrack: T | undefined; deviceError: Error | null; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useRemoteParticipant
|
|
3
|
+
# useRemoteParticipant
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -12,11 +12,12 @@ import { useRemoteParticipant } from '@livekit/components-react';
|
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| identity | string | |
|
|
18
|
-
| options | [UseRemoteParticipantOptions](./react/useremoteparticipantoptions.md) | _(Optional)_ |
|
|
15
|
+
{% parameter name="identity" type="string" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
19
17
|
|
|
20
|
-
|
|
18
|
+
{% parameter name="options" type="UseRemoteParticipantOptions" optional=true %}
|
|
19
|
+
{% /parameter %}
|
|
21
20
|
|
|
22
|
-
|
|
21
|
+
## Returns
|
|
22
|
+
|
|
23
|
+
`RemoteParticipant | undefined`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useRemoteParticipants
|
|
3
|
+
# useRemoteParticipants
|
|
4
4
|
|
|
5
5
|
The useRemoteParticipants
|
|
6
6
|
|
|
@@ -14,10 +14,9 @@ import { useRemoteParticipants } from '@livekit/components-react';
|
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
| options | [UseRemoteParticipantsOptions](./react/useremoteparticipantsoptions.md) | _(Optional)_ |
|
|
17
|
+
{% parameter name="options" type="UseRemoteParticipantsOptions" optional=true %}
|
|
18
|
+
{% /parameter %}
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
## Returns
|
|
22
21
|
|
|
23
|
-
RemoteParticipant
|
|
22
|
+
`RemoteParticipant[]`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useRoomContext
|
|
3
|
+
# useRoomContext
|
|
4
4
|
|
|
5
5
|
Ensures that a room is provided via context. If no room is provided, an error is thrown.
|
|
6
6
|
|
|
@@ -12,6 +12,6 @@ import { useRoomContext } from '@livekit/components-react';
|
|
|
12
12
|
|
|
13
13
|
{% partial file="p_usage.md" /%}
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
## Returns
|
|
16
16
|
|
|
17
|
-
Room
|
|
17
|
+
`Room`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useRoomInfo
|
|
3
|
+
# useRoomInfo
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -12,10 +12,9 @@ import { useRoomInfo } from '@livekit/components-react';
|
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| options | [UseRoomInfoOptions](./react/useroominfooptions.md) | _(Optional)_ |
|
|
15
|
+
{% parameter name="options" type="UseRoomInfoOptions" optional=true %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
{
|
|
20
|
+
`{ name: string; metadata: string | undefined; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useSortedParticipants
|
|
3
|
+
# useSortedParticipants
|
|
4
4
|
|
|
5
5
|
The useSortedParticipants hook returns the only the active speakers of all participants.
|
|
6
6
|
|
|
@@ -14,10 +14,9 @@ import { useSortedParticipants } from '@livekit/components-react';
|
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
| participants | Array<Participant> | |
|
|
17
|
+
{% parameter name="participants" type="Array<Participant>" optional=false %}
|
|
18
|
+
{% /parameter %}
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
## Returns
|
|
22
21
|
|
|
23
|
-
Participant
|
|
22
|
+
`Participant[]`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useSpeakingParticipants
|
|
3
|
+
# useSpeakingParticipants
|
|
4
4
|
|
|
5
5
|
The useSpeakingParticipants hook returns the only the active speakers of all participants.
|
|
6
6
|
|
|
@@ -12,6 +12,6 @@ import { useSpeakingParticipants } from '@livekit/components-react';
|
|
|
12
12
|
|
|
13
13
|
{% partial file="p_usage.md" /%}
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
## Returns
|
|
16
16
|
|
|
17
|
-
import("livekit-client").Participant
|
|
17
|
+
`import("livekit-client").Participant[]`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useToken
|
|
3
|
+
# useToken
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -12,12 +12,15 @@ import { useToken } from '@livekit/components-react';
|
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| tokenEndpoint | string \| undefined | |
|
|
18
|
-
| roomName | string | |
|
|
19
|
-
| options | [UseTokenOptions](./react/usetokenoptions.md) | _(Optional)_ |
|
|
15
|
+
{% parameter name="roomName" type="string" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
20
17
|
|
|
21
|
-
|
|
18
|
+
{% parameter name="tokenEndpoint" type="string | undefined" optional=false %}
|
|
19
|
+
{% /parameter %}
|
|
22
20
|
|
|
23
|
-
|
|
21
|
+
{% parameter name="options" type="UseTokenOptions" optional=true %}
|
|
22
|
+
{% /parameter %}
|
|
23
|
+
|
|
24
|
+
## Returns
|
|
25
|
+
|
|
26
|
+
`string | undefined`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useTrackContext
|
|
3
|
+
# useTrackContext
|
|
4
4
|
|
|
5
5
|
Ensures that a track reference is provided via context. If not inside a `TrackContext`<!-- -->, an error is thrown.
|
|
6
6
|
|
|
@@ -12,6 +12,6 @@ import { useTrackContext } from '@livekit/components-react';
|
|
|
12
12
|
|
|
13
13
|
{% partial file="p_usage.md" /%}
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
## Returns
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
`TrackReferenceOrPlaceholder`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useTrackMutedIndicator
|
|
3
|
+
# useTrackMutedIndicator
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -12,11 +12,12 @@ import { useTrackMutedIndicator } from '@livekit/components-react';
|
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| source | Track.Source | |
|
|
18
|
-
| options | [UseTrackMutedIndicatorOptions](./react/usetrackmutedindicatoroptions.md) | _(Optional)_ |
|
|
15
|
+
{% parameter name="source" type="Track.Source" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
19
17
|
|
|
20
|
-
|
|
18
|
+
{% parameter name="options" type="UseTrackMutedIndicatorOptions" optional=true %}
|
|
19
|
+
{% /parameter %}
|
|
21
20
|
|
|
22
|
-
|
|
21
|
+
## Returns
|
|
22
|
+
|
|
23
|
+
`{ isMuted: boolean; className: string; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useTracks
|
|
3
|
+
# useTracks
|
|
4
4
|
|
|
5
5
|
The `useTracks` hook returns an array of `TrackReference` or `TrackReferenceOrPlaceholder` depending on the provided `sources` property. If only subscribed tracks are desired, set the `onlySubscribed` property to `true`<!-- -->.
|
|
6
6
|
|
|
@@ -31,11 +31,12 @@ const trackReferencesWithPlaceholders: TrackReferenceOrPlaceholder[] = useTracks
|
|
|
31
31
|
|
|
32
32
|
## Parameters
|
|
33
33
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
| sources | T | _(Optional)_ |
|
|
37
|
-
| options | [UseTracksOptions](./react/usetracksoptions.md) | _(Optional)_ |
|
|
34
|
+
{% parameter name="options" type="UseTracksOptions" optional=true %}
|
|
35
|
+
{% /parameter %}
|
|
38
36
|
|
|
39
|
-
|
|
37
|
+
{% parameter name="sources" type="T" optional=true %}
|
|
38
|
+
{% /parameter %}
|
|
40
39
|
|
|
41
|
-
|
|
40
|
+
## Returns
|
|
41
|
+
|
|
42
|
+
`UseTracksHookReturnType<T>`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useTrackToggle
|
|
3
|
+
# useTrackToggle
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -12,10 +12,9 @@ import { useTrackToggle } from '@livekit/components-react';
|
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| { source, onChange, initialState, captureOptions, ...rest } | [UseTrackToggleProps](./react/usetracktoggleprops.md)<!-- --><T> | |
|
|
15
|
+
{% parameter name="{ source, onChange, initialState, captureOptions, ...rest }" type="UseTrackToggleProps<T>" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
{
|
|
20
|
+
`{ toggle: ((forceState?: boolean | undefined) => void) | ((forceState?: boolean | undefined, captureOptions?: import("@livekit/components-core").CaptureOptionsBySource<T> | undefined) => Promise<void>); enabled: boolean; pending: boolean; track: import("livekit-client").LocalTrackPublication | undefined; buttonProps: React.ButtonHTMLAttributes<HTMLButtonElement>; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useVisualStableUpdate
|
|
3
|
+
# useVisualStableUpdate
|
|
4
4
|
|
|
5
5
|
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
6
6
|
|
|
@@ -18,12 +18,15 @@ import { useVisualStableUpdate } from '@livekit/components-react';
|
|
|
18
18
|
|
|
19
19
|
## Parameters
|
|
20
20
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
| trackReferences | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | |
|
|
24
|
-
| maxItemsOnPage | number | |
|
|
25
|
-
| options | [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md) | _(Optional)_ |
|
|
21
|
+
{% parameter name="maxItemsOnPage" type="number" optional=false %}
|
|
22
|
+
{% /parameter %}
|
|
26
23
|
|
|
27
|
-
|
|
24
|
+
{% parameter name="trackReferences" type="TrackReferenceOrPlaceholder[]" optional=false %}
|
|
25
|
+
{% /parameter %}
|
|
28
26
|
|
|
29
|
-
|
|
27
|
+
{% parameter name="options" type="UseVisualStableUpdateOptions" optional=true %}
|
|
28
|
+
{% /parameter %}
|
|
29
|
+
|
|
30
|
+
## Returns
|
|
31
|
+
|
|
32
|
+
`TrackReferenceOrPlaceholder[]`
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
| Component | Description |
|
|
8
8
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
9
|
-
| [AudioTrack({ onSubscriptionStatusChanged, volume, ...props })](./react/component/audiotrack.md)
|
|
9
|
+
| [AudioTrack({ onSubscriptionStatusChanged, volume, source, name, publication, participant: p, ...props })](./react/component/audiotrack.md) | The AudioTrack component is responsible for rendering participant audio tracks. This component must have access to the participant's context, or alternatively pass it a <code>Participant</code> as a property. |
|
|
10
10
|
| [AudioVisualizer({ participant, ...props })](./react/component/audiovisualizer.md) | |
|
|
11
11
|
| [CarouselView({ tracks, orientation, ...props })](./react/component/carouselview.md) | The <code>CarouselLayout</code> displays a list of tracks horizontally or vertically. Depending on the size of the container, the carousel will display as many tiles as possible and overflows the rest. The CarouselLayout uses the <code>useVisualStableUpdate</code> hook to ensure that tile reordering due to track updates is visually stable but still moves the important tiles (speaking participants) to the front. |
|
|
12
12
|
| [ChatEntry({ entry, hideName, hideTimestamp, messageFormatter, ...props })](./react/component/chatentry.md) | The <code>ChatEntry</code> component holds and displays one chat message. |
|
|
@@ -35,24 +35,24 @@
|
|
|
35
35
|
| [TrackLoop({ tracks, ...props })](./react/component/trackloop.md) | The TrackLoop component loops over tracks. It is for example a easy way to loop over all participant camera and screen share tracks. TrackLoop creates a TrackContext for each track that you can use to e.g. render the track. |
|
|
36
36
|
| [TrackMutedIndicator({ source, participant, show, ...props })](./react/component/trackmutedindicator.md) | The TrackMutedIndicator shows whether the participant's camera or microphone is muted or not. |
|
|
37
37
|
| [TrackToggle({ showIcon, ...props })](./react/component/tracktoggle.md) | With the TrackToggle component it is possible to mute and unmute your camera and microphone. The component uses an html button element under the hood so you can treat it like a button. |
|
|
38
|
-
| [VideoTrack({ onTrackClick, onClick, onSubscriptionStatusChanged, name, publication, source, ...props })](./react/component/videotrack.md)
|
|
38
|
+
| [VideoTrack({ onTrackClick, onClick, onSubscriptionStatusChanged, name, publication, source, participant: p, manageSubscription, ...props })](./react/component/videotrack.md) | The VideoTrack component is responsible for rendering participant video tracks like <code>camera</code> and <code>screen_share</code>. This component must have access to the participant's context, or alternatively pass it a <code>Participant</code> as a property. |
|
|
39
39
|
|
|
40
40
|
## Prefabs
|
|
41
41
|
|
|
42
42
|
| Prefab | Description |
|
|
43
43
|
| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
44
44
|
| [AudioConference({ ...props })](./react/component/audioconference.md) | This component is the default setup of a classic LiveKit audio conferencing app. It provides functionality like switching between participant grid view and focus view. |
|
|
45
|
-
| [Chat({ messageFormatter, ...props })](./react/component/chat.md)
|
|
45
|
+
| [Chat({ messageFormatter, messageDecoder, messageEncoder, ...props })](./react/component/chat.md) | The Chat component adds a basis chat functionality to the LiveKit room. The messages are distributed to all participants in the room. Only users who are in the room at the time of dispatch will receive the message. |
|
|
46
46
|
| [ControlBar({ variation, controls, ...props })](./react/component/controlbar.md) | The ControlBar prefab component gives the user the basic user interface to control their media devices and leave the room. |
|
|
47
47
|
| [MediaDeviceMenu({ kind, initialSelection, onActiveDeviceChange, tracks, requestPermissions, ...props })](./react/component/mediadevicemenu.md) | The MediaDeviceMenu prefab component is a button that opens a menu that lists all media devices and allows the user to select them. |
|
|
48
48
|
| [PreJoin({ defaults, onValidate, onSubmit, onError, debug, joinLabel, micLabel, camLabel, userLabel, ...htmlProps })](./react/component/prejoin.md) | The PreJoin prefab component is normally presented to the user before he enters a room. This component allows the user to check and select the preferred media device (camera und microphone). On submit the user decisions are returned, which can then be passed on to the LiveKitRoom so that the user enters the room with the correct media devices. |
|
|
49
|
-
| [VideoConference({ chatMessageFormatter, ...props })](./react/component/videoconference.md)
|
|
49
|
+
| [VideoConference({ chatMessageFormatter, chatMessageDecoder, chatMessageEncoder, ...props })](./react/component/videoconference.md) | This component is the default setup of a classic LiveKit video conferencing app. It provides functionality like switching between participant grid view and focus view. |
|
|
50
50
|
|
|
51
51
|
## Hooks
|
|
52
52
|
|
|
53
53
|
| Hook | Description |
|
|
54
54
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
55
|
-
| [useChat()](./react/hook/usechat.md)
|
|
55
|
+
| [useChat(options)](./react/hook/usechat.md) | |
|
|
56
56
|
| [useChatToggle({ props })](./react/hook/usechattoggle.md) | |
|
|
57
57
|
| [useClearPinButton(props)](./react/hook/useclearpinbutton.md) | |
|
|
58
58
|
| [useConnectionQualityIndicator(options)](./react/hook/useconnectionqualityindicator.md) | |
|
|
@@ -132,6 +132,8 @@
|
|
|
132
132
|
| [LocalUserChoices](./react/localuserchoices.md) | |
|
|
133
133
|
| [MediaDeviceMenuProps](./react/mediadevicemenuprops.md) | |
|
|
134
134
|
| [MediaDeviceSelectProps](./react/mediadeviceselectprops.md) | |
|
|
135
|
+
| [MessageDecoder](./react/messagedecoder.md) | |
|
|
136
|
+
| [MessageEncoder](./react/messageencoder.md) | |
|
|
135
137
|
| [MessageFormatter](./react/messageformatter.md) | |
|
|
136
138
|
| [ParticipantContext](./react/participantcontext.md) | |
|
|
137
139
|
| [ParticipantLoopProps](./react/participantloopprops.md) | |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
## MessageDecoder type
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export type MessageDecoder = (message: Uint8Array) => ReceivedChatMessage;
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
**References:** [ReceivedChatMessage](./core/receivedchatmessage.md)
|
|
12
|
+
|
|
13
|
+
{% partial file="p_usage.md" /%}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
## MessageEncoder type
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export type MessageEncoder = (message: ChatMessage) => Uint8Array;
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
**References:** [ChatMessage](./core/chatmessage.md)
|
|
12
|
+
|
|
13
|
+
{% partial file="p_usage.md" /%}
|
|
@@ -12,7 +12,7 @@ export interface ParticipantLoopProps
|
|
|
12
12
|
|
|
13
13
|
## Properties
|
|
14
14
|
|
|
15
|
-
| Property | Type | Description
|
|
16
|
-
| ------------------------------------------------------------ | --------------- |
|
|
17
|
-
| [children](./react/participantloopprops.children.md) | React.ReactNode | The template component to be used in the loop.
|
|
18
|
-
| [participants](./react/participantloopprops.participants.md) | Participant\[\] | The participants to loop over.
|
|
15
|
+
| Property | Type | Description |
|
|
16
|
+
| ------------------------------------------------------------ | --------------- | ------------------------------------------------------------------------------------------- |
|
|
17
|
+
| [children](./react/participantloopprops.children.md) | React.ReactNode | The template component to be used in the loop. |
|
|
18
|
+
| [participants](./react/participantloopprops.participants.md) | Participant\[\] | The participants to loop over. Use <code>useParticipants()</code> hook to get participants. |
|
|
@@ -12,7 +12,7 @@ export interface TrackLoopProps
|
|
|
12
12
|
|
|
13
13
|
## Properties
|
|
14
14
|
|
|
15
|
-
| Property | Type | Description
|
|
16
|
-
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
17
|
-
| [children](./react/trackloopprops.children.md) | React.ReactNode | The template component to be used in the loop.
|
|
18
|
-
| [tracks](./react/trackloopprops.tracks.md) | [TrackReference](./core/trackreference.md)<!-- -->\[\] \| [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | Track references to loop over.
|
|
15
|
+
| Property | Type | Description |
|
|
16
|
+
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |
|
|
17
|
+
| [children](./react/trackloopprops.children.md) | React.ReactNode | The template component to be used in the loop. |
|
|
18
|
+
| [tracks](./react/trackloopprops.tracks.md) | [TrackReference](./core/trackreference.md)<!-- -->\[\] \| [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | Track references to loop over. You can the use <code>useTracks()</code> hook to get TrackReferences. |
|
|
@@ -16,4 +16,6 @@ export interface VideoConferenceProps extends React.HTMLAttributes<HTMLDivElemen
|
|
|
16
16
|
|
|
17
17
|
| Property | Type | Description |
|
|
18
18
|
| ----------------------------------------------------------------------------- | ----------------------------------------------- | ------------ |
|
|
19
|
+
| [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md) | [MessageDecoder](./react/messagedecoder.md) | _(Optional)_ |
|
|
20
|
+
| [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md) | [MessageEncoder](./react/messageencoder.md) | _(Optional)_ |
|
|
19
21
|
| [chatMessageFormatter?](./react/videoconferenceprops.chatmessageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |
|