@livekit/components-js-docs 0.1.48 → 0.1.50

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 (312) hide show
  1. package/generated-docs/core/chatoptions.md +0 -2
  2. package/generated-docs/core/dedupesegments.md +0 -2
  3. package/generated-docs/core/gettrackreferenceid.md +0 -2
  4. package/generated-docs/core/gettrackreferencesource.md +0 -2
  5. package/generated-docs/core/gridlayoutdefinition.md +0 -2
  6. package/generated-docs/core/islocal.md +1 -1
  7. package/generated-docs/core/ismobilebrowser.md +0 -2
  8. package/generated-docs/core/isparticipanttrackreferencepinned.md +0 -2
  9. package/generated-docs/core/isremote.md +1 -1
  10. package/generated-docs/core/istrackreferencepinned.md +0 -2
  11. package/generated-docs/core/loaduserchoices.md +6 -2
  12. package/generated-docs/core/localuserchoices.md +0 -2
  13. package/generated-docs/core/messagedecoder.md +0 -2
  14. package/generated-docs/core/messageencoder.md +0 -2
  15. package/generated-docs/core/participantidentifier.md +5 -3
  16. package/generated-docs/core/pinstate.md +0 -2
  17. package/generated-docs/core/receivedchatmessage.md +0 -2
  18. package/generated-docs/core/saveuserchoices.md +6 -2
  19. package/generated-docs/core/sendmessage.md +0 -2
  20. package/generated-docs/core/setlogextension.md +0 -2
  21. package/generated-docs/core/setloglevel.md +0 -2
  22. package/generated-docs/core/setupdeviceselector.md +2 -2
  23. package/generated-docs/core/sortparticipants.md +0 -2
  24. package/generated-docs/core/sorttrackreferences.md +0 -2
  25. package/generated-docs/core/supportsscreensharing.md +0 -2
  26. package/generated-docs/core/trackreference.md +0 -2
  27. package/generated-docs/core/trackreferenceorplaceholder.md +0 -2
  28. package/generated-docs/core/trackreferenceplaceholder.md +0 -2
  29. package/generated-docs/core/updatepages.md +0 -2
  30. package/generated-docs/core/widgetstate.md +0 -2
  31. package/generated-docs/react/agentstate.md +5 -3
  32. package/generated-docs/react/allowaudioplaybackprops.md +0 -2
  33. package/generated-docs/react/allowmediaplaybackprops.md +0 -2
  34. package/generated-docs/react/audioconferenceprops.md +0 -2
  35. package/generated-docs/react/audiotrackprops.md +0 -2
  36. package/generated-docs/react/audiotrackprops.muted.md +6 -2
  37. package/generated-docs/react/audiotrackprops.trackref.md +0 -2
  38. package/generated-docs/react/audiotrackprops.volume.md +0 -2
  39. package/generated-docs/react/audiovisualizerprops.md +0 -2
  40. package/generated-docs/react/audiowaveformoptions.barcount.md +6 -0
  41. package/generated-docs/react/audiowaveformoptions.md +6 -2
  42. package/generated-docs/react/audiowaveformoptions.updateinterval.md +6 -0
  43. package/generated-docs/react/audiowaveformoptions.volmultiplier.md +6 -0
  44. package/generated-docs/react/barvisualizeroptions.md +5 -3
  45. package/generated-docs/react/barvisualizerprops.barcount.md +5 -3
  46. package/generated-docs/react/barvisualizerprops.children.md +5 -3
  47. package/generated-docs/react/barvisualizerprops.md +5 -3
  48. package/generated-docs/react/barvisualizerprops.options.md +5 -1
  49. package/generated-docs/react/barvisualizerprops.state.md +5 -3
  50. package/generated-docs/react/barvisualizerprops.trackref.md +5 -1
  51. package/generated-docs/react/carousellayoutprops.md +0 -2
  52. package/generated-docs/react/carousellayoutprops.orientation.md +0 -2
  53. package/generated-docs/react/chatentryprops.entry.md +0 -2
  54. package/generated-docs/react/chatentryprops.hidename.md +0 -2
  55. package/generated-docs/react/chatentryprops.hidetimestamp.md +0 -2
  56. package/generated-docs/react/chatentryprops.md +0 -2
  57. package/generated-docs/react/chatentryprops.messageformatter.md +0 -2
  58. package/generated-docs/react/chatprops.md +0 -2
  59. package/generated-docs/react/chattoggleprops.md +0 -2
  60. package/generated-docs/react/clearpinbuttonprops.md +0 -2
  61. package/generated-docs/react/component/audioconference.md +0 -2
  62. package/generated-docs/react/component/audiotrack.md +0 -2
  63. package/generated-docs/react/component/audiovisualizer.md +0 -2
  64. package/generated-docs/react/component/barvisualizer.md +5 -3
  65. package/generated-docs/react/component/carousellayout.md +0 -2
  66. package/generated-docs/react/component/chat.md +0 -2
  67. package/generated-docs/react/component/chatentry.md +0 -2
  68. package/generated-docs/react/component/chattoggle.md +0 -2
  69. package/generated-docs/react/component/clearpinbutton.md +0 -2
  70. package/generated-docs/react/component/connectionqualityindicator.md +0 -2
  71. package/generated-docs/react/component/connectionstate.md +0 -2
  72. package/generated-docs/react/component/connectionstatetoast.md +0 -2
  73. package/generated-docs/react/component/controlbar.md +0 -2
  74. package/generated-docs/react/component/disconnectbutton.md +0 -2
  75. package/generated-docs/react/component/focuslayout.md +0 -2
  76. package/generated-docs/react/component/focuslayoutcontainer.md +0 -2
  77. package/generated-docs/react/component/focustoggle.md +0 -2
  78. package/generated-docs/react/component/gridlayout.md +0 -2
  79. package/generated-docs/react/component/layoutcontext.md +0 -2
  80. package/generated-docs/react/component/layoutcontextprovider.md +6 -2
  81. package/generated-docs/react/component/livekitroom.md +0 -2
  82. package/generated-docs/react/component/mediadevicemenu.md +0 -2
  83. package/generated-docs/react/component/mediadeviceselect.md +0 -2
  84. package/generated-docs/react/component/participantaudiotile.md +0 -2
  85. package/generated-docs/react/component/participantcontext.md +0 -2
  86. package/generated-docs/react/component/participantcontextifneeded.md +0 -2
  87. package/generated-docs/react/component/participantloop.md +0 -2
  88. package/generated-docs/react/component/participantname.md +0 -2
  89. package/generated-docs/react/component/participanttile.md +6 -6
  90. package/generated-docs/react/component/prejoin.md +0 -2
  91. package/generated-docs/react/component/roomaudiorenderer.md +0 -2
  92. package/generated-docs/react/component/roomcontext.md +0 -2
  93. package/generated-docs/react/component/roomname.md +0 -2
  94. package/generated-docs/react/component/startaudio.md +0 -2
  95. package/generated-docs/react/component/startmediabutton.md +0 -2
  96. package/generated-docs/react/component/toast.md +0 -2
  97. package/generated-docs/react/component/trackloop.md +0 -2
  98. package/generated-docs/react/component/trackmutedindicator.md +0 -2
  99. package/generated-docs/react/component/trackrefcontext.md +0 -2
  100. package/generated-docs/react/component/tracktoggle.md +0 -2
  101. package/generated-docs/react/component/videoconference.md +0 -2
  102. package/generated-docs/react/component/videotrack.md +0 -2
  103. package/generated-docs/react/component/voiceassistantcontrolbar.md +5 -3
  104. package/generated-docs/react/connectionqualityindicatoroptions.md +0 -2
  105. package/generated-docs/react/connectionqualityindicatorprops.md +0 -2
  106. package/generated-docs/react/connectionstatetoastprops.md +0 -2
  107. package/generated-docs/react/connectionstatusprops.md +0 -2
  108. package/generated-docs/react/connectionstatusprops.room.md +0 -2
  109. package/generated-docs/react/controlbarcontrols.md +0 -2
  110. package/generated-docs/react/controlbarprops.md +0 -2
  111. package/generated-docs/react/controlbarprops.saveuserchoices.md +6 -2
  112. package/generated-docs/react/disconnectbuttonprops.md +0 -2
  113. package/generated-docs/react/focuslayoutcontainerprops.md +0 -2
  114. package/generated-docs/react/focuslayoutprops.md +0 -2
  115. package/generated-docs/react/focuslayoutprops.trackref.md +0 -2
  116. package/generated-docs/react/focustoggleprops.md +0 -2
  117. package/generated-docs/react/formatchatmessagelinks.md +0 -2
  118. package/generated-docs/react/gridlayoutdefinition.md +0 -2
  119. package/generated-docs/react/gridlayoutprops.md +0 -2
  120. package/generated-docs/react/hook/useaudioplayback.md +6 -2
  121. package/generated-docs/react/hook/useaudiowaveform.md +13 -3
  122. package/generated-docs/react/hook/usechat.md +0 -7
  123. package/generated-docs/react/hook/usechattoggle.md +1 -3
  124. package/generated-docs/react/hook/useclearpinbutton.md +0 -2
  125. package/generated-docs/react/hook/useconnectionqualityindicator.md +1 -3
  126. package/generated-docs/react/hook/useconnectionstate.md +0 -2
  127. package/generated-docs/react/hook/usecreatelayoutcontext.md +0 -2
  128. package/generated-docs/react/hook/usedatachannel.md +0 -2
  129. package/generated-docs/react/hook/usedatachannel_1.md +0 -2
  130. package/generated-docs/react/hook/usedisconnectbutton.md +1 -3
  131. package/generated-docs/react/hook/useensurecreatelayoutcontext.md +0 -2
  132. package/generated-docs/react/hook/useensurelayoutcontext.md +0 -2
  133. package/generated-docs/react/hook/useensureparticipant.md +0 -2
  134. package/generated-docs/react/hook/useensureroom.md +0 -2
  135. package/generated-docs/react/hook/useensuretrackref.md +0 -2
  136. package/generated-docs/react/hook/usefacingmode.md +6 -2
  137. package/generated-docs/react/hook/usefocustoggle.md +2 -4
  138. package/generated-docs/react/hook/usegridlayout.md +0 -2
  139. package/generated-docs/react/hook/useisencrypted.md +7 -3
  140. package/generated-docs/react/hook/useismuted.md +9 -1
  141. package/generated-docs/react/hook/useisrecording.md +0 -2
  142. package/generated-docs/react/hook/useisspeaking.md +0 -2
  143. package/generated-docs/react/hook/usekrispnoisefilter.md +64 -0
  144. package/generated-docs/react/hook/uselayoutcontext.md +0 -2
  145. package/generated-docs/react/hook/uselivekitroom.md +15 -17
  146. package/generated-docs/react/hook/uselocalparticipant.md +3 -3
  147. package/generated-docs/react/hook/uselocalparticipantpermissions.md +0 -2
  148. package/generated-docs/react/hook/usemaybelayoutcontext.md +0 -2
  149. package/generated-docs/react/hook/usemaybeparticipantcontext.md +0 -2
  150. package/generated-docs/react/hook/usemayberoomcontext.md +0 -2
  151. package/generated-docs/react/hook/usemaybetrackrefcontext.md +0 -2
  152. package/generated-docs/react/hook/usemediadevices.md +0 -2
  153. package/generated-docs/react/hook/usemediadeviceselect.md +5 -7
  154. package/generated-docs/react/hook/usemultibandtrackvolume.md +25 -3
  155. package/generated-docs/react/hook/usepagination.md +6 -2
  156. package/generated-docs/react/hook/useparticipantattribute.md +1 -3
  157. package/generated-docs/react/hook/useparticipantattributes.md +1 -3
  158. package/generated-docs/react/hook/useparticipantcontext.md +0 -2
  159. package/generated-docs/react/hook/useparticipantinfo.md +1 -3
  160. package/generated-docs/react/hook/useparticipantpermissions.md +1 -3
  161. package/generated-docs/react/hook/useparticipants.md +8 -3
  162. package/generated-docs/react/hook/useparticipanttile.md +4 -6
  163. package/generated-docs/react/hook/useparticipanttracks.md +0 -2
  164. package/generated-docs/react/hook/usepersistentuserchoices.md +19 -3
  165. package/generated-docs/react/hook/usepinnedtracks.md +0 -2
  166. package/generated-docs/react/hook/usepreviewdevice.md +6 -2
  167. package/generated-docs/react/hook/usepreviewtracks.md +0 -5
  168. package/generated-docs/react/hook/useremoteparticipant.md +3 -3
  169. package/generated-docs/react/hook/useremoteparticipant_1.md +3 -3
  170. package/generated-docs/react/hook/useremoteparticipants.md +8 -3
  171. package/generated-docs/react/hook/useroomcontext.md +0 -2
  172. package/generated-docs/react/hook/useroominfo.md +1 -3
  173. package/generated-docs/react/hook/usesortedparticipants.md +0 -2
  174. package/generated-docs/react/hook/usespeakingparticipants.md +0 -2
  175. package/generated-docs/react/hook/usestartaudio.md +8 -4
  176. package/generated-docs/react/hook/usestartvideo.md +8 -4
  177. package/generated-docs/react/hook/useswipe.md +6 -5
  178. package/generated-docs/react/hook/usetoken.md +1 -3
  179. package/generated-docs/react/hook/usetrackbyname.md +0 -2
  180. package/generated-docs/react/hook/usetrackmutedindicator.md +0 -2
  181. package/generated-docs/react/hook/usetrackrefcontext.md +0 -2
  182. package/generated-docs/react/hook/usetracks.md +4 -7
  183. package/generated-docs/react/hook/usetracktoggle.md +0 -2
  184. package/generated-docs/react/hook/usetracktranscription.md +16 -3
  185. package/generated-docs/react/hook/usetrackvolume.md +6 -5
  186. package/generated-docs/react/hook/usevisualstableupdate.md +3 -3
  187. package/generated-docs/react/hook/usevoiceassistant.md +5 -3
  188. package/generated-docs/react/index.md +2 -0
  189. package/generated-docs/react/layoutcontextproviderprops.md +6 -2
  190. package/generated-docs/react/layoutcontextproviderprops.onpinchange.md +6 -0
  191. package/generated-docs/react/layoutcontextproviderprops.onwidgetchange.md +6 -0
  192. package/generated-docs/react/layoutcontextproviderprops.value.md +6 -0
  193. package/generated-docs/react/layoutcontexttype.md +0 -2
  194. package/generated-docs/react/livekitroomprops.audio.md +0 -2
  195. package/generated-docs/react/livekitroomprops.connect.md +0 -2
  196. package/generated-docs/react/livekitroomprops.connectoptions.md +0 -2
  197. package/generated-docs/react/livekitroomprops.md +0 -2
  198. package/generated-docs/react/livekitroomprops.options.md +0 -2
  199. package/generated-docs/react/livekitroomprops.room.md +0 -2
  200. package/generated-docs/react/livekitroomprops.screen.md +0 -2
  201. package/generated-docs/react/livekitroomprops.serverurl.md +0 -2
  202. package/generated-docs/react/livekitroomprops.token.md +0 -2
  203. package/generated-docs/react/livekitroomprops.video.md +0 -2
  204. package/generated-docs/react/localuserchoices.md +0 -2
  205. package/generated-docs/react/mediadevicemenuprops.md +0 -2
  206. package/generated-docs/react/mediadevicemenuprops.requestpermissions.md +0 -2
  207. package/generated-docs/react/mediadeviceselectprops.exactmatch.md +0 -2
  208. package/generated-docs/react/mediadeviceselectprops.md +0 -2
  209. package/generated-docs/react/mediadeviceselectprops.requestpermissions.md +0 -2
  210. package/generated-docs/react/messagedecoder.md +0 -2
  211. package/generated-docs/react/messageencoder.md +0 -2
  212. package/generated-docs/react/messageformatter.md +0 -2
  213. package/generated-docs/react/meta-data.json +1 -1
  214. package/generated-docs/react/multibandtrackvolumeoptions.analyseroptions.md +6 -0
  215. package/generated-docs/react/multibandtrackvolumeoptions.bands.md +6 -0
  216. package/generated-docs/react/multibandtrackvolumeoptions.hipass.md +6 -2
  217. package/generated-docs/react/multibandtrackvolumeoptions.lopass.md +6 -2
  218. package/generated-docs/react/multibandtrackvolumeoptions.md +6 -2
  219. package/generated-docs/react/multibandtrackvolumeoptions.updateinterval.md +6 -2
  220. package/generated-docs/react/participantidentifier.md +5 -3
  221. package/generated-docs/react/participantloopprops.children.md +0 -2
  222. package/generated-docs/react/participantloopprops.md +0 -2
  223. package/generated-docs/react/participantloopprops.participants.md +0 -2
  224. package/generated-docs/react/participantnameprops.md +0 -2
  225. package/generated-docs/react/participanttileprops.md +0 -2
  226. package/generated-docs/react/participanttileprops.trackref.md +0 -2
  227. package/generated-docs/react/pinstate.md +0 -2
  228. package/generated-docs/react/prejoinprops.debug.md +0 -2
  229. package/generated-docs/react/prejoinprops.defaults.md +0 -2
  230. package/generated-docs/react/prejoinprops.md +0 -2
  231. package/generated-docs/react/prejoinprops.onsubmit.md +0 -2
  232. package/generated-docs/react/prejoinprops.onvalidate.md +0 -2
  233. package/generated-docs/react/prejoinprops.persistuserchoices.md +6 -2
  234. package/generated-docs/react/receivedchatmessage.md +0 -2
  235. package/generated-docs/react/roomaudiorendererprops.md +0 -2
  236. package/generated-docs/react/roomaudiorendererprops.muted.md +6 -2
  237. package/generated-docs/react/roomaudiorendererprops.volume.md +0 -2
  238. package/generated-docs/react/roomnameprops.md +0 -2
  239. package/generated-docs/react/setlogextension.md +0 -2
  240. package/generated-docs/react/setloglevel.md +0 -2
  241. package/generated-docs/react/trackloopprops.children.md +0 -2
  242. package/generated-docs/react/trackloopprops.md +0 -2
  243. package/generated-docs/react/trackloopprops.tracks.md +0 -2
  244. package/generated-docs/react/trackmutedindicatorprops.md +0 -2
  245. package/generated-docs/react/trackreference.md +0 -2
  246. package/generated-docs/react/trackreferenceorplaceholder.md +0 -2
  247. package/generated-docs/react/tracktoggleprops.md +0 -2
  248. package/generated-docs/react/tracktoggleprops.onchange.md +0 -2
  249. package/generated-docs/react/tracktranscriptionoptions.buffersize.md +6 -2
  250. package/generated-docs/react/tracktranscriptionoptions.md +6 -2
  251. package/generated-docs/react/tracktranscriptionoptions.ontranscription.md +6 -2
  252. package/generated-docs/react/usechattoggleprops.md +0 -2
  253. package/generated-docs/react/usefocustoggleprops.md +0 -2
  254. package/generated-docs/react/useisencryptedoptions.md +6 -2
  255. package/generated-docs/react/useisencryptedoptions.room.md +6 -0
  256. package/generated-docs/react/useismutedoptions.md +0 -2
  257. package/generated-docs/react/usekrispnoisefilteroptions.md +28 -0
  258. package/generated-docs/react/usekrispnoisefilteroptions.trackref.md +21 -0
  259. package/generated-docs/react/uselocalparticipantoptions.md +0 -2
  260. package/generated-docs/react/uselocalparticipantoptions.room.md +0 -2
  261. package/generated-docs/react/usemediadeviceselectprops.md +0 -2
  262. package/generated-docs/react/usemediadeviceselectprops.onerror.md +0 -2
  263. package/generated-docs/react/usemediadeviceselectprops.requestpermissions.md +0 -2
  264. package/generated-docs/react/useparticipantattributesoptions.md +0 -2
  265. package/generated-docs/react/useparticipantinfooptions.md +0 -2
  266. package/generated-docs/react/useparticipantpermissionsoptions.md +0 -2
  267. package/generated-docs/react/useparticipantsoptions.md +0 -2
  268. package/generated-docs/react/useparticipantsoptions.room.md +0 -2
  269. package/generated-docs/react/useparticipantsoptions.updateonlyon.md +0 -2
  270. package/generated-docs/react/useparticipanttileprops.md +0 -2
  271. package/generated-docs/react/useparticipanttileprops.trackref.md +0 -2
  272. package/generated-docs/react/usepersistentuserchoicesoptions.defaults.md +6 -2
  273. package/generated-docs/react/usepersistentuserchoicesoptions.md +6 -2
  274. package/generated-docs/react/usepersistentuserchoicesoptions.preventload.md +6 -2
  275. package/generated-docs/react/usepersistentuserchoicesoptions.preventsave.md +6 -2
  276. package/generated-docs/react/useremoteparticipantoptions.md +0 -2
  277. package/generated-docs/react/useremoteparticipantoptions.updateonlyon.md +0 -2
  278. package/generated-docs/react/useremoteparticipantsoptions.md +0 -2
  279. package/generated-docs/react/useremoteparticipantsoptions.room.md +0 -2
  280. package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md +0 -2
  281. package/generated-docs/react/userinfo.md +0 -2
  282. package/generated-docs/react/useroominfooptions.md +0 -2
  283. package/generated-docs/react/usestartaudioprops.md +6 -2
  284. package/generated-docs/react/usestartaudioprops.props.md +6 -0
  285. package/generated-docs/react/usestartaudioprops.room.md +6 -0
  286. package/generated-docs/react/usestartvideoprops.md +6 -2
  287. package/generated-docs/react/usestartvideoprops.props.md +6 -0
  288. package/generated-docs/react/usestartvideoprops.room.md +6 -0
  289. package/generated-docs/react/useswipeoptions.md +6 -2
  290. package/generated-docs/react/usetokenoptions.md +0 -2
  291. package/generated-docs/react/usetrackshookreturntype.md +0 -2
  292. package/generated-docs/react/usetracksoptions.md +0 -2
  293. package/generated-docs/react/usetracktoggleprops.md +0 -2
  294. package/generated-docs/react/usevisualstableupdateoptions.customsortfunction.md +0 -2
  295. package/generated-docs/react/usevisualstableupdateoptions.md +0 -2
  296. package/generated-docs/react/videoconferenceprops.md +0 -2
  297. package/generated-docs/react/videoconferenceprops.settingscomponent.md +6 -2
  298. package/generated-docs/react/videotrackprops.md +0 -2
  299. package/generated-docs/react/videotrackprops.trackref.md +0 -2
  300. package/generated-docs/react/voiceassistant.agent.md +5 -1
  301. package/generated-docs/react/voiceassistant.agentattributes.md +5 -1
  302. package/generated-docs/react/voiceassistant.agenttranscriptions.md +5 -1
  303. package/generated-docs/react/voiceassistant.audiotrack.md +5 -1
  304. package/generated-docs/react/voiceassistant.md +5 -3
  305. package/generated-docs/react/voiceassistant.state.md +5 -1
  306. package/generated-docs/react/voiceassistantcontrolbarcontrols.md +5 -3
  307. package/generated-docs/react/voiceassistantcontrolbarprops.controls.md +5 -1
  308. package/generated-docs/react/voiceassistantcontrolbarprops.md +5 -3
  309. package/generated-docs/react/voiceassistantcontrolbarprops.ondeviceerror.md +5 -1
  310. package/generated-docs/react/voiceassistantcontrolbarprops.saveuserchoices.md +5 -3
  311. package/generated-docs/react/widgetstate.md +0 -2
  312. package/package.json +2 -2
