MixOption

类型: interface

混音配置

• API

playCount

类型: number

混音播放次数

• 注意

• play_count <= 0: 无限循环

• play_count == 1: 播放一次（默认）
• play_count > 1: 播放 play_count 次

type

类型: AudioMixingType

混音播放类型

AudioMixingType

类型: enum

混音播放类型

• 成员

PlayerEvent

类型: interface

播放器事件

• API

type

类型: "video" | "audio"

类型

eventName

类型: string

事件名称

rawEvent

类型: Event

播放事件。详见官方文档

userId

类型: string

进房用户的 userId

publicStreamId

类型: string

公共流 ID。

readyState

类型: number

媒体就绪状态，详见官方文档

currentTime

类型: number

当前时间

isScreen

类型: boolean

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

onUserJoinedEvent

类型: interface

远端用户进房事件

• API

userInfo

类型: UserInfo

进房用户的 userId

UserInfo

类型: interface

用户信息。

• API

userId

类型: string

用户 ID，长度在 128 字节以内的非空字符串。

extraInfo

类型: string

用户传递的额外信息，最大长度为 200 字节。会在 onUserJoined 中回调给远端用户。

• 注意

支持以下字符集范围:

• 26 个大写字母: A ~ Z
• 26 个小写字母: a ~ z
• 10 个数字: 0 ~ 9
• 特殊字符: 下划线 "_"，at 符 "@"，减号 "-"

onUserLeaveEvent

类型: interface

远端用户退房事件

• API

userInfo

类型: UserInfo

用户信息

reason

类型: UserOfflineReason

远端用户离开房间的原因

UserOfflineReason

类型: enum

远端用户离开房间的原因

• 成员

ConnectionStateChangeEvent

类型: interface

连接状态改变

• API

state

类型: ConnectionState

内部连接状态

ConnectionState

类型: enum

SDK 与信令服务器连接状态。

• 成员

MediaType

类型: enum

媒体流类型

• 成员

StreamRemoveReason

类型: enum

房间内远端流移除原因。

• 成员

onVideoFirstFrameRenderedEvent

类型: interface

第一帧远端视频显示在视图上

• API

userId

类型: string

发布视频用户的 userId

height

类型: number

高度

width

类型: number

宽度

onVideoFirstFrameDecodedEvent

类型: interface

第一帧远端视频解码事件

• API

userId

类型: string

发布视频用户的 userId

height

类型: number

高度

width

类型: number

宽度

onAudioFirstFrameDecodedEvent

类型: interface

第一帧远端音频解码事件

• API

userId

类型: string

发布视频用户的 userId

DeviceInfo

类型: interface

媒体设备信息及状态。

• API

mediaDeviceInfo

类型: MediaDeviceInfo

媒体设备信息，参看 MediaDeviceInfo。

deviceState

类型: "active" | "inactive"

设备状态。
active：设备已连接。
inactive：设备已断开连接。

AutoPlayFailedEvent

类型: interface

自动播放失败事件

• API

userId

类型: string

自动播放失败的流所属的用户 ID。不带此参数时表示本地流播放失败。

kind

类型: "video" | "audio"

自动播放失败的媒体类型
例如，当同一用户的视频流和音频流自动播放都失败时，将触发两次 onAutoPlayFailed 回调，分别包含 audio 和 video 参数。

UserMessageEvent

类型: interface

点对点文本消息

• API

userId

类型: string

发送消息的用户

message

类型: string

点对点文本消息

UserBinaryMessageEvent

类型: interface

点对点二进制消息

• API

userId

类型: string

发送消息的用户

message

类型: ArrayBuffer

点对点二进制消息

RemoteStreamStats

类型: interface

远端媒体流统计信息，统计周期为 2s 。
本地用户订阅媒体流成功后，SDK 会周期性地通知远端的媒体流在此次统计周期内的接收状况。此数据结构为回调给用户的参数类型。

• API

userId

类型: string

进房用户的 userId

audioStats

类型: RemoteAudioStats

远端音频流信息

videoStats

类型: RemoteVideoStats

远端视频流信息

