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

Layer position of the video frame. The value ranges between 0 and 100.

  • 0: (Default) Lowest
  • 100: Highest
Note
  • If zOrder is beyond this range, the SDK reports ERR_INVALID_ARGUMENT(2).
  • As of v2.3, the SDK supports zOrder = 0.

◆ alpha

double agora_gaming_rtc.TranscodingUser.alpha

Transparency of the video frame in CDN live. The value ranges between 0 and 1.0:

  • 0: (Default) Completely transparent
  • 1.0: 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 broadcaster.
  • 1: The audio stream of the broadcaster uses the FL audio channel. If the upstream of the broadcaster uses multiple audio channels, these channels will be mixed into mono first.
  • 2: The audio stream of the broadcaster uses the FC audio channel. If the upstream of the broadcaster uses multiple audio channels, these channels will be mixed into mono first.
  • 3: The audio stream of the broadcaster uses the FR audio channel. If the upstream of the broadcaster uses multiple audio channels, these channels will be mixed into mono first.
  • 4: The audio stream of the broadcaster uses the BL audio channel. If the upstream of the broadcaster uses multiple audio channels, these channels will be mixed into mono first.
  • 5: The audio stream of the broadcaster uses the BR audio channel. If the upstream of the broadcaster 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.