@livekit/components-js-docs 0.1.8 → 0.1.10

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

@@ -1,34 +0,0 @@
----
-{
-  "title": "useMaybeTrackContext",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/track-reference-context.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# useMaybeTrackContext
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-`useMaybeTrackContext` has been renamed to `useMaybeTrackRefContext`<!-- -->, use this as a drop in replacement.
-
-{% /callout %}
-
-Returns a track reference from the `TrackContext` if it exists, otherwise `undefined`<!-- -->.
-
-## Import
-
-```typescript
-import { useMaybeTrackContext } from "@livekit/components-react";
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Returns
-
-```typescript
-TrackReferenceOrPlaceholder | undefined;
-```

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

@@ -1,49 +0,0 @@
----
-{
-  "title": "useMediaTrack",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useMediaTrack.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# useMediaTrack
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-use `useTrack` instead
-
-{% /callout %}
-
-## Import
-
-```typescript
-import { useMediaTrack } from "@livekit/components-react";
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Properties
-
-{% parameter name="source" type="VideoSource | AudioSource" optional=false %}
-{% /parameter %}
-
-{% parameter name="options" type="UseMediaTrackOptions" optional=true %}
-{% /parameter %}
-
-{% parameter name="participant" type="Participant" optional=true %}
-{% /parameter %}
-
-## Returns
-
-```typescript
-{
-  publication: import("livekit-client").TrackPublication | undefined;
-  isMuted: boolean | undefined;
-  isSubscribed: boolean | undefined;
-  track: import("livekit-client").Track | undefined;
-  elementProps: React.HTMLAttributes<HTMLElement>;
-}
-```

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

@@ -1,49 +0,0 @@
----
-{
-  "title": "useMediaTrackByName",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useMediaTrackByName.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# useMediaTrackByName
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This function will be removed in a future version, use `useTrackByName` instead.
-
-{% /callout %}
-
-## Import
-
-```typescript
-import { useMediaTrackByName } from "@livekit/components-react";
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Properties
-
-{% parameter name="name" type="string" optional=false %}
-{% /parameter %}
-
-{% parameter name="options" type="UseMediaTrackOptions" optional=true %}
-{% /parameter %}
-
-{% parameter name="participant" type="Participant" optional=true %}
-{% /parameter %}
-
-## Returns
-
-```typescript
-{
-  publication: import("livekit-client").TrackPublication | undefined;
-  isMuted: boolean | undefined;
-  isSubscribed: boolean | undefined;
-  track: import("livekit-client").Track | undefined;
-  elementProps: import("react").HTMLAttributes<HTMLElement>;
-}
-```

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

@@ -1,38 +0,0 @@
----
-{
-  "title": "useTrack",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrack.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# useTrack
-
-## Import
-
-```typescript
-import { useTrack } from "@livekit/components-react";
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Properties
-
-{% parameter name="trackRef" type="TrackIdentifier" optional=false %}
-{% /parameter %}
-
-{% parameter name="options" type="UseTrackOptions" optional=true %}
-{% /parameter %}
-
-## Returns
-
-```typescript
-{
-  publication: import("livekit-client").TrackPublication | undefined;
-  isMuted: boolean | undefined;
-  isSubscribed: boolean | undefined;
-  track: import("livekit-client").Track | undefined;
-  elementProps: React.HTMLAttributes<HTMLElement>;
-}
-```

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

@@ -1,34 +0,0 @@
----
-{
-  "title": "useTrackContext",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/track-reference-context.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# useTrackContext
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-`useTrackContext` has been renamed to `useTrackRefContext`<!-- -->, use this as a drop in replacement.
-
-{% /callout %}
-
-Ensures that a track reference is provided via context. If not inside a `TrackRefContext`<!-- -->, an error is thrown.
-
-## Import
-
-```typescript
-import { useTrackContext } from "@livekit/components-react";
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Returns
-
-```typescript
-TrackReferenceOrPlaceholder;
-```

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

@@ -1,40 +0,0 @@
----
-{
-  "title": "useTrackMutedIndicator",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackMutedIndicator.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# useTrackMutedIndicator
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This overload will be removed in a future version, pass in trackRef instead.
-
-{% /callout %}
-
-## Import
-
-```typescript
-import { useTrackMutedIndicator } from "@livekit/components-react";
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Properties
-
-{% parameter name="source" type="Track.Source" optional=false %}
-{% /parameter %}
-
-{% parameter name="options" type="UseTrackMutedIndicatorOptions" optional=true %}
-{% /parameter %}
-
-## Returns
-
-```typescript
-TrackMutedIndicatorReturnType;
-```

package/generated-docs/react/participanttileprops.participant.md

@@ -1,23 +0,0 @@
----
-{ "title": "ParticipantTileProps.participant property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# ParticipantTileProps.participant property
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-participant?: Participant;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/participanttileprops.publication.md

@@ -1,23 +0,0 @@
----
-{ "title": "ParticipantTileProps.publication property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# ParticipantTileProps.publication property
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-publication?: TrackPublication;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/participanttileprops.source.md

@@ -1,23 +0,0 @@
----
-{ "title": "ParticipantTileProps.source property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# ParticipantTileProps.source property
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-source?: Track.Source;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/prejoinprops.showe2eeoptions.md

@@ -1,23 +0,0 @@
----
-{ "title": "PreJoinProps.showE2EEOptions property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# PreJoinProps.showE2EEOptions property
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-E2EE options will be removed from PreJoin in a future version \*
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-showE2EEOptions?: boolean;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/trackcontext.md

@@ -1,26 +0,0 @@
----
-{
-  "title": "TrackContext variable",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/track-reference-context.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# TrackContext variable
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-`TrackContext` has been renamed to `TrackRefContext`<!-- -->, use this as a drop in replacement.
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-TrackContext: React.Context<TrackReferenceOrPlaceholder | undefined>;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/trackmutedindicatorprops.participant.md

@@ -1,23 +0,0 @@
----
-{ "title": "TrackMutedIndicatorProps.participant property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# TrackMutedIndicatorProps.participant property
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-participant?: Participant;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/trackmutedindicatorprops.source.md

@@ -1,23 +0,0 @@
----
-{ "title": "TrackMutedIndicatorProps.source property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# TrackMutedIndicatorProps.source property
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-source?: Track.Source;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usefocustoggleprops.participant.md

@@ -1,23 +0,0 @@
----
-{ "title": "UseFocusToggleProps.participant property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# UseFocusToggleProps.participant property
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-participant?: Participant;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usefocustoggleprops.tracksource.md

@@ -1,23 +0,0 @@
----
-{ "title": "UseFocusToggleProps.trackSource property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# UseFocusToggleProps.trackSource property
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-trackSource?: Track.Source;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usemediatrackoptions.element.md

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

package/generated-docs/react/usemediatrackoptions.md

@@ -1,25 +0,0 @@
----
-{
-  "title": "UseMediaTrackOptions interface",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useMediaTrack.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# UseMediaTrackOptions interface
-
-**Signature:**
-
-```typescript
-export interface UseMediaTrackOptions
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Properties
-
-| Property                                            | Type                                                             | Description  |
-| --------------------------------------------------- | ---------------------------------------------------------------- | ------------ |
-| [element?](./react/usemediatrackoptions.element.md) | React.RefObject&lt;HTMLMediaElement&gt;                          | _(Optional)_ |
-| [props?](./react/usemediatrackoptions.props.md)     | React.HTMLAttributes&lt;HTMLVideoElement \| HTMLAudioElement&gt; | _(Optional)_ |

package/generated-docs/react/usemediatrackoptions.props.md

@@ -1,13 +0,0 @@
----
-{ "title": "UseMediaTrackOptions.props property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# UseMediaTrackOptions.props property
-
-**Signature:**
-
-```typescript
-props?: React.HTMLAttributes<HTMLVideoElement | HTMLAudioElement>;
-```

package/generated-docs/react/useparticipanttileprops.participant.md

@@ -1,23 +0,0 @@
----
-{ "title": "UseParticipantTileProps.participant property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# UseParticipantTileProps.participant property
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-participant?: Participant;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useparticipanttileprops.publication.md

@@ -1,23 +0,0 @@
----
-{ "title": "UseParticipantTileProps.publication property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# UseParticipantTileProps.publication property
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-publication?: TrackPublication;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useparticipanttileprops.source.md

@@ -1,23 +0,0 @@
----
-{ "title": "UseParticipantTileProps.source property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# UseParticipantTileProps.source property
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-source?: Track.Source;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usetrackmutedindicatoroptions.md

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

package/generated-docs/react/usetrackmutedindicatoroptions.participant.md

@@ -1,23 +0,0 @@
----
-{ "title": "UseTrackMutedIndicatorOptions.participant property" }
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# UseTrackMutedIndicatorOptions.participant property
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-participant?: Participant;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usetrackoptions.element.md

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