isScreen

类型: boolean

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

RemoteAudioStats

类型: interface

远端音频流统计信息，统计周期为 2s 。
本地用户订阅音频流成功后，SDK 会周期性地通知远端的音频流在此次统计周期内的接收状况。此数据结构为回调给用户的参数类型。

• API

audioLossRate

类型: number

音频丢包率。统计周期内的音频下行丢包率，取值范围为 [0, 1] 。

receivedKBitrate

类型: number

接收码率。统计周期内的音频接收码率，单位为 kbps 。

stallCount

类型: number

统计周期内的卡顿次数

stallDuration

类型: number

统计周期内的卡顿时长，单位为 ms 。

statsInterval

类型: number

统计间隔。此次统计周期的间隔，单位为 ms 。

rtt

类型: number

往返时延，单位：ms

jitterBufferDelay

类型: number

抖动延迟，单位：ms

numChannels

类型: number

声道数

receivedSampleRate

类型: number

接收侧采样率

concealedSamples

类型: number

音频丢包补偿(PLC) 样点总个数

concealmentEvent

类型: number

音频丢包补偿(PLC) 累计次数

RemoteVideoStats

类型: interface

远端视频流统计信息，统计周期为 2s 。
本地用户订阅视频流成功后，SDK 会周期性地通知远端的视频流在此次统计周期内的接收状况。此数据结构为回调给用户的参数类型。

• API

width

类型: number

宽度，单位：px

height

类型: number

高度，单位：px

videoLossRate

类型: number

视频丢包率。统计周期内的音频下行丢包率，取值范围为 [0, 1] 。

receivedKBitrate

类型: number

接收码率。统计周期内的音频接收码率，单位为 kbps 。

decoderOutputFrameRate

类型: number

解码器输出帧率。统计周期内的视频解码器输出帧率，单位 fps 。

stallCount

类型: number

统计周期内的卡顿次数

stallDuration

类型: number

统计周期内的卡顿时长，单位为 ms 。

isScreen

类型: boolean

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

statsInterval

类型: number

统计间隔。此次统计周期的间隔，单位为 ms 。

rtt

类型: number

客户端到服务端数据传输的往返时延，单位：ms

LocalStreamStats

类型: interface

本地媒体流统计信息以及网络状况，统计周期为 2s 。
本地用户发布媒体流成功后，SDK 会周期性地通知本地用户发布的媒体流在此次统计周期内的发送状况。此数据结构为回调给用户的参数类型。

• API

audioStats

类型: LocalAudioStats

本地发送音频流的统计信息。

videoStats

类型: LocalVideoStats

本地发送视频流的统计信息。

isScreen

类型: boolean

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

LocalAudioStats

类型: interface

本地音频流统计信息以及网络状况，统计周期为 2s 。
本地用户发布音频流成功后，SDK 会周期性地通知本地用户发布的音频流在此次统计周期内的发送状况。此数据结构为回调给用户的参数类型。

• API

audioLossRate

类型: number

音频丢包率。统计周期内的音频上行丢包率，取值范围为 [0, 1] 。

sendKBitrate

类型: number

发送码率。统计周期内的音频接收码率，单位为 kbps 。

recordSampleRate

类型: number

采集采样率。统计周期内的音频采集采样率信息，单位为 Hz 。

statsInterval

类型: number

统计间隔。此次统计周期的间隔，单位为 ms 。

rtt

类型: number

客户端到服务端数据传输的往返时延，单位：ms

numChannels

类型: number

声道数

LocalVideoStats

类型: interface

本地视频流统计信息以及网络状况，统计周期为 2s 。
本地用户发布视频流成功后，SDK 会周期性地通知本地用户发布的视频流在此次统计周期内的发送状况。此数据结构为回调给用户的参数类型。

• API

sentKBitrate

类型: number

发送码率，单位：kbps。统计周期内的视频发送码率

sentFrameRate

类型: number

发送帧率。统计周期内的视频发送帧率，单位为 fps 。

encoderOutputFrameRate

类型: number

编码器输出帧率。当前编码器在此次统计周期内的输出帧率，单位为 fps 。

