@livekit/components-js-docs 0.1.1 → 0.1.3

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

@@ -0,0 +1,32 @@
+---
+{
+  "title": "usePreviewTracks",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/PreJoin.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# usePreviewTracks
+
+## Import
+
+```typescript
+import { usePreviewTracks } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="options" type="CreateLocalTracksOptions" optional=false %}
+{% /parameter %}
+
+{% parameter name="onError" type="(err: Error) => void" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+LocalTrack[] | undefined
+```

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

@@ -0,0 +1,43 @@
+---
+{
+  "title": "useStartAudio",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useStartAudio.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useStartAudio
+
+In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The `useStatAudio` hook returns an object with a boolean `canPlayAudio` flag that indicates whether audio playback is allowed in the current context, as well as a `startAudio` function that can be called in a button `onClick` callback to start audio playback in the current context.
+
+## Import
+
+```typescript
+import { useStartAudio } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
+{% /parameter %}
+
+{% parameter name="room" type="Room" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+{
+    mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {
+        className: string;
+        onClick: () => void;
+        style: {
+            display: string;
+        };
+    };
+    canPlayAudio: boolean;
+}
+```

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

@@ -0,0 +1,43 @@
+---
+{
+  "title": "useStartVideo",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useStartVideo.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useStartVideo
+
+In some browsers to start video playback in low power mode, the user must perform a user-initiated event such as clicking a button. The `useStartVideo` hook returns an object with a boolean `canPlayVideo` flag that indicates whether video playback is allowed in the current context, as well as a `startVideo` function that can be called in a button `onClick` callback to start video playback in the current context.
+
+## Import
+
+```typescript
+import { useStartVideo } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
+{% /parameter %}
+
+{% parameter name="room" type="Room" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+{
+    mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {
+        className: string;
+        onClick: () => void;
+        style: {
+            display: string;
+        };
+    };
+    canPlayVideo: boolean;
+}
+```

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

@@ -0,0 +1,44 @@
+---
+{
+  "title": "useSwipe",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSwipe.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useSwipe
+
+Simple implementation to detect horizontal swipe actions. Accepts callbacks for on right and left swipes.
+
+## Import
+
+```typescript
+import { useSwipe } from "@livekit/components-react";
+```
+
+## Usage
+
+```tsx
+ <div
+      onTouchStart={onTouchStart}
+      onTouchMove={onTouchMove}
+      onTouchEnd={onTouchEnd}
+    >
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
+
+## Properties
+
+{% parameter name="element" type="React.RefObject<HTMLElement>" optional=false %}
+{% /parameter %}
+
+{% parameter name="options" type="UseSwipeOptions" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+void
+```