Interface

混流任务 id（客户自定义,务必保证唯一），必填，最大为256个字符,仅支持数字,英文字符 和 '~', '!', '@', '#', '$', '', '^', '&', '*', '(', ')', '_', '+', '=', '-', ', ';', '’', ',', '

自动混流任务的房间 ID。

自动混流任务的音频配置，可配置音频码率、音频声道，编码 ID、多路音频流混音模式。

自动混流任务的输出流列表，列表中为 URL 或者流 ID，若为 URL 格式 目前只支持 RTMP URL 格式：rtmp://xxxxxxxx。

开启混流音浪回调通知，用于获取混流中每个音频输入的音浪。开启后拉混流时可通过 on [AutoMixerSoundLevelUpdate] 回调收到每条单流的声浪信息。

流对齐模式，0 为关闭，1为开启。

设置混流服务器拉流缓存自适应调整的区间范围下限。在实时合唱 KTV 场景下，推流端网络轻微波动可能会导致混流的卡顿，此时观众拉混流的时候，会有比较高概率出现卡顿的问题。通过调节混流服务器拉流缓存自适应调整的区间范围下限，可优化观众端拉混流出现的卡顿问题，但会增大延迟。默认不设置，即服务端使用自身配置值。只会对新的输入流设置生效，对于已经开始混流的输入流不生效。

发送消息用户

消息内容

发送时间

消息ID

发送消息用户

消息内容

发送时间

消息ID

本地 log 级别，等级越高，打印日志越少

混流背景颜色; backgroundColor 为十六进制的 RGB，输入格式必须为 0xRRGGBB00。例如纯白色则传 0xffffff00。

混流背景图片; backgroundImage 需要提前在即构后台预设 imageId，输入格式为 preset-id://xxx

混流视频编码，'vp8'(string) 或 ' h264' (string),默认 'h264'(string)

用户自定义数据，长度不超过 1000 字节，设置后拉流方可通过监听 [onPlayerRecvSEI] 的回调获取 SEI 内容。注意必须使用 [ByteBuffer.allocateDirect] 函数创建，否则数据不能传给SDK

混流任务 id（客户自定义,务必保证唯一），必填，最大为256个字符,仅支持数字,英文字符 和 '~', '!', '@', '#', '$', '', '^', '&', '*', '(', ')', '_', '+', '=', '-', ', ';', '’', ',', '

混流输入流列表

混流输出流列表

混流输出配置

混流水印

开启混流音浪回调通知，用于获取混流中每个音频输入的音浪。开启后拉混流时可通过 [mixerSoundLevelUpdate] 回调收到每条单流的声浪信息。 注：小程序拉流暂不支持 [mixerSoundLevelUpdate] 回调。

流对齐模式，0 为关闭，1为开启。

混流白板输入对象

输入流 ID

混流内容类型;contentType 取值为'VIDEO'(音视频)、'AUDIO'(纯音频),"VIDEO_ONLY"(纯视频), 默认为'VIDEO'

流在输出画布上的布局，当 contentType 为 “AUDIO” 时 layout 参数可不传。

渲染模式，0 为填充模式，1 为适应模式。

用户图片信息。

文字水印

视频画面圆角半径，单位 px。

混流音浪 ID，用于在 [mixerSoundLevelUpdate] 中找对应输入流的音浪值。

输入流音量, 有效范围 [0, 200], 默认是 100。

当前输入流是否开启焦点语音，开启了会突出此路流的声音。默认 false。

目标位置，上

目标位置，左

目标位置，下

目标位置，右

混流输出流 ID 或 URL

混流输出视频设置。

混流输出视频码率，kbps 数值 （必须，且大于 0）

混流输出视频帧率

混流输出视频分辨率宽度

混流输出视频分辨率高度

混流输出音频编码 outputAudioCodecID 可选0：HE-AAC,1： AAC-LC,2：MP3,3: OPULS ；默认为0。 注意：如果使用 CDN 录制，音频编码请选择 AAC-LC。这是因为部分浏览器（如 Google Chrome 和 Microsoft Edge）不兼容 HE-AAC 音频编码格式，从而导致录制文件无法播放。

混流输出音频码率，kbps

混流输出声道数

多路音频流混音模式。若 [ZegoAudioMixMode] 选择为 [Focused]，SDK 将会选择 4 路已设置 [isAudioFocus] 的输入流作为焦点语音突出，若未选择或选择少于 4 路，则会自动补齐 4 路。

混流输出视频编码格式，支持 H.264, H.265 编码

混流输出视频码率，单位为 kbps。默认值为 [ZegoMixStreamOutputConfig] 中配置的 bitrate。

混流输出视频编码规格。默认值为 [ZegoEncodeProfileDefault]。

混流输出视频编码延时，有效值范围 [0, 2000], 单位毫秒。默认值为 0。

开启高清低码，默认值为 false

音频码率

音频编码格式"opus"

网络抖动

音量

丢包数

丢包率

拉流音频质量

采样率

音轨是否被关闭

音频帧率

累计音频解码时长，单位为毫秒 （2.19.0 及以上版本支持）。

