C# (.NET) SDK Reference

Windows .NET SDK public interface, installation and capability notes.

Interface sections generated from the public SDK definitions

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

The C# (.NET) SDK has the RtcEngine + IRtcEngineEventHandler shape; it is isomorphic to the Unity SDK but targets desktop .NET (WPF / WinForms / console services).

Prerequisites#

• .NET 8 SDK (net8.0), Windows 10 1809+ (the current declaration reference version comes from the Windows C# wrapper).
• System camera/microphone permissions.
• An appId and a token service (see Enable Services and Get Credentials).

Installation#

<!-- planned coordinates, not published to NuGet yet -->
<PackageReference Include="Nimeet.Rtc" Version="0.1.0" />

Get a token#

Your server issues the token (POST /v1/tokens); the desktop client only receives the string. Never put appCustomerSecret into a configuration file.

var response = await httpClient.GetFromJsonAsync<TokenResponse>("/api/rtc-token?channel=weekly-sync&uid=10001");
engine.JoinChannel(response.RtcToken, "weekly-sync", 10001, options);

Join a channel#

using Nimeet.Rtc;

public sealed class MeetingController : IRtcEngineEventHandler
{
    private readonly IRtcEngine engine;

    public MeetingController(string appId)
    {
        engine = RtcEngine.CreateAgoraRtcEngine();
        engine.Initialize(new RtcEngineContext { AppId = appId, EventHandler = this });
        engine.SetChannelProfile(ChannelProfileType.ChannelProfileLiveBroadcasting);
        engine.EnableVideo();
        engine.StartPreview();
    }

    public void Join(string token, uint uid)
    {
        var options = new ChannelMediaOptions
        {
            ClientRoleType = ClientRoleType.ClientRoleBroadcaster,
            AutoSubscribeAudio = true,
            AutoSubscribeVideo = true,
        };
        var code = engine.JoinChannel(token, "weekly-sync", uid, options);
        if (code < 0) throw new RtcException(code);
    }

    public void OnJoinChannelSuccess(RtcConnection connection, int elapsed) { }
    public void OnUserJoined(RtcConnection connection, uint remoteUid, int elapsed) { }
    public void OnUserOffline(RtcConnection connection, uint remoteUid, UserOfflineReasonType reason) { }
    public void OnTokenPrivilegeWillExpire(string token) => engine.RenewToken(FetchFreshToken());
    public void OnError(int err, string msg) => Console.Error.WriteLine($"rtc {err}: {msg}");
}

Publishing and subscribing#

engine.MuteLocalAudioStream(true);
engine.MuteLocalVideoStream(true);
engine.EnableLocalVideo(false);
engine.UpdateChannelMediaOptions(options);

Screen sharing: GetScreenCaptureSources → StartScreenCaptureByWindowId / StartScreenCaptureByScreenRect; in WPF the remote picture is usually drawn into an Image/D3DImage through the render callback the plugin provides.

Events#

IRtcEngineEventHandler: 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;
• Asynchronous errors arrive through OnError;
• 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 csharp 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.

JoinChannel(token: string, channelId: string, info?: string, uid?: uint): int
LeaveChannel(): int
MuteRemoteAudioStream(uid: uint, mute: bool): int
SetClientRole(role: CLIENT_ROLE_TYPE): int
SetupLocalVideo(canvas: VideoCanvas): int
StartPreview(): int
Initialize(): int
RenewToken(token: string): int
SetChannelProfile(profile: CHANNEL_PROFILE_TYPE): int

Events and callbacks

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。