6labs SDK for Unreal

The 6labs SDK is provided as an Unreal Engine plugin.

Add the module to your Unreal project:

1. Download the latest version v2.3.5 of the 6labs SDK for Unreal.
2. Extract the plugin into your project's Plugins directory (YourProject/Plugins/SixLabsSDK/).
3. Confirm that the plugin is enabled:
   • In the Unreal Editor, go to Edit > Plugins.
   • Search for “6labs SDK” and confirm it is enabled.
4. Add module dependency:
   • In your game module's Build.cs, add: PublicDependencyModuleNames.Add("SixLabsSDK");

Use the StartSession() method to start observing gameplay, as illustrated below.

// MyGameInstance.h
UFUNCTION()
void OnStartSessionComplete(ESixLabsSdkResponse Response, const FString& ErrorMessage);

// MyGameInstance.cpp
#include "SixLabsSubsystem.h"
if (USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>())
{
    FSixLabsLifecycleComplete OnComplete;
    OnComplete.BindDynamic(this, &UMyGameInstance::OnStartSessionComplete);

    SixLabs->StartSession(TEXT("<player_in_game_id>"), TEXT("<developer_payload>"), OnComplete);
}

void UMyGameInstance::OnStartSessionComplete(ESixLabsSdkResponse Response, const FString& ErrorMessage)
{
    // Response == ESixLabsSdkResponse::SIXLABS_SUCCESS means StartSession() completed successfully
    // handle result
    // SixLabs->GetSdkState() gives you the SDK's current state
}

void StartSession(
    const FString& InGameId,
    const FString& DeveloperPayload,
    const FSixLabsLifecycleComplete& OnComplete);

Use the SetInGameId() method to associate a player's in-game ID with an existing observation session. This is typically required when the SDK is initialized before the user account is created, and you want to link the signed-in user to the session that is already in progress.

if (USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>())
{
    SixLabs->SetInGameId(TEXT("<player_in_game_id>"));
}

void SetInGameId(const FString& InGameId);

Use the SendGameEvent() method to log a custom gameplay event during an active observation session. Events are attached to the session and can be used to correlate specific gameplay moments during analysis.

const bool bAccepted = SixLabs->SendGameEvent(TEXT("<event_name>"), TEXT("<event_data_as_json>"));
if (!bAccepted)
{
    // the event was not sent; see the conditions below
}

bool SendGameEvent(
    const FString& EventName,
    const FString& EventDataJson);

StartSession() begins observing gameplay for a new session. Use PauseSession(), ResumeSession(), and StopSession() to control that session afterward based on your requirements.

5.1 PauseSession

const ESixLabsSdkResponse Response = SixLabs->PauseSession();
if (Response != ESixLabsSdkResponse::SIXLABS_SUCCESS)
{
    // the SDK was not capturing; see the responses below
}

ESixLabsSdkResponse PauseSession();

5.2 ResumeSession

// MyGameInstance.h
UFUNCTION()
void OnResumeSessionComplete(ESixLabsSdkResponse Response, const FString& ErrorMessage);

// MyGameInstance.cpp
#include "SixLabsSubsystem.h"
if (USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>())
{
    FSixLabsLifecycleComplete OnComplete;
    OnComplete.BindDynamic(this, &UMyGameInstance::OnResumeSessionComplete);

    SixLabs->ResumeSession(OnComplete);
}

void UMyGameInstance::OnResumeSessionComplete(ESixLabsSdkResponse Response, const FString& ErrorMessage)
{
    // Response == ESixLabsSdkResponse::SIXLABS_SUCCESS means ResumeSession() completed successfully
    // handle result
    // SixLabs->GetSdkState() gives you the SDK's current state
}

void ResumeSession(const FSixLabsLifecycleComplete& OnComplete);

5.3 StopSession

// MyGameInstance.h
UFUNCTION()
void OnStopSessionComplete(ESixLabsSdkResponse Response, const FString& ErrorMessage);

// MyGameInstance.cpp
#include "SixLabsSubsystem.h"
if (USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>())
{
    FSixLabsLifecycleComplete OnComplete;
    OnComplete.BindDynamic(this, &UMyGameInstance::OnStopSessionComplete);

    SixLabs->StopSession(OnComplete);
}

void UMyGameInstance::OnStopSessionComplete(ESixLabsSdkResponse Response, const FString& ErrorMessage)
{
    // Response == ESixLabsSdkResponse::SIXLABS_SUCCESS means StopSession() completed successfully
    // handle result
    // SixLabs->GetSdkState() gives you the SDK's current state
}

void StopSession(const FSixLabsLifecycleComplete& OnComplete);

The SDK moves through the following states. Which methods you can call, and what they return, depends on the current state:

• You can check the current SDK state at any time using GetSdkState(), which returns an ESixLabsSdkState.
• StartSession(), PauseSession(), ResumeSession(), and StopSession() can only be called from valid SDK states. Calling an operation from an invalid state returns an error.
• PauseSession() returns an ESixLabsSdkResponse directly. StartSession(), ResumeSession(), and StopSession() return their result through the OnComplete callback.
• The OnComplete callback is called asynchronously on the game thread.

6.1 Callback Type

6.2 States

6.3 Response Codes