累计音频卡顿时长，单位为毫秒 （2.19.0 及以上版本支持）。

累计音频卡顿率，单位为 1，取值范围 [0,1]（2.19.0 及以上版本支持）。

视频相关描述

音频相关描述

具体实现编码器的名称

表示当前本端发送到远程对端并返回所需的秒数

发送视频数据可用的带宽（谷歌浏览器特有字段，且新版本已废弃）

接收端在检测到一个或多个数据包在传输过程中丢失后向发送端发送 NACK 数据包的次数

流的接收端向发送端发送 PLI 数据包的次数

样本时间窗口

发送 STUN 连接和同意检查请求与接收响应之间经过的总秒数

接收视频高

接收视频宽

视频编码格式

视轨是否被关闭

视频码率

视频解码帧率

视频丢包数

视频丢包率

视频接收帧率

视频解码总大小

累计视频解码时长，单位为毫秒 （2.19.0 及以上版本支持）。

累计视频卡顿时长，单位为毫秒 （2.19.0 及以上版本支持

累计视频卡顿率，单位为百分比，0.0 ~ 1.0 （2.9.0 及以上版本支持

流id

NO_PLAY：未拉流状态，PLAY_REQUESTING：正在请求拉流状态，PLAYING：正在拉流状态

错误码

扩展信息

音频码率

音频编码格式

音频丢包数

音频丢包率

音频编码格式

音轨是否被关闭

音频帧率

推流音频质量

推流视频数据

推流音频数据

具体实现编码器的名称

表示当前本端发送到远程对端并返回所需的秒数

视频编码器实际输出的码率（谷歌浏览器特有字段，且新版本已废弃）

发送视频数据可用的带宽（谷歌浏览器特有字段，且新版本已废弃）

是否因为宽带受限而降低发送的视频分辨率（谷歌浏览器特有字段，且新版本已废弃）

是否因为CPU不足而降低发送的视频分辨率（谷歌浏览器特有字段，且新版本已废弃）

发送端设置的分辨率高（谷歌浏览器特有字段，且新版本已废弃）

发送端设置的初始帧率（谷歌浏览器特有字段，且新版本已废弃）

发送端设置的分辨率宽（谷歌浏览器特有字段，且新版本已废弃）

视频编码的目标码率（谷歌浏览器特有字段，且新版本已废弃）

是否静音

接收端在检测到一个或多个数据包在传输过程中丢失后向发送端发送 NACK 数据包的次数

是否暂停

流的接收端向发送端发送 PLI 数据包的次数

限制流质量的原因

输出的音频设备 ID

发送 STUN 连接和同意检查请求与接收响应之间经过的总秒数

音量值

是否开启降噪

是否开启自动增益

是否开启回声消除

采集视频高

采集视频宽

视频编码格式

视轨是否被关闭

视频码率

视频编码帧率

视频丢包数

视频丢包率

视频发送帧率

是否开启硬编，true 为开启，false 为关闭，undefined 为未知。

流ID

NO_PUBLISH：未推流状态，PUBLISH_REQUESTING：正在请求推流状态，PUBLISHING：正在推流状态

错误码

扩展信息

当房间用户发生变化时触发的回调

房间和服务器之间的连接状态发生变化时触发的回调

房间内人数发生改变时触发

房间消息通知

房间弹幕消息通知

自定义信令通知

监听房间附加消息通知

token 过期时间少于30s时会触发

当房间的连接状态改变时触发该回调，并通知改变的原因。

参数

详情

当前登录的房间,如果用户发生新增,删除等,触发回调通知当前用户

触发条件：其他用户登录,退出时触发

限制频率：无

关注回调：无

重点提示：触发前提是登录时,设置了关注用户变化，即 loginRoom 的参数 config 的 userUpdate 设置为 true

参数

详情

房间连接状态回调，state 分别为'DISCONNECTED'，'CONNECTING'，'CONNECTED'

触发条件：登录房间、登出房间或断网重连等情况触发。

限制频率：无

重点提示：登录前注册才会收到回调，2.16.0 及以上版本建议使用 roomStateChanged。

参数

详情

房间连接状态回调，state 分别为'LOGINING'，'LOGINED'，'LOGIN_FAILED' ，'RECONNECTING'，'RECONNECTED'，'RECONNECT_FAILED'，'KICKOUT'，'LOGOUT'，'LOGOUT_FAILED'

触发条件：在断开连接，重试连接及重连成功时触发

限制频率：无

重点提示：登录前注册才会收到回调

参数

详情

回调当前房间内的在线人数

触发条件：用户成功登录房间时触发，成功登录后每30s触发一次

重点提示：无

参数

详情

token 将要过期通知, 收到通知后请主动调用renewToken更新token

触发条件：token 中包含过期时间前30s触发该回调

限制频率：无

关注接口：renewToken

重点提示：token过期时间取自token, 请确保生成token的服务器时间准确

设置 roomUserUpdate 是否回调，默认为 false 不回调

房间最大用户数量，传 0 视为不限制，默认无限制; 只有第一个登录房间的用户设置生效

