@livekit/components-js-docs 0.0.5 → 0.1.1
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 +7 -0
- package/generated-docs/core/allparticipantevents.md +8 -1
- package/generated-docs/core/allparticipantroomevents.md +8 -1
- package/generated-docs/core/allremoteparticipantevents.md +8 -1
- package/generated-docs/core/allremoteparticipantroomevents.md +8 -1
- package/generated-docs/core/attachifsubscribed.md +8 -1
- package/generated-docs/core/audiosource.md +8 -1
- package/generated-docs/core/basedatamessage.md +8 -1
- package/generated-docs/core/basedatamessage.payload.md +5 -1
- package/generated-docs/core/basedatamessage.topic.md +5 -1
- package/generated-docs/core/captureoptionsbysource.md +8 -1
- package/generated-docs/core/chatmessage.md +8 -1
- package/generated-docs/core/chatmessage.message.md +5 -1
- package/generated-docs/core/chatmessage.timestamp.md +5 -1
- package/generated-docs/core/computemenuposition.md +8 -1
- package/generated-docs/core/connectedparticipantobserver.md +8 -1
- package/generated-docs/core/connectedparticipantobserveroptions.md +8 -1
- package/generated-docs/core/connectedparticipantsobserver.md +8 -1
- package/generated-docs/core/connectionstateobserver.md +9 -2
- package/generated-docs/core/createactivedeviceobservable.md +8 -1
- package/generated-docs/core/createconnectionqualityobserver.md +9 -2
- package/generated-docs/core/createdataobserver.md +11 -4
- package/generated-docs/core/createdefaultgrammar.md +8 -1
- package/generated-docs/core/createisspeakingobserver.md +7 -0
- package/generated-docs/core/createmediadeviceobserver.md +8 -1
- package/generated-docs/core/createtrackobserver.md +8 -1
- package/generated-docs/core/createurlregexp.md +8 -1
- package/generated-docs/core/cssprefix.md +9 -2
- package/generated-docs/core/datasendoptions.md +8 -1
- package/generated-docs/core/datatopic.md +8 -1
- package/generated-docs/core/encryptionstatusobservable.md +8 -1
- package/generated-docs/core/gettrackbyidentifier.md +9 -2
- package/generated-docs/core/gettrackreferenceid.md +13 -2
- package/generated-docs/core/gettrackreferencesource.md +8 -1
- package/generated-docs/core/grid_layouts.md +8 -1
- package/generated-docs/core/gridlayoutdefinition.md +8 -1
- package/generated-docs/core/index.md +119 -111
- package/generated-docs/core/isequaltrackref.md +8 -1
- package/generated-docs/core/islocal.md +7 -0
- package/generated-docs/core/ismobilebrowser.md +7 -0
- package/generated-docs/core/isparticipantsourcepinned.md +16 -1
- package/generated-docs/core/isparticipanttrackreferencepinned.md +23 -0
- package/generated-docs/core/isremote.md +7 -0
- package/generated-docs/core/issourceswithoptions.md +8 -1
- package/generated-docs/core/issourcewitoptions.md +8 -1
- package/generated-docs/core/istrackreference.md +7 -0
- package/generated-docs/core/istrackreferencepinned.md +8 -1
- package/generated-docs/core/istrackreferenceplaceholder.md +8 -1
- package/generated-docs/core/log.md +8 -1
- package/generated-docs/core/mediatoggletype.md +8 -1
- package/generated-docs/{react → core}/messagedecoder.md +8 -1
- package/generated-docs/{react → core}/messageencoder.md +8 -1
- package/generated-docs/core/mutedobserver.md +8 -4
- package/generated-docs/core/observeparticipantevents.md +7 -0
- package/generated-docs/core/observeparticipantmedia.md +8 -1
- package/generated-docs/core/observeroomevents.md +7 -0
- package/generated-docs/core/observetrackevents.md +7 -0
- package/generated-docs/core/participantclickevent.md +8 -1
- package/generated-docs/core/participantclickevent.participant.md +5 -1
- package/generated-docs/core/participantclickevent.track.md +5 -1
- package/generated-docs/core/participanteventselector.md +8 -1
- package/generated-docs/core/participantfilter.md +9 -2
- package/generated-docs/core/participantinfoobserver.md +7 -0
- package/generated-docs/core/participantmedia.cameratrack.md +5 -1
- package/generated-docs/core/participantmedia.iscameraenabled.md +5 -1
- package/generated-docs/core/participantmedia.ismicrophoneenabled.md +5 -1
- package/generated-docs/core/participantmedia.isscreenshareenabled.md +5 -1
- package/generated-docs/core/participantmedia.md +8 -1
- package/generated-docs/core/participantmedia.microphonetrack.md +5 -1
- package/generated-docs/core/participantmedia.participant.md +5 -1
- package/generated-docs/core/participantpermissionobserver.md +9 -2
- package/generated-docs/core/pin_default_state.md +8 -1
- package/generated-docs/core/pinstate.md +8 -1
- package/generated-docs/core/receivedchatmessage.from.md +5 -1
- package/generated-docs/core/receivedchatmessage.md +8 -1
- package/generated-docs/core/receiveddatamessage.from.md +5 -1
- package/generated-docs/core/receiveddatamessage.md +8 -1
- package/generated-docs/core/requireonlyone.md +8 -1
- package/generated-docs/core/roomaudioplaybackallowedobservable.md +7 -0
- package/generated-docs/core/roomeventselector.md +8 -1
- package/generated-docs/core/roominfoobserver.md +7 -0
- package/generated-docs/core/roomobserver.md +7 -0
- package/generated-docs/core/screenshareobserver.md +7 -0
- package/generated-docs/core/screensharetrackmap.md +8 -1
- package/generated-docs/core/selectgridlayout.md +8 -1
- package/generated-docs/core/sendmessage.md +8 -1
- package/generated-docs/core/setdifference.md +7 -0
- package/generated-docs/core/setloglevel.md +7 -0
- package/generated-docs/core/setmediadeviceoptions.md +8 -1
- package/generated-docs/core/setupchat.md +9 -2
- package/generated-docs/core/setupchattoggle.md +7 -0
- package/generated-docs/core/setupclearpinbutton.md +7 -0
- package/generated-docs/core/setupconnectionqualityindicator.md +9 -60
- package/generated-docs/core/setupdatamessagehandler.md +9 -2
- package/generated-docs/core/setupdeviceselector.md +9 -2
- package/generated-docs/core/setupdisconnectbutton.md +7 -0
- package/generated-docs/core/setupfocustoggle.md +7 -0
- package/generated-docs/core/setuplivekitroom.md +7 -0
- package/generated-docs/core/setupmanualtoggle.md +7 -0
- package/generated-docs/core/setupmediatoggle.md +8 -1
- package/generated-docs/core/setupmediatrack.md +8 -1
- package/generated-docs/core/setupparticipantname.md +8 -1
- package/generated-docs/core/setupparticipanttile.md +7 -0
- package/generated-docs/core/setupstartaudio.md +7 -0
- package/generated-docs/core/setuptrackmutedindicator.md +9 -5
- package/generated-docs/core/sortparticipants.md +7 -0
- package/generated-docs/core/sorttrackreferences.md +8 -1
- package/generated-docs/core/sourcesarray.md +8 -1
- package/generated-docs/core/supportsscreensharing.md +7 -0
- package/generated-docs/core/togglesource.md +8 -1
- package/generated-docs/core/tokenize.md +8 -1
- package/generated-docs/core/tokenizegrammar.md +8 -1
- package/generated-docs/core/trackidentifier.md +8 -1
- package/generated-docs/core/trackobservable.md +7 -0
- package/generated-docs/core/trackreference.md +8 -1
- package/generated-docs/core/trackreferencefilter.md +9 -2
- package/generated-docs/core/trackreferenceid.md +16 -0
- package/generated-docs/core/trackreferenceorplaceholder.md +8 -1
- package/generated-docs/core/trackreferenceplaceholder.md +8 -1
- package/generated-docs/core/trackreferencesobservable.md +8 -1
- package/generated-docs/core/tracksource.md +9 -2
- package/generated-docs/core/tracksourcewithoptions.md +8 -1
- package/generated-docs/core/updatepages.md +8 -1
- package/generated-docs/core/videosource.md +8 -1
- package/generated-docs/core/wasclickoutside.md +7 -0
- package/generated-docs/core/widget_default_state.md +8 -1
- package/generated-docs/core/widgetstate.md +8 -1
- package/generated-docs/index.md +5 -1
- package/generated-docs/react/allowaudioplaybackprops.label.md +5 -1
- package/generated-docs/react/allowaudioplaybackprops.md +8 -1
- package/generated-docs/react/audioconferenceprops.md +8 -1
- package/generated-docs/react/audiotrackprops.md +17 -9
- package/generated-docs/react/audiotrackprops.name.md +15 -1
- package/generated-docs/react/audiotrackprops.onsubscriptionstatuschanged.md +5 -1
- package/generated-docs/react/audiotrackprops.participant.md +15 -1
- package/generated-docs/react/audiotrackprops.publication.md +15 -1
- package/generated-docs/react/audiotrackprops.source.md +16 -2
- package/generated-docs/react/audiotrackprops.trackref.md +17 -0
- package/generated-docs/react/audiotrackprops.volume.md +5 -1
- package/generated-docs/react/audiovisualizerprops.md +12 -4
- package/generated-docs/react/audiovisualizerprops.participant.md +15 -1
- package/generated-docs/react/audiovisualizerprops.trackref.md +13 -0
- package/generated-docs/react/{carouselviewprops.children.md → carousellayoutprops.children.md} +5 -1
- package/generated-docs/react/carousellayoutprops.md +28 -0
- package/generated-docs/react/{carouselviewprops.orientation.md → carousellayoutprops.orientation.md} +5 -1
- package/generated-docs/react/{carouselviewprops.tracks.md → carousellayoutprops.tracks.md} +5 -1
- package/generated-docs/react/carouselview.md +26 -0
- package/generated-docs/react/chatentryprops.entry.md +5 -1
- package/generated-docs/react/chatentryprops.hidename.md +5 -1
- package/generated-docs/react/chatentryprops.hidetimestamp.md +5 -1
- package/generated-docs/react/chatentryprops.md +8 -1
- package/generated-docs/react/chatentryprops.messageformatter.md +5 -1
- package/generated-docs/react/chatprops.md +10 -3
- package/generated-docs/react/chatprops.messagedecoder.md +5 -1
- package/generated-docs/react/chatprops.messageencoder.md +5 -1
- package/generated-docs/react/chatprops.messageformatter.md +5 -1
- package/generated-docs/react/chattoggleprops.md +8 -1
- package/generated-docs/react/clearpinbuttonprops.md +8 -1
- package/generated-docs/react/component/audioconference.md +8 -1
- package/generated-docs/react/component/audiotrack.md +40 -10
- package/generated-docs/react/component/audiovisualizer.md +31 -3
- package/generated-docs/react/component/{carouselview.md → carousellayout.md} +15 -4
- package/generated-docs/react/component/chat.md +8 -1
- package/generated-docs/react/component/chatentry.md +8 -1
- package/generated-docs/react/component/chattoggle.md +13 -2
- package/generated-docs/react/component/clearpinbutton.md +11 -4
- package/generated-docs/react/component/connectionqualityindicator.md +9 -2
- package/generated-docs/react/component/connectionstate.md +9 -2
- package/generated-docs/react/component/connectionstatetoast.md +10 -1
- package/generated-docs/react/component/controlbar.md +9 -2
- package/generated-docs/react/component/disconnectbutton.md +9 -2
- package/generated-docs/react/component/focuslayout.md +20 -2
- package/generated-docs/react/component/focuslayoutcontainer.md +20 -3
- package/generated-docs/react/component/focustoggle.md +30 -4
- package/generated-docs/react/component/gridlayout.md +13 -2
- package/generated-docs/react/component/livekitroom.md +9 -2
- package/generated-docs/react/component/mediadevicemenu.md +9 -2
- package/generated-docs/react/component/mediadeviceselect.md +9 -2
- package/generated-docs/react/component/participantaudiotile.md +29 -5
- package/generated-docs/react/component/participantcontextifneeded.md +19 -2
- package/generated-docs/react/component/participantloop.md +9 -2
- package/generated-docs/react/component/participantname.md +9 -2
- package/generated-docs/react/component/participanttile.md +43 -9
- package/generated-docs/react/component/prejoin.md +15 -3
- package/generated-docs/react/component/roomaudiorenderer.md +9 -2
- package/generated-docs/react/component/roomname.md +9 -2
- package/generated-docs/react/component/startaudio.md +9 -2
- package/generated-docs/react/component/toast.md +17 -2
- package/generated-docs/react/component/trackloop.md +14 -7
- package/generated-docs/react/component/trackmutedindicator.md +27 -5
- package/generated-docs/react/component/tracktoggle.md +9 -2
- package/generated-docs/react/component/videoconference.md +10 -3
- package/generated-docs/react/component/videotrack.md +40 -10
- package/generated-docs/react/connectionqualityindicatoroptions.md +8 -1
- package/generated-docs/react/connectionqualityindicatoroptions.participant.md +5 -1
- package/generated-docs/react/connectionqualityindicatorprops.md +8 -1
- package/generated-docs/react/connectionstatetoastprops.md +8 -1
- package/generated-docs/react/connectionstatetoastprops.room.md +5 -1
- package/generated-docs/react/connectionstatusprops.md +8 -1
- package/generated-docs/react/connectionstatusprops.room.md +5 -1
- package/generated-docs/react/controlbarcontrols.md +8 -1
- package/generated-docs/react/controlbarprops.controls.md +5 -1
- package/generated-docs/react/controlbarprops.md +8 -1
- package/generated-docs/react/controlbarprops.variation.md +5 -1
- package/generated-docs/react/disconnectbuttonprops.md +8 -1
- package/generated-docs/react/disconnectbuttonprops.stoptracks.md +5 -1
- package/generated-docs/react/focuslayoutcontainerprops.focustrack.md +15 -1
- package/generated-docs/react/focuslayoutcontainerprops.md +8 -1
- package/generated-docs/react/focuslayoutcontainerprops.participants.md +15 -1
- package/generated-docs/react/focuslayoutprops.md +13 -5
- package/generated-docs/react/focuslayoutprops.onparticipantclick.md +5 -1
- package/generated-docs/react/focuslayoutprops.track.md +15 -1
- package/generated-docs/react/focuslayoutprops.trackref.md +17 -0
- package/generated-docs/react/focustoggleprops.md +13 -5
- package/generated-docs/react/focustoggleprops.participant.md +15 -1
- package/generated-docs/react/focustoggleprops.trackref.md +13 -0
- package/generated-docs/react/focustoggleprops.tracksource.md +16 -2
- package/generated-docs/react/formatchatmessagelinks.md +7 -0
- package/generated-docs/react/gridlayoutprops.children.md +5 -1
- package/generated-docs/react/gridlayoutprops.md +8 -1
- package/generated-docs/react/gridlayoutprops.tracks.md +5 -1
- package/generated-docs/react/hook/usechat.md +19 -6
- package/generated-docs/react/hook/usechattoggle.md +16 -3
- package/generated-docs/react/hook/useclearpinbutton.md +10 -6
- package/generated-docs/react/hook/useconnectionqualityindicator.md +21 -61
- package/generated-docs/react/hook/useconnectionstate.md +10 -3
- package/generated-docs/react/hook/usecreatelayoutcontext.md +8 -1
- package/generated-docs/react/hook/usedatachannel.md +23 -3
- package/generated-docs/react/hook/usedatachannel_1.md +23 -3
- package/generated-docs/react/hook/usedisconnectbutton.md +20 -4
- package/generated-docs/react/hook/useensurecreatelayoutcontext.md +9 -2
- package/generated-docs/react/hook/useensurelayoutcontext.md +9 -2
- package/generated-docs/react/hook/useensureparticipant.md +9 -2
- package/generated-docs/react/hook/useensureroom.md +9 -2
- package/generated-docs/react/hook/useensuretrackref.md +31 -0
- package/generated-docs/react/hook/useensuretrackreference.md +17 -2
- package/generated-docs/react/hook/usefocustoggle.md +37 -4
- package/generated-docs/react/hook/usegridlayout.md +17 -4
- package/generated-docs/react/hook/useismuted.md +18 -6
- package/generated-docs/react/hook/useismuted_1.md +40 -0
- package/generated-docs/react/hook/useisspeaking.md +18 -3
- package/generated-docs/react/hook/uselayoutcontext.md +8 -1
- package/generated-docs/react/hook/uselivekitroom.md +77 -4
- package/generated-docs/react/hook/uselocalparticipant.md +17 -4
- package/generated-docs/react/hook/uselocalparticipantpermissions.md +18 -3
- package/generated-docs/react/hook/usemaybelayoutcontext.md +8 -1
- package/generated-docs/react/hook/usemaybeparticipantcontext.md +8 -1
- package/generated-docs/react/hook/usemayberoomcontext.md +8 -1
- package/generated-docs/react/hook/usemaybetrackcontext.md +16 -1
- package/generated-docs/react/hook/usemaybetrackrefcontext.md +26 -0
- package/generated-docs/react/hook/usemediadevices.md +21 -5
- package/generated-docs/react/hook/usemediadeviceselect.md +32 -4
- package/generated-docs/react/hook/usemediatrack.md +19 -4
- package/generated-docs/react/hook/usemediatrackbyname.md +20 -5
- package/generated-docs/react/hook/useparticipantcontext.md +8 -1
- package/generated-docs/react/hook/useparticipantinfo.md +9 -2
- package/generated-docs/react/hook/useparticipantpermissions.md +10 -3
- package/generated-docs/react/hook/useparticipants.md +24 -4
- package/generated-docs/react/hook/useparticipanttile.md +48 -3
- package/generated-docs/react/hook/usepinnedtracks.md +22 -3
- package/generated-docs/react/hook/usepreviewdevice.md +9 -2
- package/generated-docs/react/hook/useremoteparticipant.md +22 -3
- package/generated-docs/react/hook/useremoteparticipants.md +24 -4
- package/generated-docs/react/hook/useroomcontext.md +8 -1
- package/generated-docs/react/hook/useroominfo.md +9 -2
- package/generated-docs/react/hook/usesortedparticipants.md +10 -3
- package/generated-docs/react/hook/usespeakingparticipants.md +16 -3
- package/generated-docs/react/hook/usetoken.md +18 -3
- package/generated-docs/react/hook/usetrack.md +38 -0
- package/generated-docs/react/hook/usetrackbyname.md +38 -0
- package/generated-docs/react/hook/usetrackcontext.md +17 -2
- package/generated-docs/react/hook/usetrackmutedindicator.md +19 -10
- package/generated-docs/react/hook/usetrackmutedindicator_1.md +40 -0
- package/generated-docs/react/hook/usetrackrefcontext.md +26 -0
- package/generated-docs/react/hook/usetracks.md +10 -3
- package/generated-docs/react/hook/usetracktoggle.md +16 -5
- package/generated-docs/react/hook/usevisualstableupdate.md +22 -8
- package/generated-docs/react/index.md +168 -156
- package/generated-docs/react/layoutcontext.md +8 -1
- package/generated-docs/react/layoutcontexttype.md +8 -1
- package/generated-docs/react/livekitroomprops.audio.md +5 -1
- package/generated-docs/react/livekitroomprops.connect.md +5 -1
- package/generated-docs/react/livekitroomprops.connectoptions.md +5 -1
- package/generated-docs/react/livekitroomprops.md +8 -1
- package/generated-docs/react/livekitroomprops.onconnected.md +5 -1
- package/generated-docs/react/livekitroomprops.ondisconnected.md +5 -1
- package/generated-docs/react/livekitroomprops.onerror.md +5 -1
- package/generated-docs/react/livekitroomprops.onmediadevicefailure.md +5 -1
- package/generated-docs/react/livekitroomprops.options.md +5 -1
- package/generated-docs/react/livekitroomprops.room.md +5 -1
- package/generated-docs/react/livekitroomprops.screen.md +5 -1
- package/generated-docs/react/livekitroomprops.serverurl.md +5 -1
- package/generated-docs/react/livekitroomprops.simulateparticipants.md +5 -1
- package/generated-docs/react/livekitroomprops.token.md +5 -1
- package/generated-docs/react/livekitroomprops.video.md +5 -1
- package/generated-docs/react/localuserchoices.md +10 -1
- package/generated-docs/react/mediadevicemenuprops.initialselection.md +5 -1
- package/generated-docs/react/mediadevicemenuprops.kind.md +5 -1
- package/generated-docs/react/mediadevicemenuprops.md +8 -1
- package/generated-docs/react/mediadevicemenuprops.onactivedevicechange.md +5 -1
- package/generated-docs/react/mediadevicemenuprops.requestpermissions.md +5 -1
- package/generated-docs/react/mediadevicemenuprops.tracks.md +5 -1
- package/generated-docs/react/mediadeviceselectprops.exactmatch.md +5 -1
- package/generated-docs/react/mediadeviceselectprops.initialselection.md +5 -1
- package/generated-docs/react/mediadeviceselectprops.kind.md +5 -1
- package/generated-docs/react/mediadeviceselectprops.md +8 -1
- package/generated-docs/react/mediadeviceselectprops.onactivedevicechange.md +5 -1
- package/generated-docs/react/mediadeviceselectprops.ondevicelistchange.md +5 -1
- package/generated-docs/react/mediadeviceselectprops.ondeviceselecterror.md +5 -1
- package/generated-docs/react/mediadeviceselectprops.requestpermissions.md +5 -1
- package/generated-docs/react/mediadeviceselectprops.track.md +5 -1
- package/generated-docs/react/messageformatter.md +8 -1
- package/generated-docs/react/meta-data.json +1 -1
- package/generated-docs/react/participantcontext.md +8 -1
- package/generated-docs/react/participantloopprops.children.md +5 -1
- package/generated-docs/react/participantloopprops.md +8 -1
- package/generated-docs/react/participantloopprops.participants.md +5 -1
- package/generated-docs/react/participantnameprops.md +8 -1
- package/generated-docs/react/participanttileprops.disablespeakingindicator.md +5 -1
- package/generated-docs/react/participanttileprops.md +16 -8
- package/generated-docs/react/participanttileprops.onparticipantclick.md +5 -1
- package/generated-docs/react/participanttileprops.participant.md +15 -1
- package/generated-docs/react/participanttileprops.publication.md +15 -1
- package/generated-docs/react/participanttileprops.source.md +15 -1
- package/generated-docs/react/participanttileprops.trackref.md +17 -0
- package/generated-docs/react/prejoinprops.camlabel.md +5 -1
- package/generated-docs/react/prejoinprops.debug.md +5 -1
- package/generated-docs/react/prejoinprops.defaults.md +5 -1
- package/generated-docs/react/prejoinprops.joinlabel.md +5 -1
- package/generated-docs/react/prejoinprops.md +20 -12
- package/generated-docs/react/prejoinprops.miclabel.md +5 -1
- package/generated-docs/react/prejoinprops.onerror.md +5 -1
- package/generated-docs/react/prejoinprops.onsubmit.md +5 -1
- package/generated-docs/react/prejoinprops.onvalidate.md +5 -1
- package/generated-docs/react/prejoinprops.showe2eeoptions.md +13 -0
- package/generated-docs/react/prejoinprops.userlabel.md +5 -1
- package/generated-docs/react/roomcontext.md +8 -1
- package/generated-docs/react/roomnameprops.childrenposition.md +5 -1
- package/generated-docs/react/roomnameprops.md +8 -1
- package/generated-docs/react/trackcontext.md +16 -1
- package/generated-docs/react/trackloopprops.children.md +5 -1
- package/generated-docs/react/trackloopprops.md +8 -1
- package/generated-docs/react/trackloopprops.tracks.md +5 -1
- package/generated-docs/react/trackmutedindicatorprops.md +14 -6
- package/generated-docs/react/trackmutedindicatorprops.participant.md +15 -1
- package/generated-docs/react/trackmutedindicatorprops.show.md +5 -1
- package/generated-docs/react/trackmutedindicatorprops.source.md +16 -2
- package/generated-docs/react/trackmutedindicatorprops.trackref.md +13 -0
- package/generated-docs/react/trackrefcontext.md +20 -0
- package/generated-docs/react/tracktoggleprops.captureoptions.md +5 -1
- package/generated-docs/react/tracktoggleprops.initialstate.md +5 -1
- package/generated-docs/react/tracktoggleprops.md +8 -1
- package/generated-docs/react/tracktoggleprops.onchange.md +5 -1
- package/generated-docs/react/tracktoggleprops.showicon.md +5 -1
- package/generated-docs/react/tracktoggleprops.source.md +5 -1
- package/generated-docs/react/usechattoggleprops.md +8 -1
- package/generated-docs/react/usechattoggleprops.props.md +5 -1
- package/generated-docs/react/usefocustoggleprops.md +14 -6
- package/generated-docs/react/usefocustoggleprops.participant.md +15 -1
- package/generated-docs/react/usefocustoggleprops.props.md +5 -1
- package/generated-docs/react/usefocustoggleprops.trackref.md +13 -0
- package/generated-docs/react/usefocustoggleprops.tracksource.md +16 -2
- package/generated-docs/react/useismutedoptions.md +8 -1
- package/generated-docs/react/useismutedoptions.participant.md +5 -1
- package/generated-docs/react/uselocalparticipantoptions.md +8 -1
- package/generated-docs/react/uselocalparticipantoptions.room.md +5 -1
- package/generated-docs/react/usemediadeviceselectprops.kind.md +5 -1
- package/generated-docs/react/usemediadeviceselectprops.md +8 -1
- package/generated-docs/react/usemediadeviceselectprops.requestpermissions.md +5 -1
- package/generated-docs/react/usemediadeviceselectprops.room.md +5 -1
- package/generated-docs/react/usemediadeviceselectprops.track.md +5 -1
- package/generated-docs/react/usemediatrackoptions.element.md +5 -1
- package/generated-docs/react/usemediatrackoptions.md +8 -1
- package/generated-docs/react/usemediatrackoptions.props.md +5 -1
- package/generated-docs/react/useparticipantinfooptions.md +17 -2
- package/generated-docs/react/useparticipantinfooptions.participant.md +5 -1
- package/generated-docs/react/useparticipantpermissionsoptions.md +17 -2
- package/generated-docs/react/useparticipantpermissionsoptions.participant.md +5 -1
- package/generated-docs/react/useparticipantsoptions.md +8 -1
- package/generated-docs/react/useparticipantsoptions.room.md +5 -1
- package/generated-docs/react/useparticipantsoptions.updateonlyon.md +5 -1
- package/generated-docs/react/useparticipanttileprops.disablespeakingindicator.md +5 -1
- package/generated-docs/react/useparticipanttileprops.htmlprops.md +5 -1
- package/generated-docs/react/useparticipanttileprops.md +17 -9
- package/generated-docs/react/useparticipanttileprops.onparticipantclick.md +5 -1
- package/generated-docs/react/useparticipanttileprops.participant.md +16 -2
- package/generated-docs/react/useparticipanttileprops.publication.md +15 -1
- package/generated-docs/react/useparticipanttileprops.source.md +16 -2
- package/generated-docs/react/useparticipanttileprops.trackref.md +17 -0
- package/generated-docs/react/useremoteparticipantoptions.md +11 -4
- package/generated-docs/react/useremoteparticipantoptions.updateonlyon.md +9 -1
- package/generated-docs/react/useremoteparticipantsoptions.md +8 -1
- package/generated-docs/react/useremoteparticipantsoptions.room.md +5 -1
- package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md +5 -1
- package/generated-docs/react/userinfo.identity.md +5 -1
- package/generated-docs/react/userinfo.md +8 -1
- package/generated-docs/react/userinfo.metadata.md +5 -1
- package/generated-docs/react/userinfo.name.md +5 -1
- package/generated-docs/react/useroominfooptions.md +21 -2
- package/generated-docs/react/useroominfooptions.room.md +5 -1
- package/generated-docs/react/usetokenoptions.md +8 -1
- package/generated-docs/react/usetokenoptions.userinfo.md +5 -1
- package/generated-docs/react/usetrackmutedindicatoroptions.md +8 -1
- package/generated-docs/react/usetrackmutedindicatoroptions.participant.md +15 -1
- package/generated-docs/react/usetrackoptions.element.md +13 -0
- package/generated-docs/react/usetrackoptions.md +25 -0
- package/generated-docs/react/usetrackoptions.props.md +13 -0
- package/generated-docs/react/usetrackshookreturntype.md +8 -1
- package/generated-docs/react/usetracksoptions.md +8 -1
- package/generated-docs/react/usetracktoggleprops.md +8 -1
- package/generated-docs/react/usevisualstableupdateoptions.customsortfunction.md +5 -1
- package/generated-docs/react/usevisualstableupdateoptions.md +8 -1
- package/generated-docs/react/videoconferenceprops.chatmessagedecoder.md +5 -1
- package/generated-docs/react/videoconferenceprops.chatmessageencoder.md +5 -1
- package/generated-docs/react/videoconferenceprops.chatmessageformatter.md +5 -1
- package/generated-docs/react/videoconferenceprops.md +10 -3
- package/generated-docs/react/videotrackprops.managesubscription.md +5 -1
- package/generated-docs/react/videotrackprops.md +18 -10
- package/generated-docs/react/videotrackprops.name.md +15 -1
- package/generated-docs/react/videotrackprops.onsubscriptionstatuschanged.md +5 -1
- package/generated-docs/react/videotrackprops.ontrackclick.md +5 -1
- package/generated-docs/react/videotrackprops.participant.md +15 -1
- package/generated-docs/react/videotrackprops.publication.md +15 -1
- package/generated-docs/react/videotrackprops.source.md +16 -2
- package/generated-docs/react/videotrackprops.trackref.md +17 -0
- package/package.json +1 -1
- package/generated-docs/react/carouselviewprops.md +0 -21
|
@@ -1,6 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "LayoutContext variable",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/layout-context.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
1
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
9
|
|
|
3
|
-
|
|
10
|
+
# LayoutContext variable
|
|
4
11
|
|
|
5
12
|
**Signature:**
|
|
6
13
|
|
|
@@ -1,6 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "LayoutContextType type",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/layout-context.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
1
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
9
|
|
|
3
|
-
|
|
10
|
+
# LayoutContextType type
|
|
4
11
|
|
|
5
12
|
**Signature:**
|
|
6
13
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "LiveKitRoomProps.audio property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# LiveKitRoomProps.audio property
|
|
4
8
|
|
|
5
9
|
Publish audio immediately after connecting to your LiveKit room.
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "LiveKitRoomProps.connect property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# LiveKitRoomProps.connect property
|
|
4
8
|
|
|
5
9
|
If set to true a connection to LiveKit room is initiated.
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "LiveKitRoomProps.connectOptions property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# LiveKitRoomProps.connectOptions property
|
|
4
8
|
|
|
5
9
|
Define options how to connect to the LiveKit server.
|
|
6
10
|
|
|
@@ -1,6 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "LiveKitRoomProps interface",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/LiveKitRoom.tsx"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
1
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
9
|
|
|
3
|
-
|
|
10
|
+
# LiveKitRoomProps interface
|
|
4
11
|
|
|
5
12
|
**Signature:**
|
|
6
13
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "LiveKitRoomProps.onDisconnected property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# LiveKitRoomProps.onDisconnected property
|
|
4
8
|
|
|
5
9
|
**Signature:**
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "LiveKitRoomProps.onMediaDeviceFailure property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# LiveKitRoomProps.onMediaDeviceFailure property
|
|
4
8
|
|
|
5
9
|
**Signature:**
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "LiveKitRoomProps.options property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# LiveKitRoomProps.options property
|
|
4
8
|
|
|
5
9
|
Options for when creating a new room. When you pass your own room instance to this component, these options have no effect. Instead, set the options directly in the room instance.
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "LiveKitRoomProps.room property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# LiveKitRoomProps.room property
|
|
4
8
|
|
|
5
9
|
Optional room instance. By passing your own room instance you overwrite the `options` parameter, make sure to set the options directly on the room instance itself.
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "LiveKitRoomProps.screen property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# LiveKitRoomProps.screen property
|
|
4
8
|
|
|
5
9
|
Publish screen share immediately after connecting to your LiveKit room.
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "LiveKitRoomProps.serverUrl property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# LiveKitRoomProps.serverUrl property
|
|
4
8
|
|
|
5
9
|
URL to the LiveKit server. For example: `wss://<domain>.livekit.cloud` To simplify the implementation, `undefined` is also accepted as an intermediate value, but only with a valid string url can the connection be established.
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "LiveKitRoomProps.simulateParticipants property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# LiveKitRoomProps.simulateParticipants property
|
|
4
8
|
|
|
5
9
|
**Signature:**
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "LiveKitRoomProps.token property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# LiveKitRoomProps.token property
|
|
4
8
|
|
|
5
9
|
A user specific access token for a client to authenticate to the room. This token is necessary to establish a connection to the room. To simplify the implementation, `undefined` is also accepted as an intermediate value, but only with a valid string token can the connection be established.
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "LiveKitRoomProps.video property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# LiveKitRoomProps.video property
|
|
4
8
|
|
|
5
9
|
Publish video immediately after connecting to your LiveKit room.
|
|
6
10
|
|
|
@@ -1,6 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "LocalUserChoices type",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/PreJoin.tsx"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
1
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
9
|
|
|
3
|
-
|
|
10
|
+
# LocalUserChoices type
|
|
4
11
|
|
|
5
12
|
**Signature:**
|
|
6
13
|
|
|
@@ -11,6 +18,8 @@ export type LocalUserChoices = {
|
|
|
11
18
|
audioEnabled: boolean;
|
|
12
19
|
videoDeviceId: string;
|
|
13
20
|
audioDeviceId: string;
|
|
21
|
+
e2ee: boolean;
|
|
22
|
+
sharedPassphrase: string;
|
|
14
23
|
};
|
|
15
24
|
```
|
|
16
25
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MediaDeviceMenuProps.initialSelection property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# MediaDeviceMenuProps.initialSelection property
|
|
4
8
|
|
|
5
9
|
**Signature:**
|
|
6
10
|
|
|
@@ -1,6 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "MediaDeviceMenuProps interface",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/MediaDeviceMenu.tsx"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
1
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
9
|
|
|
3
|
-
|
|
10
|
+
# MediaDeviceMenuProps interface
|
|
4
11
|
|
|
5
12
|
**Signature:**
|
|
6
13
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MediaDeviceMenuProps.onActiveDeviceChange property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# MediaDeviceMenuProps.onActiveDeviceChange property
|
|
4
8
|
|
|
5
9
|
**Signature:**
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MediaDeviceMenuProps.requestPermissions property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# MediaDeviceMenuProps.requestPermissions property
|
|
4
8
|
|
|
5
9
|
this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions.
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MediaDeviceSelectProps.exactMatch property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# MediaDeviceSelectProps.exactMatch property
|
|
4
8
|
|
|
5
9
|
will force the browser to only return the specified device will call `onDeviceSelectError` with the error in case this fails
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MediaDeviceSelectProps.initialSelection property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# MediaDeviceSelectProps.initialSelection property
|
|
4
8
|
|
|
5
9
|
**Signature:**
|
|
6
10
|
|
|
@@ -1,6 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "MediaDeviceSelectProps interface",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/MediaDeviceSelect.tsx"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
1
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
9
|
|
|
3
|
-
|
|
10
|
+
# MediaDeviceSelectProps interface
|
|
4
11
|
|
|
5
12
|
**Signature:**
|
|
6
13
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MediaDeviceSelectProps.onActiveDeviceChange property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# MediaDeviceSelectProps.onActiveDeviceChange property
|
|
4
8
|
|
|
5
9
|
**Signature:**
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MediaDeviceSelectProps.onDeviceListChange property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# MediaDeviceSelectProps.onDeviceListChange property
|
|
4
8
|
|
|
5
9
|
**Signature:**
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MediaDeviceSelectProps.onDeviceSelectError property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# MediaDeviceSelectProps.onDeviceSelectError property
|
|
4
8
|
|
|
5
9
|
**Signature:**
|
|
6
10
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "MediaDeviceSelectProps.requestPermissions property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# MediaDeviceSelectProps.requestPermissions property
|
|
4
8
|
|
|
5
9
|
this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions.
|
|
6
10
|
|
|
@@ -1,6 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "MessageFormatter type",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/ChatEntry.tsx"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
1
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
9
|
|
|
3
|
-
|
|
10
|
+
# MessageFormatter type
|
|
4
11
|
|
|
5
12
|
**Signature:**
|
|
6
13
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"
|
|
1
|
+
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"}],"hooks":[{"filename":"usechat.md","title":"useChat"},{"filename":"usechattoggle.md","title":"useChatToggle"},{"filename":"useclearpinbutton.md","title":"useClearPinButton"},{"filename":"useconnectionqualityindicator.md","title":"useConnectionQualityIndicator"},{"filename":"useconnectionstate.md","title":"useConnectionState"},{"filename":"usecreatelayoutcontext.md","title":"useCreateLayoutContext"},{"filename":"usedatachannel.md","title":"useDataChannel"},{"filename":"usedatachannel_1.md","title":"useDataChannel"},{"filename":"usedisconnectbutton.md","title":"useDisconnectButton"},{"filename":"useensurecreatelayoutcontext.md","title":"useEnsureCreateLayoutContext"},{"filename":"useensurelayoutcontext.md","title":"useEnsureLayoutContext"},{"filename":"useensureparticipant.md","title":"useEnsureParticipant"},{"filename":"useensureroom.md","title":"useEnsureRoom"},{"filename":"useensuretrackref.md","title":"useEnsureTrackRef"},{"filename":"useensuretrackreference.md","title":"useEnsureTrackReference"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useismuted_1.md","title":"useIsMuted"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"uselayoutcontext.md","title":"useLayoutContext"},{"filename":"uselivekitroom.md","title":"useLiveKitRoom"},{"filename":"uselocalparticipant.md","title":"useLocalParticipant"},{"filename":"uselocalparticipantpermissions.md","title":"useLocalParticipantPermissions"},{"filename":"usemaybelayoutcontext.md","title":"useMaybeLayoutContext"},{"filename":"usemaybeparticipantcontext.md","title":"useMaybeParticipantContext"},{"filename":"usemayberoomcontext.md","title":"useMaybeRoomContext"},{"filename":"usemaybetrackcontext.md","title":"useMaybeTrackContext"},{"filename":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemediatrack.md","title":"useMediaTrack"},{"filename":"usemediatrackbyname.md","title":"useMediaTrackByName"},{"filename":"useparticipantcontext.md","title":"useParticipantContext"},{"filename":"useparticipantinfo.md","title":"useParticipantInfo"},{"filename":"useparticipantpermissions.md","title":"useParticipantPermissions"},{"filename":"useparticipants.md","title":"useParticipants"},{"filename":"useparticipanttile.md","title":"useParticipantTile"},{"filename":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrack.md","title":"useTrack"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackcontext.md","title":"useTrackContext"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackmutedindicator_1.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"}]}
|
|
@@ -1,6 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "ParticipantContext variable",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/participant-context.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
1
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
9
|
|
|
3
|
-
|
|
10
|
+
# ParticipantContext variable
|
|
4
11
|
|
|
5
12
|
**Signature:**
|
|
6
13
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "ParticipantLoopProps.children property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# ParticipantLoopProps.children property
|
|
4
8
|
|
|
5
9
|
The template component to be used in the loop.
|
|
6
10
|
|
|
@@ -1,6 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "ParticipantLoopProps interface",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/ParticipantLoop.tsx"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
1
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
9
|
|
|
3
|
-
|
|
10
|
+
# ParticipantLoopProps interface
|
|
4
11
|
|
|
5
12
|
**Signature:**
|
|
6
13
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "ParticipantLoopProps.participants property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# ParticipantLoopProps.participants property
|
|
4
8
|
|
|
5
9
|
The participants to loop over. Use `useParticipants()` hook to get participants.
|
|
6
10
|
|
|
@@ -1,6 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "ParticipantNameProps interface",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/ParticipantName.tsx"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
1
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
9
|
|
|
3
|
-
|
|
10
|
+
# ParticipantNameProps interface
|
|
4
11
|
|
|
5
12
|
**Signature:**
|
|
6
13
|
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "ParticipantTileProps.disableSpeakingIndicator property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
1
5
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
# ParticipantTileProps.disableSpeakingIndicator property
|
|
4
8
|
|
|
5
9
|
**Signature:**
|
|
6
10
|
|
|
@@ -1,6 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "ParticipantTileProps interface",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/ParticipantTile.tsx"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
1
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
9
|
|
|
3
|
-
|
|
10
|
+
# ParticipantTileProps interface
|
|
4
11
|
|
|
5
12
|
**Signature:**
|
|
6
13
|
|
|
@@ -14,10 +21,11 @@ export interface ParticipantTileProps extends React.HTMLAttributes<HTMLDivElemen
|
|
|
14
21
|
|
|
15
22
|
## Properties
|
|
16
23
|
|
|
17
|
-
| Property | Type | Description
|
|
18
|
-
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
19
|
-
| [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean | _(Optional)_
|
|
20
|
-
| [onParticipantClick?](./react/participanttileprops.onparticipantclick.md) | (event: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) => void | _(Optional)_
|
|
21
|
-
| [participant?](./react/participanttileprops.participant.md) | Participant | _(Optional)_
|
|
22
|
-
| [publication?](./react/participanttileprops.publication.md) | TrackPublication | _(Optional)_
|
|
23
|
-
| [source?](./react/participanttileprops.source.md) | Track.Source | _(Optional)_
|
|
24
|
+
| Property | Type | Description |
|
|
25
|
+
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------- |
|
|
26
|
+
| [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean | _(Optional)_ |
|
|
27
|
+
| [onParticipantClick?](./react/participanttileprops.onparticipantclick.md) | (event: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) => void | _(Optional)_ |
|
|
28
|
+
| [participant?](./react/participanttileprops.participant.md) | Participant | _(Optional)_ |
|
|
29
|
+
| [publication?](./react/participanttileprops.publication.md) | TrackPublication | _(Optional)_ |
|
|
30
|
+
| [source?](./react/participanttileprops.source.md) | Track.Source | _(Optional)_ |
|
|
31
|
+
| [trackRef?](./react/participanttileprops.trackref.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ The track reference to display. |
|