@livekit/components-js-docs 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (260) hide show
  1. package/generated-docs/core/activespeakerobserver.md +1 -1
  2. package/generated-docs/core/computemenuposition.md +1 -1
  3. package/generated-docs/core/connectedparticipantobserver.md +1 -1
  4. package/generated-docs/core/connectedparticipantsobserver.md +1 -1
  5. package/generated-docs/core/connectionstateobserver.md +1 -1
  6. package/generated-docs/core/createactivedeviceobservable.md +1 -1
  7. package/generated-docs/core/createconnectionqualityobserver.md +1 -1
  8. package/generated-docs/core/createdataobserver.md +1 -1
  9. package/generated-docs/core/createisspeakingobserver.md +1 -1
  10. package/generated-docs/core/createmediadeviceobserver.md +1 -1
  11. package/generated-docs/core/createtrackobserver.md +1 -1
  12. package/generated-docs/core/gettrackbyidentifier.md +1 -1
  13. package/generated-docs/core/gettrackreferenceid.md +2 -2
  14. package/generated-docs/core/gettrackreferencesource.md +2 -2
  15. package/generated-docs/core/index.md +1 -1
  16. package/generated-docs/core/isequaltrackref.md +1 -1
  17. package/generated-docs/core/islocal.md +1 -1
  18. package/generated-docs/core/ismobilebrowser.md +2 -2
  19. package/generated-docs/core/isparticipantsourcepinned.md +2 -2
  20. package/generated-docs/core/isremote.md +1 -1
  21. package/generated-docs/core/issourceswithoptions.md +1 -1
  22. package/generated-docs/core/issourcewitoptions.md +1 -1
  23. package/generated-docs/core/istrackreference.md +1 -1
  24. package/generated-docs/core/istrackreferencepinned.md +2 -2
  25. package/generated-docs/core/istrackreferenceplaceholder.md +1 -1
  26. package/generated-docs/core/mutedobserver.md +1 -1
  27. package/generated-docs/core/observeparticipantevents.md +1 -1
  28. package/generated-docs/core/observeparticipantmedia.md +1 -1
  29. package/generated-docs/core/observeroomevents.md +1 -1
  30. package/generated-docs/core/observetrackevents.md +1 -1
  31. package/generated-docs/core/participanteventselector.md +1 -1
  32. package/generated-docs/core/participantinfoobserver.md +1 -1
  33. package/generated-docs/core/participantpermissionobserver.md +2 -2
  34. package/generated-docs/core/roomaudioplaybackallowedobservable.md +1 -1
  35. package/generated-docs/core/roomeventselector.md +1 -1
  36. package/generated-docs/core/roominfoobserver.md +1 -1
  37. package/generated-docs/core/roomobserver.md +1 -1
  38. package/generated-docs/core/screenshareobserver.md +1 -1
  39. package/generated-docs/core/selectgridlayout.md +1 -1
  40. package/generated-docs/core/sendmessage.md +2 -2
  41. package/generated-docs/core/setdifference.md +1 -1
  42. package/generated-docs/core/setloglevel.md +2 -2
  43. package/generated-docs/core/setupchat.md +8 -2
  44. package/generated-docs/core/setupchattoggle.md +1 -1
  45. package/generated-docs/core/setupclearpinbutton.md +1 -1
  46. package/generated-docs/core/setupconnectionqualityindicator.md +1 -1
  47. package/generated-docs/core/setupdatamessagehandler.md +1 -1
  48. package/generated-docs/core/setupdeviceselector.md +1 -1
  49. package/generated-docs/core/setupdisconnectbutton.md +1 -1
  50. package/generated-docs/core/setupfocustoggle.md +1 -1
  51. package/generated-docs/core/setuplivekitroom.md +1 -1
  52. package/generated-docs/core/setupmanualtoggle.md +1 -1
  53. package/generated-docs/core/setupmediatoggle.md +1 -1
  54. package/generated-docs/core/setupmediatrack.md +1 -1
  55. package/generated-docs/core/setupparticipantname.md +1 -1
  56. package/generated-docs/core/setupparticipanttile.md +1 -1
  57. package/generated-docs/core/setupstartaudio.md +1 -1
  58. package/generated-docs/core/setuptrackmutedindicator.md +1 -1
  59. package/generated-docs/core/sortparticipants.md +2 -2
  60. package/generated-docs/core/sorttrackreferences.md +2 -2
  61. package/generated-docs/core/supportsscreensharing.md +2 -2
  62. package/generated-docs/core/tokenize.md +1 -1
  63. package/generated-docs/core/trackidentifier.md +1 -1
  64. package/generated-docs/core/trackobservable.md +1 -1
  65. package/generated-docs/core/trackreferencesobservable.md +1 -1
  66. package/generated-docs/core/updatepages.md +2 -2
  67. package/generated-docs/core/wasclickoutside.md +1 -1
  68. package/generated-docs/react/allowaudioplaybackprops.md +1 -1
  69. package/generated-docs/react/audioconferenceprops.md +1 -1
  70. package/generated-docs/react/audiotrackprops.md +1 -1
  71. package/generated-docs/react/audiotrackprops.volume.md +1 -1
  72. package/generated-docs/react/audiovisualizerprops.md +1 -1
  73. package/generated-docs/react/carouselviewprops.md +1 -1
  74. package/generated-docs/react/carouselviewprops.orientation.md +1 -1
  75. package/generated-docs/react/chatentryprops.entry.md +1 -1
  76. package/generated-docs/react/chatentryprops.hidename.md +1 -1
  77. package/generated-docs/react/chatentryprops.hidetimestamp.md +1 -1
  78. package/generated-docs/react/chatentryprops.md +1 -1
  79. package/generated-docs/react/chatentryprops.messageformatter.md +1 -1
  80. package/generated-docs/react/chatprops.md +3 -1
  81. package/generated-docs/react/chatprops.messagedecoder.md +9 -0
  82. package/generated-docs/react/chatprops.messageencoder.md +9 -0
  83. package/generated-docs/react/chattoggleprops.md +1 -1
  84. package/generated-docs/react/clearpinbuttonprops.md +1 -1
  85. package/generated-docs/react/component/audioconference.md +2 -2
  86. package/generated-docs/react/component/audiotrack.md +29 -10
  87. package/generated-docs/react/component/audiovisualizer.md +6 -5
  88. package/generated-docs/react/component/carouselview.md +12 -7
  89. package/generated-docs/react/component/chat.md +16 -5
  90. package/generated-docs/react/component/chatentry.md +21 -8
  91. package/generated-docs/react/component/chattoggle.md +2 -2
  92. package/generated-docs/react/component/clearpinbutton.md +2 -2
  93. package/generated-docs/react/component/connectionqualityindicator.md +2 -2
  94. package/generated-docs/react/component/connectionstate.md +6 -5
  95. package/generated-docs/react/component/connectionstatetoast.md +6 -5
  96. package/generated-docs/react/component/controlbar.md +11 -6
  97. package/generated-docs/react/component/disconnectbutton.md +6 -5
  98. package/generated-docs/react/component/focuslayout.md +11 -6
  99. package/generated-docs/react/component/focuslayoutcontainer.md +11 -6
  100. package/generated-docs/react/component/focustoggle.md +9 -6
  101. package/generated-docs/react/component/gridlayout.md +7 -6
  102. package/generated-docs/react/component/livekitroom.md +71 -18
  103. package/generated-docs/react/component/mediadevicemenu.md +26 -9
  104. package/generated-docs/react/component/mediadeviceselect.md +39 -12
  105. package/generated-docs/react/component/participantaudiotile.md +26 -9
  106. package/generated-docs/react/component/participantcontextifneeded.md +2 -2
  107. package/generated-docs/react/component/participantloop.md +11 -6
  108. package/generated-docs/react/component/participantname.md +2 -2
  109. package/generated-docs/react/component/participanttile.md +26 -9
  110. package/generated-docs/react/component/prejoin.md +46 -13
  111. package/generated-docs/react/component/roomaudiorenderer.md +2 -2
  112. package/generated-docs/react/component/roomname.md +6 -5
  113. package/generated-docs/react/component/startaudio.md +4 -5
  114. package/generated-docs/react/component/toast.md +2 -2
  115. package/generated-docs/react/component/trackloop.md +11 -6
  116. package/generated-docs/react/component/trackmutedindicator.md +14 -7
  117. package/generated-docs/react/component/tracktoggle.md +24 -9
  118. package/generated-docs/react/component/videoconference.md +16 -5
  119. package/generated-docs/react/component/videotrack.md +34 -10
  120. package/generated-docs/react/connectionqualityindicatoroptions.md +1 -1
  121. package/generated-docs/react/connectionqualityindicatorprops.md +1 -1
  122. package/generated-docs/react/connectionstatetoastprops.md +1 -1
  123. package/generated-docs/react/connectionstatusprops.md +1 -1
  124. package/generated-docs/react/connectionstatusprops.room.md +1 -1
  125. package/generated-docs/react/controlbarcontrols.md +1 -1
  126. package/generated-docs/react/controlbarprops.md +1 -1
  127. package/generated-docs/react/disconnectbuttonprops.md +1 -1
  128. package/generated-docs/react/focuslayoutcontainerprops.md +1 -1
  129. package/generated-docs/react/focuslayoutprops.md +1 -1
  130. package/generated-docs/react/focustoggleprops.md +1 -1
  131. package/generated-docs/react/formatchatmessagelinks.md +11 -0
  132. package/generated-docs/react/gridlayoutprops.md +1 -1
  133. package/generated-docs/react/hook/usechat.md +12 -4
  134. package/generated-docs/react/hook/usechattoggle.md +6 -7
  135. package/generated-docs/react/hook/useclearpinbutton.md +6 -7
  136. package/generated-docs/react/hook/useconnectionqualityindicator.md +6 -7
  137. package/generated-docs/react/hook/useconnectionstate.md +6 -7
  138. package/generated-docs/react/hook/usecreatelayoutcontext.md +4 -4
  139. package/generated-docs/react/hook/usedatachannel.md +9 -8
  140. package/generated-docs/react/hook/usedatachannel_1.md +6 -7
  141. package/generated-docs/react/hook/usedisconnectbutton.md +6 -7
  142. package/generated-docs/react/hook/useensurecreatelayoutcontext.md +6 -7
  143. package/generated-docs/react/hook/useensurelayoutcontext.md +6 -7
  144. package/generated-docs/react/hook/useensureparticipant.md +6 -7
  145. package/generated-docs/react/hook/useensureroom.md +6 -7
  146. package/generated-docs/react/hook/useensuretrackreference.md +6 -7
  147. package/generated-docs/react/hook/usefocustoggle.md +6 -7
  148. package/generated-docs/react/hook/usegridlayout.md +9 -8
  149. package/generated-docs/react/hook/useismuted.md +9 -8
  150. package/generated-docs/react/hook/useisspeaking.md +6 -7
  151. package/generated-docs/react/hook/uselayoutcontext.md +4 -4
  152. package/generated-docs/react/hook/uselivekitroom.md +6 -7
  153. package/generated-docs/react/hook/uselocalparticipant.md +6 -7
  154. package/generated-docs/react/hook/uselocalparticipantpermissions.md +4 -4
  155. package/generated-docs/react/hook/usemaybelayoutcontext.md +4 -4
  156. package/generated-docs/react/hook/usemaybeparticipantcontext.md +4 -4
  157. package/generated-docs/react/hook/usemayberoomcontext.md +4 -4
  158. package/generated-docs/react/hook/usemaybetrackcontext.md +4 -4
  159. package/generated-docs/react/hook/usemediadevices.md +8 -7
  160. package/generated-docs/react/hook/usemediadeviceselect.md +6 -7
  161. package/generated-docs/react/hook/usemediatrack.md +12 -9
  162. package/generated-docs/react/hook/usemediatrackbyname.md +12 -9
  163. package/generated-docs/react/hook/useparticipantcontext.md +4 -4
  164. package/generated-docs/react/hook/useparticipantinfo.md +6 -7
  165. package/generated-docs/react/hook/useparticipantpermissions.md +6 -7
  166. package/generated-docs/react/hook/useparticipants.md +6 -7
  167. package/generated-docs/react/hook/useparticipanttile.md +6 -7
  168. package/generated-docs/react/hook/usepinnedtracks.md +6 -7
  169. package/generated-docs/react/hook/usepreviewdevice.md +12 -9
  170. package/generated-docs/react/hook/useremoteparticipant.md +9 -8
  171. package/generated-docs/react/hook/useremoteparticipants.md +6 -7
  172. package/generated-docs/react/hook/useroomcontext.md +4 -4
  173. package/generated-docs/react/hook/useroominfo.md +6 -7
  174. package/generated-docs/react/hook/usesortedparticipants.md +6 -7
  175. package/generated-docs/react/hook/usespeakingparticipants.md +4 -4
  176. package/generated-docs/react/hook/usetoken.md +12 -9
  177. package/generated-docs/react/hook/usetrackcontext.md +4 -4
  178. package/generated-docs/react/hook/usetrackmutedindicator.md +9 -8
  179. package/generated-docs/react/hook/usetracks.md +9 -8
  180. package/generated-docs/react/hook/usetracktoggle.md +6 -7
  181. package/generated-docs/react/hook/usevisualstableupdate.md +12 -9
  182. package/generated-docs/react/index.md +8 -6
  183. package/generated-docs/react/layoutcontext.md +1 -1
  184. package/generated-docs/react/layoutcontexttype.md +1 -1
  185. package/generated-docs/react/livekitroomprops.audio.md +1 -1
  186. package/generated-docs/react/livekitroomprops.connect.md +1 -1
  187. package/generated-docs/react/livekitroomprops.connectoptions.md +1 -1
  188. package/generated-docs/react/livekitroomprops.md +1 -1
  189. package/generated-docs/react/livekitroomprops.options.md +1 -1
  190. package/generated-docs/react/livekitroomprops.room.md +1 -1
  191. package/generated-docs/react/livekitroomprops.screen.md +1 -1
  192. package/generated-docs/react/livekitroomprops.serverurl.md +1 -1
  193. package/generated-docs/react/livekitroomprops.token.md +1 -1
  194. package/generated-docs/react/livekitroomprops.video.md +1 -1
  195. package/generated-docs/react/localuserchoices.md +1 -1
  196. package/generated-docs/react/mediadevicemenuprops.md +1 -1
  197. package/generated-docs/react/mediadevicemenuprops.requestpermissions.md +1 -1
  198. package/generated-docs/react/mediadeviceselectprops.exactmatch.md +1 -1
  199. package/generated-docs/react/mediadeviceselectprops.md +1 -1
  200. package/generated-docs/react/mediadeviceselectprops.requestpermissions.md +1 -1
  201. package/generated-docs/react/messagedecoder.md +13 -0
  202. package/generated-docs/react/messageencoder.md +13 -0
  203. package/generated-docs/react/messageformatter.md +1 -1
  204. package/generated-docs/react/meta-data.json +1 -0
  205. package/generated-docs/react/participantcontext.md +1 -1
  206. package/generated-docs/react/participantloopprops.children.md +1 -1
  207. package/generated-docs/react/participantloopprops.md +5 -5
  208. package/generated-docs/react/participantloopprops.participants.md +2 -2
  209. package/generated-docs/react/participantnameprops.md +1 -1
  210. package/generated-docs/react/participanttileprops.md +1 -1
  211. package/generated-docs/react/prejoinprops.debug.md +1 -1
  212. package/generated-docs/react/prejoinprops.defaults.md +1 -1
  213. package/generated-docs/react/prejoinprops.md +12 -12
  214. package/generated-docs/react/prejoinprops.onsubmit.md +1 -1
  215. package/generated-docs/react/prejoinprops.onvalidate.md +1 -1
  216. package/generated-docs/react/{hook/prejoinprops.userlabel.md → prejoinprops.userlabel.md} +2 -2
  217. package/generated-docs/react/roomcontext.md +1 -1
  218. package/generated-docs/react/roomnameprops.md +1 -1
  219. package/generated-docs/react/trackcontext.md +1 -1
  220. package/generated-docs/react/trackloopprops.children.md +1 -1
  221. package/generated-docs/react/trackloopprops.md +5 -5
  222. package/generated-docs/react/trackloopprops.tracks.md +2 -2
  223. package/generated-docs/react/trackmutedindicatorprops.md +1 -1
  224. package/generated-docs/react/tracktoggleprops.md +1 -1
  225. package/generated-docs/react/usechattoggleprops.md +1 -1
  226. package/generated-docs/react/usefocustoggleprops.md +1 -1
  227. package/generated-docs/react/useismutedoptions.md +1 -1
  228. package/generated-docs/react/uselocalparticipantoptions.md +1 -1
  229. package/generated-docs/react/uselocalparticipantoptions.room.md +1 -1
  230. package/generated-docs/react/usemediadeviceselectprops.md +1 -1
  231. package/generated-docs/react/usemediadeviceselectprops.requestpermissions.md +1 -1
  232. package/generated-docs/react/usemediatrackoptions.md +1 -1
  233. package/generated-docs/react/useparticipantinfooptions.md +1 -1
  234. package/generated-docs/react/useparticipantpermissionsoptions.md +1 -1
  235. package/generated-docs/react/useparticipantsoptions.md +1 -1
  236. package/generated-docs/react/useparticipantsoptions.room.md +1 -1
  237. package/generated-docs/react/useparticipantsoptions.updateonlyon.md +1 -1
  238. package/generated-docs/react/useparticipanttileprops.md +1 -1
  239. package/generated-docs/react/useremoteparticipantoptions.md +1 -1
  240. package/generated-docs/react/useremoteparticipantsoptions.md +1 -1
  241. package/generated-docs/react/useremoteparticipantsoptions.room.md +1 -1
  242. package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md +1 -1
  243. package/generated-docs/react/userinfo.md +1 -1
  244. package/generated-docs/react/useroominfooptions.md +1 -1
  245. package/generated-docs/react/usetokenoptions.md +4 -4
  246. package/generated-docs/react/{hook/usetokenoptions.userinfo.md → usetokenoptions.userinfo.md} +2 -2
  247. package/generated-docs/react/usetrackmutedindicatoroptions.md +1 -1
  248. package/generated-docs/react/usetrackshookreturntype.md +1 -1
  249. package/generated-docs/react/usetracksoptions.md +1 -1
  250. package/generated-docs/react/usetracktoggleprops.md +1 -1
  251. package/generated-docs/react/usevisualstableupdateoptions.customsortfunction.md +1 -1
  252. package/generated-docs/react/usevisualstableupdateoptions.md +1 -1
  253. package/generated-docs/react/videoconferenceprops.chatmessagedecoder.md +9 -0
  254. package/generated-docs/react/videoconferenceprops.chatmessageencoder.md +9 -0
  255. package/generated-docs/react/videoconferenceprops.md +3 -1
  256. package/generated-docs/react/videotrackprops.managesubscription.md +9 -0
  257. package/generated-docs/react/videotrackprops.md +2 -1
  258. package/package.json +1 -1
  259. package/generated-docs/react/component/formatchatmessagelinks.md +0 -11
  260. package/meta-data.json +0 -78
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useEnsureParticipant (hook)
3
+ # useEnsureParticipant
4
4
 
