FScreenCaptureParameters2

  • Unreal Blueprint

更新时间不可用

屏幕共享的参数配置。

C++
USTRUCT(BlueprintType)
struct FScreenCaptureParameters2
{
	GENERATED_BODY()
public:
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|ScreenCaptureParameters2")
	bool captureAudio = false;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|ScreenCaptureParameters2")
	FScreenAudioParameters audioParams = FScreenAudioParameters();
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|ScreenCaptureParameters2")
	bool captureVideo = false;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|ScreenCaptureParameters2")
	FScreenVideoParameters videoParams = FScreenVideoParameters();
#if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
	FScreenCaptureParameters2(){}
	FScreenCaptureParameters2(const agora::rtc::ScreenCaptureParameters2 & AgoraData){
		captureAudio = AgoraData.captureAudio;
		audioParams = FScreenAudioParameters(AgoraData.audioParams);
		captureVideo = AgoraData.captureVideo;
		videoParams = FScreenVideoParameters(AgoraData.videoParams);
	}
	agora::rtc::ScreenCaptureParameters2 CreateAgoraData() const {
		agora::rtc::ScreenCaptureParameters2 AgoraData;
		AgoraData.captureAudio = captureAudio;
		AgoraData.audioParams = audioParams.CreateAgoraData();
		AgoraData.captureVideo = captureVideo;
		AgoraData.videoParams = videoParams.CreateAgoraData();
		return AgoraData;
	}
	void FreeAgoraData(agora::rtc::ScreenCaptureParameters2& AgoraData) const {
		audioParams.FreeAgoraData(AgoraData.audioParams);
		videoParams.FreeAgoraData(AgoraData.videoParams);
	}
#endif
};

属性

参数名描述
captureAudio

屏幕共享时是否采集系统音频:

  • true: 采集系统音频。
  • false: (默认)不采集系统音频。

注:

  • 受系统限制,采集系统音频仅适用于 Android API 级别为 29 及以上,即 Android 10 及以上。
  • 为提高屏幕共享时采集系统音频的成功率,请确保你已调用 SetAudioScenario 方法并设置音频场景为 AUDIO_SCENARIO_GAME_STREAMING。
audioParams

共享屏幕流的音频配置。详见 FScreenAudioParameters。

注意: 该参数仅在 captureAudio 为 true 时生效。

captureVideo

屏幕共享时是否采集屏幕:

  • true:(默认)采集屏幕。
  • false: 不采集屏幕。

注: 受系统限制,采集屏幕仅适用于 Android API 级别为 21 及以上,即 Android 5 及以上。

videoParams

共享屏幕流的视频编码配置。详见 FScreenVideoParameters。

注意: 该参数仅在 captureVideo 为 true 时生效。

表格内容超出当前宽度,可横向滚动查看更多列。

这个页面有帮助吗?