Interface

ZegoAutoMixerTask

自动混流任务对象

详情

调用 [startAutoMixerTask] 函数向 ZEGO RTC 服务器发起自动混流任务时，需要通过该参数配置自动混流任务，包括任务 ID、房间 ID、音频配置、输出流列表、是否开启声浪回调通知。

业务场景：当向 ZEGO RTC 服务器发起自动混流任务时，需要这个配置。

属性

taskID

taskID: string

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

roomID

roomID: string

自动混流任务的房间 ID。

业务场景：当发起自动混流任务时，需要配置该参数。
是否必填：是。
取值范围：长度不超过 128 字节的字符串。

注意事项：仅支持数字，英文字符和 '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''。如果需要与 Web SDK 互通，请不要使用 '%'。

audioConfig

audioConfig: ZegoMixerAudioConfig

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

业务场景：如果对自动混流任务的音频有特殊需求，比如需要调整音频码率，可根据需要调整该参数，否则不用配置。
是否必填：否。
默认值：默认音频码率为 "48 kbps", 默认音频声道为 "ZEGO_AUDIO_CHANNEL_MONO", 默认编码 ID 为 "ZEGO_AUDIO_CODEC_ID_DEFAULT"，默认多路音频流混音模式为 "ZEGO_AUDIO_MIX_MODE_RAW"。
建议值：根据需求设置。

outputList

outputList: ZegoMixStreamOutput[]

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

业务场景：当发起自动混流任务时，需要配置该参数指明混流输出目标。Mix stream output target
是否必填：是。

enableSoundLevel

enableSoundLevel: boolean

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

streamAlignmentMode

streamAlignmentMode: number

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

minPlayStreamBufferLength

minPlayStreamBufferLength: number

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

取值范围：[0,10000]，超过最大值混流会失败。

ZegoBarrageMessageInfo

房间弹幕消息

属性

fromUser

fromUser: ZegoUser

发送消息用户

message

message: string

消息内容

sendTime

sendTime: number

发送时间

messageID

messageID: string

消息ID

ZegoBroadcastMessageInfo

广播消息

属性

fromUser

fromUser: ZegoUser

发送消息用户

message

message: string

消息内容

sendTime

sendTime: number

发送时间

messageID

messageID: number

消息ID

ZegoLogConfig

日志配置选项

支持版本：1.0.0

废弃时间：无

属性

logLevel

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

ZegoMixStreamAdvance

属性

backgroundColor

backgroundColor: number

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

backgroundImage

backgroundImage: string

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

videoCodec

videoCodec: 'VP8' | 'H264' | 'H265' | 'vp8' | 'h264' | 'h265';

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

userData

userData: Uint8Array

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

ZegoMixStreamConfig

属性

taskID

taskID: string

inputList

inputList: ZegoMixStreamInput[]

混流输入流列表

outputList

outputList: ZegoMixStreamOutput[]

混流输出流列表

outputConfig

outputConfig: ZegoMixStreamOutputConfig

混流输出配置

watermark

watermark: ZegoWatermark

混流水印

enableSoundLevel

enableSoundLevel: boolean

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

streamAlignmentMode

streamAlignmentMode: number

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

whiteboard

whiteboard: ZegoMixerWhiteboard

混流白板输入对象

ZegoMixStreamInput

属性

streamID

streamID: string

输入流 ID

contentType

contentType: "VIDEO" | "AUDIO" | "VIDEO_ONLY"

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

layout

layout: ZegoMixStreamLayout

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

renderMode

renderMode: ZegoMixStreamRenderMode

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

imageInfo

imageInfo: ZegoMixerImageInfo

用户图片信息。

label

label: ZegoLabelInfo

文字水印

cornerRadius

cornerRadius: number

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

是否必填：否。
取值范围：不超过 [layout] 参数设置的视频画面的宽高。
默认值：0。

soundLevelID

soundLevelID: number

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

volume

volume: number

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

isAudioFocus

isAudioFocus: boolean

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

ZegoMixStreamLayout

属性

top

top: number

目标位置，上

left

left: number

目标位置，左

bottom

bottom: number

目标位置，下

right

right: number

目标位置，右

ZegoMixStreamOutput

属性

target

target: string

