@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
- # tokenize (undefined)
3
+ # tokenize
4
4
 
5
5
  **Signature:**
6
6
 
@@ -14,4 +14,4 @@ export type TrackIdentifier<T extends Track.Source = Track.Source> =
14
14
 
15
15
  **References:** [TrackSource](./core/tracksource.md)<!-- -->, [TrackReference](./core/trackreference.md)
16
16
 
17
- {% partial file="p_usage.md" /%}
17
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # trackObservable (undefined)
3
+ # trackObservable
4
4
 
5
5
  **Signature:**
6
6
 
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # trackReferencesObservable (undefined)
3
+ # trackReferencesObservable
4
4
 
5
5
  **Signature:**
6
6
 
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # updatePages (undefined)
3
+ # updatePages
4
4
 
5
5
  Divide the list of elements into pages and and check if pages need updating.
6
6
 
@@ -14,4 +14,4 @@ export declare function updatePages<T extends UpdatableItem>(
14
14
  ): T[];
15
15
  ```
16
16
 
17
- {% partial file="p_usage.md" /%}
17
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # wasClickOutside (undefined)
3
+ # wasClickOutside
4
4
 
5
5
  **Signature:**
6
6
 
@@ -10,7 +10,7 @@ export interface AllowAudioPlaybackProps extends React.ButtonHTMLAttributes<HTML
10
10
 
11
11
  **Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
@@ -10,4 +10,4 @@ export interface AudioConferenceProps extends React.HTMLAttributes<HTMLDivElemen
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,7 +10,7 @@ export interface AudioTrackProps<T extends HTMLMediaElement = HTMLMediaElement>
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;T&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
@@ -10,4 +10,4 @@ by the default the range is between 0 and 1
10
10
  volume?: number;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,7 +10,7 @@ export interface AudioVisualizerProps extends React.HTMLAttributes<SVGElement>
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;SVGElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
@@ -10,7 +10,7 @@ export interface CarouselLayoutProps extends React.HTMLAttributes<HTMLMediaEleme
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;HTMLMediaElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
@@ -10,4 +10,4 @@ Place the tiles vertically or horizontally next to each other. If undefined orie
10
10
  orientation?: 'vertical' | 'horizontal';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ The chat massage object to display.
10
10
  entry: ReceivedChatMessage;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Hide sender name. Useful when displaying multiple consecutive chat messages from
10
10
  hideName?: boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Hide message timestamp.
10
10
  hideTimestamp?: boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -12,7 +12,7 @@ export interface ChatEntryProps extends React.HTMLAttributes<HTMLLIElement>
12
12
 
13
13
  **Extends:** React.HTMLAttributes&lt;HTMLLIElement&gt;
14
14
 
15
- {% partial file="p_usage.md" /%}
15
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
16
16
 
17
17
  ## Properties
18
18
 
@@ -10,4 +10,4 @@ An optional formatter for the message body.
10
10
  messageFormatter?: MessageFormatter;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,10 +10,12 @@ export interface ChatProps extends React.HTMLAttributes<HTMLDivElement>
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
17
17
  | Property | Type | Description |
18
18
  | ---------------------------------------------------------- | ----------------------------------------------- | ------------ |
19
+ | [messageDecoder?](./react/chatprops.messagedecoder.md) | [MessageDecoder](./react/messagedecoder.md) | _(Optional)_ |
20
+ | [messageEncoder?](./react/chatprops.messageencoder.md) | [MessageEncoder](./react/messageencoder.md) | _(Optional)_ |
19
21
  | [messageFormatter?](./react/chatprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |
@@ -0,0 +1,9 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ ## ChatProps.messageDecoder property
4
+
5
+ **Signature:**
6
+
7
+ ```typescript
8
+ messageDecoder?: MessageDecoder;
9
+ ```
@@ -0,0 +1,9 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ ## ChatProps.messageEncoder property
4
+
5
+ **Signature:**
6
+
7
+ ```typescript
8
+ messageEncoder?: MessageEncoder;
9
+ ```
@@ -10,4 +10,4 @@ export interface ChatToggleProps extends React.ButtonHTMLAttributes<HTMLButtonEl
10
10
 
11
11
  **Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ export interface ClearPinButtonProps extends React.ButtonHTMLAttributes<HTMLButt
10
10
 
11
11
  **Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # AudioConference (prefab)
3
+ # AudioConference
4
4
 
5
5
  This component is the default setup of a classic LiveKit audio conferencing app. It provides functionality like switching between participant grid view and focus view.
6
6
 
@@ -22,4 +22,4 @@ The component is implemented with other LiveKit components like `FocusContextPro
22
22
  <LiveKitRoom>
