fix: Update types

PiperOrigin-RevId: 723178043

Author: koumiGoogle

web/types/mediatypes.d.ts

@@ -28,28 +28,82 @@ import {LogLevel} from './enums';
 import {Subscribable} from './subscribable';
 
 /**
- * Media entry serves as the central relational object between the
+ * Serves as the central relational object between the
  * participant, media canvas and meet stream. This object represents media in
  * a Meet call and holds metadata for the media.
  */
 export interface MediaEntry {
-  // We expect participant to be set once.
+  /**
+   * Participant abstraction associated with this media entry.
+   * We expect participant to be set once.
+   */
   readonly participant: Subscribable<Participant | undefined>;
+  /**
+   * Whether this participant muted their audio stream.
+   */
   readonly audioMuted: Subscribable<boolean>;
+  /**
+   * Whether this participant muted their video stream.
+   */
   readonly videoMuted: Subscribable<boolean>;
+  /**
+   * Whether the current entry is a screenshare.
+   */
   readonly screenShare: Subscribable<boolean>;
+  /**
+   * Whether the current entry is a presenter self-view.
+   */
   readonly isPresenter: Subscribable<boolean>;
+  /**
+   * The media layout associated with this media entry.
+   */
   readonly mediaLayout: Subscribable<MediaLayout | undefined>;
+  /**
+   * The video meet stream track associated with this media entry. Contains the
+   * webrtc media stream track.
+   */
   readonly videoMeetStreamTrack: Subscribable<MeetStreamTrack | undefined>;
+  /**
+   * The audio meet stream track associated with this media entry. Contains the
+   * webrtc media stream track.
+   */
   readonly audioMeetStreamTrack: Subscribable<MeetStreamTrack | undefined>;
+  /**
+   * The session ID of the media entry.
+   *
+   * Format is
+   * `participants/{participant}/participantSessions/{participant_session}`
+   *
+   * You can use this to retrieve additional information about
+   * the participant session from the
+   * {@link https://developers.google.com/meet/api/reference/rest/v2/conferenceRecords.participants.participantSessions | Meet REST API - ParticipantSessions} resource.
+   *
+   * `Note`: This has to be in the format of `conferenceRecords/{conference_record}/participants/{participant}/participantSessions/{participant_session}`.
+   *
+   *  You can retrieve the conference record from the {@link https://developers.google.com/meet/api/guides/conferences | Meet REST API - Conferences} resource.
+   */
   sessionName?: string;
+  /**
+   * Participant session name. There should be a one to one mapping of session
+   * to Media Entry. You can use this to retrieve additional information about
+   * the participant session from the
+   * {@link https://developers.google.com/meet/api/reference/rest/v2/conferenceRecords.participants.participantSessions | Meet REST API - ParticipantSessions} resource
+   *
+   * Format is
+   * `conferenceRecords/{conference_record}/participants/{participant}/participantSessions/{participant_session}`
+   * Unused for now. Use sessionName instead.
+   */
   session?: string;
 }
 
 /**
- * Base participant type.
+ * An abstraction that represents a participant in a Meet call. Contains
+ * the participant object and the media entries associated with this participant.
  */
 export interface Participant {
+  /**
+   * Participant abstraction associated with this participant.
+   */
   participant: BaseParticipant;
   /**
    * The media entries associated with this participant. These can be
@@ -59,68 +113,55 @@ export interface Participant {
 }
 
 /**
- * Base participant type.
+ * Base participant type. Only one of signedInUser, anonymousUser, or phoneUser
+ * fields will be set to determine the type of participant.
  */
 export interface BaseParticipant {
-  // Resource name of the participant.
-  // Format: `conferenceRecords/{conferenceRecord}/participants/{participant}`
+  /**
+   * Resource name of the participant.
+   * Format: `conferenceRecords/{conferenceRecord}/participants/{participant}`
+   *
+   * You can use this to retrieve additional information about the participant
+   * from the {@link https://developers.google.com/meet/api/reference/rest/v2/conferenceRecords.participants | Meet REST API - Participants} resource.
+   *
+   * Unused for now. Use participantKey instead.
+   */
   name?: string;
-  // Participant key of associated participant. The user must construct the
-  // resource name from this field to create an Meet API reference.
-  // Format is `participants/{participant}`
-  // You can retrieve the conference record from https://developers.google.com/meet/api/guides/conferences
-  // and use the conference record to construct the participant name in the
-  // format of
-  // `conferenceRecords/{conference_record}/participants/{participant}`
+  /**
+   * Participant key of associated participant.
+   * Format is `participants/{participant}`.
+   *
+   * You can use this to retrieve additional information about the participant
+   * from the {@link https://developers.google.com/meet/api/reference/rest/v2/conferenceRecords.participants | Meet REST API - Participants} resource.
+   *
+   * `Note`: This has to be in the format of `conferenceRecords/{conference_record}/participants/{participant}`.
+   *
+   *  You can retrieve the conference record from the {@link https://developers.google.com/meet/api/guides/conferences | Meet REST API - Conferences} resource.
+   *
+   */
   participantKey?: string;
+  /**
+   * If set, the participant is a signed in user. Provides a unique ID and
+   * display name.
+   */
   signedInUser?: SignedInUser;
+  /**
+   * If set, the participant is an anonymous user. Provides a display name.
+   */
   anonymousUser?: AnonymousUser;
+  /**
+   * If set, the participant is a dial-in user. Provides a partially redacted
+   * phone number.
+   */
   phoneUser?: PhoneUser;
 }
 
-/**
- * A signed in participant in a Meet call.
- */
-export interface SignedInParticipant extends BaseParticipant {
-  signedInUser: SignedInUser;
-  anonymousUser?: never;
-  phoneUser?: never;
-}
-
-/**
- * An anonymous participant in a Meet call.
- */
-export interface AnonymousParticipant extends BaseParticipant {
-  signedInUser?: never;
-  anonymousUser: AnonymousUser;
-  phoneUser?: never;
-}
-
-/**
- * A phone participant in a Meet call.
- */
-export interface PhoneParticipant extends BaseParticipant {
-  signedInUser?: never;
-  anonymousUser?: never;
-  phoneUser: PhoneUser;
-}
-
-/**
- * A representation of a participant for a Media API client.
- * This maps to
- * https://developers.google.com/meet/api/reference/rest/v2/conferenceRecords.participants#Participant.
- */
-export type ParticipantType =
-  | SignedInParticipant
-  | AnonymousParticipant
-  | PhoneParticipant;
-
 /**
  * A signed in user in a Meet call.
  */
 export interface SignedInUser {
   /**
-   * Unique ID of the user which is interoperable with Admin SDK API and People
+   * Unique ID of the user which is interoperable with the Google Admin SDK API and People
    * API.
    */
   readonly user: string;
@@ -152,7 +193,9 @@ export interface PhoneUser {
  * both audio and video tracks and their relationship to Media Entries.
  */
 export interface MeetStreamTrack {
-  /** WebRTC media stream track. */
+  /**
+   * {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack | WebRTC MediaStreamTrack}
+   */
   readonly mediaStreamTrack: MediaStreamTrack;
   /**
    * The media entry associated with this track. This a one to one
@@ -162,57 +205,74 @@ export interface MeetStreamTrack {
 }
 
 /**
- * The dimensions of the canvas.
+ * The dimensions of the canvas for video streams.
  */
 export interface CanvasDimensions {
-  /** Width measured in pixels. This can be changed by the user. */
+  /**
+   * Width measured in pixels. This can be changed by the user.
+   */
   width: number;
-  /** Height measured in pixels. This can be changed by the user. */
+  /**
+   * Height measured in pixels. This can be changed by the user.
+   */
   height: number;
 }
 
 /**
  * A Media layout for the Media Api Web client. This must be created by the
- * Media API client to be valid.
+ * Media API client to be valid. This is used to request a video stream.
  */
 export interface MediaLayout {
-  /** The dimensions of the layout. */
+  /**
+   * The dimensions of the layout.
+   */
   readonly canvasDimensions: CanvasDimensions;
-  /** The media entry associated with this layout. */
+  /**
+   * The media entry associated with this layout.
+   */
   readonly mediaEntry: Subscribable<MediaEntry | undefined>;
 }
 
 /**
- * A request for a MediaLayout. This is required to be able to request a video
- * stream. Can be used to request a presenter, direct or relevant media layout.
+ * A request for a {@link MediaLayout}. This is required to be able to request a video
+ * stream.
  */
-export type MediaLayoutRequest =
-  // Used to request or change the presenter stream if it exists.
-  | {presenter: true; mediaLayout: MediaLayout; mediaEntry?: never}
-  // Used to request a direct media layout. This can be any media entry in the
-  // meeting.
-  | {mediaEntry: MediaEntry; mediaLayout: MediaLayout; presenter?: never}
-  // Used to request a relevant media layout. This is a media layout that
-  // the backend determines is relevant to the user. This could be a current
-  // loudest speaker, presenter, etc.
-  | {mediaLayout: MediaLayout; mediaEntry?: never; presenter?: never};
+export interface MediaLayoutRequest {
+  /**
+   * The {@link MediaLayout} to request.
+   */
+  mediaLayout: MediaLayout;
+}
 
 /**
- * Required configuration for the MeetMediaApiClient.
+ * Required configuration for the {@link MeetMediaApiClient}.
  */
 export interface MeetMediaClientRequiredConfiguration {
+  /**
+   * The meeting space ID to connect to.
+   */
   meetingSpaceId: string;
+  /**
+   * The number of video streams to request.
+   */
   numberOfVideoStreams: number;
-  /* Number of audio streams is not configurable. False maps to 0 and True maps
+  /**
+   * Number of audio streams is not configurable. False maps to 0 and True maps
    * to 3.
    */
   enableAudioStreams: boolean;
+  /**
+   * The access token to use for authentication.
+   */
   accessToken: string;
+  /**
+   * The callback to use for logging events.
+   */
   logsCallback?: (logEvent: LogEvent) => void;
 }
 
 /**
- * List of log source types
+ * List of log source types.
  */
 export type LogSourceType =
   | 'session-control'
@@ -225,9 +285,21 @@ export type LogSourceType =
  * Log event that is propagated to the callback.
  */
 export interface LogEvent {
+  /**
+   * The level of the log event.
+   */
   level: LogLevel;
+  /**
+   * The log string of the event.
+   */
   logString: string;
+  /**
+   * The source type of the event.
+   */
   sourceType: LogSourceType;
+  /**
+   * The relevant object of the event.
+   */
   relevantObject?:
     | Error
     | DeletedResource

web/types/subscribable.d.ts

@@ -19,6 +19,10 @@
  * functions. Only the owner of the class can update the value.
  */
 
+/**
+ * A helper class that can be used to get and subscribe to updates on a
+ * value.
+ */
 export interface Subscribable<T> {
   /**
    * @return the current value.
@@ -28,14 +32,14 @@ export interface Subscribable<T> {
   /**
    * Allows a callback to be added. This callback will be called whenever the
    * value is updated.
-   * @return an unsubscribe function
+   * @return An unsubscribe function.
    */
   subscribe(callback: (value: T) => void): () => void;
 
   /**
    * Removes the callback from the list of subscribers. The original callback
    * instance must be passed in as an argument.
-   * @return true if the callback was removed, false if it was not found.
+   * @return True if the callback was removed, false if it was not found.
    */
   unsubscribe(callback: (value: T) => void): boolean;
 }