Zoom Meeting SDK - macOS - 5.12.8

Original publication date: November 16, 2022

Added

• New interface to control waiting room configuration for the customized user interface.

  • New interface class namedZoomSDKCustomWaitingRoomDatadefined inZoomSDKWaitingRoomController.h

    @property (copy, nonatomic, readonly) NSString* title;
    @property (copy, nonatomic, readonly) NSString* dataDescription;
    @property (copy, nonatomic, readonly) NSString* logoPath;
    @property (copy, nonatomic, readonly) NSString* videoPath;
    @property (assign, nonatomic, readonly) ZoomSDKWaitingRoomLayoutType type;
    @property (assign, nonatomic, readonly) ZoomSDKCustomWaitingRoomDataStatus status;

  • New interface class namedZoomSDKWaitingRoomDataDownloadHandlerdefined inZoomSDKWaitingRoomController.h

    -(void)retry;
    -(void)ignore;

   

  • New callback inZoomSDKWaitingRoomDelegate

    -(void)onCustomWaitingRoomDataUpdated:(ZoomSDKCustomWaitingRoomData*)bData handle:(ZoomSDKWaitingRoomDataDownloadHandler*)handle;

  • New interface inZoomSDKWaitingRoomController

    -(ZoomSDKError)requestCustomWaitingRoomData;

  • New Enum namedZoomSDKWaitingRoomLayoutType

    ZoomSDKWaitingRoomLayoutType_Default,
    ZoomSDKWaitingRoomLayoutType_Logo, 
    ZoomSDKWaitingRoomLayoutType_Video,

  • New Enum namedZoomSDKCustomWaitingRoomDataStatus

    ZoomSDKCustomWaitingRoomDataStatus_Init,
    ZoomSDKCustomWaitingRoomDataStatus_Downloading, 
    ZoomSDKCustomWaitingRoomDataStatus_Download_OK, 
    ZoomSDKCustomWaitingRoomDataStatus_Download_Failed, 

• New interface to allow non-host SDK participant to manage(start or stop) "live streaming".

  • New interfaces inZoomSDKLiveStreamHelper

    -(BOOL)isRawLiveStreamSupported;
    -(ZoomSDKError)canStartRawLiveStream;
    -(ZoomSDKError)requestRawLiveStream:(NSString*)broadcastURL;
    -(ZoomSDKError)removeRawLiveStreamPrivilege:(unsigned int)userID;
    -(NSArray<ZoomSDKRawLiveStreamInfo*>*)getRawLiveStreamingInfoList;
    -(NSArray<NSNumber*>*)getRawLiveStreamPrivilegeUserList;

  • New interface class namedZoomSDKRawLiveStreamInfodefined inZoomSDKLiveStreamHelper.h

    @property(nonatomic, assign, readonly) unsigned int userID;
    @property(nonatomic, copy, readonly) NSString *broadcastUrl;

  • New interface class namedZoomSDKRequestRawLiveStreamPrivilegeHandlerdefined inZoomSDKLiveStreamHelper.h

    @property(nonatomic, copy, readonly) NSString *requestId;
    @property(nonatomic, assign, readonly) unsigned int requesterId;
    @property(nonatomic, copy, readonly) NSString *requesterName;
    @property(nonatomic, copy, readonly) NSString *broadcastUrl;
    -(ZoomSDKError)grantRawLiveStreamPrivilege;
    -(ZoomSDKError)denyRawLiveStreamPrivilege;

  • New callback inZoomSDKLiveStreamHelperDelegate

    -(void)onRawLiveStreamPrivilegeChanged:(BOOL)bHasPrivilege;
    -(void)onRawLiveStreamPrivilegeRequestTimeout;
    -(void)onUserRawLiveStreamPrivilegeChanged:(unsigned int)userID hasPrivilege:(BOOL)bHasPrivilege;
    -(void)onRawLiveStreamPrivilegeRequested:(ZoomSDKRequestRawLiveStreamPrivilegeHandler*)handler;
    -(void)onUserRawLiveStreamingStatusChanged:(NSArray<ZoomSDKRawLiveStreamInfo*>*)liveStreamList;

  • New interfaces inZoomSDKUserInfo

    - (BOOL)isRawLiveStreaming
    - (BOOL)hasRawLiveStreamPrivilege

• New interfaces to allow the hardware acceleration setting for screen sharing.

  • New interface inZoomSDKShareScreenSetting:

    - (ZoomSDKError)enableHardwareAcceleratedVideoSharing:(BOOL)bEnable;
    - (BOOL)isVideoSharingHardwareAccelerated;

