Unity SDK Guide

Unity package install, join, render and events.

Interface sections generated from the public SDK definitions

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

The Unity SDK has the C# RtcEngine + IRtcEngineEventHandler shape with capitalized method names (Initialize, JoinChannel, OnUserJoined) — the same as the Agora Unity reference version.

Prerequisites#

• Unity 2022.3 LTS+ (IL2CPP or Mono).
• Platform permissions: CAMERA/RECORD_AUDIO on Android, a usage description on iOS, the system camera permission on Windows/macOS.
• An appId and a token service (see Enable Services and Get Credentials).

Installation#

Planned distribution:
  1) UPM: add "com.nimeet.rtc": "file:../ni-meet/sdk/unity" to Packages/manifest.json
  2) or import the .unitypackage (Assets/Nimeet/Rtc)
Unity SDK installation and version information follow the published package; the examples on this page use the public interface.

Get a token#

The game backend issues the token; the Unity client only receives a string. Do not write the App Certificate into the client. Production advice: hand out a short-lived token at login and renew it against the same backend inside OnTokenPrivilegeWillExpire.

Join a channel#

using Nimeet.Rtc;

public class MeetingController : MonoBehaviour, IRtcEngineEventHandler
{
    private IRtcEngine engine;

    void Start()
    {
        engine = RtcEngine.CreateAgoraRtcEngine();
        var context = new RtcEngineContext { appId = AppConfig.AppId, eventHandler = this };
        engine.Initialize(context);
        engine.SetChannelProfile(ChannelProfileType.ChannelProfileLiveBroadcasting);
        engine.EnableVideo();
        engine.StartPreview();

        var options = new ChannelMediaOptions
        {
            clientRoleType = ClientRoleType.ClientRoleBroadcaster,
            autoSubscribeAudio = true,
            autoSubscribeVideo = true,
        };
        engine.JoinChannel(AppConfig.RtcToken, "weekly-sync", 10001, options);
    }

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

    void OnDestroy() => RtcEngine.Destroy();
}

Publishing and subscribing#

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

Screen sharing: GetScreenCaptureSources enumerates sources → StartScreenCaptureByDisplayId / StartScreenCaptureByWindowId; in Unity the shared picture is usually rendered into a RawImage (texture callback) rather than a VideoSurface.

Events#

IRtcEngineEventHandler is implemented explicitly in C#: 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 unity 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.

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

Events and callbacks

This SDK has no event 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。