混流输出流 ID 或 URL

videoConfig

videoConfig: ZegoMixerOutputVideoConfig

混流输出视频设置。

ZegoMixStreamOutputConfig

属性

outputBitrate

outputBitrate: number

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

outputFPS

outputFPS: number

混流输出视频帧率

outputWidth

outputWidth: number

混流输出视频分辨率宽度

outputHeight

outputHeight: number

混流输出视频分辨率高度

outputAudioCodecID

outputAudioCodecID: 0 | 1 | 2 | 3

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

outputAudioBitrate

outputAudioBitrate: number

混流输出音频码率，kbps

outputAudioChannels

outputAudioChannels: 1 | 2

混流输出声道数

audioMixMode

audioMixMode: ZegoAudioMixMode

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

ZegoMixerOutputVideoConfig

详情

配置混流输出的视频参数，编码格式、码率。

业务场景：手动混流场景，比如多人连麦直播。

属性

videoCodecID

videoCodecID: string

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

bitrate

bitrate: number

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

encodeProfile

encodeProfile: ZegoEncodeProfile

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

encodeLatency

encodeLatency: number

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

enableLowBitrateHD

enableLowBitrateHD: boolean

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

ZegoPlayAudioStats

属性

audioBitrate

audioBitrate: number

音频码率

audioCodec

audioCodec: string

音频编码格式"opus"

audioJitter

audioJitter: number

网络抖动

audioLevel

audioLevel: number

音量

audioPacketsLost

audioPacketsLost: number

丢包数

audioPacketsLostRate

audioPacketsLostRate: number

丢包率

audioQuality

audioQuality: number

拉流音频质量

audioSamplingRate

audioSamplingRate: number

采样率

muteState

muteState: "0" | "1"

音轨是否被关闭

audioFPS

audioFPS: number

音频帧率

audioCumulativeDecodeTime

audioCumulativeDecodeTime: number

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

audioCumulativeBreakTime

audioCumulativeBreakTime: number

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

audioCumulativeBreakRate

audioCumulativeBreakRate: number

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

ZegoPlayStats

拉流质量回调详细信息

属性

video

video: ZegoPlayVideoStats

视频相关描述

audio

audio: ZegoPlayAudioStats

音频相关描述

codecImplementationName

codecImplementationName: string

具体实现编码器的名称

currentRoundTripTime

currentRoundTripTime: number

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

googAvailableSendBandwidth

googAvailableSendBandwidth: string

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

nackCount

nackCount: number

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

pliCount

pliCount: number

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

sampleTimeWindow

sampleTimeWindow: number

样本时间窗口

totalRoundTripTime

totalRoundTripTime: number

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

ZegoPlayVideoStats

属性

frameHeight

frameHeight: number

接收视频高

frameWidth

frameWidth: number

接收视频宽

googCodecName

googCodecName: string

视频编码格式

muteState

muteState: "0"|"1"

视轨是否被关闭

videoBitrate

videoBitrate: number

视频码率

videoFPS

videoFPS: number

视频解码帧率

videoPacketsLost

videoPacketsLost: number

视频丢包数

videoPacketsLostRate

videoPacketsLostRate: number

视频丢包率

videoTransferFPS

videoTransferFPS: number

视频接收帧率

videoFramesDecoded

videoFramesDecoded: number

视频解码总大小

videoCumulativeDecodeTime

videoCumulativeDecodeTime: number

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

videoCumulativeBreakTime

videoCumulativeBreakTime: number

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

videoCumulativeBreakRate

videoCumulativeBreakRate: number

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

ZegoPlayerState

拉流状态

属性

streamID

streamID: string

流id

state

state: 'NO_PLAY' | 'PLAY_REQUESTING' | 'PLAYING'

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

errorCode

errorCode: number

错误码

extendedData

extendedData: string

扩展信息

ZegoPublishAudioStats

属性

audioBitrate

audioBitrate: number

音频码率

audioCodec

audioCodec: string

音频编码格式

audioPacketsLost

audioPacketsLost: number

音频丢包数

audioPacketsLostRate

audioPacketsLostRate: number

音频丢包率

googCodecName

googCodecName: string

音频编码格式

muteState

muteState: '0' | '1'

音轨是否被关闭