23
23
  ```
24
24
 
25
- {% partial file="p_usage.md" /%}
25
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # AudioTrack (component)
3
+ # AudioTrack
4
4
 
5
5
  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 `Participant` as a property.
6
6
 
@@ -18,15 +18,34 @@ import { AudioTrack } from '@livekit/components-react';
18
18
  </ParticipantTile>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
25
- | Property | Type | Description |
26
- | -------------------------------------------------------------------------------------- | -------------------------------- | -------------------------------------------------------- |
27
- | [name?](./react/audiotrackprops.name.md) | string | _(Optional)_ |
28
- | [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void | _(Optional)_ |
29
- | [participant?](./react/audiotrackprops.participant.md) | Participant | _(Optional)_ |
30
- | [publication?](./react/audiotrackprops.publication.md) | TrackPublication | _(Optional)_ |
31
- | [source](./react/audiotrackprops.source.md) | Track.Source | |
32
- | [volume?](./react/audiotrackprops.volume.md) | number | _(Optional)_ by the default the range is between 0 and 1 |
25
+ {% parameter name="source" type="Track.Source" optional=false %}
26
+ {% /parameter %}
27
+
28
+ {% parameter name="name" type="string" optional=true %}
29
+ _(Optional)_
30
+
31
+ {% /parameter %}
32
+
33
+ {% parameter name="onSubscriptionStatusChanged" type="(subscribed: boolean) => void" optional=true %}
34
+ _(Optional)_
35
+
36
+ {% /parameter %}
37
+
38
+ {% parameter name="participant" type="Participant" optional=true %}
39
+ _(Optional)_
40
+
41
+ {% /parameter %}
42
+
43
+ {% parameter name="publication" type="TrackPublication" optional=true %}
44
+ _(Optional)_
45
+
46
+ {% /parameter %}
47
+
48
+ {% parameter name="volume" type="number" optional=true %}
49
+ _(Optional)_ by the default the range is between 0 and 1
50
+
51
+ {% /parameter %}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # AudioVisualizer (component)
3
+ # AudioVisualizer
4
4
 
5
5
  ## Import
6
6
 
@@ -8,10 +8,11 @@
8
8
  import { AudioVisualizer } 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
  ## Properties
14
14
 
15
- | Property | Type | Description |
16
- | ----------------------------------------------------------- | ----------- | ------------ |
17
- | [participant?](./react/audiovisualizerprops.participant.md) | Participant | _(Optional)_ |
15
+ {% parameter name="participant" type="Participant" optional=true %}
16
+ _(Optional)_
17
+
18
+ {% /parameter %}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # CarouselView (component)
3
+ # CarouselView
4
4
 
5
5
  The `CarouselLayout` displays a list of tracks horizontally or vertically. Depending on the size of the container, the carousel will display as many tiles as possible and overflows the rest. The CarouselLayout uses the `useVisualStableUpdate` hook to ensure that tile reordering due to track updates is visually stable but still moves the important tiles (speaking participants) to the front.
6
6
 
@@ -19,12 +19,17 @@ const tracks = useTracks();
19
19
  </CarouselLayout>;
20
20
  ```
21
21
 