@@ -9,14 +9,18 @@
9
9
 
10
10
  # LayoutContextProviderProps interface
11
11
 
12
+ {% callout type="note" variation="normal" %}
13
+
14
+ This feature is experimental and may change or be removed based on developer feedback and real-world usage.
15
+
16
+ {% /callout %}
17
+
12
18
  **Signature:**
13
19
 
14
20
  ```typescript
15
21
  export interface LayoutContextProviderProps
16
22
  ```
17
23
 
18
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
19
-
20
24
  ## Properties
21
25
 
22
26
  | Property | Type | Description |
@@ -6,6 +6,12 @@
6
6
 
7
7
  # LayoutContextProviderProps.onPinChange property
8
8
 
9
+ {% callout type="note" variation="normal" %}
10
+
11
+ This feature is experimental and may change or be removed based on developer feedback and real-world usage.
12
+
13
+ {% /callout %}
14
+
9
15
  **Signature:**
10
16
 
11
17
  ```typescript
@@ -6,6 +6,12 @@
6
6
 
7
7
  # LayoutContextProviderProps.onWidgetChange property
8
8
 
9
+ {% callout type="note" variation="normal" %}
10
+
11
+ This feature is experimental and may change or be removed based on developer feedback and real-world usage.
12
+
13
+ {% /callout %}
14
+
9
15
  **Signature:**
10
16
 
11
17
  ```typescript
