@livekit/components-js-docs 0.0.2
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/README.md +10 -0
- package/generated-docs/core/activespeakerobserver.md +9 -0
- package/generated-docs/core/allparticipantevents.md +9 -0
- package/generated-docs/core/allparticipantroomevents.md +9 -0
- package/generated-docs/core/allremoteparticipantevents.md +9 -0
- package/generated-docs/core/allremoteparticipantroomevents.md +9 -0
- package/generated-docs/core/attachifsubscribed.md +9 -0
- package/generated-docs/core/audiosource.md +9 -0
- package/generated-docs/core/basedatamessage.md +16 -0
- package/generated-docs/core/basedatamessage.payload.md +9 -0
- package/generated-docs/core/basedatamessage.topic.md +9 -0
- package/generated-docs/core/captureoptionsbysource.md +17 -0
- package/generated-docs/core/chatmessage.md +16 -0
- package/generated-docs/core/chatmessage.message.md +9 -0
- package/generated-docs/core/chatmessage.timestamp.md +9 -0
- package/generated-docs/core/computemenuposition.md +15 -0
- package/generated-docs/core/connectedparticipantobserver.md +13 -0
- package/generated-docs/core/connectedparticipantobserveroptions.md +11 -0
- package/generated-docs/core/connectedparticipantsobserver.md +12 -0
- package/generated-docs/core/connectionstateobserver.md +11 -0
- package/generated-docs/core/createactivedeviceobservable.md +12 -0
- package/generated-docs/core/createconnectionqualityobserver.md +11 -0
- package/generated-docs/core/createdataobserver.md +18 -0
- package/generated-docs/core/createdefaultgrammar.md +12 -0
- package/generated-docs/core/createisspeakingobserver.md +9 -0
- package/generated-docs/core/createmediadeviceobserver.md +12 -0
- package/generated-docs/core/createtrackobserver.md +14 -0
- package/generated-docs/core/createurlregexp.md +9 -0
- package/generated-docs/core/cssprefix.md +9 -0
- package/generated-docs/core/datasendoptions.md +12 -0
- package/generated-docs/core/datatopic.md +11 -0
- package/generated-docs/core/gettrackbyidentifier.md +11 -0
- package/generated-docs/core/gettrackreferenceid.md +15 -0
- package/generated-docs/core/gettrackreferencesource.md +15 -0
- package/generated-docs/core/grid_layouts.md +9 -0
- package/generated-docs/core/gridlayoutdefinition.md +17 -0
- package/generated-docs/core/index.md +115 -0
- package/generated-docs/core/isequaltrackref.md +12 -0
- package/generated-docs/core/islocal.md +9 -0
- package/generated-docs/core/ismobilebrowser.md +17 -0
- package/generated-docs/core/isparticipantsourcepinned.md +17 -0
- package/generated-docs/core/isremote.md +9 -0
- package/generated-docs/core/issourceswithoptions.md +11 -0
- package/generated-docs/core/issourcewitoptions.md +11 -0
- package/generated-docs/core/istrackreference.md +9 -0
- package/generated-docs/core/istrackreferencepinned.md +16 -0
- package/generated-docs/core/istrackreferenceplaceholder.md +11 -0
- package/generated-docs/core/log.md +9 -0
- package/generated-docs/core/mediatoggletype.md +16 -0
- package/generated-docs/core/mutedobserver.md +12 -0
- package/generated-docs/core/observeparticipantevents.md +12 -0
- package/generated-docs/core/observeparticipantmedia.md +11 -0
- package/generated-docs/core/observeroomevents.md +9 -0
- package/generated-docs/core/observetrackevents.md +12 -0
- package/generated-docs/core/participantclickevent.md +16 -0
- package/generated-docs/core/participantclickevent.participant.md +9 -0
- package/generated-docs/core/participantclickevent.track.md +9 -0
- package/generated-docs/core/participanteventselector.md +12 -0
- package/generated-docs/core/participantfilter.md +9 -0
- package/generated-docs/core/participantinfoobserver.md +20 -0
- package/generated-docs/core/participantmedia.cameratrack.md +9 -0
- package/generated-docs/core/participantmedia.iscameraenabled.md +9 -0
- package/generated-docs/core/participantmedia.ismicrophoneenabled.md +9 -0
- package/generated-docs/core/participantmedia.isscreenshareenabled.md +9 -0
- package/generated-docs/core/participantmedia.md +20 -0
- package/generated-docs/core/participantmedia.microphonetrack.md +9 -0
- package/generated-docs/core/participantmedia.participant.md +9 -0
- package/generated-docs/core/participantpermissionobserver.md +13 -0
- package/generated-docs/core/pin_default_state.md +9 -0
- package/generated-docs/core/pinstate.md +11 -0
- package/generated-docs/core/receivedchatmessage.from.md +9 -0
- package/generated-docs/core/receivedchatmessage.md +17 -0
- package/generated-docs/core/receiveddatamessage.from.md +9 -0
- package/generated-docs/core/receiveddatamessage.md +17 -0
- package/generated-docs/core/requireonlyone.md +12 -0
- package/generated-docs/core/roomaudioplaybackallowedobservable.md +11 -0
- package/generated-docs/core/roomeventselector.md +12 -0
- package/generated-docs/core/roominfoobserver.md +12 -0
- package/generated-docs/core/roomobserver.md +9 -0
- package/generated-docs/core/screenshareobserver.md +9 -0
- package/generated-docs/core/screensharetrackmap.md +12 -0
- package/generated-docs/core/selectgridlayout.md +14 -0
- package/generated-docs/core/sendmessage.md +18 -0
- package/generated-docs/core/setdifference.md +9 -0
- package/generated-docs/core/setloglevel.md +13 -0
- package/generated-docs/core/setmediadeviceoptions.md +11 -0
- package/generated-docs/core/setupchat.md +14 -0
- package/generated-docs/core/setupchattoggle.md +11 -0
- package/generated-docs/core/setupclearpinbutton.md +11 -0
- package/generated-docs/core/setupconnectionqualityindicator.md +70 -0
- package/generated-docs/core/setupdatamessagehandler.md +21 -0
- package/generated-docs/core/setupdeviceselector.md +17 -0
- package/generated-docs/core/setupdisconnectbutton.md +12 -0
- package/generated-docs/core/setupfocustoggle.md +11 -0
- package/generated-docs/core/setuplivekitroom.md +11 -0
- package/generated-docs/core/setupmanualtoggle.md +14 -0
- package/generated-docs/core/setupmediatoggle.md +13 -0
- package/generated-docs/core/setupmediatrack.md +12 -0
- package/generated-docs/core/setupparticipantname.md +23 -0
- package/generated-docs/core/setupparticipanttile.md +11 -0
- package/generated-docs/core/setupstartaudio.md +13 -0
- package/generated-docs/core/setuptrackmutedindicator.md +15 -0
- package/generated-docs/core/sortparticipants.md +13 -0
- package/generated-docs/core/sorttrackreferences.md +15 -0
- package/generated-docs/core/sourcesarray.md +11 -0
- package/generated-docs/core/supportsscreensharing.md +13 -0
- package/generated-docs/core/togglesource.md +12 -0
- package/generated-docs/core/tokenize.md +18 -0
- package/generated-docs/core/tokenizegrammar.md +11 -0
- package/generated-docs/core/trackidentifier.md +17 -0
- package/generated-docs/core/trackobservable.md +9 -0
- package/generated-docs/core/trackreference.md +13 -0
- package/generated-docs/core/trackreferencefilter.md +11 -0
- package/generated-docs/core/trackreferenceorplaceholder.md +11 -0
- package/generated-docs/core/trackreferenceplaceholder.md +13 -0
- package/generated-docs/core/trackreferencesobservable.md +16 -0
- package/generated-docs/core/tracksource.md +16 -0
- package/generated-docs/core/tracksourcewithoptions.md +12 -0
- package/generated-docs/core/updatepages.md +17 -0
- package/generated-docs/core/videosource.md +9 -0
- package/generated-docs/core/wasclickoutside.md +9 -0
- package/generated-docs/core/widget_default_state.md +9 -0
- package/generated-docs/core/widgetstate.md +12 -0
- package/generated-docs/index.md +10 -0
- package/generated-docs/react/allowaudioplaybackprops.label.md +9 -0
- package/generated-docs/react/allowaudioplaybackprops.md +19 -0
- package/generated-docs/react/audioconferenceprops.md +13 -0
- package/generated-docs/react/audiotrackprops.md +24 -0
- package/generated-docs/react/audiotrackprops.name.md +9 -0
- package/generated-docs/react/audiotrackprops.onsubscriptionstatuschanged.md +9 -0
- package/generated-docs/react/audiotrackprops.participant.md +9 -0
- package/generated-docs/react/audiotrackprops.publication.md +9 -0
- package/generated-docs/react/audiotrackprops.source.md +9 -0
- package/generated-docs/react/audiotrackprops.volume.md +13 -0
- package/generated-docs/react/audiovisualizerprops.md +19 -0
- package/generated-docs/react/audiovisualizerprops.participant.md +9 -0
- package/generated-docs/react/carouselviewprops.children.md +9 -0
- package/generated-docs/react/carouselviewprops.md +21 -0
- package/generated-docs/react/carouselviewprops.orientation.md +13 -0
- package/generated-docs/react/carouselviewprops.tracks.md +9 -0
- package/generated-docs/react/chatentryprops.entry.md +13 -0
- package/generated-docs/react/chatentryprops.hidename.md +13 -0
- package/generated-docs/react/chatentryprops.hidetimestamp.md +13 -0
- package/generated-docs/react/chatentryprops.md +24 -0
- package/generated-docs/react/chatentryprops.messageformatter.md +13 -0
- package/generated-docs/react/chatprops.md +19 -0
- package/generated-docs/react/chatprops.messageformatter.md +9 -0
- package/generated-docs/react/chattoggleprops.md +13 -0
- package/generated-docs/react/clearpinbuttonprops.md +13 -0
- package/generated-docs/react/component/audioconference.md +25 -0
- package/generated-docs/react/component/audiotrack.md +32 -0
- package/generated-docs/react/component/audiovisualizer.md +17 -0
- package/generated-docs/react/component/carouselview.md +30 -0
- package/generated-docs/react/component/chat.md +27 -0
- package/generated-docs/react/component/chatentry.md +30 -0
- package/generated-docs/react/component/chattoggle.md +21 -0
- package/generated-docs/react/component/clearpinbutton.md +25 -0
- package/generated-docs/react/component/connectionqualityindicator.md +19 -0
- package/generated-docs/react/component/connectionstate.md +27 -0
- package/generated-docs/react/component/connectionstatetoast.md +17 -0
- package/generated-docs/react/component/controlbar.md +32 -0
- package/generated-docs/react/component/disconnectbutton.md +27 -0
- package/generated-docs/react/component/focuslayout.md +18 -0
- package/generated-docs/react/component/focuslayoutcontainer.md +18 -0
- package/generated-docs/react/component/focustoggle.md +28 -0
- package/generated-docs/react/component/formatchatmessagelinks.md +11 -0
- package/generated-docs/react/component/gridlayout.md +30 -0
- package/generated-docs/react/component/livekitroom.md +40 -0
- package/generated-docs/react/component/mediadevicemenu.md +35 -0
- package/generated-docs/react/component/mediadeviceselect.md +34 -0
- package/generated-docs/react/component/participantaudiotile.md +29 -0
- package/generated-docs/react/component/participantcontextifneeded.md +11 -0
- package/generated-docs/react/component/participantloop.md +33 -0
- package/generated-docs/react/component/participantname.md +19 -0
- package/generated-docs/react/component/participanttile.md +31 -0
- package/generated-docs/react/component/prejoin.md +37 -0
- package/generated-docs/react/component/roomaudiorenderer.md +21 -0
- package/generated-docs/react/component/roomname.md +27 -0
- package/generated-docs/react/component/startaudio.md +27 -0
- package/generated-docs/react/component/toast.md +11 -0
- package/generated-docs/react/component/trackloop.md +31 -0
- package/generated-docs/react/component/trackmutedindicator.md +28 -0
- package/generated-docs/react/component/tracktoggle.md +32 -0
- package/generated-docs/react/component/videoconference.md +31 -0
- package/generated-docs/react/component/videotrack.md +30 -0
- package/generated-docs/react/connectionqualityindicatoroptions.md +17 -0
- package/generated-docs/react/connectionqualityindicatoroptions.participant.md +9 -0
- package/generated-docs/react/connectionqualityindicatorprops.md +13 -0
- package/generated-docs/react/connectionstatetoastprops.md +19 -0
- package/generated-docs/react/connectionstatetoastprops.room.md +9 -0
- package/generated-docs/react/connectionstatusprops.md +19 -0
- package/generated-docs/react/connectionstatusprops.room.md +13 -0
- package/generated-docs/react/controlbarcontrols.md +17 -0
- package/generated-docs/react/controlbarprops.controls.md +9 -0
- package/generated-docs/react/controlbarprops.md +20 -0
- package/generated-docs/react/controlbarprops.variation.md +9 -0
- package/generated-docs/react/disconnectbuttonprops.md +19 -0
- package/generated-docs/react/disconnectbuttonprops.stoptracks.md +9 -0
- package/generated-docs/react/focuslayoutcontainerprops.focustrack.md +9 -0
- package/generated-docs/react/focuslayoutcontainerprops.md +20 -0
- package/generated-docs/react/focuslayoutcontainerprops.participants.md +9 -0
- package/generated-docs/react/focuslayoutprops.md +20 -0
- package/generated-docs/react/focuslayoutprops.onparticipantclick.md +9 -0
- package/generated-docs/react/focuslayoutprops.track.md +9 -0
- package/generated-docs/react/focustoggleprops.md +20 -0
- package/generated-docs/react/focustoggleprops.participant.md +9 -0
- package/generated-docs/react/focustoggleprops.tracksource.md +9 -0
- package/generated-docs/react/gridlayoutprops.children.md +9 -0
- package/generated-docs/react/gridlayoutprops.md +20 -0
- package/generated-docs/react/gridlayoutprops.tracks.md +9 -0
- package/generated-docs/react/hook/prejoinprops.userlabel.md +9 -0
- package/generated-docs/react/hook/usechat.md +15 -0
- package/generated-docs/react/hook/usechattoggle.md +21 -0
- package/generated-docs/react/hook/useclearpinbutton.md +21 -0
- package/generated-docs/react/hook/useconnectionqualityindicator.md +21 -0
- package/generated-docs/react/hook/useconnectionstate.md +29 -0
- package/generated-docs/react/hook/usecreatelayoutcontext.md +15 -0
- package/generated-docs/react/hook/usedatachannel.md +22 -0
- package/generated-docs/react/hook/usedatachannel_1.md +21 -0
- package/generated-docs/react/hook/usedisconnectbutton.md +21 -0
- package/generated-docs/react/hook/useensurecreatelayoutcontext.md +21 -0
- package/generated-docs/react/hook/useensurelayoutcontext.md +23 -0
- package/generated-docs/react/hook/useensureparticipant.md +23 -0
- package/generated-docs/react/hook/useensureroom.md +23 -0
- package/generated-docs/react/hook/useensuretrackreference.md +23 -0
- package/generated-docs/react/hook/usefocustoggle.md +21 -0
- package/generated-docs/react/hook/usegridlayout.md +24 -0
- package/generated-docs/react/hook/useismuted.md +22 -0
- package/generated-docs/react/hook/useisspeaking.md +21 -0
- package/generated-docs/react/hook/uselayoutcontext.md +17 -0
- package/generated-docs/react/hook/uselivekitroom.md +21 -0
- package/generated-docs/react/hook/uselocalparticipant.md +23 -0
- package/generated-docs/react/hook/uselocalparticipantpermissions.md +15 -0
- package/generated-docs/react/hook/usemaybelayoutcontext.md +17 -0
- package/generated-docs/react/hook/usemaybeparticipantcontext.md +17 -0
- package/generated-docs/react/hook/usemayberoomcontext.md +17 -0
- package/generated-docs/react/hook/usemaybetrackcontext.md +17 -0
- package/generated-docs/react/hook/usemediadevices.md +21 -0
- package/generated-docs/react/hook/usemediadeviceselect.md +21 -0
- package/generated-docs/react/hook/usemediatrack.md +23 -0
- package/generated-docs/react/hook/usemediatrackbyname.md +23 -0
- package/generated-docs/react/hook/useparticipantcontext.md +17 -0
- package/generated-docs/react/hook/useparticipantinfo.md +21 -0
- package/generated-docs/react/hook/useparticipantpermissions.md +21 -0
- package/generated-docs/react/hook/useparticipants.md +23 -0
- package/generated-docs/react/hook/useparticipanttile.md +21 -0
- package/generated-docs/react/hook/usepinnedtracks.md +21 -0
- package/generated-docs/react/hook/usepreviewdevice.md +23 -0
- package/generated-docs/react/hook/useremoteparticipant.md +22 -0
- package/generated-docs/react/hook/useremoteparticipants.md +23 -0
- package/generated-docs/react/hook/useroomcontext.md +17 -0
- package/generated-docs/react/hook/useroominfo.md +21 -0
- package/generated-docs/react/hook/usesortedparticipants.md +23 -0
- package/generated-docs/react/hook/usespeakingparticipants.md +17 -0
- package/generated-docs/react/hook/usetoken.md +23 -0
- package/generated-docs/react/hook/usetokenoptions.userinfo.md +9 -0
- package/generated-docs/react/hook/usetrackcontext.md +17 -0
- package/generated-docs/react/hook/usetrackmutedindicator.md +22 -0
- package/generated-docs/react/hook/usetracks.md +41 -0
- package/generated-docs/react/hook/usetracktoggle.md +21 -0
- package/generated-docs/react/hook/usevisualstableupdate.md +29 -0
- package/generated-docs/react/index.md +168 -0
- package/generated-docs/react/layoutcontext.md +11 -0
- package/generated-docs/react/layoutcontexttype.md +14 -0
- package/generated-docs/react/livekitroomprops.audio.md +13 -0
- package/generated-docs/react/livekitroomprops.connect.md +13 -0
- package/generated-docs/react/livekitroomprops.connectoptions.md +13 -0
- package/generated-docs/react/livekitroomprops.md +32 -0
- package/generated-docs/react/livekitroomprops.onconnected.md +9 -0
- package/generated-docs/react/livekitroomprops.ondisconnected.md +9 -0
- package/generated-docs/react/livekitroomprops.onerror.md +9 -0
- package/generated-docs/react/livekitroomprops.onmediadevicefailure.md +9 -0
- package/generated-docs/react/livekitroomprops.options.md +13 -0
- package/generated-docs/react/livekitroomprops.room.md +13 -0
- package/generated-docs/react/livekitroomprops.screen.md +13 -0
- package/generated-docs/react/livekitroomprops.serverurl.md +13 -0
- package/generated-docs/react/livekitroomprops.simulateparticipants.md +9 -0
- package/generated-docs/react/livekitroomprops.token.md +13 -0
- package/generated-docs/react/livekitroomprops.video.md +13 -0
- package/generated-docs/react/localuserchoices.md +17 -0
- package/generated-docs/react/mediadevicemenuprops.initialselection.md +9 -0
- package/generated-docs/react/mediadevicemenuprops.kind.md +9 -0
- package/generated-docs/react/mediadevicemenuprops.md +23 -0
- package/generated-docs/react/mediadevicemenuprops.onactivedevicechange.md +9 -0
- package/generated-docs/react/mediadevicemenuprops.requestpermissions.md +13 -0
- package/generated-docs/react/mediadevicemenuprops.tracks.md +9 -0
- package/generated-docs/react/mediadeviceselectprops.exactmatch.md +13 -0
- package/generated-docs/react/mediadeviceselectprops.initialselection.md +9 -0
- package/generated-docs/react/mediadeviceselectprops.kind.md +9 -0
- package/generated-docs/react/mediadeviceselectprops.md +26 -0
- package/generated-docs/react/mediadeviceselectprops.onactivedevicechange.md +9 -0
- package/generated-docs/react/mediadeviceselectprops.ondevicelistchange.md +9 -0
- package/generated-docs/react/mediadeviceselectprops.ondeviceselecterror.md +9 -0
- package/generated-docs/react/mediadeviceselectprops.requestpermissions.md +13 -0
- package/generated-docs/react/mediadeviceselectprops.track.md +9 -0
- package/generated-docs/react/messageformatter.md +11 -0
- package/generated-docs/react/participantcontext.md +11 -0
- package/generated-docs/react/participantloopprops.children.md +13 -0
- package/generated-docs/react/participantloopprops.md +18 -0
- package/generated-docs/react/participantloopprops.participants.md +13 -0
- package/generated-docs/react/participantnameprops.md +13 -0
- package/generated-docs/react/participanttileprops.disablespeakingindicator.md +9 -0
- package/generated-docs/react/participanttileprops.md +23 -0
- package/generated-docs/react/participanttileprops.onparticipantclick.md +9 -0
- package/generated-docs/react/participanttileprops.participant.md +9 -0
- package/generated-docs/react/participanttileprops.publication.md +9 -0
- package/generated-docs/react/participanttileprops.source.md +9 -0
- package/generated-docs/react/prejoinprops.camlabel.md +9 -0
- package/generated-docs/react/prejoinprops.debug.md +13 -0
- package/generated-docs/react/prejoinprops.defaults.md +13 -0
- package/generated-docs/react/prejoinprops.joinlabel.md +9 -0
- package/generated-docs/react/prejoinprops.md +27 -0
- package/generated-docs/react/prejoinprops.miclabel.md +9 -0
- package/generated-docs/react/prejoinprops.onerror.md +9 -0
- package/generated-docs/react/prejoinprops.onsubmit.md +13 -0
- package/generated-docs/react/prejoinprops.onvalidate.md +13 -0
- package/generated-docs/react/roomcontext.md +11 -0
- package/generated-docs/react/roomnameprops.childrenposition.md +9 -0
- package/generated-docs/react/roomnameprops.md +19 -0
- package/generated-docs/react/trackcontext.md +11 -0
- package/generated-docs/react/trackloopprops.children.md +13 -0
- package/generated-docs/react/trackloopprops.md +18 -0
- package/generated-docs/react/trackloopprops.tracks.md +13 -0
- package/generated-docs/react/trackmutedindicatorprops.md +21 -0
- package/generated-docs/react/trackmutedindicatorprops.participant.md +9 -0
- package/generated-docs/react/trackmutedindicatorprops.show.md +9 -0
- package/generated-docs/react/trackmutedindicatorprops.source.md +9 -0
- package/generated-docs/react/tracktoggleprops.captureoptions.md +9 -0
- package/generated-docs/react/tracktoggleprops.initialstate.md +9 -0
- package/generated-docs/react/tracktoggleprops.md +23 -0
- package/generated-docs/react/tracktoggleprops.onchange.md +9 -0
- package/generated-docs/react/tracktoggleprops.showicon.md +9 -0
- package/generated-docs/react/tracktoggleprops.source.md +9 -0
- package/generated-docs/react/usechattoggleprops.md +17 -0
- package/generated-docs/react/usechattoggleprops.props.md +9 -0
- package/generated-docs/react/usefocustoggleprops.md +19 -0
- package/generated-docs/react/usefocustoggleprops.participant.md +9 -0
- package/generated-docs/react/usefocustoggleprops.props.md +9 -0
- package/generated-docs/react/usefocustoggleprops.tracksource.md +9 -0
- package/generated-docs/react/useismutedoptions.md +17 -0
- package/generated-docs/react/useismutedoptions.participant.md +9 -0
- package/generated-docs/react/uselocalparticipantoptions.md +17 -0
- package/generated-docs/react/uselocalparticipantoptions.room.md +13 -0
- package/generated-docs/react/usemediadeviceselectprops.kind.md +9 -0
- package/generated-docs/react/usemediadeviceselectprops.md +20 -0
- package/generated-docs/react/usemediadeviceselectprops.requestpermissions.md +13 -0
- package/generated-docs/react/usemediadeviceselectprops.room.md +9 -0
- package/generated-docs/react/usemediadeviceselectprops.track.md +9 -0
- package/generated-docs/react/usemediatrackoptions.element.md +9 -0
- package/generated-docs/react/usemediatrackoptions.md +18 -0
- package/generated-docs/react/usemediatrackoptions.props.md +9 -0
- package/generated-docs/react/useparticipantinfooptions.md +17 -0
- package/generated-docs/react/useparticipantinfooptions.participant.md +9 -0
- package/generated-docs/react/useparticipantpermissionsoptions.md +17 -0
- package/generated-docs/react/useparticipantpermissionsoptions.participant.md +9 -0
- package/generated-docs/react/useparticipantsoptions.md +18 -0
- package/generated-docs/react/useparticipantsoptions.room.md +13 -0
- package/generated-docs/react/useparticipantsoptions.updateonlyon.md +13 -0
- package/generated-docs/react/useparticipanttileprops.disablespeakingindicator.md +9 -0
- package/generated-docs/react/useparticipanttileprops.htmlprops.md +9 -0
- package/generated-docs/react/useparticipanttileprops.md +24 -0
- package/generated-docs/react/useparticipanttileprops.onparticipantclick.md +9 -0
- package/generated-docs/react/useparticipanttileprops.participant.md +9 -0
- package/generated-docs/react/useparticipanttileprops.publication.md +9 -0
- package/generated-docs/react/useparticipanttileprops.source.md +9 -0
- package/generated-docs/react/useremoteparticipantoptions.md +17 -0
- package/generated-docs/react/useremoteparticipantoptions.updateonlyon.md +9 -0
- package/generated-docs/react/useremoteparticipantsoptions.md +18 -0
- package/generated-docs/react/useremoteparticipantsoptions.room.md +13 -0
- package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md +13 -0
- package/generated-docs/react/userinfo.identity.md +9 -0
- package/generated-docs/react/userinfo.md +19 -0
- package/generated-docs/react/userinfo.metadata.md +9 -0
- package/generated-docs/react/userinfo.name.md +9 -0
- package/generated-docs/react/useroominfooptions.md +17 -0
- package/generated-docs/react/useroominfooptions.room.md +9 -0
- package/generated-docs/react/usetokenoptions.md +17 -0
- package/generated-docs/react/usetrackmutedindicatoroptions.md +17 -0
- package/generated-docs/react/usetrackmutedindicatoroptions.participant.md +9 -0
- package/generated-docs/react/usetrackshookreturntype.md +17 -0
- package/generated-docs/react/usetracksoptions.md +15 -0
- package/generated-docs/react/usetracktoggleprops.md +13 -0
- package/generated-docs/react/usevisualstableupdateoptions.customsortfunction.md +13 -0
- package/generated-docs/react/usevisualstableupdateoptions.md +17 -0
- package/generated-docs/react/videoconferenceprops.chatmessageformatter.md +9 -0
- package/generated-docs/react/videoconferenceprops.md +19 -0
- package/generated-docs/react/videotrackprops.md +24 -0
- package/generated-docs/react/videotrackprops.name.md +9 -0
- package/generated-docs/react/videotrackprops.onsubscriptionstatuschanged.md +9 -0
- package/generated-docs/react/videotrackprops.ontrackclick.md +9 -0
- package/generated-docs/react/videotrackprops.participant.md +9 -0
- package/generated-docs/react/videotrackprops.publication.md +9 -0
- package/generated-docs/react/videotrackprops.source.md +9 -0
- package/meta-data.json +78 -0
- package/package.json +27 -0
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
## components-core package
|
|
4
|
+
|
|
5
|
+
## Others
|
|
6
|
+
|
|
7
|
+
| Other | Description |
|
|
8
|
+
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9
|
+
| [activeSpeakerObserver(room)](./core/activespeakerobserver.md) | |
|
|
10
|
+
| [allParticipantEvents](./core/allparticipantevents.md) | |
|
|
11
|
+
| [allParticipantRoomEvents](./core/allparticipantroomevents.md) | |
|
|
12
|
+
| [allRemoteParticipantEvents](./core/allremoteparticipantevents.md) | |
|
|
13
|
+
| [allRemoteParticipantRoomEvents](./core/allremoteparticipantroomevents.md) | |
|
|
14
|
+
| [attachIfSubscribed](./core/attachifsubscribed.md) | |
|
|
15
|
+
| [AudioSource](./core/audiosource.md) | |
|
|
16
|
+
| [BaseDataMessage](./core/basedatamessage.md) | |
|
|
17
|
+
| [CaptureOptionsBySource](./core/captureoptionsbysource.md) | |
|
|
18
|
+
| [ChatMessage](./core/chatmessage.md) | |
|
|
19
|
+
| [computeMenuPosition(button, menu)](./core/computemenuposition.md) | |
|
|
20
|
+
| [connectedParticipantObserver(room, identity, options)](./core/connectedparticipantobserver.md) | |
|
|
21
|
+
| [ConnectedParticipantObserverOptions](./core/connectedparticipantobserveroptions.md) | |
|
|
22
|
+
| [connectedParticipantsObserver(room, options)](./core/connectedparticipantsobserver.md) | |
|
|
23
|
+
| [connectionStateObserver(room)](./core/connectionstateobserver.md) | |
|
|
24
|
+
| [createActiveDeviceObservable(room, kind)](./core/createactivedeviceobservable.md) | |
|
|
25
|
+
| [createConnectionQualityObserver(participant)](./core/createconnectionqualityobserver.md) | |
|
|
26
|
+
| [createDataObserver(room)](./core/createdataobserver.md) | |
|
|
27
|
+
| [createDefaultGrammar](./core/createdefaultgrammar.md) | |
|
|
28
|
+
| [createIsSpeakingObserver(participant)](./core/createisspeakingobserver.md) | |
|
|
29
|
+
| [createMediaDeviceObserver(kind, requestPermissions)](./core/createmediadeviceobserver.md) | |
|
|
30
|
+
| [createTrackObserver(participant, options)](./core/createtrackobserver.md) | |
|
|
31
|
+
| [createUrlRegExp](./core/createurlregexp.md) | |
|
|
32
|
+
| [cssPrefix](./core/cssprefix.md) | |
|
|
33
|
+
| [DataSendOptions](./core/datasendoptions.md) | |
|
|
34
|
+
| [DataTopic](./core/datatopic.md) | |
|
|
35
|
+
| [getTrackByIdentifier(options)](./core/gettrackbyidentifier.md) | |
|
|
36
|
+
| [getTrackReferenceId(trackReference)](./core/gettrackreferenceid.md) | Returns a id to identify the <code>TrackReference</code> based on participant and source. |
|
|
37
|
+
| [getTrackReferenceSource(trackReference)](./core/gettrackreferencesource.md) | Returns the Source of the TrackReference. |
|
|
38
|
+
| [GRID_LAYOUTS](./core/grid_layouts.md) | |
|
|
39
|
+
| [GridLayoutDefinition](./core/gridlayoutdefinition.md) | |
|
|
40
|
+
| [isEqualTrackRef(a, b)](./core/isequaltrackref.md) | |
|
|
41
|
+
| [isLocal(p)](./core/islocal.md) | |
|
|
42
|
+
| [isMobileBrowser()](./core/ismobilebrowser.md) | Mobile browser detection based on <code>navigator.userAgent</code> string. Defaults to returning <code>false</code> if not in a browser. |
|
|
43
|
+
| [isParticipantSourcePinned(participant, source, pinState)](./core/isparticipantsourcepinned.md) | Check if the participant track source is pinned. |
|
|
44
|
+
| [isRemote(p)](./core/isremote.md) | |
|
|
45
|
+
| [isSourcesWithOptions(sources)](./core/issourceswithoptions.md) | |
|
|
46
|
+
| [isSourceWitOptions(source)](./core/issourcewitoptions.md) | |
|
|
47
|
+
| [isTrackReference(trackReference)](./core/istrackreference.md) | |
|
|
48
|
+
| [isTrackReferencePinned(trackReference, pinState)](./core/istrackreferencepinned.md) | Check if the <code>TrackReference</code> is pinned. |
|
|
49
|
+
| [isTrackReferencePlaceholder(trackReference)](./core/istrackreferenceplaceholder.md) | |
|
|
50
|
+
| [log](./core/log.md) | |
|
|
51
|
+
| [MediaToggleType](./core/mediatoggletype.md) | |
|
|
52
|
+
| [mutedObserver(participant, source)](./core/mutedobserver.md) | |
|
|
53
|
+
| [observeParticipantEvents(participant, events)](./core/observeparticipantevents.md) | |
|
|
54
|
+
| [observeParticipantMedia(participant)](./core/observeparticipantmedia.md) | |
|
|
55
|
+
| [observeRoomEvents(room, events)](./core/observeroomevents.md) | |
|
|
56
|
+
| [observeTrackEvents(track, events)](./core/observetrackevents.md) | |
|
|
57
|
+
| [ParticipantClickEvent](./core/participantclickevent.md) | |
|
|
58
|
+
| [participantEventSelector(participant, event)](./core/participanteventselector.md) | |
|
|
59
|
+
| [ParticipantFilter](./core/participantfilter.md) | |
|
|
60
|
+
| [participantInfoObserver(participant)](./core/participantinfoobserver.md) | |
|
|
61
|
+
| [ParticipantMedia](./core/participantmedia.md) | |
|
|
62
|
+
| [participantPermissionObserver(participant)](./core/participantpermissionobserver.md) | |
|
|
63
|
+
| [PIN_DEFAULT_STATE](./core/pin_default_state.md) | |
|
|
64
|
+
| [PinState](./core/pinstate.md) | |
|
|
65
|
+
| [ReceivedChatMessage](./core/receivedchatmessage.md) | |
|
|
66
|
+
| [ReceivedDataMessage](./core/receiveddatamessage.md) | |
|
|
67
|
+
| [RequireOnlyOne](./core/requireonlyone.md) | |
|
|
68
|
+
| [roomAudioPlaybackAllowedObservable(room)](./core/roomaudioplaybackallowedobservable.md) | |
|
|
69
|
+
| [roomEventSelector(room, event)](./core/roomeventselector.md) | |
|
|
70
|
+
| [roomInfoObserver(room)](./core/roominfoobserver.md) | |
|
|
71
|
+
| [roomObserver(room)](./core/roomobserver.md) | |
|
|
72
|
+
| [screenShareObserver(room)](./core/screenshareobserver.md) | |
|
|
73
|
+
| [ScreenShareTrackMap](./core/screensharetrackmap.md) | |
|
|
74
|
+
| [selectGridLayout(layouts, participantCount, width, height)](./core/selectgridlayout.md) | |
|
|
75
|
+
| [sendMessage(localParticipant, payload, topic, options)](./core/sendmessage.md) | Publish data from the LocalParticipant. |
|
|
76
|
+
| [setDifference(setA, setB)](./core/setdifference.md) | |
|
|
77
|
+
| [setLogLevel(level, options)](./core/setloglevel.md) | Set the log level for both the <code>@livekit/components-react</code> package and the <code>@livekit-client</code> package. To set the <code>@livekit-client</code> log independently, use the <code>liveKitClientLogLevel</code> prop on the <code>options</code> object. |
|
|
78
|
+
| [SetMediaDeviceOptions](./core/setmediadeviceoptions.md) | |
|
|
79
|
+
| [setupChat(room)](./core/setupchat.md) | |
|
|
80
|
+
| [setupChatToggle()](./core/setupchattoggle.md) | |
|
|
81
|
+
| [setupClearPinButton()](./core/setupclearpinbutton.md) | |
|
|
82
|
+
| [setupConnectionQualityIndicator(participant)](./core/setupconnectionqualityindicator.md) | |
|
|
83
|
+
| [setupDataMessageHandler(room, topic, onMessage)](./core/setupdatamessagehandler.md) | |
|
|
84
|
+
| [setupDeviceSelector(kind, room, localTrack)](./core/setupdeviceselector.md) | |
|
|
85
|
+
| [setupDisconnectButton(room)](./core/setupdisconnectbutton.md) | |
|
|
86
|
+
| [setupFocusToggle()](./core/setupfocustoggle.md) | |
|
|
87
|
+
| [setupLiveKitRoom()](./core/setuplivekitroom.md) | |
|
|
88
|
+
| [setupManualToggle()](./core/setupmanualtoggle.md) | |
|
|
89
|
+
| [setupMediaToggle(source, room, options)](./core/setupmediatoggle.md) | |
|
|
90
|
+
| [setupMediaTrack(trackIdentifier)](./core/setupmediatrack.md) | |
|
|
91
|
+
| [setupParticipantName(participant)](./core/setupparticipantname.md) | |
|
|
92
|
+
| [setupParticipantTile()](./core/setupparticipanttile.md) | |
|
|
93
|
+
| [setupStartAudio()](./core/setupstartaudio.md) | |
|
|
94
|
+
| [setupTrackMutedIndicator(participant, source)](./core/setuptrackmutedindicator.md) | |
|
|
95
|
+
| [sortParticipants(participants)](./core/sortparticipants.md) | Default sort for participants, it'll order participants by: 1. local participant 2. dominant speaker (speaker with the loudest audio level) 3. other speakers that are recently active 4. participants with video on 5. by joinedAt |
|
|
96
|
+
| [sortTrackReferences(tracks)](./core/sorttrackreferences.md) | Default sort for <code>TrackReferenceOrPlaceholder</code>, it'll order participants by: 1. local camera track (publication.isLocal) 2. remote screen_share track 3. local screen_share track 4. remote dominant speaker camera track (sorted by speaker with the loudest audio level) 5. other remote speakers that are recently active 6. remote unmuted camera tracks 7. remote tracks sorted by joinedAt |
|
|
97
|
+
| [SourcesArray](./core/sourcesarray.md) | |
|
|
98
|
+
| [supportsScreenSharing()](./core/supportsscreensharing.md) | Returns <code>true</code> if the browser supports screen sharing. |
|
|
99
|
+
| [ToggleSource](./core/togglesource.md) | |
|
|
100
|
+
| [tokenize(input, grammar)](./core/tokenize.md) | |
|
|
101
|
+
| [TokenizeGrammar](./core/tokenizegrammar.md) | |
|
|
102
|
+
| [TrackIdentifier](./core/trackidentifier.md) | The TrackIdentifier type is used to select Tracks either based on - Track.Source and/or name of the track, e.g. <code>{source: Track.Source.Camera}</code> or <code>{name: "my-track"}</code> - TrackReference (participant and publication) |
|
|
103
|
+
| [trackObservable(track)](./core/trackobservable.md) | |
|
|
104
|
+
| [TrackReference](./core/trackreference.md) | |
|
|
105
|
+
| [TrackReferenceFilter](./core/trackreferencefilter.md) | |
|
|
106
|
+
| [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | |
|
|
107
|
+
| [TrackReferencePlaceholder](./core/trackreferenceplaceholder.md) | |
|
|
108
|
+
| [trackReferencesObservable(room, sources, options)](./core/trackreferencesobservable.md) | |
|
|
109
|
+
| [TrackSource](./core/tracksource.md) | |
|
|
110
|
+
| [TrackSourceWithOptions](./core/tracksourcewithoptions.md) | |
|
|
111
|
+
| [updatePages(currentList, nextList, maxItemsOnPage)](./core/updatepages.md) | Divide the list of elements into pages and and check if pages need updating. |
|
|
112
|
+
| [VideoSource](./core/videosource.md) | |
|
|
113
|
+
| [wasClickOutside(insideElement, event)](./core/wasclickoutside.md) | |
|
|
114
|
+
| [WIDGET_DEFAULT_STATE](./core/widget_default_state.md) | |
|
|
115
|
+
| [WidgetState](./core/widgetstate.md) | |
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# isEqualTrackRef (undefined)
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export declare function isEqualTrackRef(
|
|
9
|
+
a?: TrackReferenceOrPlaceholder,
|
|
10
|
+
b?: TrackReferenceOrPlaceholder,
|
|
11
|
+
): boolean;
|
|
12
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# isMobileBrowser (undefined)
|
|
4
|
+
|
|
5
|
+
Mobile browser detection based on `navigator.userAgent` string. Defaults to returning `false` if not in a browser.
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export declare function isMobileBrowser(): boolean;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Remarks
|
|
14
|
+
|
|
15
|
+
This should only be used if feature detection or other methods do not work!
|
|
16
|
+
|
|
17
|
+
{% partial file="p_usage.md" /%}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# isParticipantSourcePinned (undefined)
|
|
4
|
+
|
|
5
|
+
Check if the participant track source is pinned.
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export declare function isParticipantSourcePinned(
|
|
11
|
+
participant: Participant,
|
|
12
|
+
source: Track.Source,
|
|
13
|
+
pinState: PinState | undefined,
|
|
14
|
+
): boolean;
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
{% partial file="p_usage.md" /%}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# isSourcesWithOptions (undefined)
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export declare function isSourcesWithOptions(
|
|
9
|
+
sources: SourcesArray,
|
|
10
|
+
): sources is TrackSourceWithOptions[];
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# isSourceWitOptions (undefined)
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export declare function isSourceWitOptions(
|
|
9
|
+
source: SourcesArray[number],
|
|
10
|
+
): source is TrackSourceWithOptions;
|
|
11
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# isTrackReferencePinned (undefined)
|
|
4
|
+
|
|
5
|
+
Check if the `TrackReference` is pinned.
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export declare function isTrackReferencePinned(
|
|
11
|
+
trackReference: TrackReferenceOrPlaceholder,
|
|
12
|
+
pinState: PinState | undefined,
|
|
13
|
+
): boolean;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
{% partial file="p_usage.md" /%}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# isTrackReferencePlaceholder (undefined)
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export declare function isTrackReferencePlaceholder(
|
|
9
|
+
trackReference?: TrackReferenceOrPlaceholder,
|
|
10
|
+
): trackReference is TrackReferencePlaceholder;
|
|
11
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
## MediaToggleType type
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export type MediaToggleType<T extends ToggleSource> = {
|
|
9
|
+
pendingObserver: Observable<boolean>;
|
|
10
|
+
toggle: (forceState?: boolean, captureOptions?: CaptureOptionsBySource<T>) => Promise<void>;
|
|
11
|
+
className: string;
|
|
12
|
+
enabledObserver: Observable<boolean>;
|
|
13
|
+
};
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
**References:** [ToggleSource](./core/togglesource.md)<!-- -->, [CaptureOptionsBySource](./core/captureoptionsbysource.md)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# mutedObserver (undefined)
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export declare function mutedObserver(
|
|
9
|
+
participant: Participant,
|
|
10
|
+
source: Track.Source,
|
|
11
|
+
): Observable<boolean>;
|
|
12
|
+
```
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# observeParticipantEvents (undefined)
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export declare function observeParticipantEvents<T extends Participant>(
|
|
9
|
+
participant: T,
|
|
10
|
+
...events: ParticipantEvent[]
|
|
11
|
+
): Observable<T>;
|
|
12
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# observeParticipantMedia (undefined)
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export declare function observeParticipantMedia<T extends Participant>(
|
|
9
|
+
participant: T,
|
|
10
|
+
): Observable<ParticipantMedia<T>>;
|
|
11
|
+
```
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# observeTrackEvents (undefined)
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export declare function observeTrackEvents(
|
|
9
|
+
track: TrackPublication,
|
|
10
|
+
...events: TrackEvent[]
|
|
11
|
+
): Observable<TrackPublication>;
|
|
12
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
## ParticipantClickEvent interface
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export interface ParticipantClickEvent
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
| Property | Type | Description |
|
|
14
|
+
| ---------------------------------------------------------- | ---------------- | ------------ |
|
|
15
|
+
| [participant](./core/participantclickevent.participant.md) | Participant | |
|
|
16
|
+
| [track?](./core/participantclickevent.track.md) | TrackPublication | _(Optional)_ |
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# participantEventSelector (undefined)
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export declare function participantEventSelector<T extends ParticipantEvent>(
|
|
9
|
+
participant: Participant,
|
|
10
|
+
event: T,
|
|
11
|
+
): Observable<Parameters<ParticipantEventCallbacks[Extract<T, keyof ParticipantEventCallbacks>]>>;
|
|
12
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# participantInfoObserver (undefined)
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export declare function participantInfoObserver(participant: Participant): Observable<
|
|
9
|
+
| {
|
|
10
|
+
name: string | undefined;
|
|
11
|
+
identity: string;
|
|
12
|
+
metadata: string | undefined;
|
|
13
|
+
}
|
|
14
|
+
| {
|
|
15
|
+
name: string | undefined;
|
|
16
|
+
identity: string;
|
|
17
|
+
metadata: string | undefined;
|
|
18
|
+
}
|
|
19
|
+
>;
|
|
20
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
## ParticipantMedia interface
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export interface ParticipantMedia<T extends Participant = Participant>
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
| Property | Type | Description |
|
|
14
|
+
| ----------------------------------------------------------------------- | ---------------- | ------------ |
|
|
15
|
+
| [cameraTrack?](./core/participantmedia.cameratrack.md) | TrackPublication | _(Optional)_ |
|
|
16
|
+
| [isCameraEnabled](./core/participantmedia.iscameraenabled.md) | boolean | |
|
|
17
|
+
| [isMicrophoneEnabled](./core/participantmedia.ismicrophoneenabled.md) | boolean | |
|
|
18
|
+
| [isScreenShareEnabled](./core/participantmedia.isscreenshareenabled.md) | boolean | |
|
|
19
|
+
| [microphoneTrack?](./core/participantmedia.microphonetrack.md) | TrackPublication | _(Optional)_ |
|
|
20
|
+
| [participant](./core/participantmedia.participant.md) | T | |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
# participantPermissionObserver (undefined)
|
|
4
|
+
|
|
5
|
+
**Signature:**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
export declare function participantPermissionObserver(
|
|
9
|
+
participant: Participant,
|
|
10
|
+
): Observable<
|
|
11
|
+
import('livekit-client/dist/src/proto/livekit_models').ParticipantPermission | undefined
|
|
12
|
+
>;
|
|
13
|
+
```
|