audioFPS

audioFPS: number

音频帧率

audioQuality

audioQuality: number

推流音频质量

ZegoPublishStats

属性

video

video: ZegoPublishVideoStats

推流视频数据

audio

audio: ZegoPublishAudioStats

推流音频数据

codecImplementationName

codecImplementationName: string

具体实现编码器的名称

currentRoundTripTime

currentRoundTripTime: number

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

googActualEncBitrate

googActualEncBitrate: string

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

googAvailableSendBandwidth

googAvailableSendBandwidth: string

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

googBandwidthLimitedResolution

googBandwidthLimitedResolution: string

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

googCpuLimitedResolution

googCpuLimitedResolution: string

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

googFrameHeightInput

googFrameHeightInput: string

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

googFrameRateInput

googFrameRateInput: string

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

googFrameWidthInput

googFrameWidthInput: string

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

googTargetEncBitrate

googTargetEncBitrate: string

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

muted

muted: boolean

是否静音

nackCount

nackCount: number

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

paused

paused: boolean

是否暂停

pliCount

pliCount: number

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

qualityLimitationReason

qualityLimitationReason: string

限制流质量的原因

sinkId

sinkId: string

输出的音频设备 ID

totalRoundTripTime

totalRoundTripTime: number

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

volume

volume: number

音量值

ZegoPublishStreamAudioConfig

属性

ANS

ANS: boolean

是否开启降噪

AGC

AGC: boolean

是否开启自动增益

AEC

AEC: boolean

是否开启回声消除

ZegoPublishVideoStats

属性

frameHeight

frameHeight: number

采集视频高

frameWidth

frameWidth: number

采集视频宽

googCodecName

googCodecName: string

视频编码格式

muteState

muteState: "0"|"1"

视轨是否被关闭

videoBitrate

videoBitrate: number

视频码率

videoFPS

videoFPS: number

视频编码帧率

videoPacketsLost

videoPacketsLost: number

视频丢包数

videoPacketsLostRate

videoPacketsLostRate: number

视频丢包率

videoTransferFPS

videoTransferFPS: number

视频发送帧率

isHardwareEncode

isHardwareEncode: boolean

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

ZegoPublisherState

推流状态

属性

streamID

streamID: string

流ID

state

state: 'PUBLISHING' | 'NO_PUBLISH' | 'PUBLISH_REQUESTING'

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

errorCode

errorCode: number

错误码

extendedData

extendedData: string

扩展信息

ZegoRTMEvent

信令服务相关事件集合

详情

描述事件名及其对应的回调参数。

业务场景：用于约束注册事件接口 on 和注销事件接口 off 的参数。

属性

roomUserUpdate

roomUserUpdate: RoomUserUpdateCallBack

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

roomStateUpdate

roomStateUpdate: RoomStateUpdateCallBack

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

roomOnlineUserCountUpdate

roomOnlineUserCountUpdate: RoomOnlineUserCountUpdateCallBack

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

IMRecvBroadcastMessage

IMRecvBroadcastMessage: IMRecvBroadcastMessageCallBack

房间消息通知

IMRecvBarrageMessage

IMRecvBarrageMessage: IMRecvBarrageMessageCallBack

房间弹幕消息通知

IMRecvCustomCommand

IMRecvCustomCommand: IMRecvCustomCommandCallBack

自定义信令通知

roomExtraInfoUpdate

roomExtraInfoUpdate: roomExtraInfoUpdateCallBack

监听房间附加消息通知

tokenWillExpire

tokenWillExpire: tokenWillExpireCallBack

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

roomStateChanged

roomStateChanged: RoomStateChangedCallBack

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

业务场景：开发者可以通过这个回调来判断房间内当前用户的状态。开发者调用房间相关函数 (参考 “相关接口”) 时会收到此通知。用户设备的网络情况变化时也可能收到此通知（SDK 在断线时会自动重新登录房间。
隐私保护声明：提醒用户尽量不要在某些参数（例如userName、userID）传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

注意事项：若长时间处于正在请求连接状态 LOGINING，一般是因为用户端网络不稳定导致。

方法

RoomUserUpdateCallBack

RoomUserUpdateCallBack(roomID: string, updateType: 'DELETE' | 'ADD', userList: ZegoUser[]): void

