Remove ready() from end user and use it internally

Author: golgetahir

packages/webrtc-sdk/README.md

@@ -140,10 +140,12 @@ Open `docs/index.html` in a browser.
 - `MediaManager`: handles local media (getUserMedia, device switching, screen share).
 
 For most applications, call methods on `WebRTCClient` only. It exposes the common
-operations you need: `ready()`, `join()`, `publish()`, `play()`, `stop()`, `listDevices()`,
+operations you need: `join()`, `publish()`, `play()`, `stop()`, `listDevices()`,
 `selectVideoInput()`, `selectAudioInput()`, `startScreenShare()`, `stopScreenShare()`,
 `sendData()`, `enableStats()/disableStats()`, room/multitrack helpers, and emits typed events.
 
+Note: Methods internally wait for signaling readiness; you don't need to call `ready()` yourself.
+
 Only use `WebSocketAdaptor` or `MediaManager` directly if you have advanced
 customization needs (e.g., custom signaling transport or bespoke media capture).
 Otherwise, prefer the higher-level `WebRTCClient` methods.

packages/webrtc-sdk/examples/play.html

@@ -117,7 +117,6 @@ <h2>Play Sample (TS v2)</h2>
         const id = streamIdEl.value.trim();
         if (!id) { log('enter stream id'); return; }
         try {
-          await adaptor.ready();
           await adaptor.join({ role: 'viewer', streamId: id, token: tokenEl.value.trim() || undefined, timeoutMs: 20000 });
           currentId = id;
         } catch (e) {

packages/webrtc-sdk/examples/publish.html

@@ -176,7 +176,6 @@ <h2>Publish Sample (TS v2)</h2>
       startBtn.onclick = async () => {
         const id = streamIdEl.value || 'stream_' + generateRandomString(6);
         try {
-          await adaptor.ready();
           await adaptor.join({ role: 'publisher', streamId: id, token: tokenEl.value.trim() || undefined, timeoutMs: 20000 });
           currentId = id;
           startShareBtn.disabled = false;

packages/webrtc-sdk/src/core/media-manager.ts

@@ -102,7 +102,10 @@ export class MediaManager extends Emitter<EventMap> {
     return grouped;
   }
 
-  /** Re-acquire default devices and replace local tracks; emits device_hotswapped. */
+  /**
+   * Re-acquire default input devices when `devicechange` fires and replace local tracks in-place.
+   * Emits `device_hotswapped` with the swapped kind. Does nothing if user explicitly selected devices.
+   */
   private async handleDeviceHotSwap(): Promise<void> {
     try {
       const prevVideoId = this.selectedVideoInputId;

packages/webrtc-sdk/src/core/webrtc-client.ts

@@ -762,7 +762,10 @@ export class WebRTCClient extends Emitter<EventMap> {
     return this.media.listDevices();
   }
 
-  /** Set audio output device for a media element (or local preview by default). */
+  /**
+   * Set audio output device (sinkId) for a media element (or local preview by default).
+   * If the browser does not support sinkId, an `error` event with code `set_sink_id_unsupported` is emitted.
+   */
   async setAudioOutput(deviceId: string, element?: HTMLMediaElement | null): Promise<void> {
     await this.media.setAudioOutput(deviceId, element);
   }
@@ -860,7 +863,8 @@ export class WebRTCClient extends Emitter<EventMap> {
    * sdk.enableTrack('mainStreamId', 'camera_user3', true);
    * ```
    */
-  enableTrack(mainTrackId: string, trackId: string, enabled: boolean): void {
+  async enableTrack(mainTrackId: string, trackId: string, enabled: boolean): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     const jsCmd = {
       command: "enableTrack",
@@ -879,7 +883,8 @@ export class WebRTCClient extends Emitter<EventMap> {
    * sdk.forceStreamQuality('mainStreamId', 720); // or 'auto'
    * ```
    */
-  forceStreamQuality(streamId: string, height: number | "auto"): void {
+  async forceStreamQuality(streamId: string, height: number | "auto"): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     const jsCmd = {
       command: "forceStreamQuality",
@@ -1296,49 +1301,57 @@ export class WebRTCClient extends Emitter<EventMap> {
   }
 
   /** Request stream info; listen on 'notification:streamInformation' or stream_information. */
-  getStreamInfo(streamId: string): void {
+  async getStreamInfo(streamId: string): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     this.ws.send(JSON.stringify({ command: "getStreamInfo", streamId }));
   }
 
   /** Request broadcast object; listen on 'notification:broadcastObject' or broadcast_object. */
-  getBroadcastObject(streamId: string): void {
+  async getBroadcastObject(streamId: string): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     this.ws.send(JSON.stringify({ command: "getBroadcastObject", streamId }));
   }
 
   /** Request room info of roomId; optionally include streamId for context. */
-  getRoomInfo(roomId: string, streamId = ""): void {
+  async getRoomInfo(roomId: string, streamId = ""): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     this.ws.send(JSON.stringify({ command: "getRoomInfo", room: roomId, streamId }));
   }
 
   /** Request track list under a main stream. */
-  getTracks(streamId: string, token = ""): void {
+  async getTracks(streamId: string, token = ""): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     this.ws.send(JSON.stringify({ command: "getTrackList", streamId, token }));
   }
 
   /** Request subtracks for a main stream with optional paging and role filter. */
-  getSubtracks(streamId: string, role = "", offset = 0, size = 50): void {
+  async getSubtracks(streamId: string, role = "", offset = 0, size = 50): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     this.ws.send(JSON.stringify({ command: "getSubtracks", streamId, role, offset, size }));
   }
 
   /** Request subtrack count for a main stream with optional role/status. */
-  getSubtrackCount(streamId: string, role = "", status = ""): void {
+  async getSubtrackCount(streamId: string, role = "", status = ""): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     this.ws.send(JSON.stringify({ command: "getSubtracksCount", streamId, role, status }));
   }
 
   /** Request current subscriber count; listen on subscriber_count. */
-  getSubscriberCount(streamId: string): void {
+  async getSubscriberCount(streamId: string): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     this.ws.send(JSON.stringify({ command: "getSubscriberCount", streamId }));
   }
 
   /** Request current subscriber list; listen on subscriber_list. */
-  getSubscriberList(streamId: string, offset = 0, size = 50): void {
+  async getSubscriberList(streamId: string, offset = 0, size = 50): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     this.ws.send(JSON.stringify({ command: "getSubscribers", streamId, offset, size }));
   }
@@ -1416,7 +1429,8 @@ export class WebRTCClient extends Emitter<EventMap> {
   }
 
   /** Request video track assignments list for a main stream. */
-  requestVideoTrackAssignments(streamId: string): void {
+  async requestVideoTrackAssignments(streamId: string): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     this.ws.send(JSON.stringify({ command: "getVideoTrackAssignmentsCommand", streamId }));
   }
@@ -1453,7 +1467,10 @@ export class WebRTCClient extends Emitter<EventMap> {
    * sdk.updateVideoTrackAssignments({ streamId: 'main', offset: 20, size: 10 });
    * ```
    */
-  updateVideoTrackAssignments(opts: import("./types.js").UpdateVideoTrackAssignmentsOptions): void {
+  async updateVideoTrackAssignments(
+    opts: import("./types.js").UpdateVideoTrackAssignmentsOptions
+  ): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     this.ws.send(
       JSON.stringify({
@@ -1473,7 +1490,8 @@ export class WebRTCClient extends Emitter<EventMap> {
    * sdk.setMaxVideoTrackCount('mainStreamId', 9);
    * ```
    */
-  setMaxVideoTrackCount(streamId: string, maxTrackCount: number): void {
+  async setMaxVideoTrackCount(streamId: string, maxTrackCount: number): Promise<void> {
+    await this.ready();
     if (!this.ws) return;
     this.ws.send(
       JSON.stringify({