Type alias ZoomSDKType

ZoomSDKType: {
    cleanup: (() => void);
    connectMyAudio: ((on) => Promise<boolean>);
    initSDK: ((config) => Promise<boolean>);
    isInitialized: (() => Promise<boolean>);
    joinMeeting: ((config) => Promise<MobileRTCMeetError>);
    muteMyAudio: ((mute) => Promise<MobileRTCAudioError | MobileRTCSDKError>);
    muteMyVideo: ((mute) => Promise<MobileRTCSDKError>);
    startMeeting: ((config) => Promise<MobileRTCMeetError>);
    updateMeetingSetting: ((config) => void);
}

Native Zoom Meeting SDK interface exposed to JavaScript via the RNZoomSDK React Native module.

Most apps should not use this directly — use ZoomSDKProvider and the useZoom hook instead. This type is exported for advanced use cases that need to talk to the native module directly.

Type declaration

cleanup: (() => void)
- - (): 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>)
- - (on): Promise<boolean>
  - Connect or disconnect the local user's audio (VoIP).
    Parameters
    - on: boolean
      
      true to connect audio, false to disconnect.
    Returns Promise<boolean>
    true on success, false on failure.
initSDK: ((config) => Promise<boolean>)
- - (config): Promise<boolean>
  - Initialize the native Zoom Meeting SDK with the given configuration.
    
    Must be called once before any other SDK method.
    
    The promise resolves once the native SDK has been told to initialize — not once authorization has completed. On iOS the resolved value is the return of [MobileRTC initialize:] (i.e. whether the native init call accepted the parameters). On Android the resolved value is always true after the init call is dispatched. SDK authorization is async on both platforms — wait for the onAuthReturn event with MobileRTCAuthError_Success (or ZOOM_ERROR_SUCCESS) before calling other SDK methods.
    Parameters
    - config: InitConfig
    Returns Promise<boolean>
isInitialized: (() => Promise<boolean>)
- - (): Promise<boolean>
  - Resolves to true if the SDK has been initialized and authorized.
    
    Returns Promise<boolean>
joinMeeting: ((config) => Promise<MobileRTCMeetError>)
- - (config): Promise<MobileRTCMeetError>
  - Join an existing Zoom meeting.
    Parameters
    - config: JoinMeetingConfig
    Returns Promise<MobileRTCMeetError>
    A meeting error code; MobileRTCMeetError_Success indicates the join request was accepted by the native SDK. Watch the onMeetingStateChange event for the actual meeting state.
muteMyAudio: ((mute) => Promise<MobileRTCAudioError | MobileRTCSDKError>)
- - (mute): Promise<MobileRTCAudioError | MobileRTCSDKError>
  - Mute or unmute the local user's audio.
    Parameters
    - mute: boolean
      
      true to mute audio, false to unmute.
    Returns Promise<MobileRTCAudioError | MobileRTCSDKError>
    On iOS, a MobileRTCAudioError value. On Android, a MobileRTCSDKError value.
muteMyVideo: ((mute) => Promise<MobileRTCSDKError>)
- - (mute): Promise<MobileRTCSDKError>
  - Mute or unmute the local user's video.
    Parameters
    - mute: boolean
      
      true to mute video, false to unmute.
    Returns Promise<MobileRTCSDKError>
    MobileRTCSDKError_Success on success, otherwise an error code.
startMeeting: ((config) => Promise<MobileRTCMeetError>)
- - (config): Promise<MobileRTCMeetError>
  - Start a new Zoom meeting as the host.
    Parameters
    - config: StartMeetingConfig
    Returns Promise<MobileRTCMeetError>
    A meeting error code; MobileRTCMeetError_Success indicates the start request was accepted by the native SDK. Watch the onMeetingStateChange event for the actual meeting state.
updateMeetingSetting: ((config) => void)
- - (config): void
  - Apply meeting-level settings such as disabling the video preview.
    Parameters
    - config: MeetingSettingsConfig
    Returns void

Type alias ZoomSDKType

Type declaration

cleanup: (() => void)

Returns void

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

Parameters

on: boolean

Returns Promise<boolean>

initSDK: ((config) => Promise<boolean>)

Parameters

config: InitConfig

Returns Promise<boolean>

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

Returns Promise<boolean>

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

Parameters

config: JoinMeetingConfig

Returns Promise<MobileRTCMeetError>

muteMyAudio: ((mute) => Promise<MobileRTCAudioError | MobileRTCSDKError>)

Parameters

mute: boolean

Returns Promise<MobileRTCAudioError | MobileRTCSDKError>

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

Parameters

mute: boolean

Returns Promise<MobileRTCSDKError>

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

Parameters

config: StartMeetingConfig

Returns Promise<MobileRTCMeetError>

updateMeetingSetting: ((config) => void)

Parameters

config: MeetingSettingsConfig

Returns void

Settings

Member Visibility

Theme