房间用户变化回调

参数

名称	类型	描述
roomID	string	发生用户变化房间的ID
updateType	'DELETE' \| 'ADD'	用户行为，DELETE 表示离开，ADD 表示进入
userList	ZegoUser[]	发生变化用户的具体信息

详情

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

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

限制频率：无

关注回调：无

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

支持版本：1.0.0

废弃时间：无

RoomStateUpdateCallBack

 RoomStateUpdateCallBack(roomID: string, state: 'DISCONNECTED' | 'CONNECTING' | 'CONNECTED', errorCode: number, extendedData: string): void

房间状态更新回调

参数

名称	类型	描述
roomID	string	房间ID
state	'DISCONNECTED' \| 'CONNECTING' \| 'CONNECTED'	DISCONNECTED: 登出房间或房间和服务器断开,并重试后仍旧失败。 CONNECTING: 断开并开始重连。 CONNECTED: 登录成功或重连成功。
errorCode	number	断开时候的具体错误码
extendedData	string	扩展信息

详情

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

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

限制频率：无

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

支持版本：1.0.0

废弃时间：无

RoomStateChangedCallBack

 RoomStateChangedCallBack(roomID: string, reason: ZegoRoomStateChangedReason, errorCode: number, extendedData: string): void

房间状态变化更新回调

参数

名称	类型	描述
roomID	string	房间ID
reason	ZegoRoomStateChangedReason	房间状态改变原因
errorCode	number	断开时候的具体错误码
extendedData	string	扩展信息

详情

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

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

限制频率：无

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

支持版本：2.16.0

废弃时间：无

RoomOnlineUserCountUpdateCallBack

RoomOnlineUserCountUpdateCallBack(roomID: string, count: number): void

房间内当前在线用户数量回调

参数

名称	类型	描述
roomID	string	发生用户变化房间的ID
count	number	当前在线用户数量

详情

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

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

重点提示：无

支持版本：1.11.0

废弃时间：无

IMRecvBroadcastMessageCallBack

IMRecvBroadcastMessageCallBack(roomID: string, chatData: ZegoBroadcastMessageInfo[]): void

房间消息通知

名称	类型	描述
roomID	string	房间ID
chatData	ZegoBroadcastMessageInfo[]	房间消息信息

IMRecvBarrageMessageCallBack

IMRecvBarrageMessageCallBack(roomID: string, messageInfo: ZegoBarrageMessageInfo[]): void

房间弹幕消息通知

名称	类型	描述
roomID	string	房间ID
messageInfo	ZegoBarrageMessageInfo[]	弹幕消息信息

IMRecvCustomCommandCallBack

IMRecvCustomCommandCallBack(roomID: string, fromUser: ZegoUser, command: string): void

自定义信令通知

名称	类型	描述
roomID	string	房间ID
fromUser	ZegoUser	发送消息用户信息
command	string	收到的自定义消息

roomExtraInfoUpdateCallBack

roomExtraInfoUpdateCallBack(roomID: string, roomExtraInfoList: ZegoRoomExtraInfo[], type: string, data: string): void

房间额外消息更新回调

名称	类型	描述
roomID	string	房间ID
roomExtraInfoList	ZegoRoomExtraInfo[]	房间附加消息数组
type	string	消息类型
data	string	消息内容

tokenWillExpireCallBack

tokenWillExpireCallBack(roomID: string): void

token将要过期回调

参数

名称	类型	描述
roomID	string	token将要过期房间的ID

详情

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

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

限制频率：无

关注接口：renewToken

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

支持版本：2.6.0

废弃时间：无

ZegoRoomConfig

房间相关配置

属性

userUpdate

userUpdate: boolean

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

maxMemberCount

maxMemberCount: number

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

ZegoRoomExtraInfo

属性

key

key: string

房间附加消息的键

value

value: string

房间附加消息的值

updateUser

updateUser: ZegoUser

更新房间附加消息的用户

updateTime

updateTime: number

房间附加消息的更新时间

ZegoRoomRecvTransparentMessage

收到房间的透传消息

属性

sendUser

sendUser: ZegoUser

发送的用户

content

content: Uint8Array

收到的消息内容

