@livekit/components-js-docs 0.1.22 → 0.1.24

package/generated-docs/react/roomname.md

@@ -1,13 +1,13 @@
 ---
 {
-  "title": "RoomName variable",
+  "title": "RoomName",
   "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/RoomName.tsx"
 }
 ---
 
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# RoomName variable
+# RoomName
 
 The `RoomName` component renders the name of the connected LiveKit room inside a span tag.
 

package/generated-docs/react/startaudio.md

@@ -1,13 +1,13 @@
 ---
 {
-  "title": "StartAudio variable",
+  "title": "StartAudio",
   "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/StartAudio.tsx"
 }
 ---
 
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# StartAudio variable
+# StartAudio
 
 The `StartAudio` component is only visible when the browser blocks audio playback. This is due to some browser implemented autoplay policies. To start audio playback, the user must perform a user-initiated event such as clicking this button. As soon as audio playback starts, the button hides itself again.
 

package/generated-docs/react/trackmutedindicator.md

@@ -1,13 +1,13 @@
 ---
 {
-  "title": "TrackMutedIndicator variable",
+  "title": "TrackMutedIndicator",
   "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/TrackMutedIndicator.tsx"
 }
 ---
 
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# TrackMutedIndicator variable
+# TrackMutedIndicator
 
 The `TrackMutedIndicator` shows whether the participant's camera or microphone is muted or not. By default, a muted/unmuted icon is displayed for a camera, microphone, and screen sharing track.
 

package/generated-docs/react/tracktoggle.md

@@ -1,13 +1,13 @@
 ---
 {
-  "title": "TrackToggle variable",
+  "title": "TrackToggle",
   "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/TrackToggle.tsx"
 }
 ---
 
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# TrackToggle variable
+# TrackToggle
 
 With the `TrackToggle` component it is possible to mute and unmute your camera and microphone. The component uses an html button element under the hood so you can treat it like a button.
 

package/generated-docs/react/tracktranscriptionoptions.buffersize.md

@@ -0,0 +1,17 @@
+---
+{ "title": "TrackTranscriptionOptions.bufferSize property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackTranscriptionOptions.bufferSize property
+
+how many transcription segments should be buffered in state
+
+**Signature:**
+
+```typescript
+bufferSize?: number;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/tracktranscriptionoptions.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "TrackTranscriptionOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackTranscription.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackTranscriptionOptions interface
+
+**Signature:**
+
+```typescript
+export interface TrackTranscriptionOptions
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+| Property                                                       | Type   | Description                                                              |
+| -------------------------------------------------------------- | ------ | ------------------------------------------------------------------------ |
+| [bufferSize?](./react/tracktranscriptionoptions.buffersize.md) | number | _(Optional)_ how many transcription segments should be buffered in state |

package/generated-docs/react/useisencryptedoptions.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "UseIsEncryptedOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useIsEncrypted.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseIsEncryptedOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseIsEncryptedOptions
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+| Property                                       | Type | Description  |
+| ---------------------------------------------- | ---- | ------------ |
+| [room?](./react/useisencryptedoptions.room.md) | Room | _(Optional)_ |

package/generated-docs/react/useisencryptedoptions.room.md

@@ -0,0 +1,13 @@
+---
+{ "title": "UseIsEncryptedOptions.room property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseIsEncryptedOptions.room property
+
+**Signature:**
+
+```typescript
+room?: Room;
+```

package/generated-docs/react/videotrack.md

@@ -1,13 +1,13 @@
 ---
 {
-  "title": "VideoTrack variable",
+  "title": "VideoTrack",
   "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/VideoTrack.tsx"
 }
 ---
 
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# VideoTrack variable
+# VideoTrack
 
 The `VideoTrack` component is responsible for rendering participant video tracks like `camera` and `screen_share`<!-- -->. This component must have access to the participant's context, or alternatively pass it a `Participant` as a property.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.1.22",
+  "version": "0.1.24",
   "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
   "repository": {
     "type": "git",
@@ -8,7 +8,7 @@
     "directory": "/docs/beta-docs"
   },
   "dependencies": {
-    "@livekit/components-react": "2.3.0"
+    "@livekit/components-react": "2.3.2"
   },
   "author": "",
   "license": "Apache-2.0",