Class ZoomVideoSdk

constructor

• new ZoomVideoSdk(): ZoomVideoSdk

  Returns ZoomVideoSdk

acceptRecordingConsent

cleanAllExportedLogs

cleanup

declineRecordingConsent

exportLog

getRecordingConsentType

getSdkVersion

isInSession

leaveSession

cancelPrepareJoin

• cancelPrepareJoin(): Promise<Errors>

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

  Returns Promise<Errors>

commitJoin

• commitJoin(): Promise<Errors>

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

  Returns Promise<Errors>

initSdk

• initSdk(config: InitConfig): any

  Initialize the Zoom Video SDK

  Parameters

  • config: InitConfig

  Returns any

joinSession

• joinSession(config: JoinSessionConfig): any

  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.

  Parameters

  • config: JoinSessionConfig

  Returns any

prepareJoin

• prepareJoin(
      config: JoinSessionConfig,
      preJoinParam?: ZoomVideoSdkPreJoinParam | null,
  ): any

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

  Parameters

  • config: JoinSessionConfig

    Same as joinSession.

  • OptionalpreJoinParam: ZoomVideoSdkPreJoinParam | null

    Optional. Pass null/undefined to use defaults (e.g. timeout 30s).

  Returns any