nertc::NERtcLiveStreamUserTranscoding结构体 参考

#include <nertc_engine_defines.h>

Public 属性
uid_t	uid
bool	video_push
NERtcLiveStreamVideoScaleMode	adaption
int	x
int	y
int	width
int	height
bool	audio_push
int	z_order

详细描述

The member layout in live streaming.

类成员变量说明

adaption

NERtcLiveStreamVideoScaleMode nertc::NERtcLiveStreamUserTranscoding::adaption

Adjustment between the video and the canvas in live streaming. For more information, see NERtcLiveStreamVideoScaleMode.

audio_push

bool nertc::NERtcLiveStreamUserTranscoding::audio_push

Specifies whether to mix the audio stream from the user in the live event. Valid values:

• true: mixes the audio streams from users in a live event.
• false: mutes the audio streams from users in a live event.

height

int nertc::NERtcLiveStreamUserTranscoding::height

The height of the user image in the canvas.

The X parameter is used to set the horizontal coordinate value of the user image. You can specify a point in the canvas with X and Y coordinates. This point is used as the anchor of the upper left corner of the user image. 0 to 1920. The default value is 0. If the specified value is set to an odd value, the value is automatically rounded down to an even number.

Value range: 0 to 1920. If the specified value is set to an odd value, the value is automatically rounded down to an even number.

uid

uid_t nertc::NERtcLiveStreamUserTranscoding::uid

Pulls the video stream of the user with the specified uid into the live event. If you add multiple users, the uid must be unique.

video_push

bool nertc::NERtcLiveStreamUserTranscoding::video_push

Specifies whether to play back the specific video stream from the user to viewers in the live event. Valid values:

• true: plays the video stream.
• false: does not play the video stream. The setting becomes invalid when the streaming mode is set to kNERtcLsModeAudio.

width

int nertc::NERtcLiveStreamUserTranscoding::width

The width of the user image in the canvas.

Value range: 0 to 1920. The default value is 0. If the specified value is set to an odd value, the value is automatically rounded down to an even number.

If the user image exceeds the canvas, an error occurs when you call the method.

x

int nertc::NERtcLiveStreamUserTranscoding::x

The X parameter is used to set the horizontal coordinate value of the user image. You can specify a point in the canvas with X and Y coordinates. This point is used as the anchor of the upper left corner of the user image.

Value range: 0 to 1920. If the specified value is set to an odd value, the value is automatically rounded down to an even number.

If the user image exceeds the canvas, an error occurs when you call the method.

y

int nertc::NERtcLiveStreamUserTranscoding::y

The Y parameter is used to set the vertical coordinate value of the user image. You can specify a point in the canvas with X and Y coordinates. This point is used as the anchor of the upper left corner of the user image.

Value range: 0 to 1920. If the specified value is set to an odd value, the value is automatically rounded down to an even number.

If the user image exceeds the canvas, an error occurs when you call the method.

z_order

int nertc::NERtcLiveStreamUserTranscoding::z_order

The layer number that is used to determine the rendering level. Value range: 0 to 100. A value of 0 indicates the bottom layer and 100 indicates the top layer.

The rendering area at the same level is overwritten based on the existing overlay strategy. Rendering is performed in the order of the array, and the index increases in ascending order.

---

该结构体的文档由以下文件生成:

• api/nertc_engine_defines.h