@@ -6,6 +6,12 @@
6
6
 
7
7
  # LayoutContextProviderProps.value property
8
8
 
9
+ {% callout type="note" variation="normal" %}
10
+
11
+ This feature is experimental and may change or be removed based on developer feedback and real-world usage.
12
+
13
+ {% /callout %}
14
+
9
15
  **Signature:**
10
16
 
11
17
  ```typescript
@@ -17,5 +17,3 @@ export type LayoutContextType = {
17
17
  widget: WidgetContextType;
18
18
  };
19
19
  ```
20
-
21
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ Publish audio immediately after connecting to your LiveKit room.
13
13
  ```typescript
14
14
  audio?: AudioCaptureOptions | boolean;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ If set to true a connection to LiveKit room is initiated.
13
13
  ```typescript
14
14
  connect?: boolean;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ Define options how to connect to the LiveKit server.
13
13
  ```typescript
14
14
  connectOptions?: RoomConnectOptions;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -17,8 +17,6 @@ export interface LiveKitRoomProps extends Omit<React.HTMLAttributes<HTMLDivEleme
17
17
 
18
18
  **Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLDivElement&gt;, 'onError'&gt;
19
19
 
20
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
21
-
22
20
  ## Properties
23
21
 
24
22
  | Property | Type | Description |
@@ -13,5 +13,3 @@ Options for when creating a new room. When you pass your own room instance to th
13
13
  ```typescript
