Using 6Labs SDK

This section shows you how to integrate the 6Labs SDK into your iOS and Android apps on Unity.

1. Download and Import the Module

The 6Labs SDK is included as a Unity package file SixLabsSDK-1.0.6.unitypackage.

Add the module to your Unity project:

Download the package containing the latest version of 6Labs SDK for Unity.
Import the package into your Unity project:
- Click on Assets > Import Package > Custom Package.
- Select SixLabsSDK-1.0.6.unitypackage from your system.
- Click on Import.

2. Start Gameplay Capture

Use the Init() method to initialize the SDK and start the gameplay capture process, as illustrated below:

SixLabsSDK.Instance.Init(
    inGameId: "<optional_player_in_game_id>",
    developerPayload: "<optional_developer_payload_here>"
);

Important Information

Ensure that you obtain user consent before initiating gameplay capture. 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 recording in your game’s EULA or privacy policy.
The SDK does not function within the Unity Editor. 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.

Method Signature

public void Init(string inGameId = null, string developerPayload = null)

Parameters

Parameter Type Required Description

inGameId string No An optional user identifier within the game. If not passed, it defaults to an empty string.

developerPayload

string

No

Optional developer-defined metadata associated with the session. This value is forwarded as-is with the capture request and can be used to attach custom tracking or contextual information.
Example:

Acquisition channel
Campaign ID
User segment (new, returning, whale)
Internal reference identifiers

3. Advanced Capture Controls

In most integrations, calling Init() is sufficient to begin the capture flow. For advanced or custom capture control, you may also use StartCapture() and StopCapture() directly.

3.1 Start Capture

Use the StartCapture() method when you want to explicitly control when gameplay capture begins.

SixLabsSDK.Instance.StartCapture(
    inGameId: "<optional_player_in_game_id>",
    developerPayload: "<optional_developer_payload_here>"
);

Method Signature

public void StartCapture(string inGameId = null, string developerPayload = null)

Parameters

Parameter	Type	Required	Description
`inGameId`	`string`	No	An optional user identifier within the game. If not passed, it defaults to an empty string.
`developerPayload`	`string`	No	Optional developer-defined metadata associated with the session. This value is forwarded as-is with the capture request and can be used to attach custom tracking or contextual information.

3.2 Stop Capture

Use the StopCapture() method to stop the active gameplay capture session.

SixLabsSDK.Instance.StopCapture();

Important Information

Stops the active gameplay capture session.
You can call StartCapture() again later to begin a new session.

Overview