Breaking Changes#

• Move enum EventType in src/hooks/useSdkEventListener.ts to src/hooks/events.ts, and add type EventPayloadMap to list event payload.

• Fix event listerner callback returning null parameter issues.

• Change joinSession callback return type

  • from:

    joinSession: (config: JoinSessionConfig) =>
        Promise<ZoomVideoSdkSession>;
    

  • to:

    joinSession: (config: JoinSessionConfig) => Promise<void>;
    

• Remove deprecated APIs

  • Deprecate the event callback onUserVideoNetworkStatusChanged, use onUserNetworkStatusChanged instead.
  • Deprecate the function isSenderDisableAnnotation in src/native/ZoomVideoSdkAnnotationHelper.ts, use canDoAnnotation instead
  • Removed the enum value AuthWrongKeyorSecret in Errors
  • Removed the enum value AuthDoesNotSupportSDK in Errors
  • Removed the enum value AuthDisableSDK in Errors
  • Removed the enum value DontSupportMultiStreamVideoUser in Errors
  • Removed the enum value FailAssignUserPrivilege in Errors
  • Removed the enum value NoRecordingInProcess in Errors
  • Removed the enum value SessionShareModuleNotReady in Errors
  • Removed the enum value SessionShareTypeIsNotSupport in Errors
  • Removed the enum value SessionShareInternalError in Errors

Added#

• Add a holding state in join flow.

  • New interface in src/native/ZoomVideoSdkOnHoldHelper.ts

    export type ZoomVideoSdkOnHoldUserType = {
        userId: string;
        userName: string;
    };
    
    export type ZoomVideoSdkOnHoldHelperType = {
        isSupportHold: () => Promise<boolean>;
        isOnHoldEnabled: () => Promise<boolean>;
        enableHold: (enable: boolean) => Promise<Errors>;
        getOnHoldUserList: () => Promise<ZoomVideoSdkOnHoldUserType[]>;
        admit: (userId: string) => Promise<Errors>;
        admitAll: () => Promise<Errors>;
    };
    

  • New event listener in src/hooks/events.ts

    [EventType.onHoldJoined]: void;
    [EventType.onHoldUserJoin]: { users: ZoomVideoSdkOnHoldUserType[] };
    [EventType.onHoldUserLeave]: { users: ZoomVideoSdkOnHoldUserType[] };
    

• Support specifying a camera device when starting the video preview.

  • New parameter in ZoomViewProps

    type ZoomViewProps = {
        // ...
        cameraDeviceId?: string | null;
    };
    

• Support live transcription in broadcast streaming session.

  • New interface in src/native/ZoomVideoSdk.ts

    canSubscribeTranslationLanguage: () => Promise<boolean>;
    subscribeTranslationLanguage: (
        language: BroadcastStreamingTranslationLanguage,
    ) => Promise<Errors>;
    unsubscribeTranslationLanguage: () => Promise<Errors>;
    

  • New enum in src/native/ZoomVideoSdkBroadcastStreamingViewer.ts

    export enum BroadcastStreamingTranslationLanguage {
        English = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_English',
        Chinese = 'ZoomVideoSDKBroadcastStreamingTrans    lationLanguage_Chinese',
        Japanese = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Japanese',
        German = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_German',
        French = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_French',
        Russian = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Russian',
        Portuguese = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Portuguese',
        Spanish = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Spanish',
        Korean = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Korean',
        Italian = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Italian',
        Vietnamese = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Vietnamese',
        Dutch = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Dutch',
        Ukrainian = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Ukrainian',
        Arabic = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Arabic',
        Bengali = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Bengali',
        ChineseTraditional = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_ChineseTraditional',
        Czech = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Czech',
        Estonian = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Estonian',
        Finnish = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Finnish',
        Greek = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Greek',
        Hebrew = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Hebrew',
        Hindi = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Hindi',
        Hungarian = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Hungarian',
        Indonesian = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Indonesian',
        Malay = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Malay',
        Persian = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Persian',
        Polish = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Polish',
        Romanian = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Romanian',
        Swedish = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Swedish',
        Tamil = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Tamil',
        Telugu = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Telugu',
        Tagalog = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Tagalog',
        Turkish = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Turkish',
        Danish = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Danish',
        Norwegian = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Norwegian',
        Thai = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Thai',
        Welsh = 'ZoomVideoSDKBroadcastStreamingTranslationLanguage_Welsh',
    }
    

Changed#

• The microphone and speaker test capability (startMicTest, playMicTest, startSpeakerTest) can now be used before joining a session and after audio has been stopped, in addition to the existing in-session support.