FTranscodingVideoStream
The video streams for local video mixing.
USTRUCT(BlueprintType) struct FTranscodingVideoStream { GENERATED_BODY() public: UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingVideoStream") EVIDEO_SOURCE_TYPE sourceType = EVIDEO_SOURCE_TYPE::VIDEO_SOURCE_CAMERA_PRIMARY; UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingVideoStream") int64 remoteUserUid = 0; UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingVideoStream") FString imageUrl = ""; UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingVideoStream") int mediaPlayerId = 0; UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingVideoStream") int x = 0; UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingVideoStream") int y = 0; UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingVideoStream") int width = 0; UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingVideoStream") int height = 0; UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingVideoStream") int zOrder = 0; UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingVideoStream") float alpha = 0; UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|TranscodingVideoStream") bool mirror = false; FTranscodingVideoStream(){} FTranscodingVideoStream(const agora::rtc::TranscodingVideoStream & AgoraData){ sourceType = static_cast<EVIDEO_SOURCE_TYPE>(AgoraData.sourceType); remoteUserUid = AgoraData.remoteUserUid; imageUrl = UTF8_TO_TCHAR(AgoraData.imageUrl); mediaPlayerId = AgoraData.mediaPlayerId; x = AgoraData.x; y = AgoraData.y; width = AgoraData.width; height = AgoraData.height; zOrder = AgoraData.zOrder; alpha = AgoraData.alpha; mirror = AgoraData.mirror; } agora::rtc::TranscodingVideoStream CreateAgoraData() const{ agora::rtc::TranscodingVideoStream AgoraData; AgoraData.sourceType = static_cast<agora::rtc::VIDEO_SOURCE_TYPE>(sourceType); AgoraData.remoteUserUid = remoteUserUid; SET_UABT_FSTRING_TO_CONST_CHAR___MEMALLOC(AgoraData.imageUrl,this->imageUrl) AgoraData.mediaPlayerId = mediaPlayerId; AgoraData.x = x; AgoraData.y = y; AgoraData.width = width; AgoraData.height = height; AgoraData.zOrder = zOrder; AgoraData.alpha = alpha; AgoraData.mirror = mirror; return AgoraData; } void FreeAgoraData(agora::rtc::TranscodingVideoStream & AgoraData) const{ SET_UABT_FSTRING_TO_CONST_CHAR___MEMFREE(AgoraData.imageUrl) } };
Attributes
- sourceType
- The video source type for local video mixing. See EUABT_VIDEO_SOURCE_TYPE.
- remoteUserUid
-
The user ID of the remote user.
Attention: Use this parameter only when the source type is VIDEO_SOURCE_REMOTE for local video mixing. - imageUrl
-
The URL of the image.Attention: Use this parameter only when the source type is the image for local video mixing.
- mediaPlayerId
- (Optional) Media player ID. Use the parameter only when you set sourceType to VIDEO_SOURCE_MEDIA_PLAYER.
- x
- The relative lateral displacement of the top left corner of the video for local video mixing to the origin (the top left corner of the canvas).
- y
- The relative longitudinal displacement of the top left corner of the captured video to the origin (the top left corner of the canvas).
- width
- The width (px) of the video for local video mixing on the canvas.
- height
- The height (px) of the video for local video mixing on the canvas.
- zOrder
- The number of the layer to which the video for the local video mixing belongs. The value range is [0, 100].
- 0: (Default) The layer is at the bottom.
- 100: The layer is at the top.
- alpha
- The transparency of the video for local video mixing. The value range is [0.0, 1.0]. 0.0 indicates that the video is completely transparent, and 1.0 indicates that it is opaque.
- mirror
- Whether to mirror the video for the local video mixing.
true
: Mirror the video for the local video mixing.false
: (Default) Do not mirror the video for the local video mixing.
Attention: This parameter only takes effect on video source types that are cameras.