FLastmileProbeConfig

Configurations of the last-mile network test.

USTRUCT(BlueprintType)
struct FLastmileProbeConfig
{
	GENERATED_BODY()
public:
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|LastmileProbeConfig")
	bool probeUplink = false;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|LastmileProbeConfig")
	bool probeDownlink = false;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|LastmileProbeConfig")
	int expectedUplinkBitrate = 0;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|LastmileProbeConfig")
	int expectedDownlinkBitrate = 0;
	FLastmileProbeConfig(){}
	FLastmileProbeConfig(const agora::rtc::LastmileProbeConfig & AgoraData){
		probeUplink = AgoraData.probeUplink;
		probeDownlink = AgoraData.probeDownlink;
		expectedUplinkBitrate = AgoraData.expectedUplinkBitrate;
		expectedDownlinkBitrate = AgoraData.expectedDownlinkBitrate;
	}
	agora::rtc::LastmileProbeConfig CreateAgoraData() const{
		agora::rtc::LastmileProbeConfig AgoraData;
		AgoraData.probeUplink = probeUplink;
		AgoraData.probeDownlink = probeDownlink;
		AgoraData.expectedUplinkBitrate = expectedUplinkBitrate;
		AgoraData.expectedDownlinkBitrate = expectedDownlinkBitrate;
		return AgoraData;
	}
	void FreeAgoraData(agora::rtc::LastmileProbeConfig& AgoraData) const {
	}
};

Attributes

probeUplink
Sets whether to test the uplink network. Some users, for example, the audience members in a LIVE_BROADCASTING channel, do not need such a test.
  • true: Test the uplink network.
  • false: Do not test the uplink network.
probeDownlink
Sets whether to test the downlink network:
  • true: Test the downlink network.
  • false: Do not test the downlink network.
expectedUplinkBitrate
The expected maximum uplink bitrate (bps) of the local user. The value range is [100000, 5000000]. Agora recommends referring to SetVideoEncoderConfiguration to set the value.
expectedDownlinkBitrate
The expected maximum downlink bitrate (bps) of the local user. The value range is [100000,5000000].