Type Alias ZoomVideoSdkType

ZoomVideoSdkType: {
    acceptRecordingConsent: () => Promise<boolean>;
    cleanAllExportedLogs: () => Promise<Errors>;
    cleanup: () => void;
    declineRecordingConsent: () => Promise<boolean>;
    exportLog: () => Promise<string>;
    getRecordingConsentType: () => Promise<ConsentType>;
    getSdkVersion: () => Promise<string>;
    initSdk: (config: InitConfig) => void;
    joinSession: (config: JoinSessionConfig) => Promise<void>;
    leaveSession: (endSession?: boolean) => void;
}

Zoom Video SDK API manager. The class that controls the video session creation, event callbacks and other main features of video SDK.

Type declaration

  • acceptRecordingConsent: () => Promise<boolean>

    Accept recording consent

  • cleanAllExportedLogs: () => Promise<Errors>

    Delete the exported log files

  • cleanup: () => void

    Un-initialize the Zoom SDK.

  • declineRecordingConsent: () => Promise<boolean>

    Decline recording consent

  • exportLog: () => Promise<string>

    Export log

  • getRecordingConsentType: () => Promise<ConsentType>

    Get recording consent

  • getSdkVersion: () => Promise<string>

    Returns the Zoom SDK internal version.

  • initSdk: (config: InitConfig) => void

    Initialize the Zoom Video SDK

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

    Call this method to join a session with the appropriate [ZoomVideoSDKSessionContext] parameters. When successful, the SDK will attempt to join a session. Use the callbacks in the delegate to confirm whether the SDK actually joined.

  • leaveSession: (endSession?: boolean) => void

    Call this method to leave a session previously joined through joinSession method call. When successful, the SDK will attempt to leave a session. Use the callbacks in the delegate to confirm whether the SDK actually left.

Settings

Member Visibility
MMNEPVFCICPMFPCPTTAAATR