1.6.0 update (#24)

CHANGELOG.md

@@ -1,4 +1,23 @@
 ## CHANGELOG
+## v1.6.0
+### Added
+* Pan-Tilt-Zoom (PTZ) camera control and far end camera control: With `stream.requestFarEndCameraControl()` and `stream.approveFarEndCameraControl()` and `stream.controlFarEndCamera` methods and several related events, now you can control the far end camera.
+* Network quality event: now you can listen to the `network-quality-change` event to get the network level of users.
+* Individual cloud recording: now with the JWT payload configured, you can record users in individual recordings.
+* Log report and bug records for development and debugging.
+
+### Enhanced
+* Added `isVideoConnect`  to user properties, it indicates whether there is a camera connected to the device.
+* Add Global user ID, `userGuid`, to user properties. This is a correlated property to share between a main session and subsession.
+* Improve the 720P video rendering on high-performance devices.
+* Add `stream.isRenderSelfViewWithVideoElement()` and `stream.isStartShareScreenWithVideoElement()` methods. Now you no longer need redundant conditional judgments to determine which element to render. The Video SDK simplifies the judgment using these methods.
+* Improved the payload of the `user-removed` event.
+
+### Fixed
+* Video cannot work on iOS Safari with SharedArrayBuffer enabled.
+* Issue with `testSpeaker()` in the second call.
+* Issue with the `stayAwake` function.
+
 ## v1.5.5
 ### Added
 * Support for multi-sharing at the same time. Enable with `stream.setSharePrivilege(SharePrivilege.MultipleShare)`. Use `stream.switchShareView` to switch the share view. 

dist/types/chat.d.ts

@@ -1,27 +1,27 @@
 import { ExecutedResult } from './common';
 
 /**
- * Message record
+ * Message record.
  */
 interface ChatMessage {
   /**
-   * message id,used for delete/modify message
+   * Message ID, used to delete or modify the message.
    */
   id?: string;
   /**
-   * message content
+   * Message content.
    */
   message: string;
   /**
-   * sender
+   * Sender information.
    */
   sender: {
     /**
-     * name
+     * Sender name.
      */
     name: string;
     /**
-     * userId
+     * Sender user ID.
      */
     userId: number;
     /**
@@ -30,20 +30,20 @@ interface ChatMessage {
     avatar?: string;
   };
   /**
-   * receiver
+   * Receiver information.
    */
   receiver: {
     /**
-     * name
+     * Receiver name.
      */
     name: string;
     /**
-     * userId
+     * Receiver user ID.
      */
     userId: number;
   };
   /**
-   * timestamp
+   * Message timestamp.
    */
   timestamp: number;
 }
@@ -53,36 +53,36 @@ interface ChatMessage {
  */
 interface ChatUserItem {
   /**
-   * userId
+   * User ID.
    */
   userId: number;
   /**
-   * display name
+   * Display name.
    */
   displayName: string;
   /**
-   * is host
+   * Whether the user is the host.
    */
   isHost: boolean;
   /**
-   * is manager
+   * Whether the user is a manager.
    */
   isManager: boolean;
 }
 /**
- * Privilege of the chat
+ * Chat privileges for users.
  */
 export declare enum ChatPrivilege {
   /**
-   * Everyone
+   * Everyone can send messages.
    */
   All = 1,
   /**
-   * No one, cannot send message
+   * No one can send messages.
    */
   NoOne = 4,
   /**
-   * Everyone but cannot send private message
+   * Everyone can send public messages, but not private messages.
    */
   EveryonePublicly = 5,
 }
@@ -91,16 +91,16 @@ export declare enum ChatMsgType {
   All = 0,
 }
 /**
- * After joining a session, call client.getChatClient() to get the chat client.
+ * After joining a session, call `client.getChatClient()` to get the chat client.
  *
  * ```javascript
  * const chat = client.getChatClient()
  * ```
  */
 export declare namespace ChatClient {
   /**
-   * To send a chat to a specific participant, call the chat.send() function.
-   * #### example
+   * Sends a chat message to a specific participant.
+   * #### Example
    * ```js
    *  chat.send('test', userId)
    * ```
@@ -109,31 +109,31 @@ export declare namespace ChatClient {
    *
    * @return
    * - `ChatMessage`: success
-   * - `Error`: Failure. Following the details of Error:
-   *     - `IMPROPER_MEETING_STATE`: It works only when user is in meeting
-   *     - `INSUFFICIENT_PRIVILEGES`: chat privilege limited
-   *     - `INVALID_PARAMETERS`: invalid parameter
+   * - `Error`: Failure. Here are the error states and details:
+   *     - `IMPROPER_MEETING_STATE`: Chat works only when the user is in meeting.
+   *     - `INSUFFICIENT_PRIVILEGES`: The user does not have the privilege to send the chat.
+   *     - `INVALID_PARAMETERS`: Issue with the parameter sent.
    */
   function send(text: string, userId: number): Promise<ChatMessage | Error>;
 
   /**
-   * To send a chat to all participants, call the chat.sendToAll() function.
-   * @param text message
+   * Sends a chat message to all participants.
+   * @param text Message to send.
    * @returns ExecutedPromise
    */
   function sendToAll(text: string): Promise<ChatMessage | Error>;
 
   /**
-   * The host or manager can control the chat privilege in the session. Following are the definition of the privilege:
+   * The host or manager can control chat privileges in the session. The following table shows privilege values and descriptions:
    *
    
-   | value                          | description                                            |
-   |--------------------------------|-----------------------------------------------------|
-   | ChatPrivilege.All              | user can chat to everyone                      |
-   | ChatPrivilege.NoOne            | user can chat to no one                         |
-   | ChatPrivilege.EveryonePublicly | user can chat to host, manager and everyone    |
+   | Value                          | Description                                          |
+   |--------------------------------|------------------------------------------------------|
+   | ChatPrivilege.All              | The user can chat to everyone.                       |
+   | ChatPrivilege.NoOne            | The user can chat to no one.                         |
+   | ChatPrivilege.EveryonePublicly | The user can chat to the host, manager, and everyone.|
    *
-   * #### example
+   * #### Example
    *
    * ```js
    * chat.setPrivilege(ChatPrivilege.All)
@@ -146,25 +146,25 @@ export declare namespace ChatClient {
   function setPrivilege(privilege: ChatPrivilege): ExecutedResult;
 
   /**
-   * Get the current chat privilege
-   * #### example
+   * Gets the current chat privilege.
+   * #### Example
    * ```js
    * const privilege = chat.getPrivilege();
    * ```
    * @return
    */
   function getPrivilege(): ChatPrivilege;
   /**
-   * get the history chat list
-   * #### example
+   * Gets the chat list history.
+   * #### Example
    * ```js
    * const historyChatList = chat.getHistory();
    * ```
    * @return
    */
   function getHistory(): Array<ChatMessage>;
   /**
-   * Get available chat receivers list
+   * Gets the list of available chat receivers.
    */
   function getReceivers(): Array<ChatUserItem>;
 }

dist/types/command.d.ts

@@ -1,47 +1,47 @@
 import { ExecutedFailure } from './common';
 /**
- * Command channel message
+ * Command channel message object.
  */
 export interface CommandChannelMsg {
   /**
-   * sender id
+   * Sender ID
    */
   senderId: number;
   /**
-   * sender name
+   * Sender name.
    */
   senderName?: string;
   /**
-   * receiver id, when send to all no receiverId
+   * Receiver ID. When sent to all, there is no `receiverId`.
    */
   receiverId?: number;
   /**
-   * content
+   * Message content.
    */
   text: string;
   /**
-   * timestamp
+   * Timestamp.
    */
   timestamp: number;
   /**
-   * msgid
+   * Message ID.
    */
   msgid?: string;
 }
 /**
- * The CommandChannelClient can be accessed by `getCommandClient` method of the `VideoClient`
+ * Use the `getCommandClient` method for the `VideoClient` to access the command channel client.
  */
 export declare namespace CommandChannel {
   /**
-   * send string text through command channel
-   * #### example only work to VideoSDK
+   * Send string text through command channel.
+   * #### Example
    * ```js
    *  const cmdChannel = client.getCommandClient()
    *  cmdChannel.send('test', userId)
    * ```
    *
-   * @param text
-   * @param userId is not pass userId, will send to all
+   * @param text The text to send.
+   * @param userId User to send to. If you don't pass a `userId`, the SDK sends the message to all users.
    *
    * @return ExecutedResult
    */