通知
本站点除 Legacy 产品与方案外，已迁移至 声网新文档中心 ，当前页面不再维护
文档中心
全部产品
Console 官网 社区 技术支持
简体中文
search-icon

Agora Web API Reference

概览 AgoraRTC AgoraRTCClient LocalTrack RemoteTrack 错误码

在配置 LiveStreamingTranscodingConfig 时用于管理参与 CDN 直播的视频转码合图的用户。

Hierarchy

  • LiveStreamingTranscodingUser

Index

Properties

Properties

Optional alpha

alpha: undefined | number

直播视频上用户视频的透明度, 取值范围为 [0.0,1.0]。

  • 0.0: 该区域图像完全透明。
  • 1.0:（默认值）该区域图像完全不透明。

Optional audioChannel

audioChannel: undefined | number

直播音频所在声道。取值范围为 [0, 5]，默认值为 0。

  • 0：（推荐）默认混音设置，最多支持双声道，与主播端上行音频相关
  • 1：对应主播的音频，推流中位于 FL 声道。如果主播上行为双声道，会先把多声道混音成单声道
  • 2：对应主播的音频，推流中位于 FC 声道。如果主播上行为双声道，会先把多声道混音成单声道
  • 3：对应主播的音频，推流中位于 FR 声道。如果主播上行为双声道，会先把多声道混音成单声道
  • 4：对应主播的音频，推流中位于 BL 声道。如果主播上行为双声道，会先把多声道混音成单声道
  • 5：对应主播的音频，推流中位于 BR 声道。如果主播上行为双声道，会先把多声道混音成单声道

Optional height

height: undefined | number

视频帧高度，默认值 640。

uid

uid: UID

直播推流的用户 ID。

Optional width

width: undefined | number

视频帧宽度，默认值 360。

Optional x

x: undefined | number

视频帧左上角的横轴位置，默认值为 0。

Optional y

y: undefined | number

视频帧左上角的纵轴位置，默认值为 0。

Optional zOrder

zOrder: undefined | number

直播视频上用户视频帧的图层编号。

整数，取值范围为 [0,100]:

  • 最小值为 0（默认值），表示该区域图像位于最下层。
  • 最大值为 100，表示该区域图像位于最上层。