5
5
  Ensures that a participant is provided, either via context or explicitly as a parameter. If not inside a `ParticipantContext` and no participant is provided, an error is thrown.
6
6
 
@@ -10,14 +10,13 @@ Ensures that a participant is provided, either via context or explicitly as a pa
10
10
  import { useEnsureParticipant } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | ----------- | ----------- | ------------ |
19
- | participant | Participant | _(Optional)_ |
17
+ {% parameter name="participant" type="Participant" optional=true %}
18
+ {% /parameter %}
20
19
 
21
- **Returns:**
20
+ ## Returns
22
21
 
23
- Participant
22
+ `Participant`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useEnsureRoom (hook)
3
+ # useEnsureRoom
4
4
 
5
5
  Ensures that a room is provided, either via context or explicitly as a parameter. If no room is provided, an error is thrown.
6
6
 
@@ -10,14 +10,13 @@ Ensures that a room is provided, either via context or explicitly as a parameter
10
10
  import { useEnsureRoom } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --------- | ---- | ------------ |
19
- | room | Room | _(Optional)_ |
17
+ {% parameter name="room" type="Room" optional=true %}
18
+ {% /parameter %}
20
19
 
21
- **Returns:**
20
+ ## Returns
22
21
 
23
- Room
22
+ `Room`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useEnsureTrackReference (hook)
3
+ # useEnsureTrackReference
4
4
 
