Skip to content

Network Diagnostics API

Network connectivity testing for business servers, media servers, and the public internet.

API Reference

checkBusinessServerConnection()

Check business server connectivity.

向课堂 API 活跃域名发送 HEAD 请求,记录往返时延。建议在用户反馈卡顿时主动调用, Sends a HEAD request to the active classroom API domain and measures round-trip latency. Combine with checkMediaServerConnection / checkNetworkConnection to localize failure sources.

Returns: Promise<TResult<{ latency: number; }>>

Example:

ts
const r = await classroom.checkBusinessServerConnection();
if (r.ok && r.data.latency > 1000) toast.warn('业务服务器延迟较高');

checkMediaServerConnection()

Check media server (TRTC) connectivity.

Uses TRTC SDK speed test; must be called after joinClass().

Returns: Promise<TResult<{ latency: number; lost: number; }>>

Example:

ts
const r = await classroom.checkMediaServerConnection();
if (r.ok && (r.data.latency > 300 || r.data.lost > 0.1)) {
  toast.warn('当前媒体网络较差');
}

checkNetworkConnection()

Check basic network connectivity.

Sends a HEAD request to a public speed-test endpoint with a 5s timeout — for the most basic "is the network up" check.

Returns: Promise<TResult<boolean>>

Example:

ts
const r = await classroom.checkNetworkConnection();
if (!r.ok) toast.error('当前网络不可用,请检查网络连接');