14
14
  options?: RoomOptions;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ Optional room instance. By passing your own room instance you overwrite the `opt
13
13
  ```typescript
14
14
  room?: Room;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ Publish screen share immediately after connecting to your LiveKit room.
13
13
  ```typescript
14
14
  screen?: ScreenShareCaptureOptions | boolean;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ URL to the LiveKit server. For example: `wss://<domain>.livekit.cloud` To simpli
13
13
  ```typescript
14
14
  serverUrl: string | undefined;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ A user specific access token for a client to authenticate to the room. This toke
13
13
  ```typescript
14
14
  token: string | undefined;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ Publish video immediately after connecting to your LiveKit room.
13
13
  ```typescript
14
14
  video?: VideoCaptureOptions | boolean;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -22,5 +22,3 @@ export type LocalUserChoices = {
22
22
  username: string;
23
23
  };
24
24
  ```
25
-
26
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -17,8 +17,6 @@ export interface MediaDeviceMenuProps extends React.ButtonHTMLAttributes<HTMLBut
17
17
 
18
18
  **Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
19
19
 
20
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
21
-
22
20
  ## Properties
23
21
 
24
22
  | Property | Type | Description |
@@ -13,5 +13,3 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
13
13
  ```typescript
14
14
  requestPermissions?: boolean;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ will force the browser to only return the specified device will call `onDeviceSe