5
5
  Ensures that a track reference is provided, either via context or explicitly as a parameter. If not inside a `TrackContext` and no track reference is provided, an error is thrown.
6
6
 
@@ -10,14 +10,13 @@ Ensures that a track reference is provided, either via context or explicitly as
10
10
  import { useEnsureTrackReference } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --------- | -------------------------------------------------------------------- | ------------ |
19
- | track | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
17
+ {% parameter name="track" type="TrackReferenceOrPlaceholder" optional=true %}
18
+ {% /parameter %}
20
19
 
21
- **Returns:**
20
+ ## Returns
22
21
 
23
- [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)
22
+ `TrackReferenceOrPlaceholder`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useFocusToggle (hook)
3
+ # useFocusToggle
4
4
 
5
5
  ## Import
6
6
 
@@ -8,14 +8,13 @@
8
8
  import { useFocusToggle } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | ----------------------------------- | ----------------------------------------------------- | ----------- |
17
- | { trackSource, participant, props } | [UseFocusToggleProps](./react/usefocustoggleprops.md) | |
15
+ {% parameter name="{ trackSource, participant, props }" type="UseFocusToggleProps" optional=false %}
16
+ {% /parameter %}
18
17
 
19
- **Returns:**
18
+ ## Returns
20
19
 
21
- { mergedProps: React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; &amp; { className: string; onClick: (event: React.MouseEvent&lt;HTMLButtonElement, MouseEvent&gt;) =&gt; void; }; inFocus: boolean; }
20
+ `{ mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & { className: string; onClick: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void; }; inFocus: boolean; }`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useGridLayout (hook)
3
+ # useGridLayout
4
4
 
