agora_gaming_rtc.TranscodingUser Struct Reference

Public Attributes
uint	uid
int	x
int	y
int	width
int	height
int	zOrder
double	alpha
int	audioChannel

Detailed Description

The video properties of the user displaying the video in the CDN live. Agora supports a maximum of 17 transcoding users in a CDN streaming channel.

Member Data Documentation

uid

uint agora_gaming_rtc.TranscodingUser.uid

User ID of the user displaying the video in the CDN live.

x

int agora_gaming_rtc.TranscodingUser.x

Horizontal position from the top left corner of the video frame.

y

int agora_gaming_rtc.TranscodingUser.y

Vertical position from the top left corner of the video frame.

width

int agora_gaming_rtc.TranscodingUser.width

Width of the video frame. The default value is 360.

height

int agora_gaming_rtc.TranscodingUser.height

Height of the video frame. The default value is 640.

zOrder

int agora_gaming_rtc.TranscodingUser.zOrder

The layer index of the video frame. An integer. The value range is [0, 100].

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

Note

• If zOrder is beyond this range, the SDK reports the ERR_INVALID_ARGUMENT(-2).
• As of v2.3, the SDK supports zOrder = 0.

alpha

double agora_gaming_rtc.TranscodingUser.alpha

The transparency level of the user's video. The value ranges between 0 and 1.0:

• 0: Completely transparent
• 1.0: (Default) Opaque

audioChannel

int agora_gaming_rtc.TranscodingUser.audioChannel

The audio channel of the sound. The default value is 0:

• 0: (Default) Supports dual channels at most, depending on the upstream of the host.
• 1: The audio stream of the host uses the FL audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.
• 2: The audio stream of the host uses the FC audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.
• 3: The audio stream of the host uses the FR audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.
• 4: The audio stream of the host uses the BL audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.
• 5: The audio stream of the host uses the BR audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.

Note

If your setting is not 0, you may need a specialized player.

---

The documentation for this struct was generated from the following file:

• AgoraBase.cs