Installation - LCK Documentation

The LCK SDK for Unreal Engine is distributed as a set of plugins. This guide covers installing the core and optional plugins, configuring module dependencies, setting up platform-specific requirements, and verifying everything works.

Download LCK from the Developer Dashboard

Go to the LIV Developer Dashboard.
Create your organization.
Create your game.
Agree to the LCK License Agreement, Privacy Policy, and binding agreement to generate your app-specific SDK.
Download the SDK package and save the Tracking ID provided.

Each game requires its own SDK. If you create a new game entry, you will need to download a new SDK.

Plugin Installation

From Source

Unzip the LCKGame project

Unzip the LCKGame project

Generate Visual Studio project files

Generate Visual Studio project files

You may need to select ‘Show More Options’ to see the below options.

Open the .sln and build

Open the .sln generated and build the project.

Locate Plugins

You can find the LCK plugins inside the /Plugins folder:Core:

LCK (required)
LCKUI
LCKTablet
LCKUnrealAudio

Platform-specific:

LCKOboe (Android microphone)

Audio Middleware (disabled by default):

LCKFMOD (requires FMODStudio)
LCKWwise (requires Wwise)
LCKVivox (requires VivoxCore)

Required Plugins

LCK

Required - Core recording functionality including encoding and capture

LCKAudio

Required - Audio source interface and mixing

Optional Plugins

UI & Interface

LCKUI - 3D UI component library
LCKTablet - Complete virtual tablet interface

Audio Sources

LCKUnrealAudio - Unreal Engine native audio
LCKOboe - Android low-latency microphone

Audio Middleware (External Dependencies)

These plugins require you to download and install third-party plugins:

LCKFMOD - FMOD Studio integration (requires FMODStudio plugin)
LCKWwise - Audiokinetic Wwise integration (requires Wwise plugin)
LCKVivox - Vivox voice chat capture (requires VivoxCore plugin)

Enabling Audio Middleware Plugins

LCKFMOD, LCKWwise, and LCKVivox plugins are disabled by default and will NOT compile without their respective third-party plugins installed. Only enable them after installing the required plugins.

Download the required plugin

FMOD: Download FMODStudio plugin for Unreal Engine
Wwise: Download Wwise plugin for Unreal Engine
Vivox: Download VivoxCore plugin for Unreal Engine

Install the plugin

Copy the downloaded plugin to your project’s Plugins/ folder.

Enable in LCKGame.uproject

Edit LCKGame.uproject and set the plugins to "Enabled": true:For FMOD:

{ "Name": "FMODStudio", "Enabled": true },
{ "Name": "LCKFMOD", "Enabled": true }

For Wwise:

{ "Name": "Wwise", "Enabled": true },
{ "Name": "WwiseSoundEngine", "Enabled": true },
{ "Name": "LCKWwise", "Enabled": true }

For Vivox:

{ "Name": "VivoxCore", "Enabled": true },
{ "Name": "LCKVivox", "Enabled": true }

Module Dependencies

Add the required modules to your .Build.cs file:

PublicDependencyModuleNames.AddRange(new string[] {
    "LCKCore",
    "LCKAudio"
});

PublicDependencyModuleNames.AddRange(new string[] {
    "LCKCore",
    "LCKAudio",
    "LCKUI",
    "LCKTablet"
});

// Audio plugins (add as needed)
PrivateDependencyModuleNames.AddRange(new string[] {
    "LCKUnrealAudio",
    "LCKFMOD",      // If using FMOD
    "LCKWwise",     // If using Wwise
    "LCKVivox"      // If using Vivox
});

Platform Configuration

Windows
Android
Linux

Windows Setup

No additional configuration required. The SDK uses Windows Media Foundation for encoding.Requirements:

Windows 10 or later
DirectX 11 compatible GPU
AVCodecsCore plugin enabled

; DefaultEngine.ini - No changes needed

Android Setup

Enable Vulkan rendering in your project settings
Configure AndroidEngine.ini:

[/Script/AndroidRuntimeSettings.AndroidRuntimeSettings]
bEnableVulkanSM5Support=True

Add required permissions to AndroidManifest.xml:

<uses-permission android:name="android.permission.RECORD_AUDIO"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

Enable LCKOboe plugin for low-latency microphone support

Android requires Vulkan for video encoding. OpenGL ES is not supported — the encoder uses Vulkan + EGL texture interop for hardware-accelerated H.264 encoding.

Project Settings

Navigate to Project Settings > Plugins > LCK SDK:

Setting	Type	Description
`Tracking ID`	String	UUID v4 identifier for analytics (required)
`Game Name`	String	Your application’s display name (required)
`Profile_SD`	Struct	1280x720 quality preset
`Profile_HD`	Struct	1920x1080 quality preset
`Profile_2K`	Struct	2560x1440 quality preset
`Profile_4K`	Struct	3840x2160 quality preset

Quality Profile Settings

Each profile contains:

USTRUCT(BlueprintType)
struct FLCKRecordingProfileSettings
{
    int32 Width;
    int32 Height;
    int32 Framerate;
    int32 VideoBitrate;
    int32 AudioBitrate;
    int32 Samplerate;
};

Start with SD (1280x720) profiles for VR standalone devices like Meta Quest to ensure smooth performance.

Verification

After installation, verify the SDK is working:

#include "LCKSubsystem.h"
#include "Features/IModularFeatures.h"
#include "ILCKAudioSource.h"

void AMyActor::VerifyLCKSetup()
{
    // Check subsystem
    ULCKSubsystem* Subsystem = GetWorld()->GetSubsystem<ULCKSubsystem>();
    if (Subsystem && Subsystem->GetService())
    {
        UE_LOG(LogTemp, Log, TEXT("LCK Service initialized"));
    }

    // Check audio sources
    TArray<ILCKAudioSource*> AudioSources;
    IModularFeatures::Get().GetModularFeatureImplementations<ILCKAudioSource>(
        ILCKAudioSource::GetModularFeatureName(),
        AudioSources
    );
    UE_LOG(LogTemp, Log, TEXT("Found %d audio sources"), AudioSources.Num());
}

Troubleshooting

Plugin not found

Verify plugin is in the correct Plugins/ directory
Regenerate project files (right-click .uproject > Generate Project Files)
Check Output Log for loading errors

Module not found in Build.cs

Ensure the plugin is enabled in .uproject file
Verify module name spelling matches exactly
Check for circular dependencies

Android build fails

Verify Vulkan is enabled
Check NDK version compatibility
Ensure permissions are added to manifest

​Download LCK from the Developer Dashboard

​Plugin Installation

​From Source

​Required Plugins

LCK

LCKAudio

​Optional Plugins

​Enabling Audio Middleware Plugins

​Module Dependencies

​Platform Configuration

​Windows Setup

​Android Setup

​Linux Setup

​Project Settings

​Quality Profile Settings

​Verification

​Troubleshooting

Download LCK from the Developer Dashboard

Plugin Installation

From Source

Required Plugins

Optional Plugins

Enabling Audio Middleware Plugins

Module Dependencies

Platform Configuration

Windows Setup

Android Setup

Linux Setup

Project Settings

Quality Profile Settings

Verification

Troubleshooting