5
5
  The useGridLayout hook tries to select the best layout to fit all tiles. If the available screen space is not enough, it will reduce the number of maximum visible tiles and select a layout that still works visually within the given limitations. As the order of tiles changes over time, the hook tries to keep visual updates to a minimum while trying to display important tiles such as speaking participants or screen shares.
6
6
 
@@ -10,15 +10,16 @@ The useGridLayout hook tries to select the best layout to fit all tiles. If the
10
10
  import { useGridLayout } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | ----------- | ------------------------------------- | ----------- |
19
- | gridElement | React.RefObject&lt;HTMLDivElement&gt; | |
20
- | trackCount | number | |
17
+ {% parameter name="gridElement" type="React.RefObject<HTMLDivElement>" optional=false %}
18
+ {% /parameter %}
21
19
 
22
- **Returns:**
20
+ {% parameter name="trackCount" type="number" optional=false %}
21
+ {% /parameter %}
23
22
 
24
- { layout: [GridLayoutDefinition](./core/gridlayoutdefinition.md)<!-- -->; }
23
+ ## Returns
24
+
25
+ `{ layout: GridLayoutDefinition; }`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useIsMuted (hook)
3
+ # useIsMuted
4
4
 
5
5
  ## Import
6
6
 
@@ -8,15 +8,16 @@
8
8
  import { useIsMuted } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --------- | ------------------------------------------------- | ------------ |
