Global

Type Definitions

RemoteMutedState

Properties:
Name Type Description
userId string

远端用户ID

hasVideo boolean

是否有视频

hasSmall boolean

是否有小流视频

hasAudio boolean

是否有音频

audioMuted boolean

是否静音

videoMuted boolean

是否关闭摄像头

远端用户音视频 mute 状态

TransportStats

Properties:
Name Type Description
rtt number

SDK 到腾讯视频云的上行媒体连接的 RTT (Round-Trip Time),单位 ms

downlinksRTT object.<userId, rtt>

SDK 到腾讯视频云的下行媒体连接的 RTT (Round-Trip Time),单位 ms。
自 v4.10.1 版本支持,对象的 key 为远端用户的 userId,value 为 rtt 值。

传输状态统计

Type:
  • object

LocalAudioStats

Properties:
Name Type Description
bytesSent number

已发送字节数

packetsSent number

已发送包数

本地流音频统计数据

Type:
  • object

LocalAudioStatsMap

本地流音频统计数据Map对象,一个 userId 对应一个 LocalAudioStats

Type:
  • object

LocalVideoStats

Properties:
Name Type Description
bytesSent number

已发送字节数

packetsSent number

已发送包数

framesEncoded number

已编码帧数

framesSent number

已发送帧数

frameWidth number

视频宽度

frameHeight number

视频高度

本地流视频统计数据

Type:
  • object

LocalVideoStatsMap

本地流视频统计数据Map对象,一个 userId 对应一个 LocalVideoStats

Type:
  • object

RemoteAudioStats

Properties:
Name Type Description
bytesReceived number

已接收字节数

packetsReceived number

已接收包数

packetsLost number

丢包数

end2EndDelay number

端到端延迟 @since 4.12.1

远端流音频统计数据

Type:
  • object

RemoteAudioStatsMap

远端流音频统计数据Map对象,一个 userId 对应一个 RemoteAudioStats

Type:
  • object

RemoteVideoStats

Properties:
Name Type Description
bytesReceived number

已接收字节数

packetsReceived number

已接收包数

packetsLost number

丢包数

framesDecoded number

已解码帧数

frameWidth number

视频宽度

frameHeight number

视频高度

end2EndDelay number

端到端延迟 @since 4.12.1

远端视频统计数据

Type:
  • object

RemoteVideoStatsMap

远端流视频统计数据Map对象,一个 userId 对应一个 RemoteVideoStats

Type:

MixUser

Properties:
Name Type Description
userId string

用户标识[必填],该用户的 userId

全手动模式(manual) 预排版模式(preset-layout)
userId 填写规则 需传入真实的 userId - 对于本地推的主流(摄像头、麦克风),需传入对应 client 的 userId
- 对于本地推的屏幕分享流,需传入屏幕分享 client 的 userId
- 对于远端流,使用字符串$PLACE_HOLDER_REMOTE$占位
roomId number | string

混流用户的房间信息,支持跨房间混流(该字段自 v4.11.5 开始支持)

pureAudio boolean

只混入该用户的音频流, 若该值为true, 则以下视频相关参数不需要传入

width number

该用户流在混流中的宽度(px),必须大于等于0,默认值为 0

height number

该用户流在混流中的高度(px),必须大于等于0,默认值为 0

locationX number

以混流左上角为起点,该用户流在混流中的 X 坐标(px),必须大于等于 0,默认值为 0

locationY number

以混流左上角为起点,该用户流在混流中的 Y 坐标(px),必须大于等于 0,默认值为 0

zOrder number

该用户流在混流中的图层层次,取值范围为[1, 15];若 pureAudio 的值为 false, 则 zOrder 必传

streamType string

用于全手动模式下指定流类型,预排版模式无需填写。取值:main(主流),auxiliary(屏幕分享辅流)
- Web 端本地音视频流及本地屏幕分享流都为主流,streamType 取值为 'main'
- 远端流的 streamType 请通过 remoteStream.getType() 方法获取

renderMode number

该用户流在混流中的渲染模式,默认为裁剪默认,该字段自 4.12.7 版本支持。
0:裁剪模式(默认),这个模式下会严格按照目的视频的宽高比对源视频进行剪裁,并填满子画面画布;在源视频和目的视频宽高比不一致的时候,画面保持不变形,但是会被剪裁。
1:用户流缩放并显示背景,这个模式下会严格保持源视频的宽高比进行等比缩放;在源视频和目的视频宽高比不一致的时候,画面的上下侧边缘或者左右侧边缘会显示输出流背景。
2:用户流缩放并显示黑底,这个模式下会严格保持源视频的宽高比进行等比缩放;在源视频和目的视频宽高比不一致的时候,画面的上下侧边缘或者左右侧边缘会显示黑底。
注意:
设置 renderMode 为 0 或者 1 时,在用户流发布之前对该用户流进行混流,混流中该用户流位置无内容;用户流发布之后,混流中该用户流按照设置的渲染模式正常渲染。
设置 renderMode 为 2 时,在用户流发布之前对该用户流进行混流,混流中该用户流位置显示为黑色;用户流发布之后,混流中该用户流按照设置的渲染模式正常渲染。

混入流的用户信息

Type:
  • object