@livekit/components-js-docs 0.1.8 → 0.1.10

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.
Files changed (96) hide show
  1. package/generated-docs/core/captureoptionsbysource.md +4 -4
  2. package/generated-docs/core/createmediadeviceobserver.md +1 -1
  3. package/generated-docs/core/defaultuserchoices.md +16 -0
  4. package/generated-docs/core/index.md +5 -4
  5. package/generated-docs/core/localuserchoices.md +0 -2
  6. package/generated-docs/core/participanttrackevents.md +16 -0
  7. package/generated-docs/core/participanttrackidentifier.md +23 -0
  8. package/generated-docs/core/participanttracksobservable.md +19 -0
  9. package/generated-docs/core/sendmessage.md +1 -2
  10. package/generated-docs/core/setupdatamessagehandler.md +1 -1
  11. package/generated-docs/core/widgetstate.md +1 -0
  12. package/generated-docs/react/audiotrackprops.md +0 -4
  13. package/generated-docs/react/audiovisualizerprops.md +3 -4
  14. package/generated-docs/react/component/audiotrack.md +0 -36
  15. package/generated-docs/react/component/audiovisualizer.md +0 -9
  16. package/generated-docs/react/component/focuslayout.md +0 -9
  17. package/generated-docs/react/component/focuslayoutcontainer.md +0 -20
  18. package/generated-docs/react/component/focustoggle.md +0 -18
  19. package/generated-docs/react/component/participantaudiotile.md +0 -27
  20. package/generated-docs/react/component/participanttile.md +0 -27
  21. package/generated-docs/react/component/prejoin.md +0 -9
  22. package/generated-docs/react/component/trackmutedindicator.md +2 -22
  23. package/generated-docs/react/component/videoconference.md +5 -0
  24. package/generated-docs/react/component/videotrack.md +0 -36
  25. package/generated-docs/react/controlbarcontrols.md +1 -0
  26. package/generated-docs/react/focuslayoutcontainerprops.md +0 -7
  27. package/generated-docs/react/focuslayoutprops.md +0 -1
  28. package/generated-docs/react/focustoggleprops.md +3 -5
  29. package/generated-docs/react/hook/usefocustoggle.md +0 -14
  30. package/generated-docs/react/hook/usemediadevices.md +2 -1
  31. package/generated-docs/react/hook/useparticipanttile.md +0 -21
  32. package/generated-docs/react/hook/useparticipanttracks.md +34 -0
  33. package/generated-docs/react/hook/usepreviewtracks.md +1 -1
  34. package/generated-docs/react/hook/usetrackbyname.md +5 -9
  35. package/generated-docs/react/index.md +76 -88
  36. package/generated-docs/react/layoutcontexttype.md +1 -1
  37. package/generated-docs/react/localuserchoices.md +0 -2
  38. package/generated-docs/react/meta-data.json +1 -1
  39. package/generated-docs/react/participanttileprops.md +0 -3
  40. package/generated-docs/react/prejoinprops.md +0 -1
  41. package/generated-docs/react/trackmutedindicatorprops.md +4 -6
  42. package/generated-docs/react/trackmutedindicatorprops.trackref.md +1 -1
  43. package/generated-docs/react/usefocustoggleprops.md +4 -6
  44. package/generated-docs/react/useparticipanttileprops.md +0 -3
  45. package/generated-docs/react/usetrackshookreturntype.md +2 -2
  46. package/generated-docs/react/videoconferenceprops.md +1 -0
  47. package/generated-docs/react/videoconferenceprops.settingscomponent.md +15 -0
  48. package/generated-docs/react/videotrackprops.md +0 -4
  49. package/generated-docs/react/widgetstate.md +1 -0
  50. package/package.json +2 -2
  51. package/generated-docs/core/datasendoptions.md +0 -19
  52. package/generated-docs/core/isparticipantsourcepinned.md +0 -32
  53. package/generated-docs/core/trackidentifier.md +0 -24
  54. package/generated-docs/react/audiotrackprops.name.md +0 -23
  55. package/generated-docs/react/audiotrackprops.participant.md +0 -23
  56. package/generated-docs/react/audiotrackprops.publication.md +0 -23
  57. package/generated-docs/react/audiotrackprops.source.md +0 -23
  58. package/generated-docs/react/audiovisualizerprops.participant.md +0 -23
  59. package/generated-docs/react/carouselview.md +0 -26
  60. package/generated-docs/react/focuslayoutcontainerprops.focustrack.md +0 -23
  61. package/generated-docs/react/focuslayoutcontainerprops.participants.md +0 -23
  62. package/generated-docs/react/focuslayoutprops.track.md +0 -23
  63. package/generated-docs/react/focustoggleprops.participant.md +0 -23
  64. package/generated-docs/react/focustoggleprops.tracksource.md +0 -23
  65. package/generated-docs/react/hook/useensuretrackreference.md +0 -39
  66. package/generated-docs/react/hook/useismuted_1.md +0 -40
  67. package/generated-docs/react/hook/usemaybetrackcontext.md +0 -34
  68. package/generated-docs/react/hook/usemediatrack.md +0 -49
  69. package/generated-docs/react/hook/usemediatrackbyname.md +0 -49
  70. package/generated-docs/react/hook/usetrack.md +0 -38
  71. package/generated-docs/react/hook/usetrackcontext.md +0 -34
  72. package/generated-docs/react/hook/usetrackmutedindicator_1.md +0 -40
  73. package/generated-docs/react/participanttileprops.participant.md +0 -23
  74. package/generated-docs/react/participanttileprops.publication.md +0 -23
  75. package/generated-docs/react/participanttileprops.source.md +0 -23
  76. package/generated-docs/react/prejoinprops.showe2eeoptions.md +0 -23
  77. package/generated-docs/react/trackcontext.md +0 -26
  78. package/generated-docs/react/trackmutedindicatorprops.participant.md +0 -23
  79. package/generated-docs/react/trackmutedindicatorprops.source.md +0 -23
  80. package/generated-docs/react/usefocustoggleprops.participant.md +0 -23
  81. package/generated-docs/react/usefocustoggleprops.tracksource.md +0 -23
  82. package/generated-docs/react/usemediatrackoptions.element.md +0 -13
  83. package/generated-docs/react/usemediatrackoptions.md +0 -25
  84. package/generated-docs/react/usemediatrackoptions.props.md +0 -13
  85. package/generated-docs/react/useparticipanttileprops.participant.md +0 -23
  86. package/generated-docs/react/useparticipanttileprops.publication.md +0 -23
  87. package/generated-docs/react/useparticipanttileprops.source.md +0 -23
  88. package/generated-docs/react/usetrackmutedindicatoroptions.md +0 -24
  89. package/generated-docs/react/usetrackmutedindicatoroptions.participant.md +0 -23
  90. package/generated-docs/react/usetrackoptions.element.md +0 -13
  91. package/generated-docs/react/usetrackoptions.md +0 -25
  92. package/generated-docs/react/usetrackoptions.props.md +0 -13
  93. package/generated-docs/react/videotrackprops.name.md +0 -23
  94. package/generated-docs/react/videotrackprops.participant.md +0 -23
  95. package/generated-docs/react/videotrackprops.publication.md +0 -23
  96. package/generated-docs/react/videotrackprops.source.md +0 -23