13
13
  ```typescript
14
14
  exactMatch?: boolean;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -17,8 +17,6 @@ export interface MediaDeviceSelectProps extends Omit<React.HTMLAttributes<HTMLUL
17
17
 
18
18
  **Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLUListElement&gt;, 'onError'&gt;
19
19
 
20
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
21
-
22
20
  ## Properties
23
21
 
24
22
  | Property | Type | Description |
@@ -13,5 +13,3 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
13
13
  ```typescript
14
14
  requestPermissions?: boolean;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -20,5 +20,3 @@ This API is deprecated: the new chat API doesn't rely on encoders and decoders a
20
20
  ```typescript
21
21
  export type MessageDecoder = (message: Uint8Array) => LegacyReceivedChatMessage;
22
22
  ```
23
-
24
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -20,5 +20,3 @@ This API is deprecated: the new chat API doesn't rely on encoders and decoders a
20
20
  ```typescript
21
21
  export type MessageEncoder = (message: LegacyChatMessage) => Uint8Array;
22
22
  ```
23
-
24
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -14,5 +14,3 @@
14
14
  ```typescript
15
15
  export type MessageFormatter = (message: string) => React.ReactNode;
16
16
  ```
17
-
18
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -1 +1 @@
1
- {"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"barvisualizer.md","title":"BarVisualizer"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontext.md","title":"LayoutContext"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontext.md","title":"ParticipantContext"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomcontext.md","title":"RoomContext"},{"filename":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"startmediabutton.md","title":"StartMediaButton"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"trackrefcontext.md","title":"TrackRefContext"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"},{"filename":"voiceassistantcontrolbar.md","title":"VoiceAssistantControlBar"}],"hooks":[{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"useaudiowaveform.md","title":"useAudioWaveform"},{"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":"useisrecording.md","title":"useIsRecording"},{"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":"useparticipantattribute.md","title":"useParticipantAttribute"},{"filename":"useparticipantattributes.md","title":"useParticipantAttributes"},{"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":"useremoteparticipant_1.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":"usetracktranscription.md","title":"useTrackTranscription"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"},{"filename":"usevoiceassistant.md","title":"useVoiceAssistant"}]}
1
+ {"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"barvisualizer.md","title":"BarVisualizer"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontext.md","title":"LayoutContext"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontext.md","title":"ParticipantContext"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomcontext.md","title":"RoomContext"},{"filename":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"startmediabutton.md","title":"StartMediaButton"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"trackrefcontext.md","title":"TrackRefContext"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"},{"filename":"voiceassistantcontrolbar.md","title":"VoiceAssistantControlBar"}],"hooks":[{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"useaudiowaveform.md","title":"useAudioWaveform"},{"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":"useisrecording.md","title":"useIsRecording"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"usekrispnoisefilter.md","title":"useKrispNoiseFilter"},{"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":"useparticipantattribute.md","title":"useParticipantAttribute"},{"filename":"useparticipantattributes.md","title":"useParticipantAttributes"},{"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":"useremoteparticipant_1.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":"usetracktranscription.md","title":"useTrackTranscription"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"},{"filename":"usevoiceassistant.md","title":"useVoiceAssistant"}]}
@@ -6,6 +6,12 @@
6
6
 