rendererOutputFrameRate

类型: number

本地渲染帧率。统计周期内的本地视频渲染帧率，单位为 fps 。

statsInterval

类型: number

统计间隔。此次统计周期的间隔，单位为 ms 。

videoLossRate

类型: number

视频丢包率。统计周期内的音频上行丢包率，取值范围为 [0, 1] 。

rtt

类型: number

客户端到服务端数据传输的往返时延，单位：ms

encodedFrameWidth

类型: number

视频编码宽度，单位为 px 。

encodedFrameHeight

类型: number

视频编码高度，单位为 px 。

encodedFrameCount

类型: number

统计周期内发送的视频帧总数

codecType

类型: string

视频的编码类型，具体参考 VideoCodecType

isScreen

类型: boolean

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

PublicStreamStats

用户订阅的公共流统计信息以及网络状况，统计周期为 2s。

• 类型

Omit<
  RemoteStreamStats,
  'userId' | 'isScreen'
> & {
  publicStreamId: string;
}

• 成员

LocalAudioPropertiesInfo

类型: interface

本地音频信息

• API

streamIndex

类型: StreamIndex

流属性，标记该流为麦克风采集音频流或屏幕音频流。

audioPropertiesInfo

类型: AudioPropertiesInfo

音频属性信息。

StreamIndex

类型: enum

流属性

• 成员

AudioPropertiesInfo

类型: interface

音频属性信息

• API

linearVolume

类型: number

线性音量，与原始音量呈线性关系，数值越大，音量越大。取值范围是：[0,255]。
- [0, 25]: 无声
- [26, 75]: 低音量
- [76, 204]: 中音量
- [205, 255]: 高音量

nonlinearVolume

类型: number

非线性音量。由原始音量的对数值转化而来，因此在中低音量时更灵敏，可以用作 Active Speaker（房间内最活跃用户）的识别。取值范围是：[-127，0]，单位 dB。
- [-127, -60]: 无声
- [-59, -40]: 低音量
- [-39, -20]: 中音量
- [-19, 0]: 高音量

RemoteAudioPropertiesInfo

类型: interface

远端音频信息

• API

streamKey

类型: StreamKey

远端流信息

audioPropertiesInfo

类型: AudioPropertiesInfo

远端音频属性信息

StreamKey

类型: interface

远端流信息

• API

roomId

类型: string

房间 ID

userId

类型: string

用户 ID

streamIndex

类型: StreamIndex

流属性，标记该流为麦克风采集音频流或屏幕音频流。

onSEIMessageEvent

类型: interface

收到带有 SEI 消息的视频帧时，收到此回调

• API

remoteStreamKey

类型: RemoteStreamKey

包含 SEI 发送者的用户名，所在的房间名和媒体流

sei

类型: Uint8Array

收到的 SEI 消息内容

RemoteStreamKey

类型: interface

远端流信息

• API

roomId

类型: string

房间 ID

userId

类型: string

用户 ID

streamIndex

类型: StreamIndex

流属性，包括主流、屏幕流。

SubscribeState

类型: enum

音视频流订阅结果

• 成员

PublishState

类型: enum

音视频流发布结果

• 成员

AudioMixingStateChangedEvent

类型: interface

音频混音文件播放状态改变事件

• API

mixId

类型: number

混音 ID

state

类型: any

混音状态

error

类型: any

混音错误

CloudProxyConnectedEvent

类型: interface

• API

interval

类型: number

PublicStreamResultEvent

类型: interface

公共流发布结果

• API

code

类型: number

公共流发布事件编号

message

类型: string

公共流发布事件详情

PublicStreamVideoFirstFrameDecodedEvent

公共流首帧视频解码事件。

• 类型

Omit<
  onVideoFirstFrameDecodedEvent,
  'userId'
> & {
  publicStreamId: string;
}

• 成员

PublicStreamAudioFirstFrameDecodedEvent

类型: interface

公共流首帧解码/渲染事件。

• API

publicStreamId

类型: string

公共流 ID。

NetworkQuality

类型: enum

