@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
|
-
# TrackMutedIndicator
|
|
3
|
+
# TrackMutedIndicator
|
|
4
4
|
|
|
5
5
|
The TrackMutedIndicator shows whether the participant's camera or microphone is muted or not.
|
|
6
6
|
|
|
@@ -17,12 +17,19 @@ import { TrackMutedIndicator } from '@livekit/components-react';
|
|
|
17
17
|
<TrackMutedIndicator source={Track.Source.Microphone} />
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
{% partial file="p_usage.md" /%}
|
|
20
|
+
{% partial file="p_usage.md" variables={exampleCount: 1} /%}
|
|
21
21
|
|
|
22
22
|
## Properties
|
|
23
23
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
24
|
+
{% parameter name="source" type="Track.Source" optional=false %}
|
|
25
|
+
{% /parameter %}
|
|
26
|
+
|
|
27
|
+
{% parameter name="participant" type="Participant" optional=true %}
|
|
28
|
+
_(Optional)_
|
|
29
|
+
|
|
30
|
+
{% /parameter %}
|
|
31
|
+
|
|
32
|
+
{% parameter name="show" type="'always' | 'muted' | 'unmuted'" optional=true %}
|
|
33
|
+
_(Optional)_
|
|
34
|
+
|
|
35
|
+
{% /parameter %}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# TrackToggle
|
|
3
|
+
# TrackToggle
|
|
4
4
|
|
|
5
5
|
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.
|
|
6
6
|
|
|
@@ -19,14 +19,29 @@ import { TrackToggle } from '@livekit/components-react';
|
|
|
19
19
|
</LiveKitRoom>
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
{% partial file="p_usage.md" /%}
|
|
22
|
+
{% partial file="p_usage.md" variables={exampleCount: 1} /%}
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
26
|
+
{% parameter name="source" type="T" optional=false %}
|
|
27
|
+
{% /parameter %}
|
|
28
|
+
|
|
29
|
+
{% parameter name="captureOptions" type="CaptureOptionsBySource<T>" optional=true %}
|
|
30
|
+
_(Optional)_
|
|
31
|
+
|
|
32
|
+
{% /parameter %}
|
|
33
|
+
|
|
34
|
+
{% parameter name="initialState" type="boolean" optional=true %}
|
|
35
|
+
_(Optional)_
|
|
36
|
+
|
|
37
|
+
{% /parameter %}
|
|
38
|
+
|
|
39
|
+
{% parameter name="onChange" type="(enabled: boolean) => void" optional=true %}
|
|
40
|
+
_(Optional)_
|
|
41
|
+
|
|
42
|
+
{% /parameter %}
|
|
43
|
+
|
|
44
|
+
{% parameter name="showIcon" type="boolean" optional=true %}
|
|
45
|
+
_(Optional)_
|
|
46
|
+
|
|
47
|
+
{% /parameter %}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# VideoConference
|
|
3
|
+
# VideoConference
|
|
4
4
|
|
|
5
5
|
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.
|
|
6
6
|
|
|
@@ -22,10 +22,21 @@ The component is implemented with other LiveKit components like `FocusContextPro
|
|
|
22
22
|
<LiveKitRoom>
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
{% partial file="p_usage.md" /%}
|
|
25
|
+
{% partial file="p_usage.md" variables={exampleCount: 1} /%}
|
|
26
26
|
|
|
27
27
|
## Properties
|
|
28
28
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
29
|
+
{% parameter name="chatMessageDecoder" type="MessageDecoder" optional=true %}
|
|
30
|
+
_(Optional)_
|
|
31
|
+
|
|
32
|
+
{% /parameter %}
|
|
33
|
+
|
|
34
|
+
{% parameter name="chatMessageEncoder" type="MessageEncoder" optional=true %}
|
|
35
|
+
_(Optional)_
|
|
36
|
+
|
|
37
|
+
{% /parameter %}
|
|
38
|
+
|
|
39
|
+
{% parameter name="chatMessageFormatter" type="MessageFormatter" optional=true %}
|
|
40
|
+
_(Optional)_
|
|
41
|
+
|
|
42
|
+
{% /parameter %}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# VideoTrack
|
|
3
|
+
# VideoTrack
|
|
4
4
|
|
|
5
5
|
The VideoTrack component is responsible for rendering participant video tracks like `camera` and `screen_share`<!-- -->. This component must have access to the participant's context, or alternatively pass it a `Participant` as a property.
|
|
6
6
|
|
|
@@ -16,15 +16,39 @@ import { VideoTrack } from '@livekit/components-react';
|
|
|
16
16
|
<VideoTrack source={Track.Source.Camera} />
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
{% partial file="p_usage.md" /%}
|
|
19
|
+
{% partial file="p_usage.md" variables={exampleCount: 1} /%}
|
|
20
20
|
|
|
21
21
|
## Properties
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
23
|
+
{% parameter name="source" type="Track.Source" optional=false %}
|
|
24
|
+
{% /parameter %}
|
|
25
|
+
|
|
26
|
+
{% parameter name="manageSubscription" type="boolean" optional=true %}
|
|
27
|
+
_(Optional)_
|
|
28
|
+
|
|
29
|
+
{% /parameter %}
|
|
30
|
+
|
|
31
|
+
{% parameter name="name" type="string" optional=true %}
|
|
32
|
+
_(Optional)_
|
|
33
|
+
|
|
34
|
+
{% /parameter %}
|
|
35
|
+
|
|
36
|
+
{% parameter name="onSubscriptionStatusChanged" type="(subscribed: boolean) => void" optional=true %}
|
|
37
|
+
_(Optional)_
|
|
38
|
+
|
|
39
|
+
{% /parameter %}
|
|
40
|
+
|
|
41
|
+
{% parameter name="onTrackClick" type="(evt: ParticipantClickEvent) => void" optional=true %}
|
|
42
|
+
_(Optional)_
|
|
43
|
+
|
|
44
|
+
{% /parameter %}
|
|
45
|
+
|
|
46
|
+
{% parameter name="participant" type="Participant" optional=true %}
|
|
47
|
+
_(Optional)_
|
|
48
|
+
|
|
49
|
+
{% /parameter %}
|
|
50
|
+
|
|
51
|
+
{% parameter name="publication" type="TrackPublication" optional=true %}
|
|
52
|
+
_(Optional)_
|
|
53
|
+
|
|
54
|
+
{% /parameter %}
|
|
@@ -10,4 +10,4 @@ export interface ConnectionQualityIndicatorProps extends React.HTMLAttributes<HT
|
|
|
10
10
|
|
|
11
11
|
**Extends:** React.HTMLAttributes<HTMLDivElement>, [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md)
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
@@ -10,7 +10,7 @@ export interface ConnectionStateToastProps extends React.HTMLAttributes<HTMLDivE
|
|
|
10
10
|
|
|
11
11
|
**Extends:** React.HTMLAttributes<HTMLDivElement>
|
|
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 ConnectionStatusProps extends React.HTMLAttributes<HTMLDivEleme
|
|
|
10
10
|
|
|
11
11
|
**Extends:** React.HTMLAttributes<HTMLDivElement>
|
|
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 ControlBarProps extends React.HTMLAttributes<HTMLDivElement>
|
|
|
10
10
|
|
|
11
11
|
**Extends:** React.HTMLAttributes<HTMLDivElement>
|
|
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 DisconnectButtonProps extends React.ButtonHTMLAttributes<HTMLBu
|
|
|
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 FocusLayoutContainerProps extends React.HTMLAttributes<HTMLDivE
|
|
|
10
10
|
|
|
11
11
|
**Extends:** React.HTMLAttributes<HTMLDivElement>
|
|
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 FocusLayoutProps extends React.HTMLAttributes<HTMLElement>
|
|
|
10
10
|
|
|
11
11
|
**Extends:** React.HTMLAttributes<HTMLElement>
|
|
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 FocusToggleProps extends React.ButtonHTMLAttributes<HTMLButtonE
|
|
|
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
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# formatChatMessageLinks
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export declare function formatChatMessageLinks(message: string): React.ReactNode;
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
@@ -10,7 +10,7 @@ export interface GridLayoutProps extends React.HTMLAttributes<HTMLDivElement>, P
|
|
|
10
10
|
|
|
11
11
|
**Extends:** React.HTMLAttributes<HTMLDivElement>, Pick<[UseParticipantsOptions](./react/useparticipantsoptions.md)<!-- -->, 'updateOnlyOn'>
|
|
12
12
|
|
|
13
|
-
{% partial file="p_usage.md" /%}
|
|
13
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
14
14
|
|
|
15
15
|
## Properties
|
|
16
16
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useChat
|
|
3
|
+
# useChat
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,8 +8,16 @@
|
|
|
8
8
|
import { useChat } 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
|
-
{
|
|
15
|
+
{% parameter name="options" type="{
|
|
16
|
+
messageEncoder?: MessageEncoder;
|
|
17
|
+
messageDecoder?: MessageDecoder;
|
|
18
|
+
}" optional=true %}
|
|
19
|
+
{% /parameter %}
|
|
20
|
+
|
|
21
|
+
## Returns
|
|
22
|
+
|
|
23
|
+
`{ send: ((message: string) => Promise<void>) | undefined; chatMessages: ReceivedChatMessage[]; isSending: boolean; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useChatToggle
|
|
3
|
+
# useChatToggle
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,14 +8,13 @@
|
|
|
8
8
|
import { useChatToggle } 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 } | [UseChatToggleProps](./react/usechattoggleprops.md) | |
|
|
15
|
+
{% parameter name="{ props }" type="UseChatToggleProps" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
{
|
|
20
|
+
`{ mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & { className: string; onClick: () => void; 'aria-pressed': string; 'data-lk-unread-msgs': string; }; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useClearPinButton
|
|
3
|
+
# useClearPinButton
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,14 +8,13 @@
|
|
|
8
8
|
import { useClearPinButton } 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 | [ClearPinButtonProps](./react/clearpinbuttonprops.md) | |
|
|
15
|
+
{% parameter name="props" type="ClearPinButtonProps" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
{
|
|
20
|
+
`{ buttonProps: ClearPinButtonProps & { className: string; disabled: boolean; onClick: () => void; }; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useConnectionQualityIndicator
|
|
3
|
+
# useConnectionQualityIndicator
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,14 +8,13 @@
|
|
|
8
8
|
import { useConnectionQualityIndicator } 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 | [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md) | _(Optional)_ |
|
|
15
|
+
{% parameter name="options" type="ConnectionQualityIndicatorOptions" optional=true %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
{
|
|
20
|
+
`{ className: "lk-rotate" | "lk-audio-conference" | "lk-audio-conference-stage" | "lk-audio-container" | "lk-button" | "lk-button-group" | "lk-button-group-container" | "lk-camera-off-note" | "lk-chat" | "lk-chat-entry" | "lk-chat-form" | "lk-chat-form-input" | "lk-chat-messages" | "lk-control-bar" | "lk-focus-layout-wrapper" | "lk-form-control" | "lk-grid-layout-wrapper" | "lk-join-button" | "lk-list" | "lk-message-body" | "lk-meta-data" | "lk-participant-name" | "lk-prejoin" | "lk-timestamp" | "lk-username-container" | "lk-video-conference" | "lk-video-conference-inner" | "lk-video-container" | "lk-audio-visualizer" | "lk-button-group-menu" | "lk-button-menu" | "lk-carousel" | "lk-chat-toggle" | "lk-connection-quality" | "lk-device-menu" | "lk-device-menu-heading" | "lk-disconnect-button" | "lk-focus-layout" | "lk-focus-toggle-button" | "lk-focused-participant" | "lk-grid-layout" | "lk-media-device-select" | "lk-pagination-control" | "lk-pagination-count" | "lk-pagination-indicator" | "lk-participant-media-audio" | "lk-participant-media-video" | "lk-participant-metadata" | "lk-participant-metadata-item" | "lk-participant-placeholder" | "lk-participant-tile" | "lk-pip-track" | "lk-room-container" | "lk-spinner" | "lk-start-audio-button" | "lk-toast" | "lk-track-muted-indicator-camera" | "lk-track-muted-indicator-microphone"; quality: ConnectionQuality; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useConnectionState
|
|
3
|
+
# useConnectionState
|
|
4
4
|
|
|
5
5
|
The `useConnectionState` hook allows you to simply implement your own `ConnectionState` component.
|
|
6
6
|
|
|
@@ -16,14 +16,13 @@ import { useConnectionState } from '@livekit/components-react';
|
|
|
16
16
|
const connectionState = useConnectionState(room);
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
{% partial file="p_usage.md" /%}
|
|
19
|
+
{% partial file="p_usage.md" variables={exampleCount: 1} /%}
|
|
20
20
|
|
|
21
21
|
## Parameters
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
| room | Room | _(Optional)_ |
|
|
23
|
+
{% parameter name="room" type="Room" optional=true %}
|
|
24
|
+
{% /parameter %}
|
|
26
25
|
|
|
27
|
-
|
|
26
|
+
## Returns
|
|
28
27
|
|
|
29
|
-
import("livekit-client").ConnectionState
|
|
28
|
+
`import("livekit-client").ConnectionState`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useCreateLayoutContext
|
|
3
|
+
# useCreateLayoutContext
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,8 +8,8 @@
|
|
|
8
8
|
import { useCreateLayoutContext } 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
|
-
|
|
15
|
+
`LayoutContextType`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useDataChannel
|
|
3
|
+
# useDataChannel
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,15 +8,16 @@
|
|
|
8
8
|
import { useDataChannel } 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
|
-
| topic | T | |
|
|
18
|
-
| onMessage | (msg: [ReceivedDataMessage](./core/receiveddatamessage.md)<!-- --><T>) => void | _(Optional)_ |
|
|
15
|
+
{% parameter name="topic" type="T" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
19
17
|
|
|
20
|
-
|
|
18
|
+
{% parameter name="onMessage" type="(msg: ReceivedDataMessage<T>) => void" optional=true %}
|
|
19
|
+
{% /parameter %}
|
|
21
20
|
|
|
22
|
-
|
|
21
|
+
## Returns
|
|
22
|
+
|
|
23
|
+
`UseDataChannelReturnType<T>`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useDataChannel
|
|
3
|
+
# useDataChannel
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,14 +8,13 @@
|
|
|
8
8
|
import { useDataChannel } 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
|
-
| onMessage | (msg: [ReceivedDataMessage](./core/receiveddatamessage.md)<!-- -->) => void | _(Optional)_ |
|
|
15
|
+
{% parameter name="onMessage" type="(msg: ReceivedDataMessage) => void" optional=true %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
UseDataChannelReturnType
|
|
20
|
+
`UseDataChannelReturnType`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useDisconnectButton
|
|
3
|
+
# useDisconnectButton
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,14 +8,13 @@
|
|
|
8
8
|
import { useDisconnectButton } 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 | [DisconnectButtonProps](./react/disconnectbuttonprops.md) | |
|
|
15
|
+
{% parameter name="props" type="DisconnectButtonProps" optional=false %}
|
|
16
|
+
{% /parameter %}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Returns
|
|
20
19
|
|
|
21
|
-
{
|
|
20
|
+
`{ buttonProps: DisconnectButtonProps & { className: string; onClick: () => void; disabled: boolean; }; }`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useEnsureCreateLayoutContext
|
|
3
|
+
# useEnsureCreateLayoutContext
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
@@ -8,14 +8,13 @@
|
|
|
8
8
|
import { useEnsureCreateLayoutContext } 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
|
-
| 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
|
+
`LayoutContextType`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
# useEnsureLayoutContext
|
|
3
|
+
# useEnsureLayoutContext
|
|
4
4
|
|
|
5
5
|
Ensures that a layout context is provided, either via context or explicitly as a parameter. If not inside a `LayoutContext` and no layout context is provided, an error is thrown.
|
|
6
6
|
|
|
@@ -10,14 +10,13 @@ Ensures that a layout context is provided, either via context or explicitly as a
|
|
|
10
10
|
import { useEnsureLayoutContext } 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
|
-
| layoutContext | [LayoutContextType](./react/layoutcontexttype.md) | _(Optional)_ |
|
|
17
|
+
{% parameter name="layoutContext" type="LayoutContextType" optional=true %}
|
|
18
|
+
{% /parameter %}
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
## Returns
|
|
22
21
|
|
|
23
|
-
|
|
22
|
+
`LayoutContextType`
|