适用于 Unreal 的 6labs SDK

本节说明如何在 Windows 上将 6labs SDK 集成到您的 Unreal Engine 应用中。

1. 下载并导入模块

6labs SDK 以 Unreal Engine 插件的形式提供。

将该模块添加到您的 Unreal 项目中：

下载软件包，其中包含适用于 Unreal Engine 的最新版本 6labs SDK。
将插件解压到您项目的 Plugins 目录中（YourProject/Plugins/SixLabsSDK/）。
确认插件已启用：
- 在 Unreal Editor 中，前往 Edit > Plugins。
- 搜索“6Labs SDK”，并确认其已启用。
添加模块依赖
- 在您游戏模块的 Build.cs 中添加：PublicDependencyModuleNames.Add("SixLabsSDK");

2. 开始游戏过程捕获

使用 Init() 方法初始化 SDK 并启动游戏过程捕获，如下所示：

#include "SixLabsSubsystem.h"

 USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>();

 // 启动一个捕获会话
 SixLabs->Init(TEXT("optional_player_in_game_id"), TEXT("optional_developer_payload_here"));

 // ... 游戏进行中 —— 数据会被自动捕获并上传 ...

重要信息

请确保在开始游戏过程捕获之前已获得用户同意。SDK 不会自动请求权限；同意处理逻辑必须由您的游戏自行实现。
作为推荐的最佳实践，您可以在游戏的 EULA 或隐私政策中加入有关游戏录制的披露说明。
要正确测试，您需要创建对应平台的构建版本，并在真机设备上运行。

参考

以下是 Init() 方法的参考说明。

方法签名

SixLabs->Init(TEXT("optional_player_in_game_id"), TEXT("optional_developer_payload_here"));

参数

参数类型必填说明

InGameId FString 否游戏内的可选用户标识符。如果未传入，则默认为空字符串。

DeveloperPayload

FString

否

与该会话关联的可选开发者自定义元数据。该值会原样随捕获请求一起转发，可用于附加自定义追踪信息或上下文信息。
示例：

获客渠道
活动 ID
用户分群（例如：新用户、回访用户、鲸鱼用户）
A/B 测试变体（例如：variant_a、variant_b）—— 将用户分配到不同群组，并在 6Labs 仪表板中比较他们的游戏指标。
内部参考标识符

3. 高级捕获控制

在大多数集成场景中，调用 Init() 即可开始捕获流程。对于更高级或自定义的捕获控制，您也可以直接使用 StartCapture() 和 StopCapture()。

3.1 开始捕获

当您希望显式控制何时开始游戏过程捕获时，请使用 StartCapture() 方法。

#include "SixLabsSubsystem.h"

 USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>();

 // 启动一个捕获会话
 SixLabs->StartCapture(TEXT("optional_player_in_game_id"), TEXT("optional_developer_payload_here"));

 // ... 游戏进行中 —— 数据会被自动捕获并上传 ...

方法签名

SixLabs->StartCapture(TEXT("optional_player_in_game_id"), TEXT("optional_developer_payload_here"));

参数

参数	类型	必填	说明
`InGameId`	`FString`	否	游戏内的可选用户标识符。如果未传入，则默认为空字符串。
`DeveloperPayload`	`FString`	否	与该会话关联的可选开发者自定义元数据。该值会原样随捕获请求一起转发，可用于附加自定义追踪信息或上下文信息。

3.2 停止捕获

使用 StopCapture() 方法停止当前活动的游戏过程捕获会话。

// 停止会话
 SixLabs->StopCapture();

重要信息

停止当前活动的游戏过程捕获会话。
您之后可以再次调用 StartCapture() 以开始新的会话。

适用于 Unity 的 6Labs SDK