1.2.0 update (#12)

CHANGELOG.md

@@ -1,5 +1,21 @@
 ## CHANGELOG
 
+## v1.2.0
+
+### Added:
+* Support for [Cloud Recording](https://marketplace.zoom.us/docs/sdk/video/web/essential/recording)
+* Limited support for [720p video send](https://marketplace.zoom.us/docs/sdk/overview/720p)
+* Support for call out
+* Support for command channel / real-time data
+* Improved role management
+  * *The user who created a session is considered the "original host". The original host has the following privileges: the session ends after a configurable timeout after the original host leaves a session, if a new host was not assigned. When the original host rejoins the same session later, if nobody was assigned as the new host by the original host before they left the session, the original host can claim the 'host' role, based on its user_identity setting in the JWT payload. The original host can take the host role at any time from the current host. See user_identity and role_type in [Authentication](https://marketplace.zoom.us/docs/sdk/video/auth) for details.*
+* Interface to disable session timeout
+  * *Previously, the Video SDK session would end after being idle for 48 hours. This interface enables you to choose to disable the timeout and allow the participants to be idle for an unlimited period of time. The new parameter is an unsigned int sessionIdleTimeoutMins. The default value is 40 minutes.*
+
+### Fixed:
+* chatClient.getHistory() method was not exposed
+* makeManager, revokeManager, and isManager are not available as co-hosts are not supported by the Web Video SDK. These have been removed from the documentation as well
+
 ## v1.1.7
 
 ### Added:

dist/types/chat.d.ts

@@ -30,27 +30,16 @@ export declare enum ChatMsgType {
   All = 0,
 }
 /**
- * The chat interface provides the methods define the chat behavior
- *
- * The chat object can be accessed by `getFeatureModule` method of a `ZoomMeeting` instance.
+ * The chat client provides the methods define the chat behavior
  *  ```js
- * const client = ZoomMeeting.createClient();
- * client.init(
- *  sdkKey,
- *  makeSignature(),
- *  ...,
- *  ['chat'], // to enable chat interface
- * );
- * client.join(meetingNumber, 'test', '', '[email protected]')
+ * const client = ZoomVideo.createClient();
+ *
  * ```
  *
- * after joining meeting success, chat interface is available
+ * After joining meeting success, chat client is available
  *
  * ```js
- * const chat = client.getFeatureModule('chat');
- * if (chat) {
- *  chat.getHistory(); // chat methods can be used now
- * }
+ * const chat = client.getChatClient();
  * // start to receive chat message
  * client.on('chat-on-message', (v) => {
  *  console.log(v);
@@ -66,8 +55,7 @@ export declare namespace ChatClient {
    *  chat.sendMessage('test', userId)
    *  .then(() => {
    *      // success
-   *  })
-   *     .catch(v => {
+   *  }).catch(v => {
    *      // fail
    *      console.log(v)
    *  })
@@ -92,14 +80,14 @@ export declare namespace ChatClient {
   function sendToAll(text: string): Promise<ChatMessage | Error>;
 
   /**
-   * host or co-Host use it to change chat privilege which defines what kind of role of user that attendee can talk to, there are the different privilege as following.
+   * host or manager use it to change chat privilege which defines what kind of role of user that user can chat to, there are the different privilege as following.
    *
    
    |         | privilege value                | describe                                            |
    |---------|--------------------------------|-----------------------------------------------------|
-   | meeting | ChatPrivilege.All              | attendee can talk to everyone                      |
-   |         | ChatPrivilege.NoOne            | attendee can talk to no one                         |
-   |         | ChatPrivilege.EveryonePublicly | attendee can talk to host, manager and everyone    |
+   | meeting | 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    |
    *
    * #### example
    *

dist/types/command.d.ts

@@ -0,0 +1,54 @@
+import { ExecutedFailure } from './common';
+export interface CommandChannelMsg {
+  /**
+   * sender id
+   */
+  senderId: number;
+  /**
+   * sender name
+   */
+  senderName?: string;
+  /**
+   * receiver id, when send to all no receiverId
+   */
+  receiverId?: number;
+  /**
+   * content
+   */
+  text: string;
+  /**
+   * timestamp
+   */
+  timestamp: number;
+  /**
+   * msgid
+   */
+  msgid?: string;
+}
+
+export declare namespace CommandChannel {
+  /**
+   * send string text through command channel
+   * #### example only work to VideoSDK
+   * ```js
+   *  const cmdChannel = client.getCommandClient()
+   *  cmdChannel.send('test', userId)
+   *  .then(() => {
+   *      // success
+   *  })
+   *     .catch(v => {
+   *      // fail
+   *      console.log(v)
+   *  })
+   * ```
+   *
+   * @param text
+   * @param userId is not pass userId, will send to all
+   *
+   * @return ExecutedResult
+   */
+  function send(
+    text: string,
+    userId?: number,
+  ): Promise<ExecutedFailure | CommandChannelMsg>;
+}

dist/types/common.d.ts

@@ -29,6 +29,101 @@ interface ExecutedFailure {
  * - ExecutedFailure: Failure. Use `.catch(error=>{})` or `try{ *your code* }catch(error){}` to handle the errors.
  */
 export type ExecutedResult = Promise<'' | ExecutedFailure>;
+
 /**
- * Interface for the additional configuration of initialization.
+ * The state of dial out state
+ *
+ * Normal process: Calling-> Ringing->Accepted->Success
+ *
+ * Busy process: Calling->Busy
  */
+export enum DialoutState {
+  /**
+   * Calling
+   */
+  Calling = 1,
+  /**
+   * Ringing
+   */
+  Ringing = 2,
+  /**
+   * Accepted the call
+   */
+  Accepted = 3,
+  /**
+   * Busy
+   */
+  Busy = 4,
+  /**
+   * Service unavailable
+   */
+  NotAvailable = 5,
+  /**
+   * Hang up the call
+   */
+  HangUp = 6,
+  /**
+   * Fail
+   */
+  Fail = 7,
+  /**
+   * Success
+   */
+  Success = 8,
+  /**
+   * Timeout
+   */
+  Timeout = 9,
+  /**
+   * Canceling the call
+   */
+  Canceling = 10,
+  /**
+   * Canceled the call
+   */
+  Canceled = 11,
+  /**
+   * Cancel the call failed
+   */
+  CancelFailed = 12,
+}
+
+/**
+ * Payload audio muted source type for current-audio-change event
+ */
+export enum MutedSource {
+  /**
+   * User actively muted
+   */
+  Active = 'active',
+  /**
+   * The host muted you
+   */
+  PassiveByMuteOne = 'passive(mute one)',
+  /**
+   * The host muted all
+   */
+  PassiveByMuteAll = 'passive(mute all)',
+}
+
+/**
+ * Payload for action type of current audio change
+ */
+export enum AudioChangeAction {
+  /**
+   * Join the audio
+   */
+  Join = 'join',
+  /**
+   * Leave the audio
+   */
+  Leave = 'leave',
+  /**
+   * Muted
+   */
+  Muted = 'muted',
+  /**
+   * Unmuted
+   */
+  Unmuted = 'unmuted',
+}

dist/types/event-callback.d.ts

@@ -1,5 +1,7 @@
+import { RecordingStatus } from './recording';
 import { SharePrivilege } from './media';
 import { ChatMessage, ChatPrivilege } from './chat';
+import { DialoutState } from './common';
 /**
  * The State of Meeting connection.
  */
@@ -356,6 +358,36 @@ export declare function event_chat_privilege_change(payload: {
   chatPrivilege: ChatPrivilege;
 }): void;
 
+/**
+ * Occurs when the command channel status changed
+ * @param payload
+ *```javascript
+ * client.on('command-channel-status',payload=>{
+ *  console.log('from %s, message:%s',payload);
+ * })
+ * ```
+ * @event
+ */
+export declare function event_command_channel_status(payload: any): void;
+
+/**
+ * Occurs when command channel receive msg
+ * @param payload the event detail
+ * ```javascript
+ * client.on('command-channel-message',payload=>{
+ *  console.log('from %s, message:%s',payload.senderId, payload.text, payload.timestamp);
+ * })
+ * ```
+ * @event
+ */
+export declare function event_command_channel_message(payload: any): void;
+/**
+ * Occurs when cloud recording status changes.
+ * @param payload The recording status
+ */
+export declare function event_recording_change(payload: {
+  state: RecordingStatus;
+}): void;
 /**
  * Occurs when add or remove the microphone/speaker/camera
  * @event
@@ -446,3 +478,16 @@ export declare function event_share_content_change(payload: {
 export declare function event_share_privilege_change(payload: {
   privilege: SharePrivilege;
 }): void;
+
+/**
+ * Occurs when dial out state change
+ *
+ * ```javascript
+ * client.on('dialout-state-change', (payload) => {
+ *    console.log(payload.code);
+ * });
+ * ```
+ * @param payload
+ * @event
+ */
+export declare function event_dial_out_change(payload: { code: DialoutState }): void;

dist/types/index.d.ts

@@ -3,6 +3,8 @@ export * from './common';
 export * from './event-callback';
 export * from './media';
 export * from './chat';
+export * from './command';
 export * from './videoclient';
+export * from './recording';
 export * from './preview';
 export default ZoomVideo;