Windows SDK Guide

Windows C++ SDK install, join, render and platform notes.

Interface sections generated from the public SDK definitions

Version v1.1.0 · Updated 2026-10-26 · revision 1

Windows (C++) has the IRtcEngine + IRtcEngineEventHandler shape: initialize → joinChannel → callbacks drive everything. Desktop capture supports three modes: by window id, by screen region and by display id.

Prerequisites#

• Visual Studio 2022 (MSVC v143), CMake 3.25+, Windows 10 1809+.
• Camera/microphone permission at runtime (in Windows, "Privacy & security → Camera / Microphone").
• You already have an appId and a token service (see Enable services and get credentials).

Install#

# planned vcpkg port (not published yet)
vcpkg install nimeet-rtc:x64-windows
# or add sdk/windows directly as a subdirectory CMake project
add_subdirectory(sdk/windows)
target_link_libraries(your_app PRIVATE nimeet::rtc)

Get a token#

The client must not hold customerSecret. In production the host program runs a backend service that issues tokens, and the C++ side only receives a string; during development you can keep the token in an environment variable, but do not compile it into the binary.

Join a channel#

#include "nimeet/rtc/IRtcEngine.h"

class Handler : public IRtcEngineEventHandler {
 public:
  void onJoinChannelSuccess(const char* channel, uid_t uid, int elapsed) override {
    // Join succeeded
  }
  void onUserJoined(uid_t uid, int elapsed) override { /* allocate the remote video */ }
  void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason) override { /* release the video */ }
  void onTokenPrivilegeWillExpire(const char* token) override { /* call renewToken after refreshing the token */ }
  void onError(int err, const char* msg) override { /* route by error number */ }
};

Handler handler;
IRtcEngine* engine = createAgoraRtcEngine();
RtcEngineContext context;
context.appId = app_id;
context.eventHandler = &handler;
engine->initialize(context);

engine->setChannelProfile(CHANNEL_PROFILE_LIVE_BROADCASTING);
engine->enableVideo();

VideoCanvas canvas;
canvas.view = local_hwnd;
engine->setupLocalVideo(canvas);
engine->startPreview();

engine->joinChannel(token, "weekly-sync", "", 10001);

joinChannel also has an overload taking ChannelMediaOptions& (to specify the role, subscription scope and publish source); for the complete signatures see the API reference for this platform.

Publish and subscribe#

engine->muteLocalAudioStream(true);   // mute the microphone
engine->muteLocalVideoStream(true);   // turn off the local video
engine->enableLocalVideo(false);      // stop capture
engine->updateChannelMediaOptions(options);

Screen sharing:

IScreenCaptureSourceList* sources = engine->getScreenCaptureSources({160, 90}, {32, 32}, true);
// share by window
Rectangle region{0, 0, 0, 0};
ScreenCaptureParameters params;
params.frameRate = 15;
engine->startScreenCaptureByWindowId(window_id, region, params);

Events#

IRtcEngineEventHandler has 88 callbacks. The most commonly used: onJoinChannelSuccess, onUserJoined, onUserOffline, onFirstRemoteVideoDecoded, onTokenPrivilegeWillExpire, onError, onConnectionStateChanged.

Error handling#

• Synchronous methods return int: 0 means success, and a negative value is an Agora error number.
• onError(int err, const char* msg) provides a readable message; log both.
• Unimplemented capabilities return -4 (ERR_NOT_SUPPORTED).

Troubleshooting#

Next steps#

• Full interfaces and overloads: API reference for this platform
• Error codes and troubleshooting: Error code table, FAQ
• Issue tokens on your server: Token authentication

Platform information

The public interfaces are aligned with the Agora windows API; installation and runtime requirements are listed under Prerequisites above.

Availability

This platform's SDK: Generally available. The examples use the public API; runtime capability follows the published SDK package.

join-channel flow

The method names, parameter types and return values match the API reference for the same platform. Where a method has several overloads, the most common one is shown here; see the API reference for all overloads.

initialize(config: const LocalSpatialAudioConfig&): int
muteRemoteAudioStream(uid: uid_t, mute: bool): int
renewToken(token: const char*): int
enableVideo(): int
joinChannel(token: const char*, channelId: const char*, info: const char*, uid: uid_t): int
leaveChannel(): int
setChannelProfile(profile: CHANNEL_PROFILE_TYPE): int
setClientRole(role: CLIENT_ROLE_TYPE): int
setupLocalVideo(canvas: const VideoCanvas&): int

Events and callbacks

Callbacks are registered on IRtcEngineEventHandler; naming differs by platform, and the full list is in the API reference for the same platform.

Error codes

the platform REST layer uses REST error codes；the SDK layer maps connection/authentication failures to Agora error numbers, for the mapping table see SDK error identifiers per platform。