ZegoRoomSendTransparentMessage

房间透传消息

详情

房间透传消息，包括房间id, 消息内容，发送用户，发送类型，发送模式，超时时间。

属性

sendMode

sendMode: ZegoRoomTransparentMessageMode

发送模式

sendType

sendType: ZegoRoomTransparentMessageType

发送类型

content

content: Uint8Array

发送的内容

recvUserList

recvUserList: ZegoUser[]

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

timeOut

timeOut: number

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

ZegoServerResponse

属性

errorCode

errorCode: number

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

extendedData

extendedData: string

扩展信息

ZegoSoundLevelInfo

音浪信息

属性

streamID

streamID: string

流ID

soundLevel

soundLevel: number

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

type

type: "push" | "pull"

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

ZegoStreamList

流信息

属性

streamID

streamID: string

流 ID

user

user: ZegoUser

流对应的用户

extraInfo

extraInfo: string

流附加信息

urlsFLV

urlsFLV: string

flv 播放地址

urlsRTMP

urlsRTMP: string

rtmp 播放地址

urlsHLS

urlsHLS: string

hls 播放地址

urlsHttpsFLV

urlsHttpsFLV: string

https 协议的 flv 播放地址

urlsHttpsHLS

urlsHttpsHLS: string

https 协议的 hls 播放地址

ZegoUser

属性

userID

userID: string

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

userName

userName: string

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

ZegoVideoCodec

属性

H264

H264: boolean

是否支持H264编解码能力

VP8

VP8: boolean

是否支持VP8编解码能力

H265

H265: boolean

是否支持H265编解码能力

ZegoWebPublishOption

属性

streamParams

streamParams: string

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

extraInfo

extraInfo: string

流附加信息

videoCodec

videoCodec: 'VP8' | 'H264' | 'H265'

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

roomID

roomID: string

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

isSEIStart

isSEIStart: boolean

是否开启 SEI

SEIType

SEIType: ZegoSEIType

SEI 类型

forceSynchronousNetworkTime

forceSynchronousNetworkTime: number

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

enableDTX

enableDTX: boolean

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

inspectFlag

inspectFlag: ZegoInspectFlagType

注意事项：当设置为不允许送审时，审核服务商将不会拉取此条流送审；在使用流注入方式实现跨房间 PK 的业务场景时，建议将此字段设置为"不允许"，以避免同一条流在多个房间内被重复送审。

trafficControlFocusOnMode

trafficControlFocusOnMode: TrafficControlFocusOnMode

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

trafficControlMinVideoBitrate

trafficControlMinVideoBitrate: number

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

enableTrafficControl

enableTrafficControl: boolean

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

enableAutoSwitchVideoCodec

enableAutoSwitchVideoCodec: boolean

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

trafficControlMinVideoMode

trafficControlMinVideoMode: TrafficControlMinVideoBitrateMode

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

ZegoWechatMiniEvent

媒体服务相关事件集合

详情

描述事件名及其对应的回调参数。

业务场景：用于约束注册事件接口 on 和注销事件接口 off 的参数。

属性

publishQualityUpdate

publishQualityUpdate: PublishQualityUpdateCallBack

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

publisherStateUpdate

publisherStateUpdate: PublisherStateUpdateCallBack

推流状态回调

playQualityUpdate

playQualityUpdate: PlayQualityUpdateCallBack

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

streamExtraInfoUpdate

streamExtraInfoUpdate: StreamExtraInfoUpdateCallBack

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

playerStateUpdate

playerStateUpdate: PlayerStateUpdateCallBack

拉流状态回调

roomStreamUpdate

roomStreamUpdate: RoomStreamUpdateCallBack

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

mixerSoundLevelUpdate

mixerSoundLevelUpdate: MixerSoundLevelUpdateCallBack

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

mixerRelayCDNStateUpdate

mixerRelayCDNStateUpdate: MixerRelayCDNStateUpdateCallBack

混流转推 CDN 状态回调

方法

PublishQualityUpdateCallBack

PublishQualityUpdateCallBack(streamID: string, stats: ZegoPublishStats): void

订阅推流质量回调

参数

名称	类型	描述
streamID	string	推流流ID
stats	ZegoPublishStats	推流质量描述

