6Labs SDK for Unreal
This section explains how to integrate the 6Labs SDK into your Unreal Engine apps on Windows.
1. Download and Import the Module
The 6Labs SDK is provided as an Unreal Engine plugin.
Add the module to your Unreal project:
- Download the package containing the latest version of 6Labs SDK for Unreal Engine.
- Extract the plugin into your project’s Plugins directory
(
YourProject/Plugins/SixLabsSDK/). - Confirm that the plugin is enabled:
- In the Unreal Editor, go to Edit > Plugins .
- Search for “6Labs SDK” and confirm it is enabled.
- Add module dependency:
- In your game module’s
Build.cs, add:PublicDependencyModuleNames.Add("SixLabsSDK");
- In your game module’s
2. Start Observing Gameplay
Use the Init() method to initialize the
SDK and
start observing gameplay, as
illustrated
below:
#include "SixLabsSubsystem.h"
USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>();
// Start observing gameplay
SixLabs->Init(TEXT("optional_player_in_game_id"), TEXT("optional_developer_payload_here"));// ... gameplay happens — session data is uploaded automatically ...
Important Information
- If
InGameIdis not passed, the observed session may be discarded and will not be used for AI analysis. Without it, sessions cannot be attributed to a player, which is required for downstream insights. - Ensure that you obtain user consent before observing gameplay. The SDK does not automatically request permission; consent handling must be implemented in your game logic.
- As a suggested best practice, you may include a disclosure of gameplay observation in your game’s EULA or privacy policy.
- To properly test it, you need to create a platform-specific build and run it on a physical device.
Reference
The following is the method reference for the
Init() method.
Usage
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
InGameId |
FString |
No | An optional but recommended user identifier. If omitted, the session may be discarded and will not be used for AI analysis. |
DeveloperPayload
|
FString |
No | Optional developer-defined metadata associated with the session. This value is forwarded as-is with the session request and can be used to attach custom tracking or contextual information. Providing richer DeveloperPayload can significantly improve AI-powered analysis and session understanding.
Example:
|
3. Advanced Controls
In most integrations, calling Init() is
sufficient to begin observing gameplay. For
advanced or
custom control, you may also use
StartCapture() and
StopCapture() directly.
3.1 Start Observing
Use the StartCapture() method when you
want to
explicitly control when gameplay observation begins.
#include "SixLabsSubsystem.h"
USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>();
// Start observing gameplay
SixLabs->StartCapture(TEXT("optional_player_in_game_id"), TEXT("optional_developer_payload_here"));// ... gameplay happens — session data is uploaded automatically ...
Usage
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
InGameId |
FString |
No | An optional but recommended user identifier. If omitted, the session may be discarded and will not be used for AI analysis. |
DeveloperPayload
|
FString |
No | Optional developer-defined metadata associated with the session. This value is forwarded as-is with the session request and can be used to attach custom tracking or contextual information. Providing richer DeveloperPayload can significantly improve AI-powered analysis and session understanding. |
3.2 Stop Observing
Use the StopCapture() method to stop observing gameplay.
// Stop gameplay observation
SixLabs->StopCapture();Important Information
- Stops the active gameplay observation.
- You can call
StartCapture()again later to start gameplay observation.