Developers!

We are happy to announce that our macOS SDK has been updated to v5.4.54518.1229, and it is available in Zoom App Marketplace.

In this version, we have included the following changes:

Added:

  • Upgraded Zoom default UI to match Zoom client 5.4.3, including but not limit to the following new features:
    • End-to-end(E2E) encryption
    • Multi-pin and multi-spotlight
    • High Fidelity Audio mode
  • Added a new interface to clean up SDK
    • -(void)unInitSDK in ZoomSDK.h
  • Added new methods to support multi-spotlight
    • New methods in ZoomSDKMeetingActionController.h
-(ZoomSDKError)canSpotlight:(unsigned int)userID result:(ZoomSDKSpotlightResult*)result;
-(ZoomSDKError)canUnSpotlight:(unsigned int)userID result:(ZoomSDKSpotlightResult*)result;
-(ZoomSDKError)spotlightVideo:(unsigned int)userID;
-(ZoomSDKError)unSpotlightVideo:(unsigned int)userID;
-(ZoomSDKError)unSpotlightAllVideos;
-(NSArray*)getSpotlightedUserList;
  • Added new methods to support multi-pin
    • New methods in ZoomSDKMeetingActionController.h
-(ZoomSDKError)canPinToFirstView:(unsigned int)userID result:(ZoomSDKPinResult*)result;
-(ZoomSDKError)pinVideoToFirstView:(unsigned int)userID;
-(ZoomSDKError)unPinVideoFromFirstView:(unsigned int)userID;
-(ZoomSDKError)unPinAllVideosFromFirstView;
-(NSArray*)getPinnedUserListFromFirstView;
-(ZoomSDKError)canPinToSecondView:(unsigned int)userID result:(ZoomSDKPinResult*)result;
-(ZoomSDKError)pinVideoToSecondView:(unsigned int)userID;
-(ZoomSDKError)unPinVideoFromSecondView:(unsigned int)userID;
-(NSArray*)getPinnedUserListFromSecondView;
  • Added new methods to enable share computer sound
    • New methods in ZoomSDKASController.h
-(BOOL)isSupportEnableOptimizeForFullScreenVideoClip;
-(BOOL)isEnableShareComputerSoundOn;
-(BOOL)isEnableOptimizeForFullScreenVideoClipOn;
-(ZoomSDKError)enableShareComputerSound:(BOOL)enable;
-(ZoomSDKError)enableOptimizingScreenShareForVideoClip:(BOOL)enable;
-(ZoomSDKError)enableShareComputerSoundWhenSharing:(BOOL)enable;
-(ZoomSDKError)enableOptimizingScreenShareForVideoClipWhenSharing:(BOOL)enable;
  • Added new method to get the raise hand status
    • - (BOOL)isRaisingHand in ZoomSDKUserInfo.h
  • Added new method and callback in PreMeetingService to get meeting invite email content asynchronously
    • -(ZoomSDKError)asyncGetInviteEmailContent in ZoomSDKPremeetingService.h
    • -(void)onGetInviteEmailContent:(NSString *)content result:(ZoomSDKPremeetingError)result meetingUniqueID:(long long)meetingUniqueID;
  • Added a new class ZoomSDKShareScreenSetting that includes the following methods:
    • New methods in ZoomSDKSettingService.h
