1.7.5 update (#27)

CHANGELOG.md

@@ -1,4 +1,21 @@
 ## CHANGELOG
+## v1.7.5
+### Added
+*  liveTranscriptionClient.disableCaptions method to allow hosts to disable captions in a session.
+*  stream.getCurrentSessionCallinInfo method to retrieve call-in info when the PSTN plan is available.
+
+### Enhanced
+*  Noise suppression support by adding a backgroundNoiseSuppression option to the stream.startAudio method, and a new stream.enableBackgroundNoiseSuppression method.
+*  stream.startAudio method with a syncButtonsOnHeadset option to support mute state sync'ing with specific audio devices.
+*  stream.startAudio method with a mute option to automatically mute users upon joining audio.
+*  Phone user payload with a phoneNumber attribute on the side of caller.
+*  Share Tab Audio such that it can now also support using a microphone simultaneously.
+
+### Fixed
+*  A/V sync issues when enabling "Optimize for Video Clip".
+*  stream.updateSharingCanvasDimension not working on certain browsers.
+*  Promise returned from stream.switchCamera method not resolving properly.
+
 ## v1.7.0
 ### Added
 * checkFeatureRequirements API to check browser compatibility with supported features.

dist/types/common.d.ts

@@ -60,7 +60,7 @@ interface Participant {
   audio: '' | 'computer' | 'phone';
   /**
    * Whether audio is muted.
-   * If the user is not joined the audio(not connected to the microphone), the value is undefined
+   * If the user is not joined to audio (not connected to the microphone), the value is undefined
    */
   muted?: boolean;
   /**
@@ -117,13 +117,18 @@ interface Participant {
    */
   isVideoConnect: boolean;
   /**
-   * customized user identity
+   * The `user_identity` from the JWT payload.
    */
   userIdentity?: string;
   /**
    * Whether the user is only connected to the speaker, not the microphone
    */
   isSpeakerOnly?: boolean;
+  /**
+   * The phone number if the user is call out user
+   * For the privacy concern, only the calling user has the property.
+   */
+  phoneNumber?: string;
 }
 /**
  * Subsession's status.

dist/types/event-callback.d.ts

@@ -72,11 +72,11 @@ export interface ParticipantPropertiesPayload {
    */
   bShareToSubsession?: boolean;
   /**
-   *  Whether the user is phone call user.
+   *  Whether the user joined via a phone call.
    */
   isPhoneUser?: boolean;
   /**
-   * The unified ID of a user among the main session or subsessions.
+   * The unified ID of a user within the main session or subsessions.
    */
   userGuid?: string;
   /**
@@ -88,13 +88,23 @@ export interface ParticipantPropertiesPayload {
    */
   isVideoConnect?: boolean;
   /**
-   * Customized user identity
+   * The `user_identity` from the JWT payload, not the in-session user ID.
    */
   userIdentity?: string;
   /**
    * Whether the user is only connected to the speaker, not the microphone
    */
   isSpeakerOnly?: boolean;
+  /**
+   * The phone number if the user is call out user
+   * For the privacy concern, only the calling user has the property.
+   */
+  phoneNumber?: string;
+  /**
+   * Subsession ID.
+   * It's available if the user is in a subsession.
+   */
+  subsessionId?: string;
 }
 /**
  * The session's connection state.
@@ -1219,19 +1229,19 @@ export declare function event_network_quality_change(payload: {
   level: number;
 }): void;
 /**
- * Occurs when decode (recevied) or encode (sent) the share statistics data is changed
+ * Occurs when the share statistics data is changed during decoding (receipt) or encoding (sent)
  * @param payload the event detail
  * - `data`
- *  - `encoding`: if encoding is true, means that the data is encoding video data statisitics.
+ *  - `encoding`: if encoding is true, means that the data is encoding video data statistics.
  *  - `avg_loss`: average package loss for video
  *  - `jitter`: jitter for video
  *  - `max_loss`: max package loss for video
- *  - `rtt`: round trip time for video .
+ *  - `rtt`: round trip time for video
  *  - `sample_rate`: sample rate video
  *  - `width`: width for video
  *  - `height`: height for video
- *  - `fps`: fps for video
- * - `type` : string share
+ *  - `fps`: Frames per second (FPS) for video
+ * - `type` : string "VIDEOSHARE_QOS_DATA"
  *
  * ```javascript
  * client.on('share_statistic_data_change', (payload) => {
@@ -1242,7 +1252,7 @@ export declare function event_network_quality_change(payload: {
  */
 export declare function event_share_statistic_data_change(payload: {
   /**
-   * Data.
+   * Quality of Service (QoS) data.
    */
   data: {
     /**
@@ -1278,9 +1288,16 @@ export declare function event_share_statistic_data_change(payload: {
      */
     height: number;
     /**
-     * Share's frame rate in frames per second (fps).
+     * Share's frame rate in frames per second (FPS).
      */
     fps: number;
   };
   type: 'VIDEOSHARE_QOS_DATA';
 }): void;
+/**
+ * Occurs when host disable caption
+ * @param payload boolean
+ *
+ * @event
+ */
+export declare function event_caption_host_disable(payload: boolean): void;

dist/types/live-transcription.d.ts

@@ -459,4 +459,10 @@ export declare namespace LiveTranscriptionClient {
   function getFullTranscriptionHistory():
     | Array<LiveTranscriptionMessage>
     | Promise<Array<LiveTranscriptionMessage>>;
+  /**
+   * Disable/enable the captions in meeting.
+   * 
+   * @param disable Boolean, true to disable the captions, false to enable the captions.
+   */
+    function disableCaptions(disable:boolean): ExecutedResult;
 }