@livekit/components-js-docs 0.1.67 → 0.1.69

package/generated-docs/react/hook/usesequentialroomconnectdisconnect.md

@@ -0,0 +1,41 @@
+---
+{
+  "title": "useSequentialRoomConnectDisconnect",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSequentialRoomConnectDisconnect.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useSequentialRoomConnectDisconnect
+
+When calling room.disconnect() as part of a React useEffect cleanup function, it is possible for a room.connect(...) in the effect body to start running while the room.disconnect() is still running. This hook sequentializes these two operations, so they always happen in order and never overlap.
+
+## Import
+
+```typescript
+import { useSequentialRoomConnectDisconnect } from "@livekit/components-react";
+```
+
+## Usage
+
+```ts
+const { connect, disconnect } = useSequentialRoomConnectDisconnect(room);
+
+// Connecting to a room:
+useEffect(() => {
+  connect();
+  return () => disconnect();
+}, [connect, disconnect]);
+```
+
+## Properties
+
+{% parameter name="room" type="R" optional=false %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+UseSequentialRoomConnectDisconnectResults<R>;
+```

package/generated-docs/react/hook/usesession.md

@@ -0,0 +1,35 @@
+---
+{
+  "title": "useSession",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSession.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useSession
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+A Session represents a managed connection to a Room which can contain Agents.
+
+## Import
+
+```typescript
+import { useSession } from "@livekit/components-react";
+```
+
+## Properties
+
+{% parameter name="tokenSource" type="TokenSourceConfigurable" optional=false %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+UseSessionReturn;
+```

package/generated-docs/react/hook/usesessioncontext.md

@@ -0,0 +1,30 @@
+---
+{
+  "title": "useSessionContext",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/session-context.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useSessionContext
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+Ensures that a session is provided via context. If no session is provided, an error is thrown.
+
+## Import
+
+```typescript
+import { useSessionContext } from "@livekit/components-react";
+```
+
+## Returns
+
+```typescript
+UseSessionReturn;
+```

package/generated-docs/react/hook/usesessionmessages.md

@@ -0,0 +1,33 @@
+---
+{
+  "title": "useSessionMessages",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSessionMessages.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useSessionMessages
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+## Import
+
+```typescript
+import { useSessionMessages } from "@livekit/components-react";
+```
+
+## Properties
+
+{% parameter name="session" type="UseSessionReturn" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+UseSessionMessagesReturn;
+```

package/generated-docs/react/hook/usetracktoggle.md

@@ -24,6 +24,11 @@ const { buttonProps, enabled } = useTrackToggle(trackRef);
 return <button {...buttonProps}>{enabled ? "disable" : "enable"}</button>;
 ```
 
+## Properties
+
+{% parameter name="{ source, onChange, initialState, captureOptions, publishOptions, onDeviceError, room, ...rest }.room" type="Room" optional=true %}
+{% /parameter %}
+
 ## Returns
 
 ```typescript

package/generated-docs/react/hook/usetracktranscription.md

@@ -15,6 +15,12 @@ This feature is experimental and may change or be removed based on developer fee
 
 {% /callout %}
 
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated: Use useTranscription instead
+
+{% /callout %}
+
 ## Import
 
 ```typescript

package/generated-docs/react/hook/usetranscriptions.md

@@ -35,6 +35,9 @@ return <div>{transcriptions.map((transcription) => transcription.text)}</div>;
 {% parameter name="opts.participantIdentities" type="string[]" optional=true %}
 {% /parameter %}
 
+{% parameter name="opts.room" type="Room" optional=true %}
+{% /parameter %}
+
 {% parameter name="opts.trackSids" type="string[]" optional=true %}
 {% /parameter %}