Product updates

Developer Changelog

Keep track of changes and upgrades to the Zoom Developer platform. You can also subscribe to our Changelog RSS feed below.


Video SDKmacOS

Version 2.4.0

Breaking changeSDK version

Summary:Breaking changes include increasing the maximum userName length to 200 characters and updating session password rules to allow a maximum of 10 characters including all visible alphanumeric and special characters on the English keyboard (ASCII 32-126). Older SDK versions may fail to join sessions with passwords that don't comply with legacy rules. Adds support for Real-Time Media Streams (RTMS) with new enums for status tracking and failure reasons, a new helper class with methods to control media streams, and new delegate callbacks to monitor stream status and failures.

Breaking Changes

  • Updated the maximum username length for joining a session to 200.
  • Session Password Rule Update. Session passwords must now follow these rules:
    • Maximum length: 10 characters
    • Allowed characters: all visible alphanumeric and special characters on the English keyboard (character range: 32 ≤ ch < 127)
    • Note: When a session is created with the new SDK, older SDK versions may fail to join if the password does not comply with their legacy rules.
    • For sessions comprising both current and legacy non-web SDK clients, the Developer shall configure session passwords to comply with the legacy non-web SDK's more restrictive password requirements (i.e. max 10 alphanumeric characters and the following special characters only: @, -, _, and *).
    • Upon full migration of all participants to the current SDK, the Developer may apply the current SDK's less restrictive password requirements(e.g. max 10 characters of printable ASCII).

Added

  • Support for RTMS. Contact Sales to enable.

    • New enums in ZMVideoSDKDef.h
    typedef enum
    {
    	ZMVideoSDKRealTimeMediaStreamsStatus_None = 0,
    	ZMVideoSDKRealTimeMediaStreamsStatus_Start,
    	ZMVideoSDKRealTimeMediaStreamsStatus_Pause,
    	ZMVideoSDKRealTimeMediaStreamsStatus_Stop
    }ZMVideoSDKRealTimeMediaStreamsStatus;
    
    typedef enum
    {
    	ZMVideoSDKRealTimeMediaStreamsFailReason_None = 0,
    	ZMVideoSDKRealTimeMediaStreamsFailReason_NoSubscription,
    	ZMVideoSDKRealTimeMediaStreamsFailReason_StartFail
    }ZMVideoSDKRealTimeMediaStreamsFailReason;
    
    
    • Add new class in ZMVideoSDKRTMSHelper.h
    @interface ZMVideoSDKRTMSHelper : NSObject
    - (BOOL)isSupportRealTimeMediaStreams;
    - (ZMVideoSDKErrors)canStartRealTimeMediaStreams;
    - (ZMVideoSDKErrors)startRealTimeMediaStreams;
    - (ZMVideoSDKErrors)pauseRealTimeMediaStreams;
    - (ZMVideoSDKErrors)resumeRealTimeMediaStreams;
    - (ZMVideoSDKErrors)stopRealTimeMediaStreams;
    @end
    
    • New callback in ZMVideoSDKDelegate.h.
    - (void)onRealTimeMediaStreamsStatusChanged:(ZMVideoSDKRealTimeMediaStreamsStatus)status;
    - (void)onRealTimeMediaStreamsFail:(ZMVideoSDKRealTimeMediaStreamsFailReason)failReason;
    
    • New interface in ZMVideoSDK.h.
    - (ZMVideoSDKRTMSHelper* _Nullable)getRealTimeMediaStreamsHelper;