6labs SDK for Unity

The 6labs SDK is included as a Unity package file.

Add the module to your Unity project:

1. Download the latest version v4.0.0 of the 6labs SDK for Unity.
2. Import the package into your Unity project:
   • Click on Assets > Import Package > Custom Package.
   • Select the downloaded .unitypackage file from your system.
   • Click on Import.

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

using SixLabs.SDK;

SixLabsSDK.Instance.StartSession(
    inGameId: "<optional_player_in_game_id>",
    developerPayload: "<optional_developer_payload_here>",
    callbackOnComplete: (sdkResponse, errorMessage) => {
        // sdkResponse == SdkResponse.SUCCESS means StartSession() completed successfully
        // handle result
        // SixLabsSDK.Instance.CurrentState gives you the SDK's current state
    }
);

public void StartSession(
    string inGameId = null,
    string developerPayload = null,
    Action<SdkResponse, string> callbackOnComplete = null)

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.

SixLabsSDK.Instance.SetInGameId("<player_in_game_id>");

public void SetInGameId(string 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.

bool result = SixLabsSDK.Instance.SendGameEvent(
    eventName: "<event_name>",
    eventDataJson: "<event_data_as_json>"
);

public bool SendGameEvent(
    string eventName,
    string 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

Use the PauseSession() method to pause gameplay observation.

SdkResponse result = SixLabsSDK.Instance.PauseSession();

public SdkResponse PauseSession()

5.2 ResumeSession

Use the ResumeSession() method to continue a session that was previously paused with PauseSession().

SixLabsSDK.Instance.ResumeSession(
    callbackOnComplete: (sdkResponse, errorMessage) => {
        // sdkResponse == SdkResponse.SUCCESS means ResumeSession() completed successfully
        // handle result
        // SixLabsSDK.Instance.CurrentState gives you the SDK's current state
    }
);

public void ResumeSession(Action<SdkResponse, string> callbackOnComplete = null)

5.3 StopSession

Use the StopSession() method to permanently end the current session. Unlike PauseSession(), a stopped session cannot be continued with ResumeSession() — starting a new session requires calling StartSession() again.

SixLabsSDK.Instance.StopSession(
    callbackOnComplete: (sdkResponse, errorMessage) => {
        // sdkResponse == SdkResponse.SUCCESS means StopSession() completed successfully
        // handle result
        // SixLabsSDK.Instance.CurrentState gives you the SDK's current state
    }
);

public void StopSession(Action<SdkResponse, string> callbackOnComplete = null)

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 SixLabsSDK.Instance.CurrentState.
• 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 SdkResponse directly. StartSession(), ResumeSession(), and StopSession() return their result through the optional callbackOnComplete callback.
• The callbackOnComplete callback is called asynchronously.

6.1 Callback Parameters

The callback is of type Action<SdkResponse, string> and receives the following two parameters:

6.2 States

The following states describe the SDK's lifecycle. The current state determines which operations the SDK accepts.

6.3 Response Codes

The following response codes indicate the outcome of a lifecycle method call.