网络质量

• 成员

RemoteStreamSwitch

类型: interface

流切换信息。本地用户订阅的远端流触发回退策略时的流切换信息。

• API

userId

类型: string

订阅的音视频流的发布者的用户 ID

isScreen

类型: boolean

是否是屏幕共享流

beforeVideoIndex

类型: number

原分辨率视频流的下标

afterVideoIndex

类型: number

现分辨率视频流的下标

beforeEnable

类型: boolean

原媒体流是否是视频流

afterEnable

类型: boolean

现媒体流是否是视频流

reason

类型: FallbackOrRecoverReason

触发流回退或恢复的原因

FallbackOrRecoverReason

类型: enum

触发流回退或恢复的原因

• 成员

StreamMixingEvent

类型: interface

转推直播相关事件。

• API

event

类型: StreamMixingEventType

转推直播事件类型。

error

类型: StreamMixingEventErrorCode

转推直播事件错误码。

message

类型: string

转推直播事件错误详情。

StreamMixingEventType

类型: enum

转推直播事件类型

• 成员

StreamMixingEventErrorCode

类型: enum

转推直播错误码

• 成员

VideoStreamBannedEvent

类型: interface

视频流发布封禁/解禁事件

• API

uid

类型: string

被禁用/解禁的视频流用户 ID

banned

类型: boolean

视频流发布状态
true：视频流发布被禁止
false: 视频流发布被解禁

AudioStreamBannedEvent

类型: interface

音频流发布封禁/解禁事件

• API

uid

类型: string

被禁用/解禁的音频流用户 ID

banned

类型: boolean

音频流发布状态
true：音频流发布被禁止
false: 音频流发布被解禁

RoomConfig

类型: interface

房间参数配置

• API

isAutoPublish

类型: boolean

是否自动发布音频流，默认为自动发布。
取消自动发布后，通过调用 publish 进行音视频流发布。

isAutoSubscribeAudio

类型: boolean

是否自动订阅音频流，默认为自动订阅。
不包含屏幕流。
进房后，你可以调用 subscribeUserStream 修改订阅设置。

isAutoSubscribeVideo

类型: boolean

是否自动订阅视频流，默认为自动订阅。
不包含屏幕流。
进房后，你可以调用 subscribeUserStream 修改订阅设置。

roomProfileType

类型: RoomProfileType

房间模式
根据所需场景，选择合适的房间模式，应用不同的音视频算法、视频参数和网络配置
调用 setAudioProfile 选择音频参数配置

remoteVideoConfig

类型: RemoteVideoConfig

远端视频流参数

RoomProfileType

类型: enum

房间模式
调用 joinRoom 时，根据所需场景，选择合适的房间模式，应用不同的音视频算法、视频参数和网络配置
如果需要设置音频参数，应调用 setAudioProfile 进行配置

• 成员

RemoteVideoConfig

类型: interface

远端视频流参数

• API

width

类型: number

视频宽度，单位：px

height

类型: number

视频宽度，单位：px

ScreenConfig

类型: interface

屏幕共享流设置

• API

enableAudio

类型: boolean

在共享屏幕时是否显示共享音频选项:
• Window 端选择共享整个屏幕时支持共享系统音频；在共享 Chrome 标签页时支持共享 Tab 标签页面音频。
• macOS 仅支持在共享 Chrome 标签页时共享 Tab 标签页面音频。

VideoPlayerOption

类型: interface

播放器信息和渲染模式

• API

renderDom

类型: string | HTMLElement

DOM

renderMode

类型: VideoRenderMode

渲染模式：可选 RENDER_MODE_HIDDEN 和 RENDER_MODE_FIT 。

userId

类型: string

用户 ID，支持以下字符集范围
+ 26 个大写字母 A ~ Z
+ 26 个小写字母 a ~ z
+ 10 个数字 0 ~ 9
+ 下划线 "_"，at 符 "@"，减 号 "-"

VideoRenderMode

类型: enum

渲染模式

• 成员

MirrorType

类型: enum

镜像类型

• 成员

VideoEncoderConfig

类型: interface

