Public Zoom SDK API surface exposed by ZoomSDKProvider via React context, and consumed through the useZoom hook.

Every component that calls one of these methods must be rendered as a descendant of ZoomSDKProvider. Accessing this context outside the provider throws.

Hierarchy

  • ZoomSDKContext

Properties

cleanup: (() => void)

Type declaration

    • (): void
    • Tear down the native SDK. Call only when the SDK is no longer needed — after cleanup the SDK must be re-initialized before use.

      Returns void

connectMyAudio: ((on) => Promise<boolean>)

Type declaration

    • (on): Promise<boolean>
    • Connect or disconnect the local user's audio (VoIP).

      Parameters

      • on: boolean

        true to connect, false to disconnect.

      Returns Promise<boolean>

      true on success, false on failure.

isInitialized: (() => Promise<boolean>)

Type declaration

    • (): Promise<boolean>
    • Resolves to true if the SDK has been initialized and authorized.

      Returns Promise<boolean>

joinMeeting: ((config) => Promise<string>)

Type declaration

    • (config): Promise<string>
    • Join an existing Zoom meeting.

      Parameters

      Returns Promise<string>

      A meeting error code; MobileRTCMeetError_Success indicates the join request was accepted. Subscribe to onMeetingStateChange to track the meeting lifecycle after the request is accepted.

muteMyAudio: ((mute) => Promise<string>)

Type declaration

    • (mute): Promise<string>
    • Mute or unmute the local user's audio.

      Parameters

      • mute: boolean

        true to mute, false to unmute.

      Returns Promise<string>

      On iOS, a MobileRTCAudioError value. On Android, a MobileRTCSDKError value.

muteMyVideo: ((mute) => Promise<string>)

Type declaration

    • (mute): Promise<string>
    • Mute or unmute the local user's video.

      Parameters

      • mute: boolean

        true to mute, false to unmute.

      Returns Promise<string>

      MobileRTCSDKError_Success on success, otherwise an error code.

startMeeting: ((config) => Promise<string>)

Type declaration

    • (config): Promise<string>
    • Start a new Zoom meeting as the host.

      Parameters

      Returns Promise<string>

      A meeting error code; MobileRTCMeetError_Success indicates the start request was accepted. Subscribe to onMeetingStateChange to track the meeting lifecycle after the request is accepted.

updateMeetingSetting: ((config) => void)

Type declaration

    • (config): void
    • Apply meeting-level settings such as disabling the video preview.

      Parameters

      Returns void

Generated using TypeDoc