@livekit/components-js-docs 0.1.17 → 0.1.19
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/react/audiotrack.md +30 -0
- package/generated-docs/react/{component/audiovisualizer.md → audiovisualizer.md} +6 -11
- package/generated-docs/react/chatentry.md +28 -0
- package/generated-docs/react/{component/chattoggle.md → chattoggle.md} +6 -4
- package/generated-docs/react/{component/clearpinbutton.md → clearpinbutton.md} +6 -4
- package/generated-docs/react/{component/connectionqualityindicator.md → connectionqualityindicator.md} +6 -4
- package/generated-docs/react/{component/connectionstate.md → connectionstate.md} +6 -11
- package/generated-docs/react/{component/disconnectbutton.md → disconnectbutton.md} +6 -11
- package/generated-docs/react/{component/focustoggle.md → focustoggle.md} +6 -11
- package/generated-docs/react/hook/useclearpinbutton.md +1 -1
- package/generated-docs/react/index.md +98 -98
- package/generated-docs/react/livekitroom.md +32 -0
- package/generated-docs/react/mediadeviceselect.md +30 -0
- package/generated-docs/react/meta-data.json +1 -1
- package/generated-docs/react/{component/participantaudiotile.md → participantaudiotile.md} +6 -21
- package/generated-docs/react/{component/participantname.md → participantname.md} +6 -4
- package/generated-docs/react/{component/participanttile.md → participanttile.md} +6 -21
- package/generated-docs/react/{component/roomname.md → roomname.md} +4 -11
- package/generated-docs/react/{component/startaudio.md → startaudio.md} +6 -9
- package/generated-docs/react/{component/trackmutedindicator.md → trackmutedindicator.md} +6 -14
- package/generated-docs/react/tracktoggle.md +31 -0
- package/generated-docs/react/videotrack.md +28 -0
- package/package.json +2 -2
- package/generated-docs/react/component/audiotrack.md +0 -50
- package/generated-docs/react/component/chatentry.md +0 -50
- package/generated-docs/react/component/livekitroom.md +0 -105
- package/generated-docs/react/component/mediadeviceselect.md +0 -73
- package/generated-docs/react/component/tracktoggle.md +0 -54
- package/generated-docs/react/component/videotrack.md +0 -48
|
@@ -10,36 +10,17 @@
|
|
|
10
10
|
|
|
11
11
|
| Component | Description |
|
|
12
12
|
| ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
13
|
-
| [AudioTrack(props)](./react/component/audiotrack.md) | The AudioTrack component is responsible for rendering participant audio tracks. This component must have access to the participant's context, or alternatively pass it a <code>Participant</code> as a property. |
|
|
14
|
-
| [AudioVisualizer(props)](./react/component/audiovisualizer.md) | The AudioVisualizer component is used to visualize the audio volume of a given audio track. |
|
|
15
13
|
| [CarouselLayout({ tracks, orientation, ...props })](./react/component/carousellayout.md) | The <code>CarouselLayout</code> component displays a list of tracks in a scroll container. It will display as many tiles as possible and overflow the rest. |
|
|
16
|
-
| [ChatEntry(props)](./react/component/chatentry.md) | The <code>ChatEntry</code> component holds and displays one chat message. |
|
|
17
|
-
| [ChatToggle(props)](./react/component/chattoggle.md) | The <code>ChatToggle</code> component is a button that toggles the visibility of the <code>Chat</code> component. |
|
|
18
|
-
| [ClearPinButton(props)](./react/component/clearpinbutton.md) | The <code>ClearPinButton</code> is a basic html button with the added ability to signal the <code>LayoutContext</code> that it should display the grid view again. |
|
|
19
|
-
| [ConnectionQualityIndicator(props)](./react/component/connectionqualityindicator.md) | The <code>ConnectionQualityIndicator</code> shows the individual connection quality of a participant. |
|
|
20
|
-
| [ConnectionState(props)](./react/component/connectionstate.md) | The <code>ConnectionState</code> component displays the connection status of the room as strings (<code>"connected" | "connecting" | "disconnected" | "reconnecting"</code>). |
|
|
21
14
|
| [ConnectionStateToast(props)](./react/component/connectionstatetoast.md) | The <code>ConnectionStateToast</code> component displays a toast notification indicating the current connection state of the room. |
|
|
22
|
-
| [DisconnectButton(props)](./react/component/disconnectbutton.md) | The <code>DisconnectButton</code> is a basic html button with the added ability to disconnect from a LiveKit room. Normally this is the big red button that allows end users to leave the video or audio call. |
|
|
23
15
|
| [FocusLayout({ trackRef, ...htmlProps })](./react/component/focuslayout.md) | The <code>FocusLayout</code> component is just a light wrapper around the <code>ParticipantTile</code> to display a single participant. |
|
|
24
16
|
| [FocusLayoutContainer(props)](./react/component/focuslayoutcontainer.md) | The <code>FocusLayoutContainer</code> is a layout component that expects two children: A small side component: In a video conference, this is usually a carousel of participants who are not in focus. And a larger main component to display the focused participant. For example, with the <code>FocusLayout</code> component. |
|
|
25
|
-
| [FocusToggle(props)](./react/component/focustoggle.md) | The <code>FocusToggle</code> puts the <code>ParticipantTile</code> in focus or removes it from focus. |
|
|
26
17
|
| [GridLayout({ tracks, ...props })](./react/component/gridlayout.md) | The <code>GridLayout</code> component displays the nested participants in a grid where every participants has the same size. It also supports pagination if there are more participants than the grid can display. |
|
|
27
18
|
| [LayoutContextProvider({ value, onPinChange, onWidgetChange, children, })](./react/component/layoutcontextprovider.md) | |
|
|
28
|
-
| [LiveKitRoom(props)](./react/component/livekitroom.md) | The <code>LiveKitRoom</code> component provides the room context to all its child components. It is generally the starting point of your LiveKit app and the root of the LiveKit component tree. It provides the room state as a React context to all child components, so you don't have to pass it yourself. |
|
|
29
|
-
| [MediaDeviceSelect(props)](./react/component/mediadeviceselect.md) | The <code>MediaDeviceSelect</code> list all media devices of one kind. Clicking on one of the listed devices make it the active media device. |
|
|
30
|
-
| [ParticipantAudioTile(props)](./react/component/participantaudiotile.md) | The <code>ParticipantAudioTile</code> component is the base utility wrapper for displaying a visual representation of a participant. This component can be used as a child of the <code>TileLoop</code> or independently if a participant is passed as a property. |
|
|
31
19
|
| [ParticipantContextIfNeeded(props)](./react/component/participantcontextifneeded.md) | The <code>ParticipantContextIfNeeded</code> component only creates a <code>ParticipantContext</code> if there is no <code>ParticipantContext</code> already. |
|
|
32
20
|
| [ParticipantLoop({ participants, ...props })](./react/component/participantloop.md) | The <code>ParticipantLoop</code> component loops over an array of participants to create a context for every participant. This component takes exactly one child component as a template. By providing your own template as a child you have full control over the look and feel of your participant representations. |
|
|
33
|
-
| [ParticipantName(props)](./react/component/participantname.md) | The <code>ParticipantName</code> component displays the name of the participant as a string within an HTML span element. If no participant name is undefined the participant identity string is displayed. |
|
|
34
|
-
| [ParticipantTile(props)](./react/component/participanttile.md) | The <code>ParticipantTile</code> component is the base utility wrapper for displaying a visual representation of a participant. This component can be used as a child of the <code>TrackLoop</code> component or by passing a track reference as property. |
|
|
35
21
|
| [RoomAudioRenderer({ volume, muted })](./react/component/roomaudiorenderer.md) | The <code>RoomAudioRenderer</code> component is a drop-in solution for adding audio to your LiveKit app. It takes care of handling remote participants’ audio tracks and makes sure that microphones and screen share are audible. |
|
|
36
|
-
| [RoomName(props)](./react/component/roomname.md) | The <code>RoomName</code> component renders the name of the connected LiveKit room inside a span tag. |
|
|
37
|
-
| [StartAudio(props)](./react/component/startaudio.md) | The <code>StartAudio</code> component is only visible when the browser blocks audio playback. This is due to some browser implemented autoplay policies. To start audio playback, the user must perform a user-initiated event such as clicking this button. As soon as audio playback starts, the button hides itself again. |
|
|
38
22
|
| [Toast(props)](./react/component/toast.md) | The <code>Toast</code> component is a rudimentary way to display a message to the user. This message should be short lived and not require user interaction. For example, displaying the current connection state like <code>ConnectionStateToast</code> does. |
|
|
39
23
|
| [TrackLoop({ tracks, ...props })](./react/component/trackloop.md) | The <code>TrackLoop</code> component loops over tracks. It is for example a easy way to loop over all participant camera and screen share tracks. <code>TrackLoop</code> creates a <code>TrackRefContext</code> for each track that you can use to e.g. render the track. |
|
|
40
|
-
| [TrackMutedIndicator(props)](./react/component/trackmutedindicator.md) | The <code>TrackMutedIndicator</code> shows whether the participant's camera or microphone is muted or not. By default, a muted/unmuted icon is displayed for a camera, microphone, and screen sharing track. |
|
|
41
|
-
| [TrackToggle(props)](./react/component/tracktoggle.md) | With the <code>TrackToggle</code> component it is possible to mute and unmute your camera and microphone. The component uses an html button element under the hood so you can treat it like a button. |
|
|
42
|
-
| [VideoTrack(props)](./react/component/videotrack.md) | The <code>VideoTrack</code> component is responsible for rendering participant video tracks like <code>camera</code> and <code>screen_share</code>. This component must have access to the participant's context, or alternatively pass it a <code>Participant</code> as a property. |
|
|
43
24
|
|
|
44
25
|
## Prefabs
|
|
45
26
|
|
|
@@ -59,7 +40,7 @@
|
|
|
59
40
|
| [useAudioPlayback(room)](./react/hook/useaudioplayback.md) | In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The <code>useAudioPlayback</code> hook returns an object with a boolean <code>canPlayAudio</code> flag that indicates whether audio playback is allowed in the current context, as well as a <code>startAudio</code> function that can be called in a button <code>onClick</code> callback to start audio playback in the current context. |
|
|
60
41
|
| [useChat(options)](./react/hook/usechat.md) | The <code>useChat</code> hook provides chat functionality for a LiveKit room. It returns a simple <code>send</code> function to send chat messages and an array of <code>chatMessages</code> to hold received messages. It also returns a <code>update</code> function that allows you to implement message-edit functionality. |
|
|
61
42
|
| [useChatToggle({ props })](./react/hook/usechattoggle.md) | The <code>useChatToggle</code> hook provides state and functions for toggling the chat window. |
|
|
62
|
-
| [useClearPinButton(props)](./react/hook/useclearpinbutton.md) | The <code>useClearPinButton</code> hook provides props for the [ClearPinButton
|
|
43
|
+
| [useClearPinButton(props)](./react/hook/useclearpinbutton.md) | The <code>useClearPinButton</code> hook provides props for the [ClearPinButton](./react/clearpinbutton.md) or your custom implementation of it component. It adds the <code>onClick</code> handler to signal the <code>LayoutContext</code> that the tile in focus should be cleared. |
|
|
63
44
|
| [useConnectionQualityIndicator(options)](./react/hook/useconnectionqualityindicator.md) | The <code>useConnectionQualityIndicator</code> hook provides props for the <code>ConnectionQualityIndicator</code> or your custom implementation of it component. |
|
|
64
45
|
| [useConnectionState(room)](./react/hook/useconnectionstate.md) | The <code>useConnectionState</code> hook allows you to simply implement your own <code>ConnectionState</code> component. |
|
|
65
46
|
| [useCreateLayoutContext()](./react/hook/usecreatelayoutcontext.md) | |
|
|
@@ -119,81 +100,100 @@
|
|
|
119
100
|
|
|
120
101
|
## Others
|
|
121
102
|
|
|
122
|
-
| Other | Description
|
|
123
|
-
| --------------------------------------------------------------------------------- |
|
|
124
|
-
| [AllowAudioPlaybackProps](./react/allowaudioplaybackprops.md) |
|
|
125
|
-
| [AudioConferenceProps](./react/audioconferenceprops.md) |
|
|
126
|
-
| [
|
|
127
|
-
| [
|
|
128
|
-
| [
|
|
129
|
-
| [
|
|
130
|
-
| [
|
|
131
|
-
| [
|
|
132
|
-
| [
|
|
133
|
-
| [
|
|
134
|
-
| [
|
|
135
|
-
| [
|
|
136
|
-
| [
|
|
137
|
-
| [
|
|
138
|
-
| [
|
|
139
|
-
| [
|
|
140
|
-
| [
|
|
141
|
-
| [
|
|
142
|
-
| [
|
|
143
|
-
| [
|
|
144
|
-
| [
|
|
145
|
-
| [
|
|
146
|
-
| [
|
|
147
|
-
| [
|
|
148
|
-
| [
|
|
149
|
-
| [
|
|
150
|
-
| [
|
|
151
|
-
| [
|
|
152
|
-
| [
|
|
153
|
-
| [
|
|
154
|
-
| [
|
|
155
|
-
| [
|
|
156
|
-
| [
|
|
157
|
-
| [
|
|
158
|
-
| [
|
|
159
|
-
| [
|
|
160
|
-
| [
|
|
161
|
-
| [
|
|
162
|
-
| [
|
|
163
|
-
| [
|
|
164
|
-
| [
|
|
165
|
-
| [
|
|
166
|
-
| [
|
|
167
|
-
| [
|
|
168
|
-
| [
|
|
169
|
-
| [
|
|
170
|
-
| [
|
|
171
|
-
| [
|
|
172
|
-
| [
|
|
173
|
-
| [
|
|
174
|
-
| [
|
|
175
|
-
| [
|
|
176
|
-
| [
|
|
177
|
-
| [
|
|
178
|
-
| [
|
|
179
|
-
| [
|
|
180
|
-
| [
|
|
181
|
-
| [
|
|
182
|
-
| [
|
|
183
|
-
| [
|
|
184
|
-
| [
|
|
185
|
-
| [
|
|
186
|
-
| [
|
|
187
|
-
| [
|
|
188
|
-
| [
|
|
189
|
-
| [
|
|
190
|
-
| [
|
|
191
|
-
| [
|
|
192
|
-
| [
|
|
193
|
-
| [
|
|
194
|
-
| [
|
|
195
|
-
| [
|
|
196
|
-
| [
|
|
197
|
-
| [
|
|
198
|
-
| [
|
|
199
|
-
| [
|
|
103
|
+
| Other | Description |
|
|
104
|
+
| --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
105
|
+
| [AllowAudioPlaybackProps](./react/allowaudioplaybackprops.md) | |
|
|
106
|
+
| [AudioConferenceProps](./react/audioconferenceprops.md) | |
|
|
107
|
+
| [AudioTrack](./react/audiotrack.md) | The AudioTrack component is responsible for rendering participant audio tracks. This component must have access to the participant's context, or alternatively pass it a <code>Participant</code> as a property. |
|
|
108
|
+
| [AudioTrackProps](./react/audiotrackprops.md) | |
|
|
109
|
+
| [AudioVisualizer](./react/audiovisualizer.md) | The AudioVisualizer component is used to visualize the audio volume of a given audio track. |
|
|
110
|
+
| [AudioVisualizerProps](./react/audiovisualizerprops.md) | |
|
|
111
|
+
| [CarouselLayoutProps](./react/carousellayoutprops.md) | |
|
|
112
|
+
| [ChatEntry](./react/chatentry.md) | The <code>ChatEntry</code> component holds and displays one chat message. |
|
|
113
|
+
| [ChatEntryProps](./react/chatentryprops.md) | ChatEntry composes the HTML div element under the hood, so you can pass all its props. These are the props specific to the ChatEntry component: |
|
|
114
|
+
| [ChatMessage](./react/chatmessage.md) | |
|
|
115
|
+
| [ChatProps](./react/chatprops.md) | |
|
|
116
|
+
| [ChatToggle](./react/chattoggle.md) | The <code>ChatToggle</code> component is a button that toggles the visibility of the <code>Chat</code> component. |
|
|
117
|
+
| [ChatToggleProps](./react/chattoggleprops.md) | |
|
|
118
|
+
| [ClearPinButton](./react/clearpinbutton.md) | The <code>ClearPinButton</code> is a basic html button with the added ability to signal the <code>LayoutContext</code> that it should display the grid view again. |
|
|
119
|
+
| [ClearPinButtonProps](./react/clearpinbuttonprops.md) | |
|
|
120
|
+
| [ConnectionQualityIndicator](./react/connectionqualityindicator.md) | The <code>ConnectionQualityIndicator</code> shows the individual connection quality of a participant. |
|
|
121
|
+
| [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md) | |
|
|
122
|
+
| [ConnectionQualityIndicatorProps](./react/connectionqualityindicatorprops.md) | |
|
|
123
|
+
| [ConnectionState](./react/connectionstate.md) | The <code>ConnectionState</code> component displays the connection status of the room as strings (<code>"connected" | "connecting" | "disconnected" | "reconnecting"</code>). |
|
|
124
|
+
| [ConnectionStateToastProps](./react/connectionstatetoastprops.md) | |
|
|
125
|
+
| [ConnectionStatusProps](./react/connectionstatusprops.md) | |
|
|
126
|
+
| [ControlBarControls](./react/controlbarcontrols.md) | |
|
|
127
|
+
| [ControlBarProps](./react/controlbarprops.md) | |
|
|
128
|
+
| [DisconnectButton](./react/disconnectbutton.md) | The <code>DisconnectButton</code> is a basic html button with the added ability to disconnect from a LiveKit room. Normally this is the big red button that allows end users to leave the video or audio call. |
|
|
129
|
+
| [DisconnectButtonProps](./react/disconnectbuttonprops.md) | |
|
|
130
|
+
| [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md) | |
|
|
131
|
+
| [FocusLayoutProps](./react/focuslayoutprops.md) | |
|
|
132
|
+
| [FocusToggle](./react/focustoggle.md) | The <code>FocusToggle</code> puts the <code>ParticipantTile</code> in focus or removes it from focus. |
|
|
133
|
+
| [FocusToggleProps](./react/focustoggleprops.md) | |
|
|
134
|
+
| [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md) | |
|
|
135
|
+
| [GridLayoutProps](./react/gridlayoutprops.md) | |
|
|
136
|
+
| [LayoutContext](./react/layoutcontext.md) | |
|
|
137
|
+
| [LayoutContextProviderProps](./react/layoutcontextproviderprops.md) | |
|
|
138
|
+
| [LayoutContextType](./react/layoutcontexttype.md) | |
|
|
139
|
+
| [LiveKitRoom](./react/livekitroom.md) | The <code>LiveKitRoom</code> component provides the room context to all its child components. It is generally the starting point of your LiveKit app and the root of the LiveKit component tree. It provides the room state as a React context to all child components, so you don't have to pass it yourself. |
|
|
140
|
+
| [LiveKitRoomProps](./react/livekitroomprops.md) | |
|
|
141
|
+
| [LocalUserChoices](./react/localuserchoices.md) | Represents the user's choices for video and audio input devices, as well as their username. |
|
|
142
|
+
| [MediaDeviceMenuProps](./react/mediadevicemenuprops.md) | |
|
|
143
|
+
| [MediaDeviceSelect](./react/mediadeviceselect.md) | The <code>MediaDeviceSelect</code> list all media devices of one kind. Clicking on one of the listed devices make it the active media device. |
|
|
144
|
+
| [MediaDeviceSelectProps](./react/mediadeviceselectprops.md) | |
|
|
145
|
+
| [MessageDecoder](./react/messagedecoder.md) | |
|
|
146
|
+
| [MessageEncoder](./react/messageencoder.md) | |
|
|
147
|
+
| [MessageFormatter](./react/messageformatter.md) | |
|
|
148
|
+
| [MultiBandTrackVolumeOptions](./react/multibandtrackvolumeoptions.md) | Interface for configuring options for the useMultibandTrackVolume hook. |
|
|
149
|
+
| [ParticipantAudioTile](./react/participantaudiotile.md) | The <code>ParticipantAudioTile</code> component is the base utility wrapper for displaying a visual representation of a participant. This component can be used as a child of the <code>TileLoop</code> or independently if a participant is passed as a property. |
|
|
150
|
+
| [ParticipantContext](./react/participantcontext.md) | |
|
|
151
|
+
| [ParticipantLoopProps](./react/participantloopprops.md) | |
|
|
152
|
+
| [ParticipantName](./react/participantname.md) | The <code>ParticipantName</code> component displays the name of the participant as a string within an HTML span element. If no participant name is undefined the participant identity string is displayed. |
|
|
153
|
+
| [ParticipantNameProps](./react/participantnameprops.md) | |
|
|
154
|
+
| [ParticipantTile](./react/participanttile.md) | The <code>ParticipantTile</code> component is the base utility wrapper for displaying a visual representation of a participant. This component can be used as a child of the <code>TrackLoop</code> component or by passing a track reference as property. |
|
|
155
|
+
| [ParticipantTileProps](./react/participanttileprops.md) | |
|
|
156
|
+
| [PinState](./react/pinstate.md) | |
|
|
157
|
+
| [PreJoinProps](./react/prejoinprops.md) | Props for the PreJoin component. |
|
|
158
|
+
| [ReceivedChatMessage](./react/receivedchatmessage.md) | |
|
|
159
|
+
| [RoomAudioRendererProps](./react/roomaudiorendererprops.md) | |
|
|
160
|
+
| [RoomContext](./react/roomcontext.md) | |
|
|
161
|
+
| [RoomName](./react/roomname.md) | The <code>RoomName</code> component renders the name of the connected LiveKit room inside a span tag. |
|
|
162
|
+
| [RoomNameProps](./react/roomnameprops.md) | |
|
|
163
|
+
| [setLogExtension(extension, options)](./react/setlogextension.md) | Set the log extension for both the <code>@livekit/components-react</code> package and the <code>@livekit-client</code> package. To set the <code>@livekit-client</code> log extension, use the <code>liveKitClientLogExtension</code> prop on the <code>options</code> object. |
|
|
164
|
+
| [setLogLevel(level, options)](./react/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. |
|
|
165
|
+
| [StartAudio](./react/startaudio.md) | The <code>StartAudio</code> component is only visible when the browser blocks audio playback. This is due to some browser implemented autoplay policies. To start audio playback, the user must perform a user-initiated event such as clicking this button. As soon as audio playback starts, the button hides itself again. |
|
|
166
|
+
| [TrackLoopProps](./react/trackloopprops.md) | |
|
|
167
|
+
| [TrackMutedIndicator](./react/trackmutedindicator.md) | The <code>TrackMutedIndicator</code> shows whether the participant's camera or microphone is muted or not. By default, a muted/unmuted icon is displayed for a camera, microphone, and screen sharing track. |
|
|
168
|
+
| [TrackMutedIndicatorProps](./react/trackmutedindicatorprops.md) | |
|
|
169
|
+
| [TrackRefContext](./react/trackrefcontext.md) | This context provides a <code>TrackReferenceOrPlaceholder</code> to all child components. |
|
|
170
|
+
| [TrackReference](./react/trackreference.md) | |
|
|
171
|
+
| [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | |
|
|
172
|
+
| [TrackToggle](./react/tracktoggle.md) | With the <code>TrackToggle</code> component it is possible to mute and unmute your camera and microphone. The component uses an html button element under the hood so you can treat it like a button. |
|
|
173
|
+
| [TrackToggleProps](./react/tracktoggleprops.md) | |
|
|
174
|
+
| [UseChatToggleProps](./react/usechattoggleprops.md) | |
|
|
175
|
+
| [UseFocusToggleProps](./react/usefocustoggleprops.md) | |
|
|
176
|
+
| [UseIsMutedOptions](./react/useismutedoptions.md) | |
|
|
177
|
+
| [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md) | |
|
|
178
|
+
| [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md) | |
|
|
179
|
+
| [UseParticipantInfoOptions](./react/useparticipantinfooptions.md) | The <code>useParticipantInfo</code> hook returns the identity, name, and metadata of a given participant. It requires a <code>Participant</code> object passed as property or via the <code>ParticipantContext</code>. |
|
|
180
|
+
| [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md) | The <code>useParticipantPermissions</code> hook returns the permissions of a given participant. |
|
|
181
|
+
| [UseParticipantsOptions](./react/useparticipantsoptions.md) | |
|
|
182
|
+
| [UseParticipantTileProps](./react/useparticipanttileprops.md) | |
|
|
183
|
+
| [UsePersistentUserChoicesOptions](./react/usepersistentuserchoicesoptions.md) | Options for the <code>usePersistentDeviceSettings</code> hook. |
|
|
184
|
+
| [UseRemoteParticipantOptions](./react/useremoteparticipantoptions.md) | |
|
|
185
|
+
| [UseRemoteParticipantsOptions](./react/useremoteparticipantsoptions.md) | |
|
|
186
|
+
| [UserInfo](./react/userinfo.md) | |
|
|
187
|
+
| [UseRoomInfoOptions](./react/useroominfooptions.md) | The <code>useRoomInfo</code> hook returns the name and metadata of the given <code>Room</code>. |
|
|
188
|
+
| [UseStartAudioProps](./react/usestartaudioprops.md) | |
|
|
189
|
+
| [UseStartVideoProps](./react/usestartvideoprops.md) | |
|
|
190
|
+
| [UseSwipeOptions](./react/useswipeoptions.md) | |
|
|
191
|
+
| [UseTokenOptions](./react/usetokenoptions.md) | |
|
|
192
|
+
| [UseTracksHookReturnType](./react/usetrackshookreturntype.md) | |
|
|
193
|
+
| [UseTracksOptions](./react/usetracksoptions.md) | |
|
|
194
|
+
| [UseTrackToggleProps](./react/usetracktoggleprops.md) | |
|
|
195
|
+
| [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md) | |
|
|
196
|
+
| [VideoConferenceProps](./react/videoconferenceprops.md) | |
|
|
197
|
+
| [VideoTrack](./react/videotrack.md) | The <code>VideoTrack</code> component is responsible for rendering participant video tracks like <code>camera</code> and <code>screen_share</code>. This component must have access to the participant's context, or alternatively pass it a <code>Participant</code> as a property. |
|
|
198
|
+
| [VideoTrackProps](./react/videotrackprops.md) | |
|
|
199
|
+
| [WidgetState](./react/widgetstate.md) | |
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "LiveKitRoom variable",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/LiveKitRoom.tsx"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# LiveKitRoom variable
|
|
11
|
+
|
|
12
|
+
The `LiveKitRoom` component provides the room context to all its child components. It is generally the starting point of your LiveKit app and the root of the LiveKit component tree. It provides the room state as a React context to all child components, so you don't have to pass it yourself.
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
LiveKitRoom: React.ForwardRefExoticComponent<
|
|
18
|
+
LiveKitRoomProps & {
|
|
19
|
+
children?: React.ReactNode;
|
|
20
|
+
} & React.RefAttributes<HTMLDivElement>
|
|
21
|
+
>;
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
```tsx
|
|
27
|
+
<LiveKitRoom token="<livekit-token>" serverUrl="<url-to-livekit-server>" connect={true}>
|
|
28
|
+
...
|
|
29
|
+
</LiveKitRoom>
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
{% partial file="p_usage.md" variables={exampleCount: 1} /%}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "MediaDeviceSelect variable",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/MediaDeviceSelect.tsx"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# MediaDeviceSelect variable
|
|
11
|
+
|
|
12
|
+
The `MediaDeviceSelect` list all media devices of one kind. Clicking on one of the listed devices make it the active media device.
|
|
13
|
+
|
|
14
|
+
**Signature:**
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
MediaDeviceSelect: React.ForwardRefExoticComponent<
|
|
18
|
+
MediaDeviceSelectProps & React.RefAttributes<HTMLUListElement>
|
|
19
|
+
>;
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
```tsx
|
|
25
|
+
<LiveKitRoom>
|
|
26
|
+
<MediaDeviceSelect kind="audioinput" />
|
|
27
|
+
</LiveKitRoom>
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
{% partial file="p_usage.md" variables={exampleCount: 1} /%}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"
|
|
1
|
+
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"videoconference.md","title":"VideoConference"}],"hooks":[{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"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":"usefacingmode.md","title":"useFacingMode"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useisencrypted.md","title":"useIsEncrypted"},{"filename":"useismuted.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":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemultibandtrackvolume.md","title":"useMultibandTrackVolume"},{"filename":"usepagination.md","title":"usePagination"},{"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":"useparticipanttracks.md","title":"useParticipantTracks"},{"filename":"usepersistentuserchoices.md","title":"usePersistentUserChoices"},{"filename":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"usepreviewtracks.md","title":"usePreviewTracks"},{"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":"usestartaudio.md","title":"useStartAudio"},{"filename":"usestartvideo.md","title":"useStartVideo"},{"filename":"useswipe.md","title":"useSwipe"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"}]}
|
|
@@ -1,20 +1,22 @@
|
|
|
1
1
|
---
|
|
2
2
|
{
|
|
3
|
-
"title": "ParticipantAudioTile",
|
|
3
|
+
"title": "ParticipantAudioTile variable",
|
|
4
4
|
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/ParticipantAudioTile.tsx"
|
|
5
5
|
}
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
9
|
|
|
10
|
-
# ParticipantAudioTile
|
|
10
|
+
# ParticipantAudioTile variable
|
|
11
11
|
|
|
12
12
|
The `ParticipantAudioTile` component is the base utility wrapper for displaying a visual representation of a participant. This component can be used as a child of the `TileLoop` or independently if a participant is passed as a property.
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
**Signature:**
|
|
15
15
|
|
|
16
16
|
```typescript
|
|
17
|
-
|
|
17
|
+
ParticipantAudioTile: React.ForwardRefExoticComponent<
|
|
18
|
+
ParticipantTileProps & React.RefAttributes<HTMLDivElement>
|
|
19
|
+
>;
|
|
18
20
|
```
|
|
19
21
|
|
|
20
22
|
## Usage
|
|
@@ -24,20 +26,3 @@ import { ParticipantAudioTile } from "@livekit/components-react";
|
|
|
24
26
|
```
|
|
25
27
|
|
|
26
28
|
{% partial file="p_usage.md" variables={exampleCount: 1} /%}
|
|
27
|
-
|
|
28
|
-
## Properties
|
|
29
|
-
|
|
30
|
-
{% parameter name="disableSpeakingIndicator" type="boolean" optional=true %}
|
|
31
|
-
_(Optional)_
|
|
32
|
-
|
|
33
|
-
{% /parameter %}
|
|
34
|
-
|
|
35
|
-
{% parameter name="onParticipantClick" type="(event: ParticipantClickEvent) => void" optional=true %}
|
|
36
|
-
_(Optional)_
|
|
37
|
-
|
|
38
|
-
{% /parameter %}
|
|
39
|
-
|
|
40
|
-
{% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
|
|
41
|
-
_(Optional)_ The track reference to display.
|
|
42
|
-
|
|
43
|
-
{% /parameter %}
|
|
@@ -1,20 +1,22 @@
|
|
|
1
1
|
---
|
|
2
2
|
{
|
|
3
|
-
"title": "ParticipantName",
|
|
3
|
+
"title": "ParticipantName variable",
|
|
4
4
|
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/ParticipantName.tsx"
|
|
5
5
|
}
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
9
|
|
|
10
|
-
# ParticipantName
|
|
10
|
+
# ParticipantName variable
|
|
11
11
|
|
|
12
12
|
The `ParticipantName` component displays the name of the participant as a string within an HTML span element. If no participant name is undefined the participant identity string is displayed.
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
**Signature:**
|
|
15
15
|
|
|
16
16
|
```typescript
|
|
17
|
-
|
|
17
|
+
ParticipantName: React.ForwardRefExoticComponent<
|
|
18
|
+
ParticipantNameProps & React.RefAttributes<HTMLSpanElement>
|
|
19
|
+
>;
|
|
18
20
|
```
|
|
19
21
|
|
|
20
22
|
## Usage
|