Web SDK Guide

Web SDK install, join, publish/subscribe, screen sharing and browser support.

Interface sections generated from the public SDK definitions

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

The browser SDK exposes the same public API as Agora Web SDK 4.24.9: 142 methods, 153 overloads, 47 events and 96 error identifiers. The method chain below covers the full path from creating a client and joining a channel to publishing, subscribing and leaving, and can be reused directly in your application.

Prerequisites#

• Node.js ≥ 22 (for builds and tests) and pnpm 10; run pnpm install.
• Browsers: Chrome 65+, Edge, Firefox 69+, Safari 11+ (screen sharing needs Safari 13+).
• Capturing audio and video requires a secure context: https:// or http://localhost; over a plain http:// LAN IP, getUserMedia fails outright.
• You have obtained an appId as described in Enable services and get credentials, plus a backend that can issue tokens.

Install#

pnpm add @nimeet/rtc-web

When developing inside the codebase, use the workspace package: pnpm --filter @nimeet/rtc-web build. The version matches the reference version (the apiVersion in the SDK interface definition matches the interface definition section).

Get a token#

The browser cannot hold customerSecret. The correct chain is your backend calling the control plane:

// Your backend (Node example):
// POST $NIMEET_API_BASE/v1/tokens  { channelName, uid, role, ttlSeconds }
// The frontend only receives { appId, rtcToken, rtcUid }
const response = await fetch('/api/rtc-token?channel=weekly-sync&uid=10001');
const { appId, rtcToken, rtcUid } = await response.json();

For token semantics (privilege bits, the exp/pexp split, wildcards) see AccessToken2 semantics.

Join a channel#

import AgoraRTC from '@nimeet/rtc-web';

const client = AgoraRTC.createClient({ mode: 'rtc', codec: 'vp8' });

client.on('user-published', async (user, mediaType) => {
  await client.subscribe(user, mediaType);
  if (mediaType === 'video') user.videoTrack?.play('remote-player');
  if (mediaType === 'audio') user.audioTrack?.play();
});
client.on('token-privilege-will-expire', async () => {
  const fresh = await fetch('/api/rtc-token?renew=1').then((r) => r.json());
  await client.renewToken(fresh.rtcToken);
});

const uid = await client.join(appId, 'weekly-sync', rtcToken, rtcUid);

The page needs two containers: <div id="local-player"></div> and <div id="remote-player"></div>. The media edge address is resolved in the order surl in the token payload → window.__NIMEET_SFU_URL__ → same-origin /rtc.

Publish and subscribe#

const [microphoneTrack, cameraTrack] = await AgoraRTC.createMicrophoneAndCameraTracks();
cameraTrack.play('local-player');
await client.publish([microphoneTrack, cameraTrack]);

// Manual subscription (auto-subscribe is the default; once disabled you must subscribe yourself)
await client.unsubscribe(remoteUser, 'video');
cameraTrack.setEnabled(false); // mute the video but keep publishing

Tracks are objects: what you publish is an ILocalTrack instance, not a "resource id". To stop publishing call client.unpublish(track); to release the capture call track.close().

Events#

Error handling#

Every failure is an AgoraRTCError: { code, message, data? }, where code is an Agora 4.x string identifier (INVALID_PARAMS, PERMISSION_DENIED, TOKEN_EXPIRE…); the full table of 96 entries is in this platform's API reference. Platform REST error codes also carry sdkCode (a negative error number); for the mapping see SDK error identifiers per platform.

try {
  await client.publish([microphoneTrack, cameraTrack]);
} catch (error) {
  if (error.code === 'PERMISSION_DENIED') {
    // The user denied the camera/microphone permission
  } else if (error.code === 'NOT_SUPPORTED') {
    // The capability is not implemented on the current media stack (for example E2EE); do not ignore it silently
  }
}

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 javascript 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.

join(appid: string, channel: string, token: string|null, uid?: UID|null, options?: {autoSubscribe?:boolean;autoReceiveAndPlayAudio?:boolean;networkQualityProbe?:boolean}): Promise<UID>
leave(): Promise<void>
publish(tracks: ILocalTrack|ILocalTrack[]): Promise<void>
renewToken(token: string): Promise<void>
setClientRole(role: ClientRole, options?: ClientRoleOptions): Promise<void>
subscribe(user: IAgoraRTCRemoteUser|UID, mediaType: "video"): Promise<IRemoteVideoTrack>
createClient(config: ClientConfig): IAgoraRTCClient

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。