视频编码参数

• API

width

类型: number

视频宽度，单位：px。

height

类型: number

视频高度，单位：px。

frameRate

类型: number

视频帧率，单位：fps。

maxKbps

类型: number

最大编码码率，RTC SDK 内部采集和自定义采集均需设定 > 0 的数值，默认值为 3000kbps。

ScreenEncoderConfig

类型: interface

屏幕共享的视频编码参数。

• API

width

类型: number

视频宽度，单位：px。

height

类型: number

视频高度，单位：px。

frameRate

类型: number

视频帧率，单位：fps。

maxKbps

类型: number

最大编码码率，RTC SDK 内部采集和自定义采集均需设定 > 0 的数值，默认值为 3000kbps。

contentHint

类型: "text" | "motion" | "detail"

屏幕共享的视频内容类型。
- 'detail'【默认值】：清晰度优先，适用于视频内容包含图片、文本混排的情况。
- 'text'：清晰度优先，适用于视频内容只包含大量文本的情况。
- 'motion'：流畅度优先，适用于视频内容为摄像头采集、电影、视频、游戏的情况。

• 注意

仅支持Chrome浏览器设置此参数。

AudioPropertiesConfig

类型: interface

音频信息提示的相关配置

• API

interval

类型: number

信息提示间隔，单位：ms，默认为 100ms
+ <= 0: 关闭信息提示；
+ (0,100]: 开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms；
+ > 100: 开启信息提示，并将信息提示间隔设置为此值。

enableInBackground

类型: boolean

是否在页面隐藏时保持开启获取音量回调，默认保持开启。
+ true: 保持开启
+ false：关闭

LiveTranscodeConfig

类型: interface

转码推流配置参数

• API

url

类型: string

推流 CDN 地址

audio

类型: Partial<LiveTranscodeAudioConfig>

音频参数

video

类型: Partial<LiveTranscodeVideoConfig>

视频参数

layout

类型: Partial<LiveTranscodeLayoutConfig>

用户布局信息

LiveTranscodeAudioConfig

类型: interface

音频转码配置参数

• API

codec

类型: string

音频编码格式，选填，默认为 AAC

kBitRate

类型: number

音频码率。单位为 kbps。可选取值：32, 64，128，192。默认值为 64 Kbps

sampleRate

类型: number

音频采样率。单位为 kHz。可选取值：32, 44.1, 48。默认值为 48 Khz。

channels

类型: number

音频声道数，可取 1 或 2。默认值为双声道。

AACProfile

类型: "LC" | "HEv1" | "HEv2"

AAC 编码类型。可选 LC, HEv1, 和 HEv2。默认值为 LC。

LiveTranscodeVideoConfig

类型: interface

视频转码配置参数。传入超出取值范围的值将导致转推任务发起或更新失败。

• API

width

类型: number

宽。范围为 [2, 4096]，必须是偶数。单位 px。默认 640 px。

height

类型: number

高。范围为 [2, 2160]，必须是偶数。单位 px。默认 360 px

codec

类型: string

编码格式。默认 H264。

fps

类型: number

合流视频帧率。取值范围 >0。单位 fps。默认为 30 fps。

gop

类型: number

视频 I 帧间隔。取值范围 >0。默认为 60。

lowLatency

类型: boolean

是否使用低延时特性。默认开启。

kBitRate

类型: number

合流视频码率。取值范围 [16, 50000000]。单位为 Kbps。默认为 600 Kbps。

LiveTranscodeLayoutConfig

类型: interface

视频流合流整体布局信息
开启转推直播功能后，你可以设置参与合流的每路视频流的预设布局信息和合流背景信息等。

• API

regions

类型: LiveTranscodeLayoutRegion[]

用户布局信息列表

appData

类型: string

透传的 App 数据

backgroundColor

类型: string

画布的背景颜色

LiveTranscodeLayoutRegion

类型: interface

单个视频流在合流中的布局信息

• API

alpha

类型: number

透明度。可选范围为 [0.0, 1.0]。

userId

类型: string

视频流发布用户的用户 ID

x

类型: number