详情

订阅推流质量回调

触发条件：推流成功后

限制频率：无

关注回调：无

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

支持版本：1.0.0

废弃时间：无

PublisherStateUpdateCallBack

PublisherStateUpdateCallBack(result: ZegoPublisherState): void

推流状态回调

参数

名称	类型	描述
result	ZegoPublisherState	推流状态结果

详情

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

触发条件：开始推流后

限制频率：无

关注回调：无

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

支持版本：1.0.0

废弃时间：无

RoomStreamUpdateCallBack

RoomStreamUpdateCallBack(roomID: string, updateType: 'DELETE' | 'ADD', streamList: ZegoStreamList[]): void

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

参数

名称	类型	描述
roomID	string	房间ID
updateType	'DELETE' \| 'ADD'	DELETE：流删除，ADD：流新增
streamList	ZegoStreamList[]	更新流列表，数组顺序是以服务器接收到的时间进行排序。

详情

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

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

限制频率：无

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

支持版本：1.0.0

废弃时间：无

PlayQualityUpdateCallBack

PlayQualityUpdateCallBack(streamID: string, stats: ZegoPlayStats): void

拉流质量回调,拉流成功后开始触发

参数

名称	类型	描述
streamID	string	流 ID
stats	ZegoPlayStats	拉流质量回调信息

详情

订阅拉流质量回调

触发条件：拉流成功后

限制频率：无

关注回调：无

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

支持版本：1.0.0

废弃时间：无

StreamExtraInfoUpdateCallBack

 StreamExtraInfoUpdateCallBack(roomID: string, streamList: { streamID: string; user: ZegoUser; extraInfo: string }[]): void

流附加消息变化时回调

参数

名称	类型	描述
roomID	string	房间ID
streamList	{ streamID: string; user: ZegoUser; extraInfo: string }[]	流信息

详情

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

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

支持版本：1.0.0

废弃时间：无

PlayerStateUpdateCallBack

PlayerStateUpdateCallBack(result: ZegoPlayerState): void

拉流状态发生变化时回调

参数

名称	类型	描述
result	ZegoPlayerState	拉流状态结果

详情

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

触发条件：开始拉流后

限制频率：无

关注回调：无

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

支持版本：1.0.0

废弃时间：无

ZegoWxConfig

属性

wxContext

wxContext: any

小程序组件上下文

pushAtr

pushAtr: string

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

playAtr

playAtr: string

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

ZegoWxPlayOption

属性

streamParams

streamParams: string

拉流选项

isMix

isMix: boolean

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

sourceType

sourceType: "CDN" | "BGP"

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

ZegoWxPlayerAttributes

拉流组件属性

属性

mode

mode: "RTC" | "live"

RTC：实时通话， live：直播模式，对应小程序 live-player 的 mode 属性

autoPlay

autoPlay: boolean

是否开启麦克风，默认为 true，对应小程序 live-player 的 mode 属性

muteAudio

muteAudio: boolean

是否静音,对应小程序 live-player 的 mute-audio 属性

muteVideo

muteVideo: boolean

是否拉取视频，对应小程序 live-player 的 mute-video 属性

orientation

orientation: "vertical" | "horizontal"

画面方向，vertical 表示竖直，horizontal 表示水平，对应小程序 live-player 的 orientation 属性

objectFit

objectFit: "contain" | "fillCrop"

填充模式，可选值有 contain，fillCrop，对应小程序 live-player 的 object-fit 属性

minCache

minCache: number

最小缓冲区，单位s（RTC 模式推荐 0.2s），对应小程序 live-player 的 min-cache 属性

maxCache

maxCache: number

最大缓冲区，单位s（RTC 模式推荐 0.8s）。缓冲区用来抵抗网络波动，缓冲数据越多，网络抗性越好，但时延越大。对应小程序 live-player 的 max-cache 属性

soundMode

soundMode: "speaker" | "ear"

声音输出方式，对应小程序 live-player 的 sound-mode 属性

autoPauseIfNavigate

autoPauseIfNavigate: boolean

当跳转到本小程序的其他页面时，是否自动暂停本页面的实时音视频播放，对应小程序 live-player 的 auto-pause-if-navigate 属性

autoPauseIfOpenNative