22
- {% partial file="p_usage.md" /%}
22
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | -------------------------------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
28
- | [children](./react/carouselviewprops.children.md) | React.ReactNode | |
29
- | [orientation?](./react/carouselviewprops.orientation.md) | 'vertical' \| 'horizontal' | _(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container. |
30
- | [tracks](./react/carouselviewprops.tracks.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | |
26
+ {% parameter name="children" type="React.ReactNode" optional=false %}
27
+ {% /parameter %}
28
+
29
+ {% parameter name="tracks" type="TrackReferenceOrPlaceholder[]" optional=false %}
30
+ {% /parameter %}
31
+
32
+ {% parameter name="orientation" type="'vertical' | 'horizontal'" optional=true %}
33
+ _(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container.
34
+
35
+ {% /parameter %}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # Chat (prefab)
3
+ # Chat
4
4
 
5
5
  The Chat component adds a basis chat functionality to the LiveKit room. The messages are distributed to all participants in the room. Only users who are in the room at the time of dispatch will receive the message.
6
6
 
@@ -18,10 +18,21 @@ import { Chat } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
25
- | Property | Type | Description |
26
- | ---------------------------------------------------------- | ----------------------------------------------- | ------------ |
27
- | [messageFormatter?](./react/chatprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |
25
+ {% parameter name="messageDecoder" type="MessageDecoder" optional=true %}
26
+ _(Optional)_
27
+
28
+ {% /parameter %}
29
+
30
+ {% parameter name="messageEncoder" type="MessageEncoder" optional=true %}
31
+ _(Optional)_
32
+
33
+ {% /parameter %}
34
+
35
+ {% parameter name="messageFormatter" type="MessageFormatter" optional=true %}
36
+ _(Optional)_
37
+
38
+ {% /parameter %}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # ChatEntry (component)
3
+ # ChatEntry
4
4
 
5
5
  The `ChatEntry` component holds and displays one chat message.
6
6
 
@@ -18,13 +18,26 @@ import { ChatEntry } from '@livekit/components-react';
18
18
  </Chat>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
25
- | Property | Type | Description |
26
- | --------------------------------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
27
- | [entry](./react/chatentryprops.entry.md) | [ReceivedChatMessage](./core/receivedchatmessage.md) | The chat massage object to display. |
28
- | [hideName?](./react/chatentryprops.hidename.md) | boolean | _(Optional)_ Hide sender name. Useful when displaying multiple consecutive chat messages from the same person. |
29
- | [hideTimestamp?](./react/chatentryprops.hidetimestamp.md) | boolean | _(Optional)_ Hide message timestamp. |
30
- | [messageFormatter?](./react/chatentryprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ An optional formatter for the message body. |
25
+ {% parameter name="entry" type="ReceivedChatMessage" optional=false %}
26
+ The chat massage object to display.
27
+
28
+ {% /parameter %}
29
+
30
+ {% parameter name="hideName" type="boolean" optional=true %}
31
+ _(Optional)_ Hide sender name. Useful when displaying multiple consecutive chat messages from the same person.
32
+
33
+ {% /parameter %}
34
+
35
+ {% parameter name="hideTimestamp" type="boolean" optional=true %}
36
+ _(Optional)_ Hide message timestamp.
37
+
38
+ {% /parameter %}
39
+
40
+ {% parameter name="messageFormatter" type="MessageFormatter" optional=true %}
41
+ _(Optional)_ An optional formatter for the message body.
42
+
43
+ {% /parameter %}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # ChatToggle (component)
3
+ # ChatToggle
4
4
 
5
5
  The ChatToggle component toggles the visibility of the chat component.
6
6
 
@@ -18,4 +18,4 @@ import { ChatToggle } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # ClearPinButton (component)
3
+ # ClearPinButton
4
4
 
5
5
  The ClearPinButton is a basic html button with the added ability to signal the LiveKitRoom that it should display the grid view again.
6
6
 
@@ -22,4 +22,4 @@ This component works only inside a PinContext.
22
22
  </LiveKitRoom>
23
23
  ```
24
24
 
25
- {% partial file="p_usage.md" /%}
25
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # ConnectionQualityIndicator (component)
3
+ # ConnectionQualityIndicator
4
4
 
5
5
  The ConnectionQualityIndicator shows the individual connection quality of a participant.
6
6
 
@@ -16,4 +16,4 @@ import { ConnectionQualityIndicator } from '@livekit/components-react';
16
16
  <ConnectionQualityIndicator />
17
17
  ```
18
18
 
19
- {% partial file="p_usage.md" /%}
19
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # ConnectionState (component)
3
+ # ConnectionState
4
4
 
5
5
  The ConnectionState component displays the connection status of the room in written form.
6
6
 
@@ -18,10 +18,11 @@ import { ConnectionState } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
25
- | Property | Type | Description |
26
- | ---------------------------------------------- | ---- | --------------------------------------------------------------------------- |
27
- | [room?](./react/connectionstatusprops.room.md) | Room | _(Optional)_ The room from which the connection status should be displayed. |
25
+ {% parameter name="room" type="Room" optional=true %}
26
+ _(Optional)_ The room from which the connection status should be displayed.
27
+
28
+ {% /parameter %}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # ConnectionStateToast (component)
3
+ # ConnectionStateToast
4
4
 
5
5
  ## Import
6
6
 
@@ -8,10 +8,11 @@
8
8
  import { ConnectionStateToast } 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
  ## Properties
14
14
 
15
- | Property | Type | Description |
16
- | -------------------------------------------------- | ---- | ------------ |
17
- | [room?](./react/connectionstatetoastprops.room.md) | Room | _(Optional)_ |
15
+ {% parameter name="room" type="Room" optional=true %}
16
+ _(Optional)_
17
+
18
+ {% /parameter %}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # ControlBar (prefab)
3
+ # ControlBar
4
4
 
5
5
  The ControlBar prefab component gives the user the basic user interface to control their media devices and leave the room.
6
6
 
@@ -22,11 +22,16 @@ This component is build with other LiveKit components like `TrackToggle`<!-- -->
22
22
  </LiveKitRoom>
23
23
  ```
24
24
 
25
- {% partial file="p_usage.md" /%}
25
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
26
26
 
27
27
  ## Properties
28
28
 
29
- | Property | Type | Description |
30
- | -------------------------------------------------- | --------------------------------------------------- | ------------ |
31
- | [controls?](./react/controlbarprops.controls.md) | [ControlBarControls](./react/controlbarcontrols.md) | _(Optional)_ |
32
- | [variation?](./react/controlbarprops.variation.md) | 'minimal' \| 'verbose' \| 'textOnly' | _(Optional)_ |
29
+ {% parameter name="controls" type="ControlBarControls" optional=true %}
30
+ _(Optional)_
31
+
32
+ {% /parameter %}
33
+
34
+ {% parameter name="variation" type="'minimal' | 'verbose' | 'textOnly'" optional=true %}
35
+ _(Optional)_
36
+
37
+ {% /parameter %}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # DisconnectButton (component)
3
+ # DisconnectButton
4
4
 
5
5
  The DisconnectButton is a basic html button with the added ability to disconnect from a LiveKit room. Normally, it is used by end-users to leave a video or audio call.
6
6
 
@@ -18,10 +18,11 @@ import { DisconnectButton } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
25
- | Property | Type | Description |
26
- | ---------------------------------------------------------- | ------- | ------------ |
27
- | [stopTracks?](./react/disconnectbuttonprops.stoptracks.md) | boolean | _(Optional)_ |
25
+ {% parameter name="stopTracks" type="boolean" optional=true %}
26
+ _(Optional)_
27
+
28
+ {% /parameter %}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # FocusLayout (component)
3
+ # FocusLayout
4
4
 
5
5
  ## Import
6
6
 
@@ -8,11 +8,16 @@
8
8
  import { FocusLayout } 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
  ## Properties
14
14
 
15
- | Property | Type | Description |
16
- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------ |
17
- | [onParticipantClick?](./react/focuslayoutprops.onparticipantclick.md) | (evt: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_ |
18
- | [track?](./react/focuslayoutprops.track.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
15
+ {% parameter name="onParticipantClick" type="(evt: ParticipantClickEvent) => void" optional=true %}
16
+ _(Optional)_
17
+
18
+ {% /parameter %}
19
+
20
+ {% parameter name="track" type="TrackReferenceOrPlaceholder" optional=true %}
21
+ _(Optional)_
22
+
23
+ {% /parameter %}
@@ -1,6 +1,6 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- # FocusLayoutContainer (component)
3
+ # FocusLayoutContainer
4
4
 
5
5
  ## Import
6
6
 
@@ -8,11 +8,16 @@
8
8
  import { FocusLayoutContainer } 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
  ## Properties
14
14
 
15
- | Property | Type | Description |
16
- | ------------------------------------------------------------------ | ------------------------------------------ | ------------ |
17
- | [focusTrack?](./react/focuslayoutcontainerprops.focustrack.md) | [TrackReference](./core/trackreference.md) | _(Optional)_ |
18
- | [participants?](./react/focuslayoutcontainerprops.participants.md) | Array&lt;Participant&gt; | _(Optional)_ |
15
+ {% parameter name="focusTrack" type="TrackReference" optional=true %}
16
+ _(Optional)_
17
+
18
+ {% /parameter %}
19
+
20
+ {% parameter name="participants" type="Array<Participant>" optional=true %}
21
+ _(Optional)_
22
+
23
+ {% /parameter %}