FVideoSubscriptionOptions

Video subscription options.

USTRUCT(BlueprintType)
struct FVideoSubscriptionOptions
{
	GENERATED_BODY()
public:
		UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|ChannelMediaOptions")
	bool type_SetValue = false;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoSubscriptionOptions")
	EVIDEO_STREAM_TYPE type = EVIDEO_STREAM_TYPE::VIDEO_STREAM_HIGH;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoSubscriptionOptions")
	EAgoraOptional encodedFrameOnly = EAgoraOptional::AGORA_NULL_VALUE;
	FVideoSubscriptionOptions(){}
	FVideoSubscriptionOptions(const agora::rtc::VideoSubscriptionOptions & AgoraData){
		SET_UEBP_OPTIONAL_VAL_ASSIGN_VAL(this->type,AgoraData.type,static_cast<EVIDEO_STREAM_TYPE>(AgoraData.type.value()))
		SET_UEBP_OPTIONAL_VAL_BOOL(this->encodedFrameOnly,AgoraData.encodedFrameOnly)
	}
	agora::rtc::VideoSubscriptionOptions CreateAgoraData() const {
		agora::rtc::VideoSubscriptionOptions AgoraData;
		SET_AGORA_OPTIONAL_VAL_ASSIGN_VAL(AgoraData.type,this->type,static_cast<agora::rtc::VIDEO_STREAM_TYPE>(this->type))
		SET_AGORA_OPTIONAL_VAL_BOOL(AgoraData.encodedFrameOnly,this->encodedFrameOnly)
		return AgoraData;
	}
	void FreeAgoraData(agora::rtc::VideoSubscriptionOptions& AgoraData) const {
	}
};

Attributes

type
The video stream type that you want to subscribe to. The default value is VIDEO_STREAM_HIGH, indicating that the high-quality video streams are subscribed. See EVIDEO_STREAM_TYPE.
encodedFrameOnly
Whether to subscribe to encoded video frames only:
  • true: Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
  • false: (Default) Subscribe to both raw video data and encoded video data.