17
- | source | Track.Source | |
18
- | options | [UseIsMutedOptions](./react/useismutedoptions.md) | _(Optional)_ |
15
+ {% parameter name="source" type="Track.Source" optional=false %}
16
+ {% /parameter %}
19
17
 
20
- **Returns:**
18
+ {% parameter name="options" type="UseIsMutedOptions" optional=true %}
19
+ {% /parameter %}
21
20
 
22
- boolean
21
+ ## Returns
22
+
23
+ `boolean`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useIsSpeaking (hook)
3
+ # useIsSpeaking
4
4
 
5
5
  ## Import
6
6
 
@@ -8,14 +8,13 @@
8
8
  import { useIsSpeaking } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | ----------- | ----------- | ------------ |
17
- | participant | Participant | _(Optional)_ |
15
+ {% parameter name="participant" type="Participant" optional=true %}
16
+ {% /parameter %}
18
17
 
19
- **Returns:**
18
+ ## Returns
20
19
 
21
- boolean
20
+ `boolean`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useLayoutContext (hook)
3
+ # useLayoutContext
4
4
 
5
5
  Ensures that a layout context is provided via context. If no layout context is provided, an error is thrown.
6
6
 
@@ -10,8 +10,8 @@ Ensures that a layout context is provided via context. If no layout context is p
10
10
  import { useLayoutContext } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
