chore: reorganize client. Move communication protocol and client interface to types. Move client impl to internals

PiperOrigin-RevId: 723245531

Author: koumiGoogle

web/BUILD

@@ -65,3 +65,24 @@ ts_library(
         "@media_api_samples//web/types:mediacapture_transform",
     ],
 )
+
+ts_library(
+    name = "meetmediaapiclient_impl",
+    srcs = [
+        "meetmediaapiclient_impl.ts",
+    ],
+    deps = [
+        ":internal_meet_stream_track_impl",
+        ":internal_types",
+        ":meet_stream_track_impl",
+        ":subscribable_impl",
+        "@media_api_samples//web/internal/channel_handlers",
+        "@media_api_samples//web/internal/communication_protocols:default_communication_protocol",
+        "@media_api_samples//web/types:communication_protocol_interface",
+        "@media_api_samples//web/types:datachannels",
+        "@media_api_samples//web/types:enums",
+        "@media_api_samples//web/types:media_types",
+        "@media_api_samples//web/types:meetmediaapiclient_interface",
+        "@media_api_samples//web/types:subcribable",
+    ],
+)

web/internal/BUILD

@@ -18,16 +18,11 @@ package(default_visibility = [
     "@media_api_samples//web:__subpackages__",
 ])
 
-ts_library(
-    name = "communication_protocol_interface",
-    srcs = ["communication_protocol.ts"],
-)
-
 ts_library(
     name = "default_communication_protocol",
     srcs = ["default_communication_protocol_impl.ts"],
     deps = [
-        ":communication_protocol_interface",
+        "@media_api_samples//web/types:communication_protocol_interface",
         "@media_api_samples//web/types:media_types",
     ],
 )

web/internal/communication_protocols/BUILD

@@ -24,7 +24,7 @@ import {MeetMediaClientRequiredConfiguration} from '../../types/mediatypes';
 import {
   MediaApiCommunicationProtocol,
   MediaApiCommunicationResponse,
-} from './communication_protocol';
+} from '../../types/communication_protocol';
 
 const MEET_API_URL = 'https://meet.googleapis.com/v2beta/';
 

web/internal/communication_protocols/default_communication_protocol_impl.ts

@@ -14,32 +14,12 @@
  * limitations under the License.
  */
 
-import {ChannelLogger} from './internal/channel_handlers/channel_logger';
-import {MediaEntriesChannelHandler} from './internal/channel_handlers/media_entries_channel_handler';
-import {MediaStatsChannelHandler} from './internal/channel_handlers/media_stats_channel_handler';
-import {ParticipantsChannelHandler} from './internal/channel_handlers/participants_channel_handler';
-import {SessionControlChannelHandler} from './internal/channel_handlers/session_control_channel_handler';
-import {VideoAssignmentChannelHandler} from './internal/channel_handlers/video_assignment_channel_handler';
 import {
   MediaApiCommunicationProtocol,
   MediaApiCommunicationResponse,
-} from './internal/communication_protocols/communication_protocol';
-import {DefaultCommunicationProtocolImpl} from './internal/communication_protocols/default_communication_protocol_impl';
-import {InternalMeetStreamTrackImpl} from './internal/internal_meet_stream_track_impl';
-import {
-  InternalMediaEntry,
-  InternalMediaLayout,
-  InternalMeetStreamTrack,
-  InternalParticipant,
-} from './internal/internal_types';
-import {MeetStreamTrackImpl} from './internal/meet_stream_track_impl';
-import {
-  SubscribableDelegate,
-  SubscribableImpl,
-} from './internal/subscribable_impl';
-import {MeetMediaApiClient} from './meetmediaapiclient';
-import {MediaApiResponseStatus} from './types/datachannels';
-import {MeetSessionStatus} from './types/enums';
+} from '../types/communication_protocol';
+import {MediaApiResponseStatus} from '../types/datachannels';
+import {MeetSessionStatus} from '../types/enums';
 import {
   CanvasDimensions,
   MediaEntry,
@@ -48,8 +28,25 @@ import {
   MeetMediaClientRequiredConfiguration,
   MeetStreamTrack,
   Participant,
-} from './types/mediatypes';
-import {Subscribable} from './types/subscribable';
+} from '../types/mediatypes';
+import {MeetMediaApiClient} from '../types/meetmediaapiclient';
+import {Subscribable} from '../types/subscribable';
+import {ChannelLogger} from './channel_handlers/channel_logger';
+import {MediaEntriesChannelHandler} from './channel_handlers/media_entries_channel_handler';
+import {MediaStatsChannelHandler} from './channel_handlers/media_stats_channel_handler';
+import {ParticipantsChannelHandler} from './channel_handlers/participants_channel_handler';
+import {SessionControlChannelHandler} from './channel_handlers/session_control_channel_handler';
+import {VideoAssignmentChannelHandler} from './channel_handlers/video_assignment_channel_handler';
+import {DefaultCommunicationProtocolImpl} from './communication_protocols/default_communication_protocol_impl';
+import {InternalMeetStreamTrackImpl} from './internal_meet_stream_track_impl';
+import {
+  InternalMediaEntry,
+  InternalMediaLayout,
+  InternalMeetStreamTrack,
+  InternalParticipant,
+} from './internal_types';
+import {MeetStreamTrackImpl} from './meet_stream_track_impl';
+import {SubscribableDelegate, SubscribableImpl} from './subscribable_impl';
 
 // Meet only supports 3 audio virtual ssrcs. If disabled, there will be no
 // audio.