-(int)getLimitFPSValue;
-(ZoomSDKError)setLimitFPSValue:(int)value ;
-(ZoomSDKError)setLimitedFPSValue:(ZoomSDKFPSValue)value ;
-(BOOL)isEnableToSetLimitFPS ;
-(ZoomSDKError)setEnableLimitFPS:(BOOL)enable ;
-(ZoomSDKError)enableSetShareScreen:(BOOL)enable  SettingCmd:(shareSettingCmd)shareCmd;
-(BOOL)isEnableToSettingShare:(shareSettingCmd)sharing;
  • Added new methods for high fidelity music mode in ZoomSDKAudioSetting

    • New methods in ZoomSDKSettingService.h
      • - (ZoomSDKError)setHighFideMusicMode:(BOOL)enable;
      • - (BOOL)isHighFideMusicMode:(BOOL*)isDisabled;
  • Added new methods to configure echo cancellation in ZoomSDKAudioSetting

    • New methods in ZoomSDKSettingService.h
    • - (ZoomSDKError)setEchoCancellationLevel:(ZoomSDKAudioEchoCancellationLevel)level;
    • - (ZoomSDKAudioEchoCancellationLevel)getEchoCancellationLevel;
  • Added new methods to stop my video and audio when my display is off or screen saver begins

    • New methods in ZoomSDKSettingService.h
      • - (ZoomSDKError)setMuteVideoAndAudioWhenLockScreen:(BOOL)enable;
      • - (BOOL)isMutedVideoAndAudioWhenLockScreen:(BOOL*)isDisabled;
  • Added new methods for the emoji in-meeting reactions feature

    • New methods in ZoomSDKReactionController.h
      • Enum ZoomSDKEmojiReactionSkinTone
      • - (ZoomSDKError)setReactionSkinTone:(ZoomSDKEmojiReactionSkinTone)skinTone;
      • -(BOOL)isEmojiReactionEnabled;
      • -(void)onEmojiReactionReceived:(unsigned int)userid reactionType:(ZoomSDKEmojiReactionType)type reactionSkinTone:(ZoomSDKEmojiReactionSkinTone)skinTone;

Changed && Fixed:

  • Extended the ability of the interface disableCustomLiveStreamAction to disable original live stream button action while sharing
    • disableCustomLiveStreamAction in ZoomSDKMeetingConfiguration.h
  • Redefined the method - (ZoomSDKError)sendChat:(NSString*)content toUser:(unsigned int)userID.
  • Fixed an issue where the float video display mode could only be modified while sharing.
  • Fixed an issue where the user could not join a meeting again after failing to join the meeting the first time.
  • Fixed an issue where language interpretation does not work as expected while editing the meeting.
    • enum ZoomSDKInterpreLanguage is deprecated.
    • Added a new interface -(NSArray<NSString*>*)getAllInterpretLanguages in class IMeetingConfigOption.
  • Fixed the spelling of ZoomSDKUserAudioStatus
  • Fixed an issue where webinar attendees could not view the active speaker’s video in Custom UI
  • Fixed an issue where the “Record privilege change notification” displayed twice
  • Fixed an issue where the notification is not being triggered when screen sharing is paused after a window was moved between multiple monitors

Deprecated

  • ActionMeetingCmd_SpotlightVideo and ActionMeetingCmd_UnSpotlightVideo: these params are used in the interface - (ZoomSDKError)actionMeetingWithCmd:(ActionMeetingCmd)cmd userID:(unsigned int)userID onScreen:(ScreenType)screen
  • ActionMeetingCmd_PinVideo and ActionMeetingCmd_UnPinVideo: these params are used in the interface - (ZoomSDKError)actionMeetingWithCmd:(ActionMeetingCmd)cmd userID:(unsigned int)userID onScreen:(ScreenType)screen
  • The following interfaces in ZoomSDKGeneralSetting
-(int)getLimitFPSValue;
-(ZoomSDKError)setLimitFPSValue:(int)value ;
-(ZoomSDKError)setLimitedFPSValue:(ZoomSDKFPSValue)value ;
-(BOOL)isEnableToSetLimitFPS ;
-(ZoomSDKError)setEnableLimitFPS:(BOOL)enable ;
-(ZoomSDKError)enableSetShareScreen:(BOOL)enable  SettingCmd:(shareSettingCmd)shareCmd;
-(BOOL)isEnableToSettingShare:(shareSettingCmd)sharing;

You may find the latest version of macOS SDK on the download page on App Marketplace (The same location as your SDK key & secret).

Should you have any questions while upgrading our SDK, please visit our Developer Forum and our SDK experts will be more than happy to assist you over there.

Happy Zooming!!