@livekit/components-js-docs 0.1.29 → 0.1.31
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/gridlayoutdefinition.md +5 -5
- package/generated-docs/core/gridlayoutinfo.md +24 -0
- package/generated-docs/core/index.md +3 -1
- package/generated-docs/core/recordingstatusobservable.md +16 -0
- package/generated-docs/core/selectgridlayout.md +2 -2
- package/generated-docs/react/gridlayoutdefinition.md +24 -0
- package/generated-docs/react/hook/usegridlayout.md +8 -1
- package/generated-docs/react/index.md +2 -1
- package/package.json +2 -2
|
@@ -13,12 +13,12 @@
|
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
15
|
export type GridLayoutDefinition = {
|
|
16
|
-
name: string;
|
|
17
16
|
columns: number;
|
|
18
17
|
rows: number;
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
minHeight: number;
|
|
18
|
+
minWidth?: number;
|
|
19
|
+
minHeight?: number;
|
|
20
|
+
orientation?: "landscape" | "portrait";
|
|
23
21
|
};
|
|
24
22
|
```
|
|
23
|
+
|
|
24
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "GridLayoutInfo type",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/grid-layouts.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# GridLayoutInfo type
|
|
11
|
+
|
|
12
|
+
**Signature:**
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
export type GridLayoutInfo = {
|
|
16
|
+
name: string;
|
|
17
|
+
columns: number;
|
|
18
|
+
rows: number;
|
|
19
|
+
maxTiles: number;
|
|
20
|
+
minWidth: number;
|
|
21
|
+
minHeight: number;
|
|
22
|
+
orientation?: "landscape" | "portrait";
|
|
23
|
+
};
|
|
24
|
+
```
|
|
@@ -48,6 +48,7 @@
|
|
|
48
48
|
| [getTrackReferenceSource(trackReference)](./core/gettrackreferencesource.md) | Returns the Source of the TrackReference. |
|
|
49
49
|
| [GRID_LAYOUTS](./core/grid_layouts.md) | |
|
|
50
50
|
| [GridLayoutDefinition](./core/gridlayoutdefinition.md) | |
|
|
51
|
+
| [GridLayoutInfo](./core/gridlayoutinfo.md) | |
|
|
51
52
|
| [isEqualTrackRef(a, b)](./core/isequaltrackref.md) | |
|
|
52
53
|
| [isLocal(p)](./core/islocal.md) | |
|
|
53
54
|
| [isMobileBrowser()](./core/ismobilebrowser.md) | Mobile browser detection based on <code>navigator.userAgent</code> string. Defaults to returning <code>false</code> if not in a browser. |
|
|
@@ -84,6 +85,7 @@
|
|
|
84
85
|
| [ReceivedChatMessage](./core/receivedchatmessage.md) | |
|
|
85
86
|
| [ReceivedDataMessage](./core/receiveddatamessage.md) | |
|
|
86
87
|
| [ReceivedTranscriptionSegment](./core/receivedtranscriptionsegment.md) | |
|
|
88
|
+
| [recordingStatusObservable(room)](./core/recordingstatusobservable.md) | |
|
|
87
89
|
| [RequireOnlyOne](./core/requireonlyone.md) | |
|
|
88
90
|
| [roomAudioPlaybackAllowedObservable(room)](./core/roomaudioplaybackallowedobservable.md) | |
|
|
89
91
|
| [roomEventSelector(room, event)](./core/roomeventselector.md) | |
|
|
@@ -93,7 +95,7 @@
|
|
|
93
95
|
| [saveUserChoices(userChoices, preventSave)](./core/saveuserchoices.md) | Saves user choices to local storage. |
|
|
94
96
|
| [screenShareObserver(room)](./core/screenshareobserver.md) | |
|
|
95
97
|
| [ScreenShareTrackMap](./core/screensharetrackmap.md) | |
|
|
96
|
-
| [selectGridLayout(
|
|
98
|
+
| [selectGridLayout(layoutDefinitions, participantCount, width, height)](./core/selectgridlayout.md) | |
|
|
97
99
|
| [sendMessage(localParticipant, payload, options)](./core/sendmessage.md) | Publish data from the LocalParticipant. |
|
|
98
100
|
| [setDifference(setA, setB)](./core/setdifference.md) | |
|
|
99
101
|
| [setLogExtension(extension, options)](./core/setlogextension.md) | Set the log extension for both the <code>@livekit/components-react</code> package and the <code>@livekit-client</code> package. To set the <code>@livekit-client</code> log extension, use the <code>liveKitClientLogExtension</code> prop on the <code>options</code> object. |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "recordingStatusObservable",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# recordingStatusObservable
|
|
11
|
+
|
|
12
|
+
**Signature:**
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
export declare function recordingStatusObservable(room: Room): Observable<boolean>;
|
|
16
|
+
```
|
|
@@ -13,9 +13,9 @@
|
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
15
|
export declare function selectGridLayout(
|
|
16
|
-
|
|
16
|
+
layoutDefinitions: GridLayoutDefinition[],
|
|
17
17
|
participantCount: number,
|
|
18
18
|
width: number,
|
|
19
19
|
height: number
|
|
20
|
-
):
|
|
20
|
+
): GridLayoutInfo;
|
|
21
21
|
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "GridLayoutDefinition type",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/helper/grid-layouts.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# GridLayoutDefinition type
|
|
11
|
+
|
|
12
|
+
**Signature:**
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
export type GridLayoutDefinition = {
|
|
16
|
+
columns: number;
|
|
17
|
+
rows: number;
|
|
18
|
+
minWidth?: number;
|
|
19
|
+
minHeight?: number;
|
|
20
|
+
orientation?: "landscape" | "portrait";
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
{% partial file="p_usage.md" variables={exampleCount: 0} /%}
|
|
@@ -33,10 +33,17 @@ const { layout } = useGridLayout(gridElement, trackCount);
|
|
|
33
33
|
{% parameter name="trackCount" type="number" optional=false %}
|
|
34
34
|
{% /parameter %}
|
|
35
35
|
|
|
36
|
+
{% parameter name="options" type="{
|
|
37
|
+
gridLayouts?: GridLayoutDefinition[];
|
|
38
|
+
}" optional=true %}
|
|
39
|
+
{% /parameter %}
|
|
40
|
+
|
|
36
41
|
## Returns
|
|
37
42
|
|
|
38
43
|
```typescript
|
|
39
44
|
{
|
|
40
|
-
layout:
|
|
45
|
+
layout: GridLayoutInfo;
|
|
46
|
+
containerWidth: number;
|
|
47
|
+
containerHeight: number;
|
|
41
48
|
}
|
|
42
49
|
```
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
| [useEnsureTrackRef(trackRef)](./react/hook/useensuretrackref.md) | Ensures that a track reference is provided, either via context or explicitly as a parameter. If not inside a <code>TrackRefContext</code> and no track reference is provided, an error is thrown. |
|
|
78
78
|
| [useFacingMode(trackReference)](./react/hook/usefacingmode.md) | Try to determine the <code>facingMode</code> of a local participant video track. |
|
|
79
79
|
| [useFocusToggle({ trackRef, props })](./react/hook/usefocustoggle.md) | The <code>useFocusToggle</code> hook is used to implement the <code>FocusToggle</code> or your custom implementation of it. The <code>TrackReferenceOrPlaceholder</code> is used to register a onClick handler and to identify the track to focus on. |
|
|
80
|
-
| [useGridLayout(gridElement, trackCount)](./react/hook/usegridlayout.md)
|
|
80
|
+
| [useGridLayout(gridElement, trackCount, options)](./react/hook/usegridlayout.md) | The <code>useGridLayout</code> hook tries to select the best layout to fit all tiles. If the available screen space is not enough, it will reduce the number of maximum visible tiles and select a layout that still works visually within the given limitations. As the order of tiles changes over time, the hook tries to keep visual updates to a minimum while trying to display important tiles such as speaking participants or screen shares. |
|
|
81
81
|
| [useIsEncrypted(participant, options)](./react/hook/useisencrypted.md) | |
|
|
82
82
|
| [useIsMuted(trackRef)](./react/hook/useismuted.md) | The <code>useIsMuted</code> hook is used to implement the <code>TrackMutedIndicator</code> or your custom implementation of it. It returns a <code>boolean</code> that indicates if the track is muted or not. |
|
|
83
83
|
| [useIsSpeaking(participant)](./react/hook/useisspeaking.md) | The <code>useIsSpeaking</code> hook returns a <code>boolean</code> that indicates if the participant is speaking or not. |
|
|
@@ -150,6 +150,7 @@
|
|
|
150
150
|
| [FocusLayoutProps](./react/focuslayoutprops.md) | |
|
|
151
151
|
| [FocusToggleProps](./react/focustoggleprops.md) | |
|
|
152
152
|
| [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md) | |
|
|
153
|
+
| [GridLayoutDefinition](./react/gridlayoutdefinition.md) | |
|
|
153
154
|
| [GridLayoutProps](./react/gridlayoutprops.md) | |
|
|
154
155
|
| [LayoutContextProviderProps](./react/layoutcontextproviderprops.md) | |
|
|
155
156
|
| [LayoutContextType](./react/layoutcontexttype.md) | |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@livekit/components-js-docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.31",
|
|
4
4
|
"description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"directory": "/docs/beta-docs"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"@livekit/components-react": "2.4.
|
|
11
|
+
"@livekit/components-react": "2.4.2"
|
|
12
12
|
},
|
|
13
13
|
"author": "",
|
|
14
14
|
"license": "Apache-2.0",
|