Zoom Meeting SDK for Windows Raw Recording Sample

This sample uses the Zoom Meeting SDK for Windows in order to obtain recording permission and stream raw audio data. This sample patches the existing "sdk_demo_v2" demo solution that can be downloaded with the Meeting SDK.

Prerequisites

1. vcpkg
2. Zoom Account
3. Zoom Meeting SDK Credentials (Instructions below)
   1. SDK Key
   2. SDK Secret

Install Dependencies

Run the following in Powershell. If you are using a version of vcpkg before September 2023 please make sure to add the triplet for your architecture: --triplet x64-windows

# Use vcpkg to install dependencies
./vcpkg.exe install yaml-cpp
./vcpkg.exe install jwt-cpp
./vcpkg.exe install boost
./vcpkg.exe integrate install

Clone the Repository

# Clone down this repository
git clone [email protected]:zoom/meetingsdk-win-raw-recording-sample.git

Download the Zoom Windows SDK

Download the Zoom SDK for Windows version 5.14.5.15340 from the Zoom Marketplace and place it in the meetingsdk-win-raw-recording-sample folder that was just downloaded

Apply The Patch

# Open the repository
cd meetingsdk-win-raw-recording-sample

git apply -p1 --directory zoom-sdk-windows-5.14.5.15340/x64 raw-recording-sample.patch

Set Credentials

If you already have credentials from a Zoom Meeting SDK app then you can follow these steps to add them. Otherwise, follow the section on how to Create your Zoom Meeting SDK app

cd zoom-sdk-windows-5.14.5.15340/x64/demo/sdk_demo_v2

# Copy the config file and enter meeting details
cp sample.config.yaml config.yaml

# Copy the config file and enter Meeting SDK credentials (S2S Credentials are optional)
cp sample.credentials.yaml credentials.yaml

Get your Zoom Meeting SDK Credentials

In your web browser, navigate to Zoom Developer Portal and register/log into your developer account.

Click the "Build App" button at the top and choose to "Meeting SDK" application.

1. Name your app
2. Choose whether to list your app on the marketplace or not
3. Click "Create"
4. Fill out the prerequisite information
5. Copy the Client ID, Client Secret and Account ID to the credentials.yaml file

For more information, you can follow this guide

(OPTIONAL) Get Your Server-to-Server Oauth Credentials

If you want to use the Join Token method to join a meeting with recording permission then you'll need to provide Server-to-Server OAuth credentials and set the join_token option to true in config.yaml

In your web browser, navigate to Zoom Developer Portal and register/log into your developer account.

Click the "Build App" button at the top and choose to "Server-to-Server OAuth" application.

1. Name your app
2. Choose whether to list your app on the marketplace or not
3. Click "Create"
4. Fill out the prerequisite information
5. Copy the Client ID, Client Secret and Account ID to the credentials.yaml file

For more information, you can follow this guide

Configure Meeting

In config.yaml, enter the meeting details manually or provide a join_url to be parsed.

Run the Solution

Now, open the x64/demo/sdk_demo_v2/sdk_demo_v2.sln solution file in Visual Studio. Run a Release x64 build per the typical Windows Meeting SDK demo build.

More information can be found here

Keeping secrets secret

Remember, credentials should never be stored in a plaintext file for production use cases.

⚠️ Never commit credentials.yaml to version control: The file likely contains Zoom SDK and Zoom OAuth Credentials

Testing

At this time there are no tests.

Need help?

If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.

Documentation

Make sure to review our documentation as a reference when building your Zoom Apps.