docs

Author: bcherry

packages/core/etc/components-core.api.md

@@ -86,10 +86,7 @@ export type ChatOptions = {
 };
 
 // @public (undocumented)
-export function computeMenuPosition(button: HTMLElement, menu: HTMLElement): Promise<{
-    x: number;
-    y: number;
-}>;
+export function computeMenuPosition(button: HTMLElement, menu: HTMLElement, onUpdate?: (x: number, y: number) => void): () => void;
 
 // @public (undocumented)
 export function connectedParticipantObserver(room: Room, identity: string, options?: ConnectedParticipantObserverOptions): Observable<RemoteParticipant | undefined>;

packages/react/etc/components-react.api.md

@@ -1256,16 +1256,12 @@ export interface VideoTrackProps extends React_2.VideoHTMLAttributes<HTMLVideoEl
 
 // @beta (undocumented)
 export interface VoiceAssistant {
-    // (undocumented)
     agent: RemoteParticipant | undefined;
-    // (undocumented)
     agentAttributes: RemoteParticipant['attributes'] | undefined;
-    // (undocumented)
     agentTranscriptions: ReceivedTranscriptionSegment[];
-    // (undocumented)
     audioTrack: TrackReference_3 | undefined;
-    // (undocumented)
     state: AgentState;
+    videoTrack: TrackReference_3 | undefined;
 }
 
 // @beta (undocumented)

packages/react/src/hooks/useVoiceAssistant.ts

@@ -23,11 +23,29 @@ export type AgentState =
  * @beta
  */
 export interface VoiceAssistant {
+  /**
+   * The agent participant.
+   */
   agent: RemoteParticipant | undefined;
+  /**
+   * The current state of the agent.
+   */
   state: AgentState;
+  /**
+   * The microphone track published by the agent or associated avatar worker (if any).
+   */
   audioTrack: TrackReference | undefined;
+  /**
+   * The camera track published by the agent or associated avatar worker (if any).
+   */
   videoTrack: TrackReference | undefined;
+  /**
+   * The transcriptions of the agent's microphone track (if any).
+   */
   agentTranscriptions: ReceivedTranscriptionSegment[];
+  /**
+   * The agent's participant attributes.
+   */
   agentAttributes: RemoteParticipant['attributes'] | undefined;
 }