房间附加消息的键

房间附加消息的值

更新房间附加消息的用户

房间附加消息的更新时间

发送的用户

收到的消息内容

发送模式

发送类型

发送的内容

消息接收者列表，当sendType 指定为ZegoRoomTransparentMessageModeOnlyServer 可不填。当指定为 ZegoRoomTransparentMessageModeClientAndServer 或 ZegoRoomTransparentMessageModeOnlyClient 时，为空将发送给房间所有在线用户。

消息的发送超时时间，单位s, 默认10s。

返回错误码，为 0 则是成功

扩展信息

流ID

音浪大小，取值范围 [0，100]，通常一个人正常说话时麦克风音浪会波动到 10 以上。

用于区分推拉流，“push” 表示推流，“pull” 表示拉流。

流 ID

流对应的用户

流附加信息

flv 播放地址

rtmp 播放地址

hls 播放地址

https 协议的 flv 播放地址

https 协议的 hls 播放地址

请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。 用户 ID，由开发者自己生成，最大 64 字节的字符串。仅支持数字，英文字符 和 '~', '!', '@', '#', '$', '', '^', '&', '*', '(', ')', '_', '+', '=', '-', ', ';', '’', ',', '.

请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。 用户名，由开发者自己生成，最大长度不超过 256 字节的字符串

是否支持H264编解码能力

是否支持VP8编解码能力

是否支持H265编解码能力

推流备选参数 ; 备选参数 streamParams 格式如下：'zg_expired=XX&zg_nonce=XX&zg_token=XX'，只有需要配置鉴权才传入（可选功能）

流附加信息

推流视频编码，只能传入 'VP8' (string) 或 'H264' (string)，默认值为 'H264' 。

房间ID，开启多房间功能后必填，选择在哪个房间推流。

是否开启 SEI

SEI 类型

推流时是否同步网络时间。且必须与 setStreamAlignmentProperty 方法配合使用。用于在混流服务或拉流端对多条流进行对齐，比如 KTV 的合唱场景。传 1 为开启，0 为关闭，默认是关闭。

是否开启 DTX 静音检测，用于减少不发声时推流的音频码率。默认是关闭 DTX。

触发流量控制的因素, 默认为TrafficControlFocusOnRemote

最低视频码率，单位为 kbps，当达不到最低视频码率时,以极低的视频帧率发送

流控开关，用于控制自适应码率，默认为开启， true： 开启， false：关闭。

当 videoCodec 不可用时，是否自动切换为可用的 videoCodec, 默认 false。 比如：当前设备不支持 H264，开启该配置后，SDK 会自动切换至 VP8。

流控触发最低码率时的视频发送模式。传 0 表示低码率切换纯音频；默认表示低码率时降低视频帧率。

推流质量回调，不支持支付宝小程序平台。

推流状态回调

拉流质量回调，每次回调间隔3s，不支持支付宝小程序平台

接收对端设置的流附加信息

拉流状态回调

相同房间内其他用户推的流增加或减少的通知。

混流中的每条单流的声浪更新通知。

自动混流中的每条单流的声浪更新通知。

背景虚化、虚拟的功能发生异常错误。

实验性 API 回调

混流转推 CDN 状态回调

参数

详情

订阅推流质量回调

触发条件：推流成功后

限制频率：无

关注回调：无

重点提示：每 3 秒回调一次

参数

详情

推流的状态通知，推流是异步过程，中间的状态切换都通过该接口回调。监听该回调，对重试依旧不能成功的情况，做错误日志收集，提示客户

触发条件：开始推流后

限制频率：无

关注回调：无

重点提示：必须在推流前监听

参数

详情

监听已登录房间内其他用户流的变化（增加，删除）

触发条件：房间内其他用户有流新增或删除

限制频率：无

重点提示：需要在登录房间前调用

参数

详情

订阅拉流质量回调

触发条件：拉流成功后

限制频率：无

关注回调：无

重点提示：每 3 秒回调一次

参数

详情

接收对端设置的流附加信息

触发条件：流附加消息更新

参数

详情

拉流的状态通知，拉流是异步过程，中间的状态切换都通过该接口回调。监听该回调，对重试依旧不能成功的情况，做错误日志收集，提示客户

触发条件：开始拉流后

限制频率：无

关注回调：无

重点提示：必须在拉流前监听

小程序组件上下文

用于存储推流组件属性字段，用于后续 推流的数据及视图更新

用于存储拉流组件列属性列表字段，用于后续拉流 数据及视图更新

拉流选项

是否拉混流。拉混流默认是只从 CDN 拉流，2.12.2 版本支持提供 sourceType 参数设置拉流来源为 “BGP” 即 ZEGO 服务器。

拉流来源，"BGP" 为 ZEGO RTC 服务器，"CDN" 为 CDN 服务器，需要 AppID 启用 CDN 配置；RTC 拉流默认是 "BGP"，拉混流默认值是 "CDN"。

推流格式

推流选项

额外信息

房间ID，开启多房间功能后必填，选择在哪个房间推流。