7
7
  # MultiBandTrackVolumeOptions.analyserOptions property
8
8
 
9
+ {% callout type="note" variation="normal" %}
10
+
11
+ This feature is experimental and may change or be removed based on developer feedback and real-world usage.
12
+
13
+ {% /callout %}
14
+
9
15
  **Signature:**
10
16
 
11
17
  ```typescript
@@ -6,6 +6,12 @@
6
6
 
7
7
  # MultiBandTrackVolumeOptions.bands property
8
8
 
9
+ {% callout type="note" variation="normal" %}
10
+
11
+ This feature is experimental and may change or be removed based on developer feedback and real-world usage.
12
+
13
+ {% /callout %}
14
+
9
15
  **Signature:**
10
16
 
11
17
  ```typescript
@@ -6,6 +6,12 @@
6
6
 
7
7
  # MultiBandTrackVolumeOptions.hiPass property
8
8
 
9
+ {% callout type="note" variation="normal" %}
10
+
11
+ This feature is experimental and may change or be removed based on developer feedback and real-world usage.
12
+
13
+ {% /callout %}
14
+
9
15
  cut off of frequency bins on the higher end Note: this is not a frequency measure, but in relation to analyserOptions.fftSize,
10
16
 
11
17
  **Signature:**
@@ -13,5 +19,3 @@ cut off of frequency bins on the higher end Note: this is not a frequency measur
13
19
  ```typescript
14
20
  hiPass?: number;
15
21
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -6,6 +6,12 @@
6
6
 
7
7
  # MultiBandTrackVolumeOptions.loPass property
8
8
 
9
+ {% callout type="note" variation="normal" %}
10
+
11
+ This feature is experimental and may change or be removed based on developer feedback and real-world usage.
12
+
13
+ {% /callout %}
14
+
9
15
  cut off of frequency bins on the lower end Note: this is not a frequency measure, but in relation to analyserOptions.fftSize,
10
16
 
11
17
  **Signature:**
@@ -13,5 +19,3 @@ cut off of frequency bins on the lower end Note: this is not a frequency measure
13
19
  ```typescript
