Types

ChannelInfo

Purpose: Channel info data, describing the channel’s basic properties, capacity limits, and extension fields.

Property	Data type	Description
appId	String?	App ID.
channel	String	Channel name.
created_at	Long	Channel creation time.
updated_at	Long	Channel update time.
link_id	Int	Media streaming connection ID.
max_user	Int	Maximum number of users in the channel.
max_audio	Int	Maximum number of audio streams forwarded in the channel.
max_peer	Int	Maximum number of streams that can be forwarded per user in the channel.
max_video	Int	Maximum number of video streams that can be forwarded per user in the channel.
props	JsonElement?	Custom properties.

UserInfo

Purpose: User info data, describing the user’s identity, device info, join status, and published tracks.

Property	Data type	Description
app_id	String?	App ID.
uid	String	User ID on your platform.
sid	String?	Session ID.
name	String?	User name.
device_type	Int?	Device type.
device_id	String?	Unique device identifier.
sdk_version	String?	SDK version.
version	String?	Version.
props	JsonElement?	Custom properties.
netid	String?	Network ID.
sgid	String?	Group ID.
channel	String?	Channel name.
is_audience	Boolean	Whether the user is audience.
join_at	Long	Join time.
updated_at	Long	Update time.
leave_at	Long	Leave time.
stream_tracks	`ArrayList<TrackInfo>?`	Info on the tracks currently being published.
link_id	Int	Media streaming connection ID.
session_key	String?	Media streaming connection key.
upload_id	String?	ID of the media streaming service the user currently belongs to.

TrackInfo

Purpose: Track info data, describing an audio or video stream’s identifier, media parameters, and extension fields.

Property	Data type	Description
id	String	Stream ID.
desc	String	Stream description.
kind	String	Stream type (`video` / `audio`).
codec	Int	Codec type.
width	Int	Video width.
height	Int	Video height.
fps	Int	Video frame rate.
angle	Int	Video angle.
bitrate	Int	Bitrate.
sample_rate	Int	Audio sample rate.
fallback_ids	`MutableList<String>?`	IDs of the lower-layer tracks this layer can fall back to, excluding itself, ordered from highest to lowest quality.
variant	Boolean?	Whether this is a simulcast secondary layer; the primary layer is usually `false`.
track	Int	Media streaming track (0–6).
props	JsonElement?	Custom properties.

UserTrackDesc

Purpose: A composite key of user and track description, commonly used to locate statistics or stream info by user track.

Property	Data type	Description
uid	String	User UID.
trackDesc	String	Track description.

VolumeInfo

Purpose: Volume data, describing the user’s current audio energy.

Property	Data type	Description
uid	String	User UID.
db	Int	Audio energy (decibels).

ActiveSpeakerInfo

Purpose: Active speaker info, delivered by RTCMediaEvent.onActiveSpeakersChanged.

Property	Data type	Description
uid	String	The speaking user’s uid.
trackId	String	The audio track’s trackId.
level	Double	Volume intensity quantized by the server.

NetworkQualityChange

Purpose: A network quality level event, delivered by RTCMediaEvent.onNetworkQualityChanged. Every quality report from the server fires once each for uplink and downlink (no debouncing); each callback represents only one direction.

Property	Data type	Description
direction	QualityDirection	The direction that changed (`UPLINK` / `DOWNLINK`). For the enum, see Enums.
previousLevel	String	The level in the previous callback; an empty string the first time (`INITIAL`).
currentLevel	String	The current level (`excellent` / `good` / `poor` / `lost`).
trend	QualityTrend	The trend compared with the previous callback (`INITIAL` / `DEGRADED` / `RECOVERED` / `STABLE`). For the enum, see Enums.
report	MediaMetric.QualityReport	A snapshot of the full quality report that triggered this event. For fields, see Media quality.

CameraDeviceCapability

Purpose: Camera device capability info, returned by RTCEngine.getCameraDevices and RTCCameraDeviceEvent.onCameraDeviceListChanged.

