Documentation
Interactive Live Streaming Premium (Legacy)
Console 官网 Community Technical support
English
search-icon

Agora Web SDK API Reference

Overview AgoraRTC Client Stream Error Codes Warning Codes

Manages the user layout configuration in setLiveTranscoding.

Hierarchy

  • TranscodingUser

Index

Properties

Properties

alpha

alpha: number

The transparency level of the video frame.

The value ranges between 0.0 and 1.0:

  • 0.0: Completely transparent.
  • 1.0: Opaque.

Optional height

height: number

The height of the video.

Integer only. The value range is [0,10000], and the default value is 360.

Optional uid

uid: number | string

The user ID of the CDN live host.

Optional width

width: number

The width of the video.

Integer only. The value range is [0,10000], and the default value is 640.

Optional x

x: number

The position of the upper left end of the video on the horizontal axis.

Integer only. The value range is [0,10000], and the default value is 0.

Optional y

y: number

The position of the upper left end of the video on the vertical axis.

Integer only. The value range is [0,10000], and the default value is 0.

Optional zOrder

zOrder: number

The layer index of the video frame.

Integer only. The value range is [0,100].

From v2.3.0, Agora SDK supports setting zOrder as 0.

  • 0: (Default) Bottom layer.
  • 100: Top layer.