FTranscodingUser

参与转码合流的每个主播的设置。

C++

USTRUCT(BlueprintType)
struct FTranscodingUser {
GENERATED_BODY()
public:
UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingUser")
int64 uid = 0;
UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingUser")
int x = 0;
UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingUser")
int y = 0;
UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingUser")
int width = 0;
UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingUser")
int height = 0;
UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingUser")
int zOrder = 0;
UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingUser")
float alpha = 1.0;
UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingUser")
int audioChannel = 0;
FTranscodingUser(){}
FTranscodingUser(const agora::rtc::TranscodingUser & AgoraData){
uid = AgoraData.uid;
x = AgoraData.x;
y = AgoraData.y;
width = AgoraData.width;
height = AgoraData.height;
zOrder = AgoraData.zOrder;
alpha = AgoraData.alpha;
audioChannel = AgoraData.audioChannel;
}
agora::rtc::TranscodingUser CreateAgoraData() const {
agora::rtc::TranscodingUser AgoraData;
AgoraData.uid = uid;
AgoraData.x = x;
AgoraData.y = y;
AgoraData.width = width;
AgoraData.height = height;
AgoraData.zOrder = zOrder;
AgoraData.alpha = alpha;
AgoraData.audioChannel = audioChannel;
return AgoraData;
}
void FreeAgoraData(agora::rtc::TranscodingUser& AgoraData) const {
}
};

uid

主播的用户 ID。

x

主播视频画面在输出视频画面的 x 坐标 (px)，以输出视频画面的左上角为原点。取值范围为[0,width]，width 为 FLiveTranscoding 中设置的 width。

y

主播视频画面在输出视频画面的 y 坐标 (px)，以输出视频画面的左上角为原点。取值范围为[0,height]，height 为 FLiveTranscoding 中设置的 height。

width

主播视频画面的宽 (px)。

height

主播视频画面的高 (px)。

zOrder

主播视频画面的图层编号。取值范围为 [0,100]。

• 0:（默认）视频画面位于图层的最下层。
• 100: 视频画面位于图层的最上层。

注意

• 如果取值小于 0 或大于 100，会返回错误 ERR_INVALID_ARGUMENT。
• 支持将 zOrder 设置为 0。

alpha

主播视频画面的透明度。取值范围为 [0.0,1.0]。

• 0.0: 完全透明。
• 1.0:（默认）完全不透明。

audioChannel

主播音频在输出音频中占用的声道。默认值为 0，取值范围为 [0,5]：

• 0: （推荐）默认混音设置，最多支持双声道，与主播上行音频相关。
• 1: 主播音频在输出音频的 FL 声道。如果主播上行音频是多声道，声网服务器会先把多声道混音成单声道。
• 2: 主播音频在输出音频的 FC 声道。如果主播上行音频是多声道，声网服务器会先把多声道混音成单声道。
• 3: 主播音频在输出音频的 FR 声道。如果主播上行音频是多声道，声网服务器会先把多声道混音成单声道。
• 4: 主播音频在输出音频的 BL 声道。如果主播上行音频是多声道，声网服务器会先把多声道混音成单声道。
• 5: 主播音频在输出音频的 BR 声道。如果主播上行音频是多声道，声网服务器会先把多声道混音成单声道。
• 0xFF 或取值大于 5: 该主播音频静音，声网服务器移除该主播的音频。

注意

取值不为 0 时，需要使用特殊的播放器。