Cocos Creator SDK API Reference
Hierarchy
- TranscodingUser
Index
Constructors
Properties
Constructors
constructor
-
Parameters
-
uid: number
-
x: number
-
y: number
-
width: number
-
height: number
-
zOrder: number
-
Default value alpha: number = 1
-
audioChannel: number
Returns TranscodingUser
-
Properties
alpha
直播视频上用户视频的透明度。
- 0: 该区域图像完全透明；
- 1:（默认）该区域图像完全不透明。
audioChannel
音频所在声道。取值范围为 [0, 5]，默认值为 0：
- 0: (推荐) 默认混音设置，最多支持双声道，与主播端上行音频相关。
- 1: 对应主播的音频，推流中位于 FL 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。
- 2: 对应主播的音频，推流中位于 FC 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。
- 3: 对应主播的音频，推流中位于 FR 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。
- 4: 对应主播的音频，推流中位于 BL 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。
- 5: 对应主播的音频，推流中位于 BR 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。
height
推流视频的总高度，默认值 640，单位为像素。
uid
旁路主播的用户 ID。
width
推流视频的总宽度，默认值 360，单位为像素。
x
左上角的横向偏移。
y
左上角的纵向偏移。
zOrder
视频帧图层编号。
- 0:（默认）表示该区域图像位于最下层，
- 100: 表示该区域图像位于最上层。
Note
- 如果取值小于 0 或大于 100，会返回错误 ERR_INVALID_ARGUMENT 。
- 从 v3.1.2 开始，支持将
zOrder设置为 0。
TranscodingUser 用于管理参与旁路直播的音视频转码合图的用户。最多支持 17 人同时参与转码合图。