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): 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.

  Parameters

  • config: JoinSessionConfig

  Returns Promise<void>

prepareJoin

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

  Pre-joins a session in the two-step join flow. Call commitJoin() to confirm or cancelPrepareJoin() to cancel.

  Parameters

  • config: JoinSessionConfig

    The session context parameters.

  • OptionalpreJoinParam: ZoomVideoSdkPreJoinParam | null

    The pre-join parameters. Do not pass null; set timeoutInterval to 0 to use the SDK default. Valid non-zero values are 1 to 60 seconds.

  Returns Promise<void>

  Note

  This API is intended for joining a session that has already been started by a host. If no host has started the session, this call fails.