@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
@@ -1,25 +0,0 @@
1
- ---
2
- {
3
- "title": "UseTrackOptions interface",
4
- "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrack.ts"
5
- }
6
- ---
7
-
8
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
-
10
- # UseTrackOptions interface
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export interface UseTrackOptions
16
- ```
17
-
18
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
19
-
20
- ## Properties
21
-
22
- | Property | Type | Description |
23
- | ---------------------------------------------- | ---------------------------------------------------------------- | ------------ |
24
- | [element?](./react/usetrackoptions.element.md) | React.RefObject&lt;HTMLMediaElement&gt; | _(Optional)_ |
25
- | [props?](./react/usetrackoptions.props.md) | React.HTMLAttributes&lt;HTMLVideoElement \| HTMLAudioElement&gt; | _(Optional)_ |
@@ -1,13 +0,0 @@
1
- ---
2
- { "title": "UseTrackOptions.props property" }
3
- ---
4
-
5
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
6
-
7
- # UseTrackOptions.props property
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- props?: React.HTMLAttributes<HTMLVideoElement | HTMLAudioElement>;
13
- ```
@@ -1,23 +0,0 @@
1
- ---
2
- { "title": "VideoTrackProps.name property" }
3
- ---
4
-
5
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
6
-
7
- # VideoTrackProps.name property
8
-
9
- {% callout type="caution" variation="normal" %}
10
-
11
- This API is deprecated:
12
-
13
- This property will be removed in a future version use `trackRef` instead.
14
-
15
- {% /callout %}
16
-
17
- **Signature:**
18
-
19
- ```typescript
20
- name?: string;
21
- ```
22
-
23
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -1,23 +0,0 @@
1
- ---
2
- { "title": "VideoTrackProps.participant property" }
3
- ---
4
-
5
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
6
-
7
- # VideoTrackProps.participant property
8
-
9
- {% callout type="caution" variation="normal" %}
10
-
11
- This API is deprecated:
12
-
13
- This property will be removed in a future version use `trackRef` instead.
14
-
15
- {% /callout %}
16
-
17
- **Signature:**
18
-
19
- ```typescript
20
- participant?: Participant;
21
- ```
22
-
23
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -1,23 +0,0 @@
1
- ---
2
- { "title": "VideoTrackProps.publication property" }
3
- ---
4
-
5
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
6
-
7
- # VideoTrackProps.publication property
8
-
9
- {% callout type="caution" variation="normal" %}
10
-
11
- This API is deprecated:
12
-
13
- This property will be removed in a future version use `trackRef` instead.
14
-
15
- {% /callout %}
16
-
17
- **Signature:**
18
-
19
- ```typescript
20
- publication?: TrackPublication;
21
- ```
22
-
23
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -1,23 +0,0 @@
1
- ---
2
- { "title": "VideoTrackProps.source property" }
3
- ---
4
-
5
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
6
-
7
- # VideoTrackProps.source property
8
-
9
- {% callout type="caution" variation="normal" %}
10
-
11
- This API is deprecated:
12
-
13
- This property will be removed in a future version use `trackRef` instead.
14
-
15
- {% /callout %}
16
-
17
- **Signature:**
18
-
19
- ```typescript
20
- source?: Track.Source;
21
- ```
22
-
23
- {% partial file="p_usage.md" variables={exampleCount: 0} /%}