• New interface to support features which allow for sign language interpreters, American Sign Language (ASL) interpreters, to be defined by the host, and pinned to a certain predictable location for all meeting participants.

  • New interface class namedZoomSDKSignInterpretationControllerdefined inZoomSDKSignInterpretationController.h

    @property(nonatomic,assign)id<ZoomSDKSignInterpretationControllerDelegate>  delegate;
    -(BOOL)isSignInterpretationEnabled;
    -(ZoomSDKSignInterpretationStatus)getSignInterpretationStatus;
    -(BOOL)isSignInterpreter;
    -(ZoomSDKSignInterpretationLanguageInfo*)getSignInterpretationLanguageInfoByID:(NSString *)signLanguageID;
    -(NSArray<ZoomSDKSignInterpretationLanguageInfo*> *)getAvailableSignLanguageInfoList;
    -(NSArray<ZoomSDKSignInterpretationLanguageInfo*> *)getAllSupportedSignLanguageInfoList;
    -(NSArray<ZoomSDKSignInterpreter*> *)getSignInterpreterList;
    -(ZoomSDKError)addSignInterpreter:(unsigned int)userID signLanguageId:(NSString *)signLanguageId;
    -(ZoomSDKError)removeSignInterpreter:(unsigned int)userID;
    -(ZoomSDKError)modifySignInterpreter:(unsigned int)userID signLanguageId:(NSString *)signLanguageId;
    -(BOOL)canStartSignInterpretation;
    -(ZoomSDKError)startSignInterpretation;
    -(ZoomSDKError)stopSignInterpretation;
    -(ZoomSDKError)requestSignLanuageInterpreterToTalk:(unsigned int)userID allowToTalk:(BOOL)allowToTalk;
    -(BOOL)canSignLanguageInterpreterTalk:(unsigned int)userID;
    -(NSString *)getSignInterpreterAssignedLanID;
    -(ZoomSDKError)joinSignLanguageChannel:(NSString *)signLanguageId;
    -(ZoomSDKError)leaveSignLanguageChannel;

  • New interface class namedZoomSDKSignInterpretationLanguageInfodefined inZoomSDKSignInterpretationController.h

    @property (copy,nonatomic,readonly) NSString *signLanguageID;
    @property (copy,nonatomic,readonly) NSString *signLanguageName;

  • New interface class namedZoomSDKSignInterpreterdefined inZoomSDKSignInterpretationController.h

    @property (assign,nonatomic,readonly) unsigned int userID;
    @property (copy,nonatomic,readonly) NSString *signLanguageID;
    @property (assign,nonatomic,readonly) BOOL isAvailable;

  • New protocol class namedZoomSDKSignInterpretationControllerDelegatedefined inZoomSDKSignInterpretationController.h

    -(void)onSignInterpretationStatusChanged:(ZoomSDKSignInterpretationStatus)status;
    -(void)onSignInterpreterListChanged;
    -(void)onSignInterpreterRoleChanged;
    -(void)onSignInterpreterLanguageChanged;
    -(void)onAvailableSignLanguageListUpdated:(NSArray<ZoomSDKSignInterpretationLanguageInfo*> *)availableSignLanguageList;
    -(void)onRequestSignInterpreterToTalk;
    -(void)onDisallowSignInterpreterToTalk;

  • New interface inZoomSDKMeetingService

    -(ZoomSDKSignInterpretationController*)getSignInterpretationController;

  • New interface inZoomSDKUserInfo

    -(BOOL)isSignLanguageInterpreter;

  • New Enum namedZoomSDKSignInterpretationStatus

    ZoomSDKSignInterpretationStatus_Initial,
    ZoomSDKSignInterpretationStatus_Started, 
    ZoomSDKSignInterpretationStatus_Stopped, 