- **Returns:**
15
+ ## Returns
16
16
 
17
- [LayoutContextType](./react/layoutcontexttype.md)
17
+ `LayoutContextType`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useLiveKitRoom (hook)
3
+ # useLiveKitRoom
4
4
 
5
5
  ## Import
6
6
 
@@ -8,14 +8,13 @@
8
8
  import { useLiveKitRoom } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --------- | ----------------------------------------------- | ----------- |
17
- | props | [LiveKitRoomProps](./react/livekitroomprops.md) | |
15
+ {% parameter name="props" type="LiveKitRoomProps" optional=false %}
16
+ {% /parameter %}
18
17
 
19
- **Returns:**
18
+ ## Returns
20
19
 
21
- { room: Room \| undefined; htmlProps: HTMLAttributes&lt;T&gt;; }
20
+ `{ room: Room | undefined; htmlProps: HTMLAttributes<T>; }`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useLocalParticipant (hook)
3
+ # useLocalParticipant
4
4
 
5
5
  The useLocalParticipant hook the state of the local participant.
6
6
 
@@ -10,14 +10,13 @@ The useLocalParticipant hook the state of the local participant.
10
10
  import { useLocalParticipant } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --------- | ------------------------------------------------------------------- | ------------ |
19
- | options | [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md) | _(Optional)_ |
17
+ {% parameter name="options" type="UseLocalParticipantOptions" optional=true %}
18
+ {% /parameter %}
20
19
 
21
- **Returns:**
20
+ ## Returns
22
21
 
23
- { isMicrophoneEnabled: boolean; isScreenShareEnabled: boolean; isCameraEnabled: boolean; microphoneTrack: TrackPublication \| undefined; cameraTrack: TrackPublication \| undefined; localParticipant: LocalParticipant; }
22
+ `{ isMicrophoneEnabled: boolean; isScreenShareEnabled: boolean; isCameraEnabled: boolean; microphoneTrack: TrackPublication | undefined; cameraTrack: TrackPublication | undefined; lastMicrophoneError: Error | undefined; lastCameraError: Error | undefined; localParticipant: LocalParticipant; }`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useLocalParticipantPermissions (hook)
3
+ # useLocalParticipantPermissions
4
4
 
5
5
  ## Import
6
6
 
@@ -8,8 +8,8 @@
8
8
  import { useLocalParticipantPermissions } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
- **Returns:**
13
+ ## Returns
14
14
 
15
- import("livekit-client/dist/src/proto/livekit_models").ParticipantPermission \| undefined
15
+ `import("livekit-client/dist/src/proto/livekit_models_pb").ParticipantPermission | undefined`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useMaybeLayoutContext (hook)
3
+ # useMaybeLayoutContext
4
4
 
5
5
  Returns a layout context from the `LayoutContext` if it exists, otherwise `undefined`<!-- -->.
