@livekit/components-js-docs 0.1.25 → 0.1.27
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.
- package/generated-docs/core/index.md +131 -129
- package/generated-docs/core/participantbyidentifierobserver.md +20 -0
- package/generated-docs/core/participantidentifier.md +26 -0
- package/generated-docs/react/component/audiotrack.md +50 -0
- package/generated-docs/react/{audiovisualizer.md → component/audiovisualizer.md} +9 -4
- package/generated-docs/react/component/chatentry.md +50 -0
- package/generated-docs/react/{chattoggle.md → component/chattoggle.md} +2 -4
- package/generated-docs/react/{clearpinbutton.md → component/clearpinbutton.md} +2 -4
- package/generated-docs/react/{connectionqualityindicator.md → component/connectionqualityindicator.md} +2 -4
- package/generated-docs/react/{connectionstate.md → component/connectionstate.md} +9 -4
- package/generated-docs/react/{disconnectbutton.md → component/disconnectbutton.md} +9 -4
- package/generated-docs/react/{focustoggle.md → component/focustoggle.md} +9 -4
- package/generated-docs/react/component/livekitroom.md +77 -0
- package/generated-docs/react/component/mediadeviceselect.md +73 -0
- package/generated-docs/react/{participantaudiotile.md → component/participantaudiotile.md} +19 -4
- package/generated-docs/react/{participantname.md → component/participantname.md} +2 -4
- package/generated-docs/react/{participanttile.md → component/participanttile.md} +19 -4
- package/generated-docs/react/{roomname.md → component/roomname.md} +9 -2
- package/generated-docs/react/{startaudio.md → component/startaudio.md} +7 -4
- package/generated-docs/react/{trackmutedindicator.md → component/trackmutedindicator.md} +12 -4
- package/generated-docs/react/component/tracktoggle.md +64 -0
- package/generated-docs/react/{videotrack.md → component/videotrack.md} +24 -4
- package/generated-docs/react/hook/useclearpinbutton.md +1 -1
- package/generated-docs/react/hook/useremoteparticipant.md +3 -3
- package/generated-docs/react/hook/useremoteparticipant_1.md +44 -0
- package/generated-docs/react/index.md +99 -97
- package/generated-docs/react/meta-data.json +1 -1
- package/generated-docs/react/participantidentifier.md +26 -0
- package/package.json +2 -2
- package/generated-docs/react/audiotrack.md +0 -30
- package/generated-docs/react/chatentry.md +0 -28
- package/generated-docs/react/mediadeviceselect.md +0 -30
- package/generated-docs/react/tracktoggle.md +0 -31
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
{
|
|
3
|
-
"title": "AudioTrack",
|
|
4
|
-
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/AudioTrack.tsx"
|
|
5
|
-
}
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
-
|
|
10
|
-
# AudioTrack
|
|
11
|
-
|
|
12
|
-
The AudioTrack component is responsible for rendering participant audio tracks. This component must have access to the participant's context, or alternatively pass it a `Participant` as a property.
|
|
13
|
-
|
|
14
|
-
**Signature:**
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
AudioTrack: React.ForwardRefExoticComponent<
|
|
18
|
-
AudioTrackProps & React.RefAttributes<HTMLAudioElement>
|
|
19
|
-
>;
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
## Usage
|
|
23
|
-
|
|
24
|
-
```tsx
|
|
25
|
-
<ParticipantTile>
|
|
26
|
-
<AudioTrack trackRef={trackRef} />
|
|
27
|
-
</ParticipantTile>
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
{% partial file="p_usage.md" variables={exampleCount: 1} /%}
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
{
|
|
3
|
-
"title": "ChatEntry",
|
|
4
|
-
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/ChatEntry.tsx"
|
|
5
|
-
}
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
-
|
|
10
|
-
# ChatEntry
|
|
11
|
-
|
|
12
|
-
The `ChatEntry` component holds and displays one chat message.
|
|
13
|
-
|
|
14
|
-
**Signature:**
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
ChatEntry: React.ForwardRefExoticComponent<ChatEntryProps & React.RefAttributes<HTMLLIElement>>;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
## Usage
|
|
21
|
-
|
|
22
|
-
```tsx
|
|
23
|
-
<Chat>
|
|
24
|
-
<ChatEntry />
|
|
25
|
-
</Chat>
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
{% partial file="p_usage.md" variables={exampleCount: 1} /%}
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
{
|
|
3
|
-
"title": "MediaDeviceSelect",
|
|
4
|
-
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/MediaDeviceSelect.tsx"
|
|
5
|
-
}
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
-
|
|
10
|
-
# MediaDeviceSelect
|
|
11
|
-
|
|
12
|
-
The `MediaDeviceSelect` list all media devices of one kind. Clicking on one of the listed devices make it the active media device.
|
|
13
|
-
|
|
14
|
-
**Signature:**
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
MediaDeviceSelect: React.ForwardRefExoticComponent<
|
|
18
|
-
MediaDeviceSelectProps & React.RefAttributes<HTMLUListElement>
|
|
19
|
-
>;
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
## Usage
|
|
23
|
-
|
|
24
|
-
```tsx
|
|
25
|
-
<LiveKitRoom>
|
|
26
|
-
<MediaDeviceSelect kind="audioinput" />
|
|
27
|
-
</LiveKitRoom>
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
{% partial file="p_usage.md" variables={exampleCount: 1} /%}
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
{
|
|
3
|
-
"title": "TrackToggle",
|
|
4
|
-
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/TrackToggle.tsx"
|
|
5
|
-
}
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
-
|
|
10
|
-
# TrackToggle
|
|
11
|
-
|
|
12
|
-
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.
|
|
13
|
-
|
|
14
|
-
**Signature:**
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
TrackToggle: React.ForwardRefExoticComponent<
|
|
18
|
-
TrackToggleProps<ToggleSource> & React.RefAttributes<HTMLButtonElement>
|
|
19
|
-
>;
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
## Usage
|
|
23
|
-
|
|
24
|
-
```tsx
|
|
25
|
-
<LiveKitRoom>
|
|
26
|
-
<TrackToggle source={Track.Source.Microphone} />
|
|
27
|
-
<TrackToggle source={Track.Source.Camera} />
|
|
28
|
-
</LiveKitRoom>
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
{% partial file="p_usage.md" variables={exampleCount: 1} /%}
|