Merge pull request #151 from AgoraIO-Extensions/dev/4.5.0

[Plugin 450] Blueprint API update

Agora-Unreal-SDK-CPP/AgoraPlugin/Source/AgoraPlugin/Private/AgoraBlueprintPlugin/AgoraBPuRtcEngine.cpp

@@ -2155,13 +2155,16 @@ int UAgoraBPuRtcEngine::ConfigRhythmPlayer(const FUABT_AgoraRhythmPlayerConfig&
 	config.FreeRawData(agoraRhythmPlayerConfig);
 	return ret;
 }
-int UAgoraBPuRtcEngine::TakeSnapshot(int64 uid, const FString& filePath)
-{
-	std::string Filepath = TCHAR_TO_UTF8(*filePath);
 
-	auto ret = AgoraUERtcEngine::Get()->takeSnapshot(uid, Filepath.c_str());
+
+int UAgoraBPuRtcEngine::TakeSnapshot(int64 uid, const FUABT_SnapshotConfig& config)
+{
+	agora::media::SnapshotConfig snapshotConfig = config.CreateRawData();
+	auto ret = AgoraUERtcEngine::Get()->takeSnapshot(UABT::ToUID(uid), snapshotConfig);
+	config.FreeRawData(snapshotConfig);
 	return ret;
 }
+
 int UAgoraBPuRtcEngine::EnableContentInspect(bool enabled, const FUABT_ContentInspectConfig& config)
 {
 	agora::media::ContentInspectConfig contentInspectConfig = config.CreateRawData();
@@ -2739,17 +2742,16 @@ int UAgoraBPuRtcEngine::SetHighPriorityUserListEx(TArray<int64> uidList, EUABT_S
 	return ret;
 }
 
-
-int UAgoraBPuRtcEngine::TakeSnapshotEx(const FUABT_RtcConnection& connection, int64 uid, const FString& filePath)
+int UAgoraBPuRtcEngine::TakeSnapshotEx(const FUABT_RtcConnection& connection, int64 uid, const FUABT_SnapshotConfig& config)
 {
 	agora::rtc::RtcConnection rtcConnection = connection.CreateRawData();
-	std::string FilePath = TCHAR_TO_UTF8(*filePath);
-	auto ret = AgoraUERtcEngine::Get()->takeSnapshotEx(rtcConnection, uid, FilePath.c_str());
+	agora::media::SnapshotConfig snapshotConfig = config.CreateRawData();
+	auto ret = AgoraUERtcEngine::Get()->takeSnapshotEx(rtcConnection, UABT::ToUID(uid), snapshotConfig);
+	config.FreeRawData(snapshotConfig);
 	connection.FreeRawData(rtcConnection);
 	return ret;
 }
 
-
 int UAgoraBPuRtcEngine::EnableContentInspectEx(bool enabled, const FUABT_ContentInspectConfig& config, const FUABT_RtcConnection& connection)
 {
 	agora::media::ContentInspectConfig contentInspectConfig = config.CreateRawData();

Agora-Unreal-SDK-CPP/AgoraPlugin/Source/AgoraPlugin/Public/AgoraBlueprintPlugin/AgoraBPuDataTypes.h

@@ -4881,4 +4881,58 @@ struct FUABT_LocalAudioMixerConfiguration {
 	void FreeRawData(agora::rtc::LocalAudioMixerConfiguration& AgoraData) const {
 		UABT::Free_RawDataArray<agora::rtc::MixedAudioStream, FUABT_MixedAudioStream>(AgoraData.sourceStreams, AgoraData.streamCount);
 	}
+};
+
+
+
+
+/** Definition of SnapshotConfig.
+ */
+
+USTRUCT(BlueprintType)
+struct FUABT_SnapshotConfig {
+
+	GENERATED_BODY()
+
+public:
+
+	/**
+	 * The local path (including filename extensions) of the snapshot. For example:
+	 * - Windows: `C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.jpg`
+	 * - iOS: `/App Sandbox/Library/Caches/example.jpg`
+	 * - macOS: `¡«/Library/Logs/example.jpg`
+	 * - Android: `/storage/emulated/0/Android/data/<package name>/files/example.jpg`
+	 */
+	UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
+	FString filePath;
+
+	/**
+	 * The position of the video observation. See VIDEO_MODULE_POSITION.
+	 *
+	 * Allowed values vary depending on the `uid` parameter passed in `takeSnapshot` or `takeSnapshotEx`:
+	 * - uid = 0: Position 2, 4 and 8 are allowed.
+	 * - uid != 0: Only position 2 is allowed.
+	 *
+	 */
+	UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
+	EUABT_VIDEO_MODULE_POSITION position = EUABT_VIDEO_MODULE_POSITION::POSITION_PRE_ENCODER;
+
+
+	FUABT_SnapshotConfig() {}
+	FUABT_SnapshotConfig(const agora::media::SnapshotConfig& AgoraData) {
+		filePath = UTF8_TO_TCHAR(AgoraData.filePath);
+		position = UABTEnum::WrapWithUE(AgoraData.position);
+	}
+
+	agora::media::SnapshotConfig CreateRawData() const {
+		agora::media::SnapshotConfig AgoraData;
+		AgoraData.filePath = UABT::New_CharPtr(filePath);
+		AgoraData.position = UABTEnum::ToRawValue(position);
+		return AgoraData;
+	}
+
+	void FreeRawData(agora::media::SnapshotConfig& AgoraData) const {
+		UABT::Free_CharPtr(AgoraData.filePath);
+	}
+
 };

Agora-Unreal-SDK-CPP/AgoraPlugin/Source/AgoraPlugin/Public/AgoraBlueprintPlugin/AgoraBPuRtcEngine.h

@@ -742,10 +742,11 @@ class AGORAPLUGIN_API UAgoraBPuRtcEngine : public UObject
 	UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
 	int ConfigRhythmPlayer(const FUABT_AgoraRhythmPlayerConfig& config);
 
-	UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
-	int TakeSnapshot(int64 uid, const FString& filePath);
+	//UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
+	//int TakeSnapshot(int64 uid, const FString& filePath);
 
-	// virtual int takeSnapshot(uid_t uid, const media::SnapshotConfig& config) override;
+	UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
+	int TakeSnapshot(int64 uid, const FUABT_SnapshotConfig& config);
 
 	UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
 	int EnableContentInspect(bool enabled, const FUABT_ContentInspectConfig& config);
@@ -915,10 +916,11 @@ UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
 	UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
 	int SetHighPriorityUserListEx(TArray<int64> uidList, EUABT_STREAM_FALLBACK_OPTIONS option, const FUABT_RtcConnection& connection);
 
-	UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
-	int TakeSnapshotEx(const FUABT_RtcConnection& connection, int64 uid, const FString& filePath);
+	//UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
+	//int TakeSnapshotEx(const FUABT_RtcConnection& connection, int64 uid, const FString& filePath);
 
-	//virtual int takeSnapshotEx(const RtcConnection& connection, uid_t uid, const media::SnapshotConfig& config) override;
+	UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
+	int TakeSnapshotEx(const FUABT_RtcConnection& connection, int64 uid, const FUABT_SnapshotConfig& config);
 
 	UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
 	int EnableContentInspectEx(bool enabled, const FUABT_ContentInspectConfig& config, const FUABT_RtcConnection& connection);