Download and compile the SDK

Requirements for external meeting access

To join meetings outside of your developer account, your app must:

  • Be reviewed by Zoom.
  • Authenticate with either a ZAK or On Behalf Of (OBF) token to attribute to a user in a meeting.

You can:

Prerequisites

See the Changelog for the latest supported Zoom Meeting SDK version. See Minimum SDK version for the minimum supported version.

General requirements

  • To use the Blueprints functionality of the Meeting SDK for Unreal, make sure you meet these requirements.
  • Have a JWT token for the Meeting SDK for Windows, and (optional) a ZAK token for user authentication across our developer platform. See SDK authorization and PKCE OAuth for more details.
  • To run the demo app, you'll need a meeting ID and passcode.
  • By default, the Meeting SDK for Unreal is only supported on Unreal Engine versions 5.3.2.
  • Set the Default RHI for Unreal Engine to DX12 or DX11.
    • Set the D3D12 Targeted Shader Format to SM5 or SM6.
    • Set the D3D11 Targeted Shader Format to SM5.

Development requirements

To develop extended functionality in C++, you will also need

  • Visual Studio 2022 or later
  • Zoom Meeting SDK 5.17.2 or later
  • Unreal Engine 5.3.* or later

Note The Meeting SDK for Unreal supports the same version as the Zoom client. See Zoom system requirements: Windows, macOS, Linux for details.

Note

Universal Windows Platform (UWP) is not supported.

Use high bandwidth mode

By default, the Meeting SDK limits the number of video subscriptions activated via raw data. This restricts the ability to work with multiple HD video feeds inside of Unreal. To have this restriction lifted, contact Zoom Support and request access to SDK High Bandwidth (High Bandwidth mode) on the account that you used to create your Zoom App Marketplace listing. Applications created by accounts with the SDK High Bandwidth flag can subscribe to 30 Mbps of incoming video from Zoom. If your app requires more than 30 Mbps of bandwidth for downlink, contact Zoom Developer Advocacy.

Download the Meeting SDK for Unreal

To access the SDK download files, you must be logged in to your Zoom App Marketplace developer account, and you need at least one app registered on the Zoom App Marketplace.

If you don't already have at least one registered app, follow these steps to create an app and download the SDK files.

  1. Sign in to your developer account on the [Zoom App Marketplace](https://marketplace.zoom.us/?ampDeviceId=cf401538-835f-45ce-a7f1-1035e348c982&SessionId=1771892802618).
  2. Select **Develop > Build App > General app**, and then select **Create**.
  3. Go to **Features** and select **Embed**.
  4. On the **Embed** page, enable **Meeting SDK**.
  5. Under the **Meeting SDK** section, configure the settings as appropriate for your app.
  6. To download the SDK files, select the platform **Linux**. This page displays available SDK versions for the selected platform, along with links to their corresponding release notes.
  7. Finally, select the **Download** button.

If you already have at least one registered app, follow these steps to download the SDK files using your existing app.

  1. Sign in to your developer account on the [Zoom App Marketplace](https://marketplace.zoom.us/?ampDeviceId=cf401538-835f-45ce-a7f1-1035e348c982&SessionId=1771892802618).
  2. Select **Manage**, and open your SDK app.
  3. Go to **Features** and select **Embed**.
  4. On the **Embed** page, go to the **Meeting SDK** section.
  5. To download the SDK files, select the platform **Linux**. This page displays available SDK versions for the selected platform, along with links to their corresponding release notes.
  6. Finally, select the **Download** button.

Compile the SDK files into your project

  1. From the download, extract the ZoomMeetingSDK folder and paste it into your Unreal project's Plugins folder.
  2. Open your project in Unreal Engine, and when prompted, compile the plugin. This may take several minutes.
  3. Unreal Engine automatically launches after the plugin is compiled for your engine version, and will be available in your project.
  4. Enable Show Plugin Content in Unreal Engine to see the assets included with the plugin.