适用于 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"));// ... 游戏进行中 —— 会话数据会被自动上传 ...
重要信息
InGameId가 전달되지 않으면 캡처된 세션이 폐기될 수 있으며 AI 분석에 사용되지 않습니다. 이 값이 없으면 세션을 플레이어에게 귀속시킬 수 없으며, 이는 후속 인사이트 생성에 필요합니다.- 如果未传递
InGameId，观察到的会话可能会被丢弃，并且不会用于 AI 分析。缺少该字段时，无法将会话归属到玩家，而这是生成后续洞察所必需的。 - 请确保在开始观察游戏之前已获得用户同意。SDK 不会自动请求权限；同意处理逻辑必须由您的游戏自行实现。
- 作为推荐的最佳实践，您可以在游戏的 EULA 或隐私政策中加入有关游戏观察的披露说明。
- 要正确测试，您需要创建对应平台的构建版本，并在真机设备上运行。
参考
以下是 Init() 方法的参考说明。
方法签名
参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
InGameId |
FString |
否 | 游戏内的可选用户标识符。如果未传入，则默认为空字符串。 |
DeveloperPayload
|
FString |
否 | 与会话关联的可选开发者自定义元数据。该值会随会话请求原样转发，可用于附加自定义追踪信息或上下文信息。提供更丰富的 DeveloperPayload 可以显著提升 AI 驱动的分析能力和会话理解效果。示例：
|
3. 高级控制
在大多数集成场景中，调用 Init() 即可开始观察游戏。对于更高级或自定义的控制，您也可以直接使用 StartSession() 和 StopSession()。
3.1 开始观察
当您希望显式控制何时开始游戏观察时，请使用 StartSession() 方法。
#include "SixLabsSubsystem.h"
USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>();
// 开始观察游戏
SixLabs->StartSession(TEXT("optional_player_in_game_id"), TEXT("optional_developer_payload_here"));// ... 游戏进行中 —— 会话数据会被自动上传 ...
方法签名
参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
InGameId |
FString |
否 | 游戏内的可选用户标识符。如果未传入，则默认为空字符串。 |
DeveloperPayload
|
FString |
否 | 与会话关联的可选开发者自定义元数据。该值会随会话请求原样转发，可用于附加自定义追踪信息或上下文信息。提供更丰富的 DeveloperPayload 可以显著提升 AI 驱动的分析能力和会话理解效果。 |
3.2 停止观察
使用 StopSession() 方法停止游戏观察。
// 停止游戏观察
SixLabs->StopSession();重要信息
- 停止当前活动的游戏观察。
- 您之后可以再次调用
StartSession()以开始新的观察。
目录
目录
文档版本 1.0