6
6
 
@@ -10,8 +10,8 @@ Returns a layout context from the `LayoutContext` if it exists, otherwise `undef
10
10
  import { useMaybeLayoutContext } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
- **Returns:**
15
+ ## Returns
16
16
 
17
- [LayoutContextType](./react/layoutcontexttype.md) \| undefined
17
+ `LayoutContextType | undefined`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useMaybeParticipantContext (hook)
3
+ # useMaybeParticipantContext
4
4
 
5
5
  Returns a participant from the `ParticipantContext` if it exists, otherwise `undefined`<!-- -->.
6
6
 
@@ -10,8 +10,8 @@ Returns a participant from the `ParticipantContext` if it exists, otherwise `und
10
10
  import { useMaybeParticipantContext } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
- **Returns:**
15
+ ## Returns
16
16
 
17
- Participant \| undefined
17
+ `Participant | undefined`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useMaybeRoomContext (hook)
3
+ # useMaybeRoomContext
4
4
 
5
5
  Returns the room context if it exists, otherwise undefined.
6
6
 
@@ -10,8 +10,8 @@ Returns the room context if it exists, otherwise undefined.
10
10
  import { useMaybeRoomContext } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
- **Returns:**
15
+ ## Returns
16
16
 
17
- Room \| undefined
17
+ `Room | undefined`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useMaybeTrackContext (hook)
3
+ # useMaybeTrackContext
4
4
 
5
5
  Returns a track reference from the `TrackContext` if it exists, otherwise `undefined`<!-- -->.
6
6
 
@@ -10,8 +10,8 @@ Returns a track reference from the `TrackContext` if it exists, otherwise `undef
10
10
  import { useMaybeTrackContext } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
- **Returns:**
15
+ ## Returns
16
16
 
17
- [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) \| undefined
17
+ `TrackReferenceOrPlaceholder | undefined`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useMediaDevices (hook)
3
+ # useMediaDevices
4
4
 
5
5
  ## Import
6
6
 
@@ -8,14 +8,15 @@
8
8
  import { useMediaDevices } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --------- | -------------------------- | ----------- |
17
- | { kind } | { kind: MediaDeviceKind; } | |
15
+ {% parameter name="{ kind }" type="{
16
+ kind: MediaDeviceKind;
17
+ }" optional=false %}
18
+ {% /parameter %}
18
19
 
19
- **Returns:**
20
+ ## Returns
20
21
 
21
- MediaDeviceInfo\[\]
22
+ `MediaDeviceInfo[]`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useMediaDeviceSelect (hook)
3
+ # useMediaDeviceSelect
4
4
 
5
5
  ## Import
6
6
 
@@ -8,14 +8,13 @@
8
8
  import { useMediaDeviceSelect } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | ------------------------------------------ | ----------------------------------------------------------------- | ----------- |
17
- | { kind, room, track, requestPermissions, } | [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md) | |
15
+ {% parameter name="{ kind, room, track, requestPermissions, }" type="UseMediaDeviceSelectProps" optional=false %}
16
+ {% /parameter %}
18
17
 
19
- **Returns:**
18
+ ## Returns
20
19
 
21
- { devices: MediaDeviceInfo\[\]; className: string; activeDeviceId: string; setActiveMediaDevice: (id: string, options?: import("@livekit/components-core").[SetMediaDeviceOptions](./core/setmediadeviceoptions.md) \| undefined) =&gt; Promise&lt;void&gt;; }
20
+ `{ devices: MediaDeviceInfo[]; className: string; activeDeviceId: string; setActiveMediaDevice: (id: string, options?: import("@livekit/components-core").SetMediaDeviceOptions | undefined) => Promise<void>; }`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useMediaTrack (hook)
3
+ # useMediaTrack
4
4
 
5
5
  ## Import
6
6
 
@@ -8,16 +8,19 @@
8
8
  import { useMediaTrack } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | ----------- | ---------------------------------------------------------------------------- | ------------ |
17
- | source | [VideoSource](./core/videosource.md) \| [AudioSource](./core/audiosource.md) | |
18
- | participant | Participant | _(Optional)_ |
19
- | options | [UseMediaTrackOptions](./react/usemediatrackoptions.md) | _(Optional)_ |
15
+ {% parameter name="source" type="VideoSource | AudioSource" optional=false %}
16
+ {% /parameter %}
20
17
 
21
- **Returns:**
18
+ {% parameter name="options" type="UseMediaTrackOptions" optional=true %}
19
+ {% /parameter %}
22
20
 
23
- { publication: import("livekit-client").TrackPublication \| undefined; isMuted: boolean \| undefined; isSubscribed: boolean \| undefined; track: import("livekit-client").Track \| undefined; elementProps: React.HTMLAttributes&lt;HTMLElement&gt;; }
21
+ {% parameter name="participant" type="Participant" optional=true %}
22
+ {% /parameter %}
23
+
24
+ ## Returns
25
+
26
+ `{ publication: import("livekit-client").TrackPublication | undefined; isMuted: boolean | undefined; isSubscribed: boolean | undefined; track: import("livekit-client").Track | undefined; elementProps: React.HTMLAttributes<HTMLElement>; }`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useMediaTrackByName (hook)
3
+ # useMediaTrackByName
4
4
 
5
5
  ## Import
6
6
 
@@ -8,16 +8,19 @@
8
8
  import { useMediaTrackByName } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | ----------- | ------------------------------------------------------- | ------------ |
17
- | name | string | |
18
- | participant | Participant | _(Optional)_ |
19
- | options | [UseMediaTrackOptions](./react/usemediatrackoptions.md) | _(Optional)_ |
15
+ {% parameter name="name" type="string" optional=false %}
16
+ {% /parameter %}
20
17
 
21
- **Returns:**
18
+ {% parameter name="options" type="UseMediaTrackOptions" optional=true %}
19
+ {% /parameter %}
22
20
 
23
- { publication: import("livekit-client").TrackPublication \| undefined; isMuted: boolean \| undefined; isSubscribed: boolean \| undefined; track: import("livekit-client").Track \| undefined; elementProps: import("react").HTMLAttributes&lt;HTMLElement&gt;; }
21
+ {% parameter name="participant" type="Participant" optional=true %}
22
+ {% /parameter %}
23
+
24
+ ## Returns
25
+
26
+ `{ publication: import("livekit-client").TrackPublication | undefined; isMuted: boolean | undefined; isSubscribed: boolean | undefined; track: import("livekit-client").Track | undefined; elementProps: import("react").HTMLAttributes<HTMLElement>; }`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useParticipantContext (hook)
3
+ # useParticipantContext
4
4
 
5
5
  Ensures that a participant is provided via context. If not inside a `ParticipantContext`<!-- -->, an error is thrown.
6
6
 
@@ -10,8 +10,8 @@ Ensures that a participant is provided via context. If not inside a `Participant
10
10
  import { useParticipantContext } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