autoPauseIfOpenNative: boolean

当跳转到其它微信原生页面时，是否自动暂停本页面的实时音视频播放，对应小程序 live-player 的 auto-pause-if-open-native 属性

ZegoWxPublishOption

属性

sourceType

sourceType: "CDN" | "BGP"

推流格式

streamParams

streamParams: string

推流选项

extraInfo

extraInfo: string

额外信息

roomID

roomID: string

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

ZegoWxPusherAttributes

推流组件属性

属性

enableCamera

enableCamera: boolean

是否开启摄像头，默认为开启，对应小程序 live-pusher 的 enable-camera 属性

enableMic

enableMic: boolean

是否开启麦克风，默认为 true，对应小程序 live-pusher 的 enable-mic 属性

enableAgc

enableAgc: boolean

是否开启 agc，对应小程序 live-pusher 的 enable-agc 属性

enableAns

enableAns: boolean

是否开启 Ans，对应小程序 live-pusher 的 enable-ans 属性

minBitrate

minBitrate: number

最小码率，对应小程序 live-pusher 的 min-bitrate 属性

maxBitrate

maxBitrate: number

最大码率，对应小程序 live-pusher 的 max-bitrate 属性

frontCamera

frontCamera: "front" | "back"

选择摄像头，前置或后置，对应小程序 live-pusher 的 device-position 属性

enableZoom？

enableZoom？: boolean

是否开启聚焦，对应小程序 live-pusher 的 zoom 属性

videoWidth？

videoWidth？: number

视频宽度，对应小程序 live-pusher 的 video-width 属性

videoHeight？

videoHeight？: number

视频高度，对应小程序 live-pusher 的 video-height 属性

beautyLevel

beautyLevel: number

美颜。取值范围 0-9 ，0 表示关闭，对应小程序 live-pusher 的 beauty 属性

beautyStyle

beautyStyle: "smooth" | "nature"

美颜类型，平滑或自然，对应小程序 live-pusher 的 beauty-style 属性

whitenessLevel

whitenessLevel: number

美白等级。取值范围 0-9 ，0 表示关闭，对应小程序 live-pusher 的 whiteness 属性

videoOrientation

videoOrientation: "vertical" | "horizontal"

视频方向。vertical：垂直方向，horizontal：水平方向，对应小程序 live-pusher 的 orientation 属性

enableRemoteMirror

enableRemoteMirror: boolean

是否开启远端镜像，对应小程序 live-pusher 的 remote-mirror 属性

localMirror？

localMirror？: "auto" | "enable" | "disable"

设置本地镜像效果，auto：前置摄像头镜像，后置摄像头不镜像，enable：前置摄像头和后置摄像头都镜像 disable: 前置摄像头和后置摄像头都不镜像，对应小程序 live-pusher 的 local-mirror 属性

audioQuality

audioQuality: "low" | "high"

音频质量等级，对应小程序 live-pusher 的 audio-quality 属性

audioVolumeType

audioVolumeType: "media" | "voicecall"

音量类型，media: 媒体音量，voicecall: 通话音量，对应小程序 live-pusher 的 audio-volume-type 属性

audioReverbType

audioReverbType: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

音频混响类型。0：关闭，1：KTV，2：小房间，3：大会堂，4：低沉，5：洪亮，6：金属声，7：磁性，对应小程序 live-pusher 的 audio-reverb-type 属性

filter

filter: "standard"     | "pink"     | "nostalgia"     | "blues"     | "romantic"     | "cool"     | "fresher"     | "solor"     | "aestheticism"     | "whitening"     | "cerisered"

对应小程序 live-pusher 的 filter 属性，滤镜类型。standard：标准，pink：粉嫩，nostalgia：怀旧，blues：蓝调，romantic：浪漫，cool：清凉，fresher：清新，solor：日系，aestheticism：唯美，whitening：美白，cerisered：樱红

mode

mode: string

SD（标清）, HD（高清）, FHD（超清）, RTC（实时通话）

wxObject

推拉流实例接口参数

属性

success

success: Function

接口调用成功的回调函数

fail

fail: Function

接口调用失败的回调函数

complete

complete: Function

接口调用结束的回调函数（调用成功、失败都会执行）