web/meetmediaapiclient_impl.ts web/internal/meetmediaapiclient_impl.tsweb/meetmediaapiclient_impl.ts renamed to web/internal/meetmediaapiclient_impl.ts

@@ -28,7 +28,7 @@ ts_library(
     name = "script",
     srcs = ["script.ts"],
     deps = [
-        "@media_api_samples//web:meetmediaapiclient_impl",
+        "@media_api_samples//web/internal:meetmediaapiclient_impl",
         "@media_api_samples//web/types:enums",
         "@media_api_samples//web/types:media_types",
     ],

web/samples/BUILD

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import {MeetMediaApiClientImpl} from '../meetmediaapiclient_impl';
+import {MeetMediaApiClientImpl} from '../internal/meetmediaapiclient_impl';
 import {MeetSessionStatus} from '../types/enums';
 import {MeetStreamTrack} from '../types/mediatypes';
 

web/samples/script.ts

@@ -48,3 +48,20 @@ ts_library(
     name = "mediacapture_transform",
     srcs = ["mediacapture_transform.d.ts"],
 )
+
+ts_library(
+    name = "communication_protocol_interface",
+    srcs = ["communication_protocol.d.ts"],
+)
+
+ts_library(
+    name = "meetmediaapiclient_interface",
+    srcs = ["meetmediaapiclient.d.ts"],
+    deps = [
+        ":communication_protocol_interface",
+        ":datachannels",
+        ":enums",
+        ":media_types",
+        ":subcribable",
+    ],
+)

web/types/BUILD

@@ -22,6 +22,11 @@
  * An abstract communication protocol.
  */
 export interface MediaApiCommunicationProtocol {
+  /**
+   * Connects to the active conference with the given SDP offer.
+   * @param sdpOffer The SDP offer to connect to the active conference.
+   * @return A promise that resolves to the communication response.
+   */
   connectActiveConference(
     sdpOffer: string,
   ): Promise<MediaApiCommunicationResponse>;
@@ -31,5 +36,8 @@ export interface MediaApiCommunicationProtocol {
  * The response from the communication protocol.
  */
 export declare interface MediaApiCommunicationResponse {
+  /**
+   * The WebRTC answer to the offer. Format is SDP.
+   */
   answer: string;
 }

…tion_protocols/communication_protocol.ts web/types/communication_protocol.d.tsweb/internal/communication_protocols/communication_protocol.ts renamed to web/types/communication_protocol.d.ts web/internal/communication_protocols/communication_protocol.ts renamed to web/types/communication_protocol.d.ts

@@ -18,36 +18,72 @@
  * @fileoverview interface for MeetMediaApiClient.
  */
 
-import {MediaApiCommunicationProtocol} from './internal/communication_protocols/communication_protocol';
-import {MediaApiResponseStatus} from './types/datachannels';
-import {MeetSessionStatus} from './types/enums';
+import {MediaApiCommunicationProtocol} from './communication_protocol';
+import {MediaApiResponseStatus} from './datachannels';
+import {MeetSessionStatus} from './enums';
 import {
   CanvasDimensions,
   MediaEntry,
   MediaLayout,
   MediaLayoutRequest,
   MeetStreamTrack,
   Participant,
-} from './types/mediatypes';
-import {Subscribable} from './types/subscribable';
+} from './mediatypes';
+import {Subscribable} from './subscribable';
 
 /**
- * Interface for the MeetMediaApiClient.
+ * Interface for the MeetMediaApiClient. Takes a required configuration
+ * and provides a set of subscribables to the client.
+ * Takes a {@link MeetMediaClientRequiredConfiguration} as a constructor
+ * parameter.
  */
 export interface MeetMediaApiClient {
+  /**
+   * The status of the session. Subscribable to changes in the session status.
+   */
   readonly sessionStatus: Subscribable<MeetSessionStatus>;
+  /**
+   * The meet stream tracks in the meeting. Subscribable to changes in the meet
+   * stream track collection.
+   */
   readonly meetStreamTracks: Subscribable<MeetStreamTrack[]>;
+  /**
+   * The media entries in the meeting. Subscribable to changes in the media
+   * entry collection.
+   */
   readonly mediaEntries: Subscribable<MediaEntry[]>;
+  /**
+   * The participants in the meeting. Subscribable to changes in the
+   * participant collection.
+   */
   readonly participants: Subscribable<Participant[]>;
+  /**
+   * The presenter in the meeting. Subscribable to changes in the presenter.
+   */
   readonly presenter: Subscribable<MediaEntry | undefined>;
+  /**
+   * The screenshare in the meeting. Subscribable to changes in the screenshare.
+   */
   readonly screenshare: Subscribable<MediaEntry[] | undefined>;
 
+  /**
+   * Joins the meeting.
+   * @param communicationProtocol The communication protocol to use. If not
+   *     provided, a default {@link MediaApiCommunicationProtocol} will be used.
+   */
   joinMeeting(
     communicationProtocol?: MediaApiCommunicationProtocol,
   ): Promise<void>;
+
+  /**
+   * Leaves the meeting.
+   */
   leaveMeeting(): Promise<void>;
 
   /**
+   * Applies the given media layout requests. This is required to be able to
+   * request a video stream. Only accepts media layouts that have been
+   * created with the {@link createMediaLayout} function.
    * @param requests The requests to apply.
    * @return A promise that resolves when the request has been accepted. NOTE:
    *     The promise resolving on the request does not mean the layout has been
@@ -58,11 +94,11 @@ export interface MeetMediaApiClient {
 
   /**
    * Creates a new media layout. Only media layouts that are created with this
-   * function can be applied. Otherwise, the applyLayout function will throw an
-   * error. Once the media layout has been created, you can construct a request
-   * and apply it with the applyLayout function. These media layout objects are
-   * meant to be reused (can be reassigned to a different request) but are
-   * distinct per stream (need to be created for each stream).
+   * function can be applied. Otherwise, the {@link applyLayout} function will
+   * throw an error. Once the media layout has been created, you can construct a
+   * request and apply it with the {@link applyLayout} function. These media
+   * layout objects are meant to be reused (can be reassigned to a different
+   * request) but are distinct per stream (need to be created for each stream).
    * @param canvasDimensions The dimensions of the canvas to render the layout
    *     on.
    * @return The new media layout.