@signalwire/js 3.6.0-dev.202111170816.f436d5f.0 → 3.7.0

package/src/RoomSession.docs.ts

@@ -71,6 +71,12 @@ export interface RoomSessionDocs<T>
   /** Contains any local screen shares added to the room via {@link startScreenShare}. */
   readonly screenShareList: RoomSessionScreenShare[]
 
+  /**
+   * If the Room has been created with the property `enable_room_previews` set
+   * to `true`, this field contains the URL to the room preview.
+   */
+  readonly previewUrl?: string
+
   /**
    * Joins the room session.
    */
@@ -280,9 +286,10 @@ interface RoomSessionConstructorDocs<T> {
    * Creates a new RoomSession.
    */
   new (opts: {
-    /** SignalWire project id, e.g. `a10d8a9f-2166-4e82-56ff-118bc3a4840f` */
-    project?: string
-    /** SignalWire project token, e.g. `PT9e5660c101cd140a1c93a0197640a369cf5f16975a0079c9` */
+    /**
+     * SignalWire video room token (get one from the [REST
+     * APIs](https://developer.signalwire.com/apis/reference/create_room_token))
+     */
     token: string
     /** logging level */
     logLevel?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent'
@@ -333,7 +340,7 @@ interface RoomMemberMethodsInterfaceDocs {
    * await room.audioMute({memberId: id})
    * ```
    */
-  audioMute(params: { memberId?: string }): Promise<void>
+  audioMute(params?: { memberId?: string }): Promise<void>
 
   /**
    * Unmutes the microphone if it had been previously muted. You can use this
@@ -361,7 +368,7 @@ interface RoomMemberMethodsInterfaceDocs {
    * await room.audioUnmute({memberId: id})
    * ```
    */
-  audioUnmute(params: { memberId?: string }): Promise<void>
+  audioUnmute(params?: { memberId?: string }): Promise<void>
 
   /**
    * Puts the video on mute. Participants will see a mute image instead of the
@@ -390,7 +397,7 @@ interface RoomMemberMethodsInterfaceDocs {
    * await room.videoMute({memberId: id})
    * ```
    */
-  videoMute(params: { memberId?: string }): Promise<void>
+  videoMute(params?: { memberId?: string }): Promise<void>
 
   /**
    * Unmutes the video if it had been previously muted. Participants will
@@ -419,7 +426,7 @@ interface RoomMemberMethodsInterfaceDocs {
    * await room.videoUnmute({memberId: id})
    * ```
    */
-  videoUnmute(params: { memberId?: string }): Promise<void>
+  videoUnmute(params?: { memberId?: string }): Promise<void>
 
   /**
    * Sets the input volume level (e.g. for the microphone). You can use this
@@ -577,7 +584,7 @@ interface RoomControlMethodsInterfaceDocs {
    * await room.deaf({memberId: id})
    * ```
    */
-  deaf(params: { memberId?: string }): Promise<void>
+  deaf(params?: { memberId?: string }): Promise<void>
 
   /**
    * Unmutes the incoming audio. The affected participant will start hearing
@@ -611,7 +618,7 @@ interface RoomControlMethodsInterfaceDocs {
    * await room.undeaf({memberId: id})
    * ```
    */
-  undeaf(params: { memberId?: string }): Promise<void>
+  undeaf(params?: { memberId?: string }): Promise<void>
 
   /**
    * Sets the output volume level (e.g., for the speaker). You can use this
@@ -620,7 +627,7 @@ interface RoomControlMethodsInterfaceDocs {
    * @param params
    * @param params.memberId id of the member to affect. If omitted, affects the
    * default device in the local client.
-   * @param params.value desired volume. Values range from -50 to 50, with a
+   * @param params.volume desired volume. Values range from -50 to 50, with a
    * default of 0.
    *
    * @permissions
@@ -1149,6 +1156,8 @@ export interface RoomSessionEvents {
    * A playback has been started. You only receive this event if your token has
    * the `room.playback` permission. The event handler receives a
    * {@link RoomSessionPlayback} object.
+   *
+   * @event
    */
   'playback.started': undefined
 
@@ -1156,6 +1165,8 @@ export interface RoomSessionEvents {
    * A playback has been updated. You only receive this event if your token has
    * the `room.playback` permission. The event handler receives a
    * {@link RoomSessionPlayback} object.
+   *
+   * @event
    */
   'playback.updated': undefined
 
@@ -1163,6 +1174,8 @@ export interface RoomSessionEvents {
    * A playback has ended. You only receive this event if your token has
    * the `room.playback` permission. The event handler receives a
    * {@link RoomSessionPlayback} object.
+   *
+   * @event
    */
   'playback.ended': undefined
 }

package/src/RoomSessionDevice.docs.ts

@@ -11,6 +11,9 @@ export interface RoomSessionDeviceDocs
   /** Detaches this device from the room session. */
   leave(): Promise<void>
 
+  /** @ignore */
+  readonly previewUrl?: string
+
   /**
    * Replaces the current camera stream with the one coming from a different
    * device.

package/src/RoomSessionScreenShare.docs.ts

@@ -11,6 +11,9 @@ export interface RoomSessionScreenShareDocs
   /** Detaches this device from the room session. */
   leave(): Promise<void>
 
+  /** @ignore */
+  readonly previewUrl?: string
+
   /**
    * Replaces the current camera stream with the one coming from a different
    * device.