FScreenAudioParameters

The audio configuration for the shared screen stream.

USTRUCT(BlueprintType)
struct FScreenAudioParameters {
	GENERATED_BODY()
public:
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|ScreenAudioParameters")
	int sampleRate = 16000;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|ScreenAudioParameters")
	int channels = 2;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|ScreenAudioParameters")
	int captureSignalVolume = 100;
#if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
	FScreenAudioParameters(){}
	FScreenAudioParameters(const agora::rtc::ScreenAudioParameters & AgoraData){
		sampleRate = AgoraData.sampleRate;
		channels = AgoraData.channels;
		captureSignalVolume = AgoraData.captureSignalVolume;
	}
	agora::rtc::ScreenAudioParameters CreateAgoraData() const {
		agora::rtc::ScreenAudioParameters AgoraData;
		AgoraData.sampleRate = sampleRate;
		AgoraData.channels = channels;
		AgoraData.captureSignalVolume = captureSignalVolume;
		return AgoraData;
	}
	void FreeAgoraData(agora::rtc::ScreenAudioParameters& AgoraData) const {
	}
#endif
};

Only available where captureAudio is true.

Attributes

sampleRate
Audio sample rate (Hz). The default value is 16000.
channels
The number of audio channels. The default value is 2, which means stereo.
captureSignalVolume
The volume of the captured system audio. The value range is [0, 100]. The default value is 100.