nimeet Docs
中文

Glossary

RTC / LiveKit / Agora concept mapping: channel, uid, token, track, egress, ingress, RTLS and more.

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

This page defines the terms that recur throughout the documentation so that the same concept does not mean different things on different pages.

Core concepts

TermMeaning
ChannelThe container for one call or live session; the same channel name means the same room
ParticipantOne connection inside a channel
UIDNumeric user identifier inside a project, 1..2147483647
userIdIM user id (string), linked to the uid through a mapping table
host / audienceThe role determines privilege bits; see Roles and live streaming
TrackOne audio or video stream; on the web you publish track objects
publishPush a local track to the media server
subscribePull a remote track
DataChannelReliable messaging channel on the connection
TokenAccess credential with an nrt1. envelope; see AccessToken2 semantics
App ID / App CertificateProject identifier + signing secret

Server-side jobs

TermMeaning
Cloud RecordingRecord a channel into files; composite / individual / web modes
Media Push (stream to a CDN)Push channel content to an RTMP address
Media Pull / input online media streamPull an external stream into a channel
Media Gateway / RTMP gatewayBring an external OBS stream into a channel
Cloud TranscodingProduce multi-bitrate ABR outputs
Crystal BallReal-time monitoring, call investigation, data insights and alerts
Webhook / callbackEvent notification signed with Agora-Signature
Kicking ruleBan joining or publishing by channel/uid/privilege

Metrics and billing

TermDefinitionWhere it appears
Video freeze rateTotal video freeze time / total video time (each freeze > 200 ms counts)Analytics
Audio freeze rateTotal audio freeze time / total audio timeSame
Network latency rateTime with end-to-end latency > 400 ms / total audio-video timeSame
Join success rateSuccessful joins / attempts (5-second success tracked separately)Same
MinutesAccumulated participant online time (float, sums rounded to 2 decimals)Pricing
pexpPrivilege expiry time, always ≤ expAccessToken2 semantics
sdkCodeAgora client error number (negative); REST error definitions store the positive absolute valueError codes

Easily confused terms

Easy to confuseDifference
setEnabled(false) vs setMuted(true)Agora 4.x uses setEnabled; setMuted belongs to older or other vendors' shapes
Channel name vs channel idni-meet has only a channel name (channelName), no separate id
resourceId vs sidIn cloud recording, resourceId is a lease (30 s TTL) and sid is the session; both are required
converter vs entry pointA converter is the current Media Push resource; an entry point is the retired legacy form
player vs online-streamA player is a pulled-in stream (Media Pull); an online-stream is a pushed-in stream (Media Gateway)
Ban vs kickA ban rule blocks future joins; a kick disconnects the current connection (and can be combined with a rule to prevent reconnection)

Generated by the documentation build pipeline · 2026-10-31 01:24:02 UTC · Documentation center v1.1.0.

Content follows the public API definitions.

ni-meet is a self-hosted RTC PaaS with a LiveKit-based media plane (Apache-2.0) and an Agora-compatible API.