14
20
  loPass?: number;
15
21
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -9,6 +9,12 @@
9
9
 
10
10
  # MultiBandTrackVolumeOptions interface
11
11
 
12
+ {% callout type="note" variation="normal" %}
13
+
14
+ This feature is experimental and may change or be removed based on developer feedback and real-world usage.
15
+
16
+ {% /callout %}
17
+
12
18
  Interface for configuring options for the useMultibandTrackVolume hook.
13
19
 
14
20
  **Signature:**
@@ -17,8 +23,6 @@ Interface for configuring options for the useMultibandTrackVolume hook.
17
23
  export interface MultiBandTrackVolumeOptions
18
24
  ```
19
25
 
20
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
21
-
22
26
  ## Properties
23
27
 
24
28
  | Property | Type | Description |
@@ -6,6 +6,12 @@
6
6
 
7
7
  # MultiBandTrackVolumeOptions.updateInterval property
8
8
 
9
+ {% callout type="note" variation="normal" %}
10
+
11
+ This feature is experimental and may change or be removed based on developer feedback and real-world usage.
12
+
13
+ {% /callout %}
14
+
9
15
  update should run every x ms
10
16
 
11
17
  **Signature:**
@@ -13,5 +19,3 @@ update should run every x ms
13
19
  ```typescript
14
20
  updateInterval?: number;
15
21
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -9,7 +9,11 @@
9
9
 
10
10
  # ParticipantIdentifier type
11
11
 
12
- > This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
12
+ {% callout type="note" variation="normal" %}
13
+
14
+ This feature is under active development and may change based on developer feedback and real-world usage.
15
+
16
+ {% /callout %}
13
17
 
14
18
  **Signature:**
15
19
 
@@ -22,5 +26,3 @@ export type ParticipantIdentifier = RequireAtLeastOne<
22
26
  "identity" | "kind"
23
27
  >;
24
28
  ```
25
-
26
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ The template component to be used in the loop.
13
13
  ```typescript
14
14
  children: React.ReactNode;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -15,8 +15,6 @@
15
15
  export interface ParticipantLoopProps
16
16
  ```
17
17
 
18
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
19
-
20
18
  ## Properties
21
19
 
22
20
  | Property | Type | Description |
@@ -13,5 +13,3 @@ The participants to loop over. Use `useParticipants()` hook to get participants.
13
13
  ```typescript
