@zoom/react-native-videosdk
    Preparing search index...

    Type Alias ZoomVideoSdkType

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

    type ZoomVideoSdkType = {
        acceptRecordingConsent: () => Promise<boolean>;
        cancelPrepareJoin: () => Promise<Errors>;
        cleanAllExportedLogs: () => Promise<Errors>;
        cleanup: () => void;
        commitJoin: () => Promise<Errors>;
        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;
        prepareJoin: (
            config: JoinSessionConfig,
            preJoinParam?: ZoomVideoSdkPreJoinParam | null,
        ) => Promise<void>;
    }

    Implemented by

    Index
    acceptRecordingConsent cancelPrepareJoin cleanAllExportedLogs cleanup commitJoin declineRecordingConsent exportLog getRecordingConsentType getSdkVersion initSdk joinSession leaveSession prepareJoin
    acceptRecordingConsent: () => Promise<boolean>

    Accept recording consent

    cancelPrepareJoin: () => Promise<Errors>

    Cancel prepare join. Valid in the two-step join flow. Resolves with Errors (e.g. Success).

    cleanAllExportedLogs: () => Promise<Errors>

    Delete the exported log files

    cleanup: () => void

    Un-initialize the Zoom SDK.

    commitJoin: () => Promise<Errors>

    Confirm join after prepareJoin. Valid in the two-step join flow. Resolves with Errors (e.g. Success).

    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.

    prepareJoin: (
        config: JoinSessionConfig,
        preJoinParam?: ZoomVideoSdkPreJoinParam | null,
    ) => Promise<void>

    Prepares to join a session (two-step join). When ready, onPrepareJoinReady is emitted. Then call commitJoin() to confirm or cancelPrepareJoin() to cancel.

    Type Declaration

    Settings
    Member Visibility

    On This Page
    Properties