@@ -15,10 +15,10 @@
15
15
  export type CaptureOptionsBySource<T extends ToggleSource> = T extends Track.Source.Camera
16
16
  ? VideoCaptureOptions
17
17
  : T extends Track.Source.Microphone
18
- ? AudioCaptureOptions
19
- : T extends Track.Source.ScreenShare
20
- ? ScreenShareCaptureOptions
21
- : never;
18
+ ? AudioCaptureOptions
19
+ : T extends Track.Source.ScreenShare
20
+ ? ScreenShareCaptureOptions
21
+ : never;
22
22
  ```
23
23
 
24
24
  **References:** [ToggleSource](./core/togglesource.md)
@@ -16,5 +16,5 @@ export declare function createMediaDeviceObserver(
16
16
  kind?: MediaDeviceKind,
17
17
  onError?: (e: Error) => void,
18
18
  requestPermissions?: boolean
19
- ): Observable<void | MediaDeviceInfo[] | undefined>;
19
+ ): Observable<MediaDeviceInfo[]>;
20
20
  ```
@@ -0,0 +1,16 @@
1
+ ---
2
+ {
3
+ "title": "defaultUserChoices variable",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/persistent-storage/user-choices.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # defaultUserChoices variable
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ defaultUserChoices: LocalUserChoices;
16
+ ```
@@ -35,8 +35,8 @@
35
35
  | [createTrackObserver(participant, options)](./core/createtrackobserver.md) | |
36
36
  | [createUrlRegExp(options)](./core/createurlregexp.md) | |
37
37
  | [cssPrefix](./core/cssprefix.md) | |
38
- | [DataSendOptions](./core/datasendoptions.md) | |
39
38
  | [DataTopic](./core/datatopic.md) | |
39
+ | [defaultUserChoices](./core/defaultuserchoices.md) | |
40
40
  | [encryptionStatusObservable(room, participant)](./core/encryptionstatusobservable.md) | |
41
41
  | [getTrackByIdentifier(options)](./core/gettrackbyidentifier.md) | |
42
42
  | [getTrackReferenceId(trackReference)](./core/gettrackreferenceid.md) | Returns a id to identify the <code>TrackReference</code> or <code>TrackReferencePlaceholder</code> based on participant, track source and trackSid. |
@@ -46,7 +46,6 @@
46
46
  | [isEqualTrackRef(a, b)](./core/isequaltrackref.md) | |
47
47
  | [isLocal(p)](./core/islocal.md) | |
48
48
  | [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. |
49
- | [isParticipantSourcePinned(participant, source, pinState)](./core/isparticipantsourcepinned.md) | Check if the participant track source is pinned. |
50
49
  | [isParticipantTrackReferencePinned(trackRef, pinState)](./core/isparticipanttrackreferencepinned.md) | Check if the participant track reference is pinned. |
51
50
  | [isRemote(p)](./core/isremote.md) | |
52
51
  | [isSourcesWithOptions(sources)](./core/issourceswithoptions.md) | |
@@ -69,6 +68,9 @@
69
68
  | [participantInfoObserver(participant)](./core/participantinfoobserver.md) | |
70
69
  | [ParticipantMedia](./core/participantmedia.md) | |
71
70
  | [participantPermissionObserver(participant)](./core/participantpermissionobserver.md) | |
71
+ | [participantTrackEvents](./core/participanttrackevents.md) | |
72
+ | [ParticipantTrackIdentifier](./core/participanttrackidentifier.md) | |
73
+ | [participantTracksObservable(participant, trackIdentifier)](./core/participanttracksobservable.md) | |
72
74
  | [PIN_DEFAULT_STATE](./core/pin_default_state.md) | |
73
75
  | [PinState](./core/pinstate.md) | |
74
76
  | [ReceivedChatMessage](./core/receivedchatmessage.md) | |
@@ -83,7 +85,7 @@
83
85
  | [screenShareObserver(room)](./core/screenshareobserver.md) | |
84
86
  | [ScreenShareTrackMap](./core/screensharetrackmap.md) | |
85
87
  | [selectGridLayout(layouts, participantCount, width, height)](./core/selectgridlayout.md) | |
86
- | [sendMessage(localParticipant, payload, topic, options)](./core/sendmessage.md) | Publish data from the LocalParticipant. |
88
+ | [sendMessage(localParticipant, payload, options)](./core/sendmessage.md) | Publish data from the LocalParticipant. |
87
89
  | [setDifference(setA, setB)](./core/setdifference.md) | |
88
90
  | [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. |
89
91
  | [setLogLevel(level, options)](./core/setloglevel.md) | Set the log level for both the <code>@livekit/components-react</code> package and the <code>@livekit-client</code> package. To set the <code>@livekit-client</code> log independently, use the <code>liveKitClientLogLevel</code> prop on the <code>options</code> object. |
@@ -112,7 +114,6 @@
112
114
  | [ToggleSource](./core/togglesource.md) | |
113
115
  | [tokenize(input, grammar)](./core/tokenize.md) | |
114
116
  | [TokenizeGrammar](./core/tokenizegrammar.md) | |
115
- | [TrackIdentifier](./core/trackidentifier.md) | The TrackIdentifier type is used to select Tracks either based on - Track.Source and/or name of the track, e.g. <code>{source: Track.Source.Camera}</code> or <code>{name: &quot;my-track&quot;}</code> - TrackReference (participant and publication) |
116
117
  | [trackObservable(track)](./core/trackobservable.md) | |
117
118
  | [TrackReference](./core/trackreference.md) | |
118
119
  | [TrackReferenceFilter](./core/trackreferencefilter.md) | |
@@ -20,8 +20,6 @@ export type LocalUserChoices = {
20
20
  videoDeviceId: string;
21
21
  audioDeviceId: string;
22
22
  username: string;
23
- e2ee: boolean;
24
- sharedPassphrase: string;
25
23
  };
26
24
  ```
27
25
 
@@ -0,0 +1,16 @@
1
+ ---
2
+ {
3
+ "title": "participantTrackEvents variable",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/eventGroups.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # participantTrackEvents variable
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ participantTrackEvents: ParticipantEvent[]
16
+ ```
@@ -0,0 +1,23 @@
1
+ ---
2
+ {
3
+ "title": "ParticipantTrackIdentifier type",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # ParticipantTrackIdentifier type
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export type ParticipantTrackIdentifier = RequireAtLeastOne<
16
+ {
17
+ sources: Track.Source[];
18
+ name: string;
19
+ kind: Track.Kind;
20
+ },
21
+ "sources" | "name" | "kind"
22
+ >;
23
+ ```
@@ -0,0 +1,19 @@
1
+ ---
2
+ {
3
+ "title": "participantTracksObservable",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/track.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # participantTracksObservable
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export declare function participantTracksObservable(
16
+ participant: Participant,
17
+ trackIdentifier: ParticipantTrackIdentifier
18
+ ): Observable<TrackReference[]>;
19
+ ```
@@ -17,8 +17,7 @@ Publish data from the LocalParticipant.
17
17
  export declare function sendMessage(
18
18
  localParticipant: LocalParticipant,
19
19
  payload: Uint8Array,
20
- topic?: string,
21
- options?: DataSendOptions
20
+ options?: DataPublishOptions
22
21
  ): Promise<void>;
23
22
  ```
24
23
 
@@ -23,6 +23,6 @@ export declare function setupDataMessageHandler<T extends string>(
23
23
  from: import("livekit-client").RemoteParticipant | undefined;
24
24
  }>;
25
25
  isSendingObservable: Observable<boolean>;
26
- send: (payload: Uint8Array, options?: DataSendOptions) => Promise<void>;
26
+ send: (payload: Uint8Array, options?: DataPublishOptions) => Promise<void>;
27
27
  };
28
28
  ```
@@ -15,6 +15,7 @@
15
15
  export type WidgetState = {
16
16
  showChat: boolean;
17
17
  unreadMessages: number;
18
+ showSettings?: boolean;
18
19
  };
19
20
  ```
20
21
 
@@ -24,10 +24,6 @@ export interface AudioTrackProps extends React.AudioHTMLAttributes<HTMLAudioElem
24
24
  | Property | Type | Description |
25
25
  | -------------------------------------------------------------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
26
26
  | [muted?](./react/audiotrackprops.muted.md) | boolean | _(Optional)_ Mutes the audio track if set to <code>true</code>. |
27
- | [name?](./react/audiotrackprops.name.md) | string | _(Optional)_ |
28
27
  | [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void | _(Optional)_ |
29
- | [participant?](./react/audiotrackprops.participant.md) | Participant | _(Optional)_ |
30
- | [publication?](./react/audiotrackprops.publication.md) | TrackPublication | _(Optional)_ |
31
- | [source?](./react/audiotrackprops.source.md) | Track.Source | _(Optional)_ |
32
28
  | [trackRef?](./react/audiotrackprops.trackref.md) | [TrackReference](./react/trackreference.md) | _(Optional)_ The track reference of the track from which the audio is to be rendered. |
33
29
  | [volume?](./react/audiotrackprops.volume.md) | number | _(Optional)_ Sets the volume of the audio track. By default, the range is between <code>0.0</code> and <code>1.0</code>. |
@@ -21,7 +21,6 @@ export interface AudioVisualizerProps extends React.HTMLAttributes<SVGElement>
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Type | Description |
25
- | ----------------------------------------------------------- | ------------------------------------------- | ------------ |
26
- | [participant?](./react/audiovisualizerprops.participant.md) | Participant | _(Optional)_ |
27
- | [trackRef?](./react/audiovisualizerprops.trackref.md) | [TrackReference](./react/trackreference.md) | _(Optional)_ |
24
+ | Property | Type | Description |
25
+ | ----------------------------------------------------- | ------------------------------------------- | ------------ |
26
+ | [trackRef?](./react/audiovisualizerprops.trackref.md) | [TrackReference](./react/trackreference.md) | _(Optional)_ |
@@ -48,39 +48,3 @@ _(Optional)_ The track reference of the track from which the audio is to be rend
48
48
  _(Optional)_ Sets the volume of the audio track. By default, the range is between `0.0` and `1.0`<!-- -->.
49
49
 
50
50
  {% /parameter %}
51
-
52
- {% parameter name="name" type="string" optional=true deprecated=true %}
53
- _(Optional)_
54
-
55
- {% callout type="caution" variation="compact" %}
56
- This property will be removed in a future version use `trackRef` instead.
57
-
58
- {% /callout %}
59
- {% /parameter %}
60
-
61
- {% parameter name="participant" type="Participant" optional=true deprecated=true %}
62
- _(Optional)_
63
-
64
- {% callout type="caution" variation="compact" %}
65
- This property will be removed in a future version use `trackRef` instead.
66
-
67
- {% /callout %}
68
- {% /parameter %}
69
-
70
- {% parameter name="publication" type="TrackPublication" optional=true deprecated=true %}
71
- _(Optional)_
72
-
73
- {% callout type="caution" variation="compact" %}
74
- This property will be removed in a future version use `trackRef` instead.
75
-
76
- {% /callout %}
77
- {% /parameter %}
78
-
79
- {% parameter name="source" type="Track.Source" optional=true deprecated=true %}
80
- _(Optional)_
81
-
82
- {% callout type="caution" variation="compact" %}
83
- This property will be removed in a future version use `trackRef` instead.
84
-
85
- {% /callout %}
86
- {% /parameter %}
@@ -35,12 +35,3 @@ Requires a `TrackReferenceOrPlaceholder` to be provided either as a property or
35
35
  _(Optional)_
36
36
 
37
37
  {% /parameter %}
38
-
39
- {% parameter name="participant" type="Participant" optional=true deprecated=true %}
40
- _(Optional)_
41
-
42
- {% callout type="caution" variation="compact" %}
43
- this property will be removed in a future version, use `trackRef` instead
44
-
45
- {% /callout %}
46
- {% /parameter %}
@@ -30,12 +30,3 @@ _(Optional)_
30
30
  _(Optional)_ The track to display in the focus layout.
31
31
 
32
32
  {% /parameter %}
33
-
34
- {% parameter name="track" type="TrackReferenceOrPlaceholder" optional=true deprecated=true %}
35
- _(Optional)_
36
-
37
- {% callout type="caution" variation="compact" %}
38
- This property will be removed in a future version use `trackRef` instead.
39
-
40
- {% /callout %}
41
- {% /parameter %}
@@ -18,23 +18,3 @@ import { FocusLayoutContainer } from "@livekit/components-react";
18
18
  ```
19
19
 
20
20
  {% partial file="p_usage.md" variables={exampleCount: 0} /%}
21
-
22
- ## Properties
23
-
24
- {% parameter name="focusTrack" type="TrackReference" optional=true deprecated=true %}
25
- _(Optional)_
26
-
27
- {% callout type="caution" variation="compact" %}
28
- This property has no effect and will be removed in a future version.
29
-
30
- {% /callout %}
31
- {% /parameter %}
32
-
33
- {% parameter name="participants" type="Array<Participant>" optional=true deprecated=true %}
34
- _(Optional)_
35
-
36
- {% callout type="caution" variation="compact" %}
37
- This property has no effect and will be removed in a future version.
38
-
39
- {% /callout %}
40
- {% /parameter %}
@@ -37,21 +37,3 @@ This component needs to live inside `LayoutContext` to work properly.
37
37
  _(Optional)_
38
38
 
39
39
  {% /parameter %}
40
-
41
- {% parameter name="participant" type="Participant" optional=true deprecated=true %}
42
- _(Optional)_
43
-
44
- {% callout type="caution" variation="compact" %}
45
- This parameter will be removed in a future version use `trackRef` instead.
46
-
47
- {% /callout %}
48
- {% /parameter %}
49
-
50
- {% parameter name="trackSource" type="Track.Source" optional=true deprecated=true %}
51
- _(Optional)_
52
-
53
- {% callout type="caution" variation="compact" %}
54
- This parameter will be removed in a future version use `trackRef` instead.
55
-
56
- {% /callout %}
57
- {% /parameter %}
@@ -41,30 +41,3 @@ _(Optional)_
41
41
  _(Optional)_ The track reference to display.
42
42
 
43
43
  {% /parameter %}
44
-
45
- {% parameter name="participant" type="Participant" optional=true deprecated=true %}
46
- _(Optional)_
47
-
48
- {% callout type="caution" variation="compact" %}
49
- This parameter will be removed in a future version use `trackRef` instead.
50
-
51
- {% /callout %}
52
- {% /parameter %}
53
-
54
- {% parameter name="publication" type="TrackPublication" optional=true deprecated=true %}
55
- _(Optional)_
56
-
57
- {% callout type="caution" variation="compact" %}
58
- This parameter will be removed in a future version use `trackRef` instead.
59
-
60
- {% /callout %}
61
- {% /parameter %}
62
-
63
- {% parameter name="source" type="Track.Source" optional=true deprecated=true %}
64
- _(Optional)_
65
-
66
- {% callout type="caution" variation="compact" %}
67
- This parameter will be removed in a future version use `trackRef` instead.
68
-
69
- {% /callout %}
70
- {% /parameter %}
@@ -53,30 +53,3 @@ _(Optional)_
53
53
  _(Optional)_ The track reference to display.
54
54
 
55
55
  {% /parameter %}
56
-
57
- {% parameter name="participant" type="Participant" optional=true deprecated=true %}
58
- _(Optional)_
59
-
60
- {% callout type="caution" variation="compact" %}
61
- This parameter will be removed in a future version use `trackRef` instead.
62
-
63
- {% /callout %}
64
- {% /parameter %}
65
-
66
- {% parameter name="publication" type="TrackPublication" optional=true deprecated=true %}
67
- _(Optional)_
68
-
69
- {% callout type="caution" variation="compact" %}
70
- This parameter will be removed in a future version use `trackRef` instead.
71
-
72
- {% /callout %}
73
- {% /parameter %}
74
-
75
- {% parameter name="source" type="Track.Source" optional=true deprecated=true %}
76
- _(Optional)_
77
-
78
- {% callout type="caution" variation="compact" %}
79
- This parameter will be removed in a future version use `trackRef` instead.
80
-
81
- {% /callout %}
82
- {% /parameter %}
@@ -80,12 +80,3 @@ _(Optional)_ If true, user choices are persisted across sessions.
80
80
  _(Optional)_
81
81
 
82
82
  {% /parameter %}
83
-
84
- {% parameter name="showE2EEOptions" type="boolean" optional=true deprecated=true %}
85
- _(Optional)_
86
-
87
- {% callout type="caution" variation="compact" %}
88
- E2EE options will be removed from PreJoin in a future version \*
89
-
90
- {% /callout %}
91
- {% /parameter %}
@@ -28,30 +28,10 @@ import { TrackMutedIndicator } from "@livekit/components-react";
28
28
 
29
29
  ## Properties
30
30
 
31
- {% parameter name="show" type="'always' | 'muted' | 'unmuted'" optional=true %}
32
- _(Optional)_
33
-
34
- {% /parameter %}
35
-
36
- {% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
37
- _(Optional)_
38
-
31
+ {% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=false %}
39
32
  {% /parameter %}
40
33
 
41
- {% parameter name="participant" type="Participant" optional=true deprecated=true %}
42
- _(Optional)_
43
-
44
- {% callout type="caution" variation="compact" %}
45
- This parameter will be removed in a future version use `trackRef` instead.
46
-
47
- {% /callout %}
48
- {% /parameter %}
49
-
50
- {% parameter name="source" type="Track.Source" optional=true deprecated=true %}
34
+ {% parameter name="show" type="'always' | 'muted' | 'unmuted'" optional=true %}
51
35
  _(Optional)_
52
36
 
53
- {% callout type="caution" variation="compact" %}
54
- This parameter will be removed in a future version use `trackRef` instead.
55
-
56
- {% /callout %}
57
37
  {% /parameter %}
@@ -47,3 +47,8 @@ _(Optional)_
47
47
  _(Optional)_
48
48
 
49
49
  {% /parameter %}
50
+
51
+ {% parameter name="SettingsComponent" type="React.ComponentType" optional=true %}
52
+ _(Optional)_
53
+
54
+ {% /parameter %}
@@ -46,39 +46,3 @@ _(Optional)_
46
46
  _(Optional)_ The track reference of the track to render.
47
47
 
48
48
  {% /parameter %}
49
-
50
- {% parameter name="name" type="string" optional=true deprecated=true %}
51
- _(Optional)_
52
-
53
- {% callout type="caution" variation="compact" %}
54
- This property will be removed in a future version use `trackRef` instead.
55
-
56
- {% /callout %}
57
- {% /parameter %}
58
-
59
- {% parameter name="participant" type="Participant" optional=true deprecated=true %}
60
- _(Optional)_
61
-
62
- {% callout type="caution" variation="compact" %}
63
- This property will be removed in a future version use `trackRef` instead.
64
-
65
- {% /callout %}
66
- {% /parameter %}
67
-
68
- {% parameter name="publication" type="TrackPublication" optional=true deprecated=true %}
69
- _(Optional)_
70
-
71
- {% callout type="caution" variation="compact" %}
72
- This property will be removed in a future version use `trackRef` instead.
73
-
74
- {% /callout %}
75
- {% /parameter %}
76
-
77
- {% parameter name="source" type="Track.Source" optional=true deprecated=true %}
78
- _(Optional)_
79
-
80
- {% callout type="caution" variation="compact" %}
81
- This property will be removed in a future version use `trackRef` instead.
82
-
83
- {% /callout %}
84
- {% /parameter %}
@@ -18,6 +18,7 @@ export type ControlBarControls = {
18
18
  chat?: boolean;
19
19
  screenShare?: boolean;
20
20
  leave?: boolean;
21
+ settings?: boolean;
21
22
  };
22
23
  ```
23
24
 
@@ -18,10 +18,3 @@ export interface FocusLayoutContainerProps extends React.HTMLAttributes<HTMLDivE
18
18
  **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
19
19
 
20
20
  {% partial file="p_usage.md" variables={exampleCount: 0} /%}
21
-
22
- ## Properties
23
-
24
- | Property | Type | Description |
25
- | ------------------------------------------------------------------ | ------------------------------------------- | ------------ |
26
- | [focusTrack?](./react/focuslayoutcontainerprops.focustrack.md) | [TrackReference](./react/trackreference.md) | _(Optional)_ |
27
- | [participants?](./react/focuslayoutcontainerprops.participants.md) | Array&lt;Participant&gt; | _(Optional)_ |
@@ -24,5 +24,4 @@ export interface FocusLayoutProps extends React.HTMLAttributes<HTMLElement>
24
24
  | Property | Type | Description |
25
25
  | --------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------ |
26
26
  | [onParticipantClick?](./react/focuslayoutprops.onparticipantclick.md) | (evt: ParticipantClickEvent) =&gt; void | _(Optional)_ |
27
- | [track?](./react/focuslayoutprops.track.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |
28
27
  | [trackRef?](./react/focuslayoutprops.trackref.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ The track to display in the focus layout. |
@@ -21,8 +21,6 @@ export interface FocusToggleProps extends React.ButtonHTMLAttributes<HTMLButtonE
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Type | Description |
25
- | ------------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
26
- | [participant?](./react/focustoggleprops.participant.md) | Participant | _(Optional)_ |
27
- | [trackRef?](./react/focustoggleprops.trackref.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |
28
- | [trackSource?](./react/focustoggleprops.tracksource.md) | Track.Source | _(Optional)_ |
24
+ | Property | Type | Description |
25
+ | ------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
26
+ | [trackRef?](./react/focustoggleprops.trackref.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |
@@ -34,20 +34,6 @@ return <button {...mergedProps}>{inFocus ? "Unfocus" : "Focus"}</button>;
34
34
  {% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
35
35
  {% /parameter %}
36
36
 
37
- {% parameter name="participant" type="Participant" optional=true deprecated=true %}
38
- {% callout type="caution" variation="compact" %}
39
- This parameter will be removed in a future version use `trackRef` instead.
40
-
41
- {% /callout %}
42
- {% /parameter %}
43
-
44
- {% parameter name="trackSource" type="Track.Source" optional=true deprecated=true %}
45
- {% callout type="caution" variation="compact" %}
46
- This parameter will be removed in a future version use `trackRef` instead.
47
-
48
- {% /callout %}
49
- {% /parameter %}
50
-
51
37
  ## Returns
52
38
 
53
39
  ```typescript
@@ -28,8 +28,9 @@ const audioDevices = useMediaDevices({ kind: "audioinput" });
28
28
 
29
29
  ## Properties
30
30
 
31
- {% parameter name="{ kind }" type="{
31
+ {% parameter name="{ kind, onError, }" type="{
32
32
  kind: MediaDeviceKind;
33
+ onError?: (e: Error) => void;
33
34
  }" optional=false %}
34
35
  {% /parameter %}
35
36
 
@@ -39,27 +39,6 @@ The track reference to display.
39
39
 
40
40
  {% /parameter %}
41
41
 
42
- {% parameter name="participant" type="Participant" optional=true deprecated=true %}
43
- {% callout type="caution" variation="compact" %}
44
- This parameter will be removed in a future version use `trackRef` instead.
45
-
46
- {% /callout %}
47
- {% /parameter %}
48
-
49
- {% parameter name="publication" type="TrackPublication" optional=true deprecated=true %}
50
- {% callout type="caution" variation="compact" %}
51
- This parameter will be removed in a future version use `trackRef` instead.
52
-
53
- {% /callout %}
54
- {% /parameter %}
55
-
56
- {% parameter name="source" type="Track.Source" optional=true deprecated=true %}
57
- {% callout type="caution" variation="compact" %}
58
- This parameter will be removed in a future version use `trackRef` instead.
59
-
60
- {% /callout %}
61
- {% /parameter %}
62
-
63
42
  ## Returns
64
43
 
65
44
  ```typescript