14
14
  participants: Participant[];
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -16,5 +16,3 @@ export interface ParticipantNameProps extends React.HTMLAttributes<HTMLSpanEleme
16
16
  ```
17
17
 
18
18
  **Extends:** React.HTMLAttributes&lt;HTMLSpanElement&gt;, [UseParticipantInfoOptions](./react/useparticipantinfooptions.md)
19
-
20
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -17,8 +17,6 @@ export interface ParticipantTileProps extends React.HTMLAttributes<HTMLDivElemen
17
17
 
18
18
  **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
19
19
 
20
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
21
-
22
20
  ## Properties
23
21
 
24
22
  | Property | Type | Description |
@@ -13,5 +13,3 @@ The track reference to display.
13
13
  ```typescript
14
14
  trackRef?: TrackReferenceOrPlaceholder;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -16,5 +16,3 @@ export type PinState = TrackReferenceOrPlaceholder[];
16
16
  ```
17
17
 
18
18
  **References:** [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)
19
-
20
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ Display a debug window for your convenience.
13
13
  ```typescript
14
14
  debug?: boolean;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ Prefill the input form with initial values.
13
13
  ```typescript
14
14
  defaults?: Partial<LocalUserChoices>;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -19,8 +19,6 @@ export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
19
19
 
20
20
  **Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLDivElement&gt;, 'onSubmit' \| 'onError'&gt;
21
21
 
22
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
23
-
24
22
  ## Properties
25
23
 
26
24
  | Property | Type | Description |
@@ -13,5 +13,3 @@ This function is called with the `LocalUserChoices` if validation is passed.
13
13
  ```typescript
14
14
  onSubmit?: (values: LocalUserChoices) => void;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ Provide your custom validation function. Only if validation is successful the us
13
13
  ```typescript
14
14
  onValidate?: (values: LocalUserChoices) => boolean;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -6,6 +6,12 @@
6
6
 
7
7
  # PreJoinProps.persistUserChoices property
8
8
 
9
+ {% callout type="note" variation="normal" %}
10
+
11
+ This feature is experimental and may change or be removed based on developer feedback and real-world usage.
12
+
13
+ {% /callout %}
14
+
9
15
  If true, user choices are persisted across sessions.
10
16
 
11
17
  **Signature:**
@@ -13,5 +19,3 @@ If true, user choices are persisted across sessions.
13
19
  ```typescript
14
20
  persistUserChoices?: boolean;
15
21
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -17,8 +17,6 @@ export interface ReceivedChatMessage extends ChatMessage
17
17
 
18
18
  **Extends:** ChatMessage
19
19
 
20
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
21
-
22
20
  ## Properties
23
21
 
24
22
  | Property | Type | Description |
@@ -15,8 +15,6 @@
15
15
  export interface RoomAudioRendererProps
16
16
  ```
17
17
 
18
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
19
-
20
18
  ## Properties
21
19
 
22
20
  | Property | Type | Description |
@@ -6,6 +6,12 @@
6
6
 
7
7
  # RoomAudioRendererProps.muted property
8
8
 
9
+ {% callout type="note" variation="normal" %}
10
+
11
+ This feature is experimental and may change or be removed based on developer feedback and real-world usage.
12
+
13
+ {% /callout %}
14
+
9
15
  If set to `true`<!-- -->, mutes all audio tracks rendered by the component.
10
16
 
11
17
  **Signature:**
@@ -17,5 +23,3 @@ muted?: boolean;
17
23
  ## Remarks
18
24
 
19
25
  If set to `true`<!-- -->, the server will stop sending audio track data to the client.
20
-
21
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ Sets the volume for all audio tracks rendered by this component. By default, the
13
13
  ```typescript
14
14
  volume?: number;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -17,8 +17,6 @@ export interface RoomNameProps extends React.HTMLAttributes<HTMLSpanElement>
17
17
 
18
18
  **Extends:** React.HTMLAttributes&lt;HTMLSpanElement&gt;
19
19
 
20
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
21
-
22
20
  ## Properties
23
21
 
24
22
  | Property | Type | Description |
@@ -19,5 +19,3 @@ export declare function setLogExtension(
19
19
  options?: SetLogExtensionOptions
20
20
  ): void;
21
21
  ```
22
-
23
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -16,5 +16,3 @@ Set the log level for both the `@livekit/components-react` package and the `@liv
16
16
  ```typescript
17
17
  export declare function setLogLevel(level: LogLevel, options?: SetLogLevelOptions): void;
18
18
  ```
19
-
20
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,5 +13,3 @@ The template component to be used in the loop.
13
13
  ```typescript
14
14
  children: React.ReactNode;
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -15,8 +15,6 @@
15
15
  export interface TrackLoopProps
16
16
  ```
17
17
 
18
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
19
-
20
18
  ## Properties
21
19
 
22
20
  | Property | Type | Description |
@@ -13,5 +13,3 @@ Track references to loop over. You can the use `useTracks()` hook to get TrackRe
13
13
  ```typescript
14
14
  tracks: TrackReference[] | TrackReferenceOrPlaceholder[];
15
15
  ```
16
-
17
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -17,8 +17,6 @@ export interface TrackMutedIndicatorProps extends React.HTMLAttributes<HTMLDivEl
17
17
 
18
18
  **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
19
19
 
20
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
21
-
22
20
  ## Properties
23
21
 
24
22
  | Property | Type | Description |
@@ -18,5 +18,3 @@ export type TrackReference = {
18
18
  source: Track.Source;
19
19
  };
20
20
  ```
21
-
22
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}