• New interface to support 3D avatars in the Meeting SDK.

  • New interface class namedZoomSDK3DAvatarImageInfodefined inZoomSDKSettingService.h:

    @property(nonatomic,assign,readonly)BOOL isSelected;
    @property(nonatomic,copy,readonly)NSString* imageFilePath;
    @property(nonatomic,copy,readonly)NSString* imageName;
    @property(nonatomic,assign,readonly)int index

  • New interface class namedZoomSDKVideoLipsyncAvatarPreviewHelperdefined inZoomSDKSettingService.h :

    - (ZoomSDKError)startLipSyncAvatarPreview:(NSView *)lipsyncPreview;
    - (ZoomSDKError)stopLipSyncAvatarPreview:(NSView *)lipsyncPreview;

  • New protocol class namedZoomSDKVideoLipSyncAvatarSettingContextDelegatedefined inZoomSDKSettingService.h

    -(void)onLipSyncAvatarItemThumbnailsDownloaded;
    -(void)onLipSyncAvatarItemDataDownloading:(int)index;
    -(void)onLipSyncAvatarItemDataDownloaded:(BOOL)isSuccess index:(int)index;

  • New interface class namedZoomSDKVideoLipSyncAvatarSettingContextdefined inZoomSDKSettingService.h

    @property(nonatomic, assign)id<ZoomSDKVideoLipSyncAvatarSettingContextDelegate> delegate;
    -(BOOL)is3DAvatarSupportedByDevice;
    -(BOOL)isLipSyncAvatarEnabled;
    -(NSArray<ZoomSDK3DAvatarImageInfo*>*)getLipSyncAvatarImageList;
    -(ZoomSDKError)setLipSyncAvatarImage:(ZoomSDK3DAvatarImageInfo*)image;
    -(ZoomSDKVideoLipSyncAvatarPreviewHelper*)getLipSyncAvatarPreviewHelper;

  • New interface class namedZoomSDK3DAvatarSettingdefined inZoomSDKSettingService.h

    -(BOOL)is3DAvatarSupportedByDevice;
    -(BOOL)is3DAvatarEnabled;
    -(NSArray<ZoomSDK3DAvatarImageInfo*>*)get3DAvatarImageList;
    -(ZoomSDKError)set3DAvatarImage:(ZoomSDK3DAvatarImageInfo*)image;
    -(ZoomSDKSettingTestVideoDeviceHelper*)getTestVideoDeviceHelper;

  • New protocol class namedZoomSDK3DAvatarSettingDelegatedefined inZoomSDKSettingService.h

    -(void)on3DAvatarItemThumbnailsDownloaded;
    -(void)on3DAvatarItemDataDownloading:(int)index;
    -(void)on3DAvatarItemDataDownloaded:(BOOL)isSuccess index:(int)index;

  • New interfaces inZoomSDKSettingService

    -(ZoomSDK3DAvatarSetting*)get3DAvatarSettings;

  • New interfaces inZoomSDKVideoSetting

    -(BOOL)isSupportLipSyncAvatar;
    -(ZoomSDKError)enableLipSyncAvatarWhenVideoOff:(BOOL)enable;
    -(BOOL)isLipSyncAvatarWhenVideoOffEnabled;
    -(ZoomSDKVideoLipSyncAvatarSettingContext *)getLipSyncAvatarSettingContext;

  • New callback inZoomSDKVirtualBackgroundSettingDelegate

    -(void)onVideoFilterItemThumnailsDownloaded;
    -(void)onVideoFilterItemDataDownloading:(ZoomSDKVideoEffectType)type index:(int)index;
    -(void)onVideoFilterItemDataDownloaded:(BOOL)ready type:(ZoomSDKVideoEffectType)type index:(int)index;  

•  New interface to allow a user to choose to join another breakout room.

  • New callback inZoomSDKNewBreakoutRoomControllerDelegate:

    -(void)onBOSwitchRequestReceived:(NSString*)newBOName newBOID:(NSString*)newBOID;

• New interfaces for following a meeting presenter's pointer.

  • New interfaces inZoomSDKASController:

    (ZoomSDKError)canEnableFollowPresenterPointerWhenViewShare:(unsigned int)userID bCan:(BOOL*)bCan;

Fixed

• Issue where the functiongetVideoOrderListreturns nil after joining a meeting and showing gallery view.

• Issue where the click behavior is incorrect when the configuration keydisableBreakoutRoomsButtonClickOriginActionis set to YES.

• Issues that occurred when sharing related interfaces when all screens subscribed to the same user. 

• Issue where the SDK was able to get the breakout room creator or admin before receiving theonHasCreatorPermissionoronHasAdminPermissioncallback.

• Issues related to the configuration keyshideChatItemInMeetingand hideCopyURLButtonWhenInviteOthers.

• Issue where, when callingGetLocalRecordingStatus, the SDK didn’t get the statusstartwhen turning on automatic local recording of a meeting in the customized user interface mode.

• Issue where the memory allocated forZoomSDKUserInfowas not released when a user started a meeting but wasn’t in the meeting.

Deprecated

• The interfaces below marked as deprecated:

  -(void)onVideoFilterItemDataDownloaded:(ZoomSDKVideoEffectType)type index:(int)index;
  -(void)onVideoFilterItemDataNeedPrepare:(ZoomSDKVideoEffectType)type index:(int)index;
  -(void)onVideoFilterItemDataReady:(BOOL)ready type:(ZoomSDKVideoEffectType)type index:(int)index;

• The interfacesgetMeetingUITypeinZoomSDKMeetingActionControllermarked as deprecated:

  -(ZoomSDKError)getMeetingUIType:(ScreenType)type isFullScreen:(BOOL*)bFullScreen meetingUIType:(MeetingUIType*)meetingUIType;

• The EnumsMeetingUITypemarked as deprecated:

  typedef enum
  {
  //No video in the meeting.
  MeetingUIType_None,
  //Video wall mode..
  MeetingUIType_VideoWall,
  //Display the video of the active user. 
  MeetingUIType_ActiveRender,         
  }MeetingUIType;