Zoom Rooms Controller SDK Reference

Welcome to the documentation for the ZRC SDK.

Overview

The Zoom Rooms Controller Software Development Kit (ZRC SDK) is a native C++ library that allows you to control a Zoom Room from your own application, with near feature parity to first-party Zoom Room Controller applications like the Zoom Rooms Android Controller and Zoom Rooms iPad Controller. The ZRC SDK provides a low-level API that accepts an activation code to pair with a Zoom Room, setting up a bi-directional communication that allows your application to receive events from, and send commands to, a Zoom Room.

Current release

ZRC SDK 6.5.0

Getting Started

Requirements

1. The ZRC SDK must be able to reach Zoom cloud services in order to function.
2. Please call ZRC SDK APIs in your application's main UI thread for thread-safe operation
3. When using the ZRC SDK for Linux, your application must call IZRCSDK::HeartBeat() in main UI thread to trigger the event loop. The recommended time interval is 150ms.
4. When using the ZRC SDK for Linux, Glibc version 2.27 or later is required.

How to use ZRC SDK

1. Get ZRC SDK instance with IZRCSDK::GetInstance()
2. Create ZoomRoomsService instance with IZRCSDK::CreateZoomRoomsService()
3. Pair room with room's activation code with IZoomRoomsService::PairRoomWithActivationCode()
4. Get your desired service and call the API.
   • For example, If you want to mute your audio in a meeting.
   • First, get MeetingService with IZoomRoomsService::GetMeetingService()
   • Then, get MeetingAudioHelper with IMeetingService::GetMeetingAudioHelper()
   • Finally, mute your audio with IMeetingAudioHelper::UpdateMyAudioStatus()
5. Unpair room with IZoomRoomsService::UnpairRoom()

To Learn More

Please review our document for more detailed instructions when building your Zoom Rooms Controller Apps.

APPENDIX A - GLOSSARY

• ZRC - Zoom Rooms Controller
• ZR - Zoom Rooms