agora::rtc::TranscodingUser Struct Reference

#include <IAgoraRtcEngine.h>

Public Member Functions
	TranscodingUser ()

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

Detailed Description

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

Constructor & Destructor Documentation

TranscodingUser()

agora::rtc::TranscodingUser::TranscodingUser ( )

inline

Member Data Documentation

uid

uid_t agora::rtc::TranscodingUser::uid

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

x

int agora::rtc::TranscodingUser::x

Horizontal position (pixel) of the video frame relative to the top left corner.

y

int agora::rtc::TranscodingUser::y

Vertical position (pixel) of the video frame relative to the top left corner.

width

int agora::rtc::TranscodingUser::width

Width (pixel) of the video frame. The default value is 360.

height

int agora::rtc::TranscodingUser::height

Height (pixel) of the video frame. The default value is 640.

zOrder

int agora::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 ERR_INVALID_ARGUMENT.
• As of v2.3, the SDK supports zOrder = 0.

alpha

double agora::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::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 are 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 are 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 are 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 are 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 are mixed into mono first.

Note

• For values of 1, 2, 3, 4, and 5, you need to use a special player.
• If you pass in a value outside the range, the Agora server removes the audio of the host from the output audio.