Property	Data type	Description
cameraId	String	The native Camera2 camera id, usable with `LocalCameraTrack.switchCameraDevice`.
position	CamraPosition	The SDK’s unified camera position (`FRONT` / `BACK` / `External`).
displayName	String?	The default display name generated by the SDK.
sensorOrientation	Int	The Camera2 sensor mounting orientation.
hardwareLevel	Int	The Camera2 hardware capability level.
formats	List<CameraFormatCapability>	The YUV capture formats supported by the device.
controls	CameraControlCapability	The control capabilities supported by the device.

CameraFormatCapability

Purpose: Camera capture format capability.

Property	Data type	Description
width	Int	Capture width.
height	Int	Capture height.
minFps	Int	Minimum frame rate of the AE fps range.
maxFps	Int	Maximum frame rate of the AE fps range.

CameraControlCapability

Purpose: Camera control capability.

Property	Data type	Description
supportsTorch	Boolean	Whether a flash or fill light is supported.
supportsZoom	Boolean	Whether zoom is supported.
supportsFocus	Boolean	Whether focus control is supported.
supportsExposure	Boolean	Whether exposure compensation is supported.
supportsWhiteBalance	Boolean	Whether white balance mode control is supported.

MicDeviceCapability

Purpose: Microphone input device capability info, returned by RTCEngine.getMicDevices(), LocalMicTrack.getMicDevices(), and RTCMicDeviceEvent.onMicDeviceListChanged.

Property	Data type	Description
deviceId	String	The `AudioDeviceInfo.id` string currently assigned by the system, valid only while the device stays connected; usable with `switchMicDevice(...)`.
key	MicDeviceKey	A persistent key for matching the device across re-plugging.
type	Int	The `AudioDeviceInfo.TYPE_*` input device type.
displayName	String?	The display name generated by the SDK.
productName	String?	The device product name reported by the system.
address	String?	The device address, such as a Bluetooth address or USB path; may be empty.
sampleRates	List<Int>	The sample rates the device reports as supported.
channelCounts	List<Int>	The channel counts the device reports as supported.
isDefault	Boolean	Whether this is the system’s current default input device.
isCurrent	Boolean	Whether this is the device currently used by the SDK’s microphone capture module.

MicDeviceKey

Purpose: The persistent matching key for a microphone device. The system deviceId may change after re-plugging, so the SDK uses type + address + productName to match the device again.

Property	Data type	Description
type	Int	The `AudioDeviceInfo.TYPE_*` input device type.
address	String?	The device address; may be empty.
productName	String?	The device product name; may be empty.

YuvFormat

Package path: cn.seastart.rtc.media.format.YuvFormat. Identifies the pixel layout of raw video frames; it doesn’t mean every input API supports every format.

Constant	Value	Pixel layout
`NV21`	`17`	Y plane + interleaved VU plane.
`NV12`	`19`	Y plane + interleaved UV plane.
`I420`	`808596553`	Separate Y, U, and V planes.
`YV12`	`842094169`	Separate Y, V, and U planes.
`YUY2`	`20`	Packed YUYV format.

The raw screen frame callback and LocalCustomVideoTrack.inputData use I420. The render view’s updateFrame supports I420, NV12, and NV21, but not YV12 or YUY2.

Overview

Web SDK

Android SDK

Swift SDK (iOS/macOS)

C SDK (server/embedded)

Python SDK (server-side AI)

Server API

ChannelInfo

UserInfo

TrackInfo

UserTrackDesc

VolumeInfo

ActiveSpeakerInfo

NetworkQualityChange

CameraDeviceCapability

CameraFormatCapability

CameraControlCapability

MicDeviceCapability

MicDeviceKey

YuvFormat

​ChannelInfo

​UserInfo

​TrackInfo

​UserTrackDesc

​VolumeInfo

​ActiveSpeakerInfo

​NetworkQualityChange

​CameraDeviceCapability

​CameraFormatCapability

​CameraControlCapability

​MicDeviceCapability

​MicDeviceKey

​YuvFormat

ChannelInfo

UserInfo

TrackInfo

UserTrackDesc

VolumeInfo

ActiveSpeakerInfo

NetworkQualityChange

CameraDeviceCapability

CameraFormatCapability

CameraControlCapability

MicDeviceCapability

MicDeviceKey

YuvFormat