视频流对应区域左上角的横坐标相对整体画面的归一化比例，取值的范围为 [0.0, 1.0)。

y

类型: number

视频流对应区域左上角的纵坐标相对整体画面的归一化比例，取值的范围为 [0.0, 1.0)。

zorder

类型: number

用户视频布局在画布中的层级。取值范围为[0 - 100]。0为底层，值越大越上层。

w

类型: number

视频流对应区域宽度相对整体画面的归一化比例，取值的范围为 (0.0, 1.0]。

h

类型: number

视频流对应区域高度相对整体画面的归一化比例，取值的范围为 (0.0, 1.0]。

renderMode

类型: number

视频显示模式，默认可设置为1。可选取值如下：
• 1: 视频尺寸等比缩放，优先保证窗口被填满。当视频尺寸与显示窗口尺寸不一致时，多出的视频将被截掉。
• 2: 视频尺寸等比缩放，优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时，会把窗口未被填满的区域填充成黑色。
• 3: 视频尺寸非等比例缩放，把窗口充满。当视频尺寸与显示窗口尺寸不一致时，视频高或宽方向会被拉伸。

contentControl

类型: number

合流内容控制。默认值为0，可选取值如下：
• 0: 输出的混流包含音视频
• 1: 只包含音频
• 2: 只包含视频

isScreenStream

类型: boolean

是否是屏幕流

isLocalUser

类型: boolean

是否本地用户

VideoSourceType

类型: enum

视频采集方式

• 成员

AudioSourceType

类型: enum

音频采集方式

• 成员

USER_ONLINE_STATUS

类型: enum

登录状态

• 成员

CloudProxyInfo

类型: interface

云代理信息。

• API

logProxy

类型: string

埋点日志上报的的代理地址。

accessProxy

类型: string

统一接入的代理地址。

configProxy

类型: string

RTC 配置下发的代理地址。

PublicStreamConfig

类型: interface

公共流配置信息

• API

video

类型: { width?: number; height?: number; fps?: number; kBitRate: number; }

视频参数

• 成员

  名称	类型	描述
  width	number	宽度，单位：px。 仅支持设为偶数，如果设为奇数，将导致公共流发布失败。
  height	number	高度，单位：px。 仅支持设为偶数，如果设为奇数，后处理会直接拒绝，导致公共流失败。
  fps	number	帧率，单位：fps
  kBitRate	number	码率，单位：kbps

layout

类型: { interpolationMode?: PublicInterpolationMode; backgroundColor?: string; backgroundImage?: string; regions?: PublicStreamLayoutRegion[]; }

公共流的布局模式

• 成员

  名称	类型	描述
  interpolationMode	PublicInterpolationMode	补帧模式
  backgroundColor	string	背景颜色，用 Hex 色值表示。
  backgroundImage	string	背景图片的 URL。长度最大为 1024 byte。可以传入的图片的格式包括：JPG, JPEG, PNG。
  regions	PublicStreamLayoutRegion[]	多路媒体流布局设置。

PublicInterpolationMode

类型: enum

补帧模式

• 成员

PublicStreamLayoutRegion

多路媒体流中一路流的布局设置。

• 类型

Omit<
  LiveTranscodeLayoutRegion,
  'isLocalUser' | 'contentControl'
> & {
  roomId: string;
  mediaType?: PublicStreamType;
  sourceCrop?: {
    x: number;
    y: number;
    w: number;
    h: number;
  };
}

• 成员

PublicStreamType

类型: enum

公共流输出内容类型

• 成员

SubscribeFallbackOption

类型: enum

订阅端音视频流回退选项。

• 成员

RemoteUserPriority

类型: enum

远端用户优先级

• 成员

AudioProfileType

类型: enum

音质档位
调用 setAudioProfile 设置的音质档位

• 成员

EngineConfig

类型: interface

引擎级别配置项

• API

autoPlayPolicy

类型: RTCAutoPlayPolicy

自动播放策略

RTCAutoPlayPolicy

类型: enum

自动播放策略。参考自动播放策略，获取更多相关信息。

• 成员