Prerequisites
Visual Studio 2022 (Windows)
Android SDK/NDK (for Android builds)
C++ project (Blueprint-only projects require C++ conversion)
Installation
Enable Required Plugins
Enable the following plugins in your project:Required:Optional (based on your needs):
LCKUI - 3D UI componentsLCKTablet - Virtual tablet interfaceLCKUnrealAudio - Unreal audio captureLCKVivox - Vivox voice chat captureLCKOboe - Android microphone (Android only)
Optional Audio Middleware (requires external plugins): Configure Module Dependencies
Add to your module’s .Build.cs:public class YourModule : ModuleRules
{
public YourModule(ReadOnlyTargetRules Target) : base(Target)
{
PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
PublicDependencyModuleNames.AddRange(new string[] {
"Core",
"CoreUObject",
"Engine",
"LCKCore",
"LCKAudio"
});
// Optional: Add UI support
PrivateDependencyModuleNames.AddRange(new string[] {
"LCKUI",
"LCKTablet"
});
}
}
Configure Project Settings
Navigate to Project Settings > Plugins > LCK SDK and configure:| Setting | Description | Required |
|---|
| Tracking ID | UUID v4 format identifier for analytics | Yes |
| Game Name | Display name for your application | Yes |
| Profile_SD | 1280x720 recording profile settings | No |
| Profile_HD | 1920x1080 recording profile settings | No |
Basic Recording
Get the LCK Service
#include "LCKSubsystem.h"
#include "LCKService.h"
// From any actor with world context
ULCKSubsystem* Subsystem = GetWorld()->GetSubsystem<ULCKSubsystem>();
ULCKService* Service = Subsystem->GetService();
// Apply recording settings
Service->ApplyRecordingSettings(
1920, // Width
1080, // Height
30, // Framerate
8000000, // Video bitrate (8 Mbps)
256000, // Audio bitrate (256 Kbps)
48000 // Sample rate
);
Register Scene Capture
// Create or reference your scene capture component
USceneCaptureComponent2D* CaptureComponent = /* your capture component */;
// Register with the service (provide a unique name)
Service->RegisterCaptureComponent(TEXT("MainCapture"), CaptureComponent);
Start Recording
// Subscribe to events first
Service->OnRecordingSaveFinished.AddDynamic(this, &AMyActor::HandleSaveFinished);
Service->OnRecordingError.AddDynamic(this, &AMyActor::HandleRecordingError);
// Start recording
Service->StartRecording();
Stop Recording
// Stop recording
Service->StopRecording();
// Progress is reported via delegate
Service->OnRecordingSaveProgress.AddDynamic(this, &AMyActor::HandleSaveProgress);
void AMyActor::HandleSaveProgress(float Progress)
{
UE_LOG(LogTemp, Log, TEXT("Save progress: %.1f%%"), Progress * 100.0f);
}
void AMyActor::HandleSaveFinished(bool bSuccess)
{
UE_LOG(LogTemp, Log, TEXT("Recording saved: %s"), bSuccess ? TEXT("Yes") : TEXT("No"));
}
For direct async control, use ULCKRecorderSubsystem which provides StartRecordingAsync() and StopRecordingAsync() methods with delegate callbacks.
Photo Capture
// Take a single photo
Service->TakePhoto();
Blueprint Usage
All major functions are exposed to Blueprints:
| Function | Category | Description |
|---|
GetService | LCK Subsystem | Get the LCK service instance |
StartRecording | Recording | Begin video recording |
StopRecording | Recording | End video recording |
TakePhoto | Recording | Capture single frame |
IsRecording | State | Check if currently recording |
GetCurrentRecordingDuration | State | Get recording time in seconds |
Next Steps
