v0.16.12

Added

• New methods and events in Meeting Views, Layers, Meeting Actions and Reactions categories.
  • zoomSdk.setScreenName
  • zoomSdk.setParticipantScreenName
  • zoomSdk.setEmojiReaction
  • zoomSdk.getEmojiConfiguration
  • zoomSdk.onEmojiReaction
  • zoomSdk.getMeetingView
  • zoomSdk.setMeetingView
  • zoomSdk.onMeetingViewChange
  • zoomSdk.setVideoFilter
  • zoomSdk.deleteVideoFilter

Updated

• Added optional parameter timeout to zoomSdk.config to pass custom timeout, that will be used while calling any of the Zoom Apps SDK APIs. If timeout is not passed in the config , SDK uses default 10000ms.
• Added optional parameters mirrorMyVideo , originalRatio and cameraDeviceId to zoomSdk.setVideoSettings
• Updated zoomSdk.getVideoSettings to return new fields mirrorMyVideo , originalRatio and cameraDevices

v0.16.11

Added

• New method zoomSdk.broadcastVoiceToBreakoutRooms to start or stop broadcasting voice to breakout rooms.
• New method zoomSdk.stopShareScreen to stop an ongoing share screen.

v0.16.10

Added

• New methods zoomSdk.getChatContext , zoomSdk.composeCard and updated zoomSdk.getAppContext , zoomSdk.getRunningContext to support apps in Zoom chat context.

v0.16.9

Added

• New methods and event for managing gallery view
  • zoomSdk.getGalleryPage
  • zoomSdk.setGalleryPage
  • zoomSdk.onGalleryPageChange
• New method zoomSdk.showMeetingInvitationDialog to open the invite-people modal.
• A warning will be thrown when zoomSdk event listeners are added or removed before calling zoomSdk.config. This will become a thrown error in a future version of the SDK.

Updated

• Added optional parameters shareToBreakoutRooms , shareSound and optimizeForVideoClip to zoomSdk.promptShareScreen API.
• Added optional parameters messageText, primaryButtonText , secondaryButtonText , htmlPageTitle , and deeplinkURL to zoomSdk.sendAppInvitation API to configure invitation.
• Added optional parameter automaticallyMoveParticipantsIntoMainRoom to zoomSdk.configureBreakoutRooms API. If set to true while configuring breakout rooms, no dialog on participant’s screen will be shown while moving to main room.
• Starting January 31, 2023, the roles for following Zoom Apps APIs are now expanded to meeting hosts and co-hosts
  • zoomSdk.getMeetingContext
  • zoomSdk.getMeetingParticipants
  • zoomSdk.getMeetingJoinUrl
  • zoomSdk.onParticipantChange
  • zoomSdk.onActiveSpeakerChange
  • zoomSdk.allowParticipantToRecord
  • zoomSdk.onReaction

Fixed

• Fixed multiple events firing bug on Windows when zoomSdk.config is called more than once.

v0.16.8

Added

New methods to update incoming participant audio state, manage audio & video settings, prompt share screen

• zoomSdk.setIncomingParticipantAudioState
• zoomSdk.getIncomingParticipantAudioState
• zoomSdk.setAudioSettings
• zoomSdk.getAudioSettings
• zoomSdk.setVideoSettings
• zoomSdk.getVideoSettings
• zoomSdk.promptShareScreen

New events in sharing, feedback, meeting actions categories

• zoomSdk.onShareScreen
• zoomSdk.onShareComputerAudio
• zoomSdk.onFeedbackReaction
• zoomSdk.onRemoveFeedbackReaction
• zoomSdk.onIncomingParticipantAudioChange

Updated

• VB APIs zoomSdk.setVirtualBackground and zoomSdk.removeVirtualBackground are updated to support in inMainClient running context from desktop client version 5.13.5.

• New optional parameter cameraModeMirroring is added to drawParticipant (in desktop client version 5.13.5) when set true the participant will be streamed as mirrored in both the local client and to other participant.

v0.16.7

Added

