Type alias ConfigResponse

ConfigResponse: { runningContext: RunningContext; unsupportedApis: Apis[]; clientVersion: string; browserVersion: string; auth: AuthObject; media?: { renderTarget?: { width: number; height: number }; defaultCutout?: ParticipantCutoutShape } & VideoMedia & AudioMedia; userAgent: string; launchContext: LaunchContext; product?: "desktop" | "mobile" | "web" | "personalZoomRoom" | "sharedZoomRoom" | "zoomRoomController" }

The product parameter is implemented mainly to support apps running on various devices. The running context tells the app whether the device is in a meeting or not, and the product parameter tells the app the device type (desktop, mobile, personal or shared ZRs).

Client OS Running Context (Parameter) Product (Parameter)
Desktop Client Win/Mac inMainClient desktop
Desktop Client Win/Mac inMeeting desktop
Mobile Client iOS/Android inMainClient mobile
Mobile Client iOS/Android inMeeting mobile
Personal Zoom Room Win/Android inMainClient personalZoomRoom
Personal Zoom Room Win/Android inMeeting personalZoomRoom
Desktop Client Win/Mac inChat desktop
Zoom Room Win/Android inMainClient sharedZoomRoom
Zoom Room Win/Android inMeeting sharedZoomRoom
Digital Signage Win/Android inDigitalSignage sharedZoomRoom
Zoom Room Controller iOS/Android inMainClient zoomRoomController
Zoom Room Controller iOS/Android inMeeting zoomRoomController
Web Client Win/Mac inMeeting/inWebinar desktop/web

Type declaration

  • runningContext: RunningContext

    The context in which the Zoom App is launched: inMeeting, inWebinar, inMainClient, inPhone.

  • unsupportedApis: Apis[]

    Unsupported JS APIs and events.

  • clientVersion: string

    Version of the Zoom Client in which the app is running.

  • browserVersion: string

    'webview2/xxxx', 'cef/xxx', 'applewebkit/xx'

  • auth: AuthObject

    'authorized' or 'unauthorized'

  • Optional media?: { renderTarget?: { width: number; height: number }; defaultCutout?: ParticipantCutoutShape } & VideoMedia & AudioMedia

    only available in meetings. Provides the specifications of audio and video

  • userAgent: string

    provides the browser userAgent

  • launchContext: LaunchContext
  • Optional product?: "desktop" | "mobile" | "web" | "personalZoomRoom" | "sharedZoomRoom" | "zoomRoomController"

    the product that this app is being run on

    desktop The app is running on a desktop client.

    mobile The app is running on a mobile client.

    web The app is running on a web client.

    personalZoomRoom The app is running on a personal Zoom Room device.

    sharedZoomRoom The app is running is on a shared Zoom Room device.

    zoomRoomController The app is running on a Zoom Room controller.

Settings

Member Visibility

Theme

Generated using TypeDoc