文档中心
语音通话 (Legacy)
Console 官网 社区 技术支持
简体中文
search-icon

Agora Web API Reference

概览 AgoraRTC Client Stream 错误代码 警告代码

在调用 setLiveTranscoding 时用于管理参与 CDN 直播的视频转码合图的用户

Hierarchy

  • TranscodingUser

Index

Properties

Properties

alpha

alpha: number

直播视频上用户视频的透明度

取值范围为 [0.0,1.0]：

  • 0.0: 该区域图像完全透明。
  • 1.0: 该区域图像完全不透明。

Optional height

height: number

视频帧高度

整数，取值范围为 [0,10000]，默认值为 360。

Optional uid

uid: number | string

直播推流的用户 ID

Optional width

width: number

视频帧宽度

整数，取值范围为 [0,10000]，默认值为 640。

Optional x

x: number

视频帧左上角的横轴位置

整数，取值范围为 [0,10000]，默认值为 0。

Optional y

y: number

视频帧左上角的纵轴位置

整数，取值范围为 [0,10000]，默认值为 0。

Optional zOrder

zOrder: number

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

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

Agora SDK 从 v2.3.0 开始支持将 zOrder 设为 0。

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