• New methods to pin, spotlight, remove attendees from a webinar, allow & disallow attendees to speak in webinar, share computer audio, set & remove feedback reaction

  • zoomSdk.addParticipantPins

  • zoomSdk.removeParticipantPins

  • zoomSdk.addParticipantSpotlight

  • zoomSdk.removeParticipantSpotlights

  • zoomSdk.getParticipantSpotlights

  • zoomSdk.removeWebinarAttendees

  • zoomSdk.allowAttendeesToSpeak

  • zoomSdk.disallowAttendeesToSpeak

  • zoomSdk.shareComputerAudio

  • zoomSdk.setFeedbackReaction

  • zoomSdk.removeFeedbackReaction

  • zoomSdk.removeAllFeedbackReaction

Updated

• Added defaultCutout field to zoomSdk.config response

• Added parameter withSound to share audio from a Zoom App zoomSdk.shareApp

• Marked participantId deprecated in the SDK documentation.

• Updated reflection to prevent __esModule & default console warnings.

v0.16.6

Updated

createBreakoutRooms

Data Input changes:

numberOfRooms: number, Amount of breakout rooms to create. Between 1 and 50. Optional if names is present

names: String[], List of names to give breakoutrooms upon creation. Between 1 and 50. If numberOfRooms is present, must match the length of this list. Added in client version 5.12.6

Data Outputs: no changes

Error & status handling

Fails if numberOfRooms and names are provided, but number of names doesn't match the requested number of rooms

onMeetingConfigChanged

Event types updated:

breakoutRoomsCreated：Breakout rooms are created in Zoom UI or by “createBreakoutRooms”.

additional parameters:

breakoutRoomUUIDs: list of breakout room identifiers

breakoutRoomsChanged：There are changes in the rooms list by Zoom UI or by methods “addBreakoutRoom“, “deleteBreakoutRoom”, ”renameBreakoutRoom“.

additional parameters:

change: "added","deleted","renamed"

breakoutRoomUUIDs: list of breakout room identifiers that were changed (added, renamed, deleted)

breakoutRoomParticipantsAssigned：By Zoom UI or by method “assignParticipantToBreakoutRoom”.

additional parameters:

breakoutRoomUUID: id of breakout room that has new participants

participantUUIDs: list of particiants assigned to the room

NOTE: depends on user permissions, ordinary participants do not get this list

breakoutRoomParticipantsJoined：Participants joined a breakout room using Zoom UI, or by method “changeBreakoutRoom”.

additional parameters:

breakoutRoomUUID: id of breakout room that has new participants

participantUUIDs: list of particiants joined to the room

NOTE: depends on user permissions, ordinary participants do not get this list

breakoutRoomParticipantsLeft：Participants left a breakout room using Zoom UI, or by method “changeBreakoutRoom”.

additional parameters:

breakoutRoomUUID: id of breakout room that participant have left

participantUUIDs: list of particiants joined the main room

NOTE: depends on user permissions, ordinary participants do not get this list

Fixed

• Fixed breakoutrooms role-based permissions documentation.

v0.16.5

• Added role-based permissions information to all APIs and events in the documentation.
• Each API & event's first available client version information is added to the documentation.
• New method zoomSdk.getAppContext added for getting zoom app’s context via the SDK.

v0.16.4

• Typescript types now provided as named exports
• Version comment added to distributed SDK files
• Typedoc updated to version 0.23.10
• New methods added for getting/setting the on/off state of current user’s audio and video:
  • zoomSdk.getVideoState
  • zoomSdk.setVideoState
  • zoomSdk.getAudioState
  • zoomSdk.setAudioState
• Persistence feature added to zoomSdk.setVirtualForeground , you can now set virtual foregrounds to persist beyond the meeting in which they are set
• Corrected type definitions for onMeetingConfigChanged event, added compatibility patch for older client versions

v0.16.3

Zoom Apps SDK v0.16.3

Added

• drawParticipant and runRenderingContext support additional shapes beyond the rectangle and person options. These new shapes are available to apps running on Zoom 5.11.6 and later:
  • standard
  • square
  • verticalRectangle
  • circle

Fixed

• Fixed the type definition for toggleParticipantMediaAudio to include participantUUIDs option.