@livekit/components-js-docs 0.1.68 → 0.1.70

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 (52) hide show
  1. package/generated-docs/core/createdataobserver.md +2 -1
  2. package/generated-docs/core/index.md +5 -0
  3. package/generated-docs/core/participantagentattributes.md +28 -0
  4. package/generated-docs/core/receivedagenttranscriptionmessage.md +21 -0
  5. package/generated-docs/core/receivedchatmessage.md +6 -13
  6. package/generated-docs/core/receivedmessage.md +27 -0
  7. package/generated-docs/core/receivedusertranscriptionmessage.md +21 -0
  8. package/generated-docs/core/sentmessage.md +16 -0
  9. package/generated-docs/react/agentcallbacks.md +28 -0
  10. package/generated-docs/react/agentevent.md +30 -0
  11. package/generated-docs/react/agentstate.md +14 -5
  12. package/generated-docs/react/allowaudioplaybackprops.md +4 -3
  13. package/generated-docs/react/allowaudioplaybackprops.room.md +13 -0
  14. package/generated-docs/react/barvisualizerprops.md +8 -7
  15. package/generated-docs/react/barvisualizerprops.track.md +19 -0
  16. package/generated-docs/react/barvisualizerprops.trackref.md +6 -0
  17. package/generated-docs/react/component/roomaudiorenderer.md +5 -0
  18. package/generated-docs/react/component/sessionprovider.md +24 -0
  19. package/generated-docs/react/component/startaudio.md +5 -0
  20. package/generated-docs/react/hook/useagent.md +35 -0
  21. package/generated-docs/react/hook/useensuresession.md +35 -0
  22. package/generated-docs/react/hook/useevents.md +40 -0
  23. package/generated-docs/react/hook/usemaybesessioncontext.md +30 -0
  24. package/generated-docs/react/hook/useparticipanttracks.md +2 -5
  25. package/generated-docs/react/hook/usepreviewtracks.md +1 -1
  26. package/generated-docs/react/hook/usesession.md +35 -0
  27. package/generated-docs/react/hook/usesessioncontext.md +30 -0
  28. package/generated-docs/react/hook/usesessionmessages.md +33 -0
  29. package/generated-docs/react/hook/usetracktoggle.md +5 -0
  30. package/generated-docs/react/hook/usetranscriptions.md +3 -0
  31. package/generated-docs/react/index.md +174 -151
  32. package/generated-docs/react/messagescallbacks.md +26 -0
  33. package/generated-docs/react/messagesevent.md +28 -0
  34. package/generated-docs/react/meta-data.json +1 -1
  35. package/generated-docs/react/roomaudiorendererprops.md +1 -0
  36. package/generated-docs/{core/receivedchatmessage.from.md → react/roomaudiorendererprops.room.md} +3 -3
  37. package/generated-docs/react/sessioncallbacks.md +28 -0
  38. package/generated-docs/react/sessionconnectoptions.md +31 -0
  39. package/generated-docs/react/sessionevent.md +30 -0
  40. package/generated-docs/react/sessionproviderprops.md +27 -0
  41. package/generated-docs/react/switchactivedeviceoptions.md +24 -0
  42. package/generated-docs/react/useagentreturn.md +22 -0
  43. package/generated-docs/react/usesessionmessagesreturn.md +31 -0
  44. package/generated-docs/react/usesessionreturn.md +27 -0
  45. package/generated-docs/react/usespeakingparticipantsoptions.md +18 -0
  46. package/generated-docs/react/usetextstreamoptions.md +24 -0
  47. package/generated-docs/react/usetracktoggleprops.md +6 -0
  48. package/generated-docs/react/usetracktoggleprops.room.md +13 -0
  49. package/generated-docs/react/usetranscriptionsoptions.md +1 -0
  50. package/generated-docs/react/usetranscriptionsoptions.room.md +19 -0
  51. package/package.json +6 -3
  52. package/generated-docs/core/receivedchatmessage.attributes.md +0 -13
@@ -0,0 +1,30 @@
1
+ ---
2
+ {
3
+ "title": "useSessionContext",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/session-context.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # useSessionContext
11
+
12
+ {% callout type="note" variation="normal" %}
13
+
14
+ This feature is under active development and may change based on developer feedback and real-world usage.
15
+
16
+ {% /callout %}
17
+
18
+ Ensures that a session is provided via context. If no session is provided, an error is thrown.
19
+
20
+ ## Import
21
+
22
+ ```typescript
23
+ import { useSessionContext } from "@livekit/components-react";
24
+ ```
25
+
26
+ ## Returns
27
+
28
+ ```typescript
29
+ UseSessionReturn;
30
+ ```
@@ -0,0 +1,33 @@
1
+ ---
2
+ {
3
+ "title": "useSessionMessages",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSessionMessages.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # useSessionMessages
11
+
12
+ {% callout type="note" variation="normal" %}
13
+
14
+ This feature is under active development and may change based on developer feedback and real-world usage.
15
+
16
+ {% /callout %}
17
+
18
+ ## Import
19
+
20
+ ```typescript
21
+ import { useSessionMessages } from "@livekit/components-react";
22
+ ```
23
+
24
+ ## Properties
25
+
26
+ {% parameter name="session" type="UseSessionReturn" optional=true %}
27
+ {% /parameter %}
28
+
29
+ ## Returns
30
+
31
+ ```typescript
32
+ UseSessionMessagesReturn;
33
+ ```
@@ -24,6 +24,11 @@ const { buttonProps, enabled } = useTrackToggle(trackRef);
24
24
  return <button {...buttonProps}>{enabled ? "disable" : "enable"}</button>;
25
25
  ```
26
26
 
27
+ ## Properties
28
+
29
+ {% parameter name="{ source, onChange, initialState, captureOptions, publishOptions, onDeviceError, room, ...rest }.room" type="Room" optional=true %}
30
+ {% /parameter %}
31
+
27
32
  ## Returns
28
33
 
29
34
  ```typescript
@@ -35,6 +35,9 @@ return <div>{transcriptions.map((transcription) => transcription.text)}</div>;
35
35
  {% parameter name="opts.participantIdentities" type="string[]" optional=true %}
36
36
  {% /parameter %}
37
37
 
38
+ {% parameter name="opts.room" type="Room" optional=true %}
39
+ {% /parameter %}
40
+
38
41
  {% parameter name="opts.trackSids" type="string[]" optional=true %}
39
42
  {% /parameter %}
40
43