目录
数据类型 | 描述 | 支持的最低版本 |
加入频道所需信息 | 0.7.0 | |
sdk 连接状态 | 0.7.0 | |
断网原因 | 0.7.0 | |
频道内的远端用户信息 | 0.7.0 | |
日志级别 | 0.7.0 | |
媒体类型 | 0.7.0 | |
远端媒体 | 0.7.0 | |
推流结果 | 0.7.0 | |
订阅参数 | 0.7.0 |
数据类型详情
JoinParam
加入频道所需信息
interface JoinParam
属性 | 类型 | 描述 | 版本 |
appId | string | 您在 DingRTC 项目的 AppId，仅支持大小写字母、数字和下划线。 | 0.7.0 |
channel | string | 频道 Id，字符内容只允许[A-Za-z0-9_-]，长度不超过64个字符。 | 0.7.0 |
token | string | 用于鉴权的token。 | 0.7.0 |
uid | string | 标识用户的 Id，字符内容只允许[A-Za-z0-9_-]，长度不超过64个字符。 | 0.7.0 |
userName | string | 用户名称，长度不超过UTF-8编码64个字节。 | 0.7.0 |
ConnectionState
sdk 连接状态
类型签名
type ConnectionState =
'disconnected' |
'connecting' |
'reconnecting' |
'connected' |
'disconnecting';DisconnectedReason
与服务器断开连接的原因
类型签名
type DisconnectedReason =
'leave' | // 用户主动离开
'network_error' | // 端侧网络链接异常
'server_error' | // 服务端错误
'uid_banned' | // uid 被移除
'uid_replaced' | // uid被重复登录顶替入会
'channel_banned'｜ // 频道被关闭
'timeout'; // 超时离会RemoteUser
频道内的远端用户信息，可以通过 DingRTCClient.remoteUsers 或者 DingRTCClient.on("user-joined") 等事件获取。
该对象描述了频道内远端用户的当前状态，包括远端用户 ID、远端是否发布了音频或视频等。
如果检测到远端用户已经发布，可以将这个对象传入 DingRTCClient.subscribe 中发起订阅。
属性列表
属性 | 类型 | 描述 | 版本 |
audioMuted | boolean | 远端当前麦克风是否静音。 | 0.7.0 |
videoMuted | boolean | 远端当前摄像头是否关闭。 | 0.7.0 |
auxiliaryMuted | boolean | 远端当前屏幕共享是否关闭。 | 0.7.0 |
hasAudio | boolean | 远端当前是否在发送音频。 | 0.7.0 |
hasAuxiliary | boolean | 远端当前是否在发送屏幕共享。 | 0.7.0 |
hasVideo | boolean | 远端当前是否在发送视频。 | 0.7.0 |
userId | string | 远端用户的用户 ID。 | 0.7.0 |
LogLevel
设置一个日志级别，你就能看到该级别及以上级别的所有日志
-debug 输出所有日志
-info 输出info、error、warn日志
-warn 输出error、warn日志
-error 输出error日志
-none 不输出日志
类型签名
type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';TrackMediaType
媒体类型
-audio 音频
-video 视频
类型签名
type TrackMediaType = 'audio' | 'video';RemoteTrack
远端媒体
类型签名
interface RemoteTrack {
/**
* RTMP 拉流地址
* 注意：在 v0.7.0 版本中，此字段通常用于绑定到原生 <live-player> 组件的 src 属性。
* 如果该字段为空或未定义，请检查是否需要在订阅时指定特定参数或通过其他方式获取流地址。
*/
rtmpPullUrl?: string;
}PublishResult
推流结果
类型签名
interface PublishResult {
/**
* RTMP 推流地址
* 注意：在小程序场景中，SDK 内部通常会自动处理推流，此字段可能用于调试或特定高级场景。
* 大多数情况下，开发者只需调用 publish 即可，无需手动处理此 URL。
*/
rtmpPushUrl?: string;
}SubscribeParam
订阅参数
类型签名
interface SubscribeParam {
/**
* 远端用户的 UID
* 注意：在源码中，uid 会被强制转换为字符串类型 ("".concat(t))
*/
uid: string;
/**
* 订阅的媒体类型
* 'audio': 仅订阅音频
* 'video': 仅订阅视频
*/
mediaType: 'audio' | 'video';
/**
* 是否为辅助流（屏幕共享）
* true: 订阅屏幕共享流
* false 或 undefined: 订阅主流（摄像头）
*/
auxiliary?: boolean;
}