@livekit/components-js-docs 0.0.2 → 0.0.4
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 +2 -2
- package/generated-docs/core/gettrackreferencesource.md +2 -2
- 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 +2 -2
- package/generated-docs/core/isparticipantsourcepinned.md +2 -2
- 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 +2 -2
- 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 +2 -2
- package/generated-docs/core/setdifference.md +1 -1
- package/generated-docs/core/setloglevel.md +2 -2
- 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 +2 -2
- package/generated-docs/core/sorttrackreferences.md +2 -2
- package/generated-docs/core/supportsscreensharing.md +2 -2
- package/generated-docs/core/tokenize.md +1 -1
- package/generated-docs/core/trackidentifier.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 +2 -2
- package/generated-docs/core/wasclickoutside.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 +3 -1
- package/generated-docs/react/chatprops.messagedecoder.md +9 -0
- package/generated-docs/react/chatprops.messageencoder.md +9 -0
- package/generated-docs/react/chattoggleprops.md +1 -1
- package/generated-docs/react/clearpinbuttonprops.md +1 -1
- package/generated-docs/react/component/audioconference.md +2 -2
- package/generated-docs/react/component/audiotrack.md +29 -10
- package/generated-docs/react/component/audiovisualizer.md +6 -5
- package/generated-docs/react/component/carouselview.md +12 -7
- package/generated-docs/react/component/chat.md +16 -5
- package/generated-docs/react/component/chatentry.md +21 -8
- package/generated-docs/react/component/chattoggle.md +2 -2
- package/generated-docs/react/component/clearpinbutton.md +2 -2
- package/generated-docs/react/component/connectionqualityindicator.md +2 -2
- package/generated-docs/react/component/connectionstate.md +6 -5
- package/generated-docs/react/component/connectionstatetoast.md +6 -5
- package/generated-docs/react/component/controlbar.md +11 -6
- package/generated-docs/react/component/disconnectbutton.md +6 -5
- package/generated-docs/react/component/focuslayout.md +11 -6
- package/generated-docs/react/component/focuslayoutcontainer.md +11 -6
- package/generated-docs/react/component/focustoggle.md +9 -6
- package/generated-docs/react/component/gridlayout.md +7 -6
- package/generated-docs/react/component/livekitroom.md +71 -18
- package/generated-docs/react/component/mediadevicemenu.md +26 -9
- package/generated-docs/react/component/mediadeviceselect.md +39 -12
- package/generated-docs/react/component/participantaudiotile.md +26 -9
- package/generated-docs/react/component/participantcontextifneeded.md +2 -2
- package/generated-docs/react/component/participantloop.md +11 -6
- package/generated-docs/react/component/participantname.md +2 -2
- package/generated-docs/react/component/participanttile.md +26 -9
- package/generated-docs/react/component/prejoin.md +46 -13
- package/generated-docs/react/component/roomaudiorenderer.md +2 -2
- package/generated-docs/react/component/roomname.md +6 -5
- package/generated-docs/react/component/startaudio.md +4 -5
- package/generated-docs/react/component/toast.md +2 -2
- package/generated-docs/react/component/trackloop.md +11 -6
- package/generated-docs/react/component/trackmutedindicator.md +14 -7
- package/generated-docs/react/component/tracktoggle.md +24 -9
- package/generated-docs/react/component/videoconference.md +16 -5
- package/generated-docs/react/component/videotrack.md +34 -10
- 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 +12 -4
- package/generated-docs/react/hook/usechattoggle.md +6 -7
- package/generated-docs/react/hook/useclearpinbutton.md +6 -7
- package/generated-docs/react/hook/useconnectionqualityindicator.md +6 -7
- package/generated-docs/react/hook/useconnectionstate.md +6 -7
- package/generated-docs/react/hook/usecreatelayoutcontext.md +4 -4
- package/generated-docs/react/hook/usedatachannel.md +9 -8
- package/generated-docs/react/hook/usedatachannel_1.md +6 -7
- package/generated-docs/react/hook/usedisconnectbutton.md +6 -7
- package/generated-docs/react/hook/useensurecreatelayoutcontext.md +6 -7
- package/generated-docs/react/hook/useensurelayoutcontext.md +6 -7
- package/generated-docs/react/hook/useensureparticipant.md +6 -7
- package/generated-docs/react/hook/useensureroom.md +6 -7
- package/generated-docs/react/hook/useensuretrackreference.md +6 -7
- package/generated-docs/react/hook/usefocustoggle.md +6 -7
- package/generated-docs/react/hook/usegridlayout.md +9 -8
- package/generated-docs/react/hook/useismuted.md +9 -8
- package/generated-docs/react/hook/useisspeaking.md +6 -7
- package/generated-docs/react/hook/uselayoutcontext.md +4 -4
- package/generated-docs/react/hook/uselivekitroom.md +6 -7
- package/generated-docs/react/hook/uselocalparticipant.md +6 -7
- package/generated-docs/react/hook/uselocalparticipantpermissions.md +4 -4
- package/generated-docs/react/hook/usemaybelayoutcontext.md +4 -4
- package/generated-docs/react/hook/usemaybeparticipantcontext.md +4 -4
- package/generated-docs/react/hook/usemayberoomcontext.md +4 -4
- package/generated-docs/react/hook/usemaybetrackcontext.md +4 -4
- package/generated-docs/react/hook/usemediadevices.md +8 -7
- package/generated-docs/react/hook/usemediadeviceselect.md +6 -7
- package/generated-docs/react/hook/usemediatrack.md +12 -9
- package/generated-docs/react/hook/usemediatrackbyname.md +12 -9
- package/generated-docs/react/hook/useparticipantcontext.md +4 -4
- package/generated-docs/react/hook/useparticipantinfo.md +6 -7
- package/generated-docs/react/hook/useparticipantpermissions.md +6 -7
- package/generated-docs/react/hook/useparticipants.md +6 -7
- package/generated-docs/react/hook/useparticipanttile.md +6 -7
- package/generated-docs/react/hook/usepinnedtracks.md +6 -7
- package/generated-docs/react/hook/usepreviewdevice.md +12 -9
- package/generated-docs/react/hook/useremoteparticipant.md +9 -8
- package/generated-docs/react/hook/useremoteparticipants.md +6 -7
- package/generated-docs/react/hook/useroomcontext.md +4 -4
- package/generated-docs/react/hook/useroominfo.md +6 -7
- package/generated-docs/react/hook/usesortedparticipants.md +6 -7
- package/generated-docs/react/hook/usespeakingparticipants.md +4 -4
- package/generated-docs/react/hook/usetoken.md +12 -9
- package/generated-docs/react/hook/usetrackcontext.md +4 -4
- package/generated-docs/react/hook/usetrackmutedindicator.md +9 -8
- package/generated-docs/react/hook/usetracks.md +9 -8
- package/generated-docs/react/hook/usetracktoggle.md +6 -7
- package/generated-docs/react/hook/usevisualstableupdate.md +12 -9
- package/generated-docs/react/index.md +8 -6
- 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 +13 -0
- package/generated-docs/react/messageencoder.md +13 -0
- 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 +5 -5
- package/generated-docs/react/participantloopprops.participants.md +2 -2
- 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 +5 -5
- package/generated-docs/react/trackloopprops.tracks.md +2 -2
- 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.chatmessagedecoder.md +9 -0
- package/generated-docs/react/videoconferenceprops.chatmessageencoder.md +9 -0
- package/generated-docs/react/videoconferenceprops.md +3 -1
- package/generated-docs/react/videotrackprops.managesubscription.md +9 -0
- package/generated-docs/react/videotrackprops.md +2 -1
- package/package.json +1 -1
- package/generated-docs/react/component/formatchatmessagelinks.md +0 -11
- package/meta-data.json +0 -78
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useEnsureParticipant
|
|
3
|
+
# useEnsureParticipant
|
|
4
4
|
|
|
5
5
|
Ensures that a participant is provided, either via context or explicitly as a parameter. If not inside a `ParticipantContext` and no participant is provided, an error is thrown.
|
|
6
6
|
|
|
@@ -10,14 +10,13 @@ Ensures that a participant is provided, either via context or explicitly as a pa
|
|
|
10
10
|
import { useEnsureParticipant } 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
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
| participant | Participant | _(Optional)_ |
|
|
17
|
+
{% parameter name="participant" type="Participant" optional=true %}
|
|
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
|
-
# useEnsureRoom
|
|
3
|
+
# useEnsureRoom
|
|
4
4
|
|
|
5
5
|
Ensures that a room is provided, either via context or explicitly as a parameter. If no room is provided, an error is thrown.
|
|
6
6
|
|
|
@@ -10,14 +10,13 @@ Ensures that a room is provided, either via context or explicitly as a parameter
|
|
|
10
10
|
import { useEnsureRoom } 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
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
| room | Room | _(Optional)_ |
|
|
17
|
+
{% parameter name="room" type="Room" optional=true %}
|
|
18
|
+
{% /parameter %}
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
## Returns
|
|
22
21
|
|
|
23
|
-
Room
|
|
22
|
+
`Room`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useEnsureTrackReference
|
|
3
|
+
# useEnsureTrackReference
|
|
4
4
|
|
|
5
5
|
Ensures that a track reference is provided, either via context or explicitly as a parameter. If not inside a `TrackContext` and no track reference is provided, an error is thrown.
|
|
6
6
|
|
|
@@ -10,14 +10,13 @@ Ensures that a track reference is provided, either via context or explicitly as
|
|
|
10
10
|
import { useEnsureTrackReference } 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
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
| track | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
|
|
17
|
+
{% parameter name="track" type="TrackReferenceOrPlaceholder" optional=true %}
|
|
18
|
+
{% /parameter %}
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
## Returns
|
|
22
21
|
|
|
23
|
-
|
|
22
|
+
`TrackReferenceOrPlaceholder`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useFocusToggle
|
|
3
|
+
# useFocusToggle
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,14 +8,13 @@
|
|
|
8
8
|
import { useFocusToggle } 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
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| { trackSource, participant, props } | [UseFocusToggleProps](./react/usefocustoggleprops.md) | |
|
|
15
|
+
{% parameter name="{ trackSource, participant, props }" type="UseFocusToggleProps" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
{
|
|
20
|
+
`{ mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & { className: string; onClick: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void; }; inFocus: boolean; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useGridLayout
|
|
3
|
+
# useGridLayout
|
|
4
4
|
|
|
5
5
|
The useGridLayout hook tries to select the best layout to fit all tiles. If the available screen space is not enough, it will reduce the number of maximum visible tiles and select a layout that still works visually within the given limitations. As the order of tiles changes over time, the hook tries to keep visual updates to a minimum while trying to display important tiles such as speaking participants or screen shares.
|
|
6
6
|
|
|
@@ -10,15 +10,16 @@ The useGridLayout hook tries to select the best layout to fit all tiles. If the
|
|
|
10
10
|
import { useGridLayout } 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
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
| gridElement | React.RefObject<HTMLDivElement> | |
|
|
20
|
-
| trackCount | number | |
|
|
17
|
+
{% parameter name="gridElement" type="React.RefObject<HTMLDivElement>" optional=false %}
|
|
18
|
+
{% /parameter %}
|
|
21
19
|
|
|
22
|
-
|
|
20
|
+
{% parameter name="trackCount" type="number" optional=false %}
|
|
21
|
+
{% /parameter %}
|
|
23
22
|
|
|
24
|
-
|
|
23
|
+
## Returns
|
|
24
|
+
|
|
25
|
+
`{ layout: GridLayoutDefinition; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useIsMuted
|
|
3
|
+
# useIsMuted
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,15 +8,16 @@
|
|
|
8
8
|
import { useIsMuted } 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
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| source | Track.Source | |
|
|
18
|
-
| options | [UseIsMutedOptions](./react/useismutedoptions.md) | _(Optional)_ |
|
|
15
|
+
{% parameter name="source" type="Track.Source" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
19
17
|
|
|
20
|
-
|
|
18
|
+
{% parameter name="options" type="UseIsMutedOptions" optional=true %}
|
|
19
|
+
{% /parameter %}
|
|
21
20
|
|
|
22
|
-
|
|
21
|
+
## Returns
|
|
22
|
+
|
|
23
|
+
`boolean`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useIsSpeaking
|
|
3
|
+
# useIsSpeaking
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,14 +8,13 @@
|
|
|
8
8
|
import { useIsSpeaking } 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
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| participant | Participant | _(Optional)_ |
|
|
15
|
+
{% parameter name="participant" type="Participant" optional=true %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
boolean
|
|
20
|
+
`boolean`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useLayoutContext
|
|
3
|
+
# useLayoutContext
|
|
4
4
|
|
|
5
5
|
Ensures that a layout context is provided via context. If no layout context is provided, an error is thrown.
|
|
6
6
|
|
|
@@ -10,8 +10,8 @@ Ensures that a layout context is provided via context. If no layout context is p
|
|
|
10
10
|
import { useLayoutContext } 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
|
+
`LayoutContextType`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useLiveKitRoom
|
|
3
|
+
# useLiveKitRoom
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,14 +8,13 @@
|
|
|
8
8
|
import { useLiveKitRoom } 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
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| props | [LiveKitRoomProps](./react/livekitroomprops.md) | |
|
|
15
|
+
{% parameter name="props" type="LiveKitRoomProps" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
{
|
|
20
|
+
`{ room: Room | undefined; htmlProps: HTMLAttributes<T>; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useLocalParticipant
|
|
3
|
+
# useLocalParticipant
|
|
4
4
|
|
|
5
5
|
The useLocalParticipant hook the state of the local participant.
|
|
6
6
|
|
|
@@ -10,14 +10,13 @@ The useLocalParticipant hook the state of the local participant.
|
|
|
10
10
|
import { useLocalParticipant } 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
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
| options | [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md) | _(Optional)_ |
|
|
17
|
+
{% parameter name="options" type="UseLocalParticipantOptions" optional=true %}
|
|
18
|
+
{% /parameter %}
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
## Returns
|
|
22
21
|
|
|
23
|
-
{
|
|
22
|
+
`{ isMicrophoneEnabled: boolean; isScreenShareEnabled: boolean; isCameraEnabled: boolean; microphoneTrack: TrackPublication | undefined; cameraTrack: TrackPublication | undefined; lastMicrophoneError: Error | undefined; lastCameraError: Error | undefined; localParticipant: LocalParticipant; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useLocalParticipantPermissions
|
|
3
|
+
# useLocalParticipantPermissions
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,8 +8,8 @@
|
|
|
8
8
|
import { useLocalParticipantPermissions } 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
|
+
## Returns
|
|
14
14
|
|
|
15
|
-
import("livekit-client/dist/src/proto/
|
|
15
|
+
`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
|
-
# useMaybeLayoutContext
|
|
3
|
+
# useMaybeLayoutContext
|
|
4
4
|
|
|
5
5
|
Returns a layout context from the `LayoutContext` if it exists, otherwise `undefined`<!-- -->.
|
|
6
6
|
|
|
@@ -10,8 +10,8 @@ Returns a layout context from the `LayoutContext` if it exists, otherwise `undef
|
|
|
10
10
|
import { useMaybeLayoutContext } 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
|
+
`LayoutContextType | undefined`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useMaybeParticipantContext
|
|
3
|
+
# useMaybeParticipantContext
|
|
4
4
|
|
|
5
5
|
Returns a participant from the `ParticipantContext` if it exists, otherwise `undefined`<!-- -->.
|
|
6
6
|
|
|
@@ -10,8 +10,8 @@ Returns a participant from the `ParticipantContext` if it exists, otherwise `und
|
|
|
10
10
|
import { useMaybeParticipantContext } 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
|
-
Participant
|
|
17
|
+
`Participant | undefined`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useMaybeRoomContext
|
|
3
|
+
# useMaybeRoomContext
|
|
4
4
|
|
|
5
5
|
Returns the room context if it exists, otherwise undefined.
|
|
6
6
|
|
|
@@ -10,8 +10,8 @@ Returns the room context if it exists, otherwise undefined.
|
|
|
10
10
|
import { useMaybeRoomContext } 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
|
-
Room
|
|
17
|
+
`Room | undefined`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useMaybeTrackContext
|
|
3
|
+
# useMaybeTrackContext
|
|
4
4
|
|
|
5
5
|
Returns a track reference from the `TrackContext` if it exists, otherwise `undefined`<!-- -->.
|
|
6
6
|
|
|
@@ -10,8 +10,8 @@ Returns a track reference from the `TrackContext` if it exists, otherwise `undef
|
|
|
10
10
|
import { useMaybeTrackContext } 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
|
+
`TrackReferenceOrPlaceholder | undefined`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useMediaDevices
|
|
3
|
+
# useMediaDevices
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,14 +8,15 @@
|
|
|
8
8
|
import { useMediaDevices } 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
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
15
|
+
{% parameter name="{ kind }" type="{
|
|
16
|
+
kind: MediaDeviceKind;
|
|
17
|
+
}" optional=false %}
|
|
18
|
+
{% /parameter %}
|
|
18
19
|
|
|
19
|
-
|
|
20
|
+
## Returns
|
|
20
21
|
|
|
21
|
-
MediaDeviceInfo
|
|
22
|
+
`MediaDeviceInfo[]`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useMediaDeviceSelect
|
|
3
|
+
# useMediaDeviceSelect
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,14 +8,13 @@
|
|
|
8
8
|
import { useMediaDeviceSelect } 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
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| { kind, room, track, requestPermissions, } | [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md) | |
|
|
15
|
+
{% parameter name="{ kind, room, track, requestPermissions, }" type="UseMediaDeviceSelectProps" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
{
|
|
20
|
+
`{ devices: MediaDeviceInfo[]; className: string; activeDeviceId: string; setActiveMediaDevice: (id: string, options?: import("@livekit/components-core").SetMediaDeviceOptions | undefined) => Promise<void>; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useMediaTrack
|
|
3
|
+
# useMediaTrack
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,16 +8,19 @@
|
|
|
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
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| source | [VideoSource](./core/videosource.md) \| [AudioSource](./core/audiosource.md) | |
|
|
18
|
-
| participant | Participant | _(Optional)_ |
|
|
19
|
-
| options | [UseMediaTrackOptions](./react/usemediatrackoptions.md) | _(Optional)_ |
|
|
15
|
+
{% parameter name="source" type="VideoSource | AudioSource" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
20
17
|
|
|
21
|
-
|
|
18
|
+
{% parameter name="options" type="UseMediaTrackOptions" optional=true %}
|
|
19
|
+
{% /parameter %}
|
|
22
20
|
|
|
23
|
-
{
|
|
21
|
+
{% parameter name="participant" type="Participant" optional=true %}
|
|
22
|
+
{% /parameter %}
|
|
23
|
+
|
|
24
|
+
## Returns
|
|
25
|
+
|
|
26
|
+
`{ publication: import("livekit-client").TrackPublication | undefined; isMuted: boolean | undefined; isSubscribed: boolean | undefined; track: import("livekit-client").Track | undefined; elementProps: React.HTMLAttributes<HTMLElement>; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useMediaTrackByName
|
|
3
|
+
# useMediaTrackByName
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,16 +8,19 @@
|
|
|
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
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| name | string | |
|
|
18
|
-
| participant | Participant | _(Optional)_ |
|
|
19
|
-
| options | [UseMediaTrackOptions](./react/usemediatrackoptions.md) | _(Optional)_ |
|
|
15
|
+
{% parameter name="name" type="string" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
20
17
|
|
|
21
|
-
|
|
18
|
+
{% parameter name="options" type="UseMediaTrackOptions" optional=true %}
|
|
19
|
+
{% /parameter %}
|
|
22
20
|
|
|
23
|
-
{
|
|
21
|
+
{% parameter name="participant" type="Participant" optional=true %}
|
|
22
|
+
{% /parameter %}
|
|
23
|
+
|
|
24
|
+
## Returns
|
|
25
|
+
|
|
26
|
+
`{ publication: import("livekit-client").TrackPublication | undefined; isMuted: boolean | undefined; isSubscribed: boolean | undefined; track: import("livekit-client").Track | undefined; elementProps: import("react").HTMLAttributes<HTMLElement>; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useParticipantContext
|
|
3
|
+
# useParticipantContext
|
|
4
4
|
|
|
5
5
|
Ensures that a participant is provided via context. If not inside a `ParticipantContext`<!-- -->, an error is thrown.
|
|
6
6
|
|
|
@@ -10,8 +10,8 @@ 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
|
-
Participant
|
|
17
|
+
`Participant`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useParticipantInfo
|
|
3
|
+
# useParticipantInfo
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,14 +8,13 @@
|
|
|
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
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| props | [UseParticipantInfoOptions](./react/useparticipantinfooptions.md) | _(Optional)_ |
|
|
15
|
+
{% parameter name="props" type="UseParticipantInfoOptions" optional=true %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
{
|
|
20
|
+
`{ identity: string; name: string | undefined; metadata: string | undefined; }`
|
|
@@ -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
|
|
|
@@ -8,14 +8,13 @@
|
|
|
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
|
|
|
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
|
|
|
@@ -10,14 +10,13 @@ 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
|
|
|
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)[]`
|