- **Returns:**
15
+ ## Returns
16
16
 
17
- Participant
17
+ `Participant`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useParticipantInfo (hook)
3
+ # useParticipantInfo
4
4
 
5
5
  ## Import
6
6
 
@@ -8,14 +8,13 @@
8
8
  import { useParticipantInfo } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --------- | ----------------------------------------------------------------- | ------------ |
17
- | props | [UseParticipantInfoOptions](./react/useparticipantinfooptions.md) | _(Optional)_ |
15
+ {% parameter name="props" type="UseParticipantInfoOptions" optional=true %}
16
+ {% /parameter %}
18
17
 
19
- **Returns:**
18
+ ## Returns
20
19
 
21
- { identity: string; name: string \| undefined; metadata: string \| undefined; }
20
+ `{ identity: string; name: string | undefined; metadata: string | undefined; }`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useParticipantPermissions (hook)
3
+ # useParticipantPermissions
4
4
 
5
5
  ## Import
6
6
 
@@ -8,14 +8,13 @@
8
8
  import { useParticipantPermissions } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --------- | ------------------------------------------------------------------------------- | ------------ |
17
- | options | [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md) | _(Optional)_ |
15
+ {% parameter name="options" type="UseParticipantPermissionsOptions" optional=true %}
16
+ {% /parameter %}
18
17
 
19
- **Returns:**
18
+ ## Returns
20
19
 
21
- import("livekit-client/dist/src/proto/livekit_models").ParticipantPermission \| undefined
20
+ `import("livekit-client/dist/src/proto/livekit_models_pb").ParticipantPermission | undefined`
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # useParticipants (hook)
3
+ # useParticipants
4
4
 
5
5
  The useParticipants hook returns all participants (local and remote) of the current room.
6
6
 
@@ -10,14 +10,13 @@ The useParticipants hook returns all participants (local and remote) of the curr
10
10
  import { useParticipants } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --------- | ----------------------------------------------------------- | ------------ |
19
- | options | [UseParticipantsOptions](./react/useparticipantsoptions.md) | _(Optional)_ |
17
+ {% parameter name="options" type="UseParticipantsOptions" optional=true %}
18
+ {% /parameter %}
20
19
 
21
- **Returns:**
20
+ ## Returns
22
21
 
23
- (import("livekit-client").RemoteParticipant \| import("livekit-client").LocalParticipant)\[\]
22
+ `(import("livekit-client").RemoteParticipant | import("livekit-client").LocalParticipant)[]`