ILckService - LCK Documentation

Description

ILckService defines the contract for interacting with the capture system. It exposes events for lifecycle notifications (recording, streaming, saving, etc.), and methods for managing capture sessions, configuring video/audio parameters, and controlling cameras and audio.

Usage

Retrieve an ILckService instance through dependency injection or the DI container:

[InjectLck] private ILckService _lckService;

Example: Start a Recording

_lckService.OnRecordingStarted += result =>
{
    if (result.Success)
        Debug.Log("Recording started successfully!");
    else
        Debug.LogError($"Failed to start recording: {result.ErrorMessage}");
};

var startResult = _lckService.StartRecording();
if (!startResult.Success)
    Debug.LogError($"Error: {startResult.ErrorMessage}");

Example: Switch Capture Settings

// Change resolution before capturing
var resolution = new CameraResolutionDescriptor(1920, 1080);
var result = _lckService.SetTrackResolution(resolution);

if (!result.Success)
    Debug.LogError($"Failed to set resolution: {result.ErrorMessage}");

Example: Control Audio

// Enable microphone capture
_lckService.SetMicrophoneCaptureActive(true);

// Adjust microphone gain
_lckService.SetMicrophoneGain(1.5f);

// Check microphone level
var micLevel = _lckService.GetMicrophoneOutputLevel();
Debug.Log($"Mic Output Level: {micLevel.Result}");

Events

Event	Type	Description
OnRecordingStarted	Action<`LckResult`>	Invoked when recording starts.
OnRecordingPaused	Action<`LckResult`>	Invoked when recording is paused.
OnRecordingResumed	Action<`LckResult`>	Invoked when recording resumes.
OnRecordingStopped	Action<`LckResult`>	Invoked when recording stops.
OnStreamingStarted	Action<`LckResult`>	Invoked when streaming starts.
OnStreamingStopped	Action<`LckResult`>	Invoked when streaming stops.
OnLowStorageSpace	Action<`LckResult`>	Invoked when low storage is detected.
OnRecordingSaved	Action<`LckResult`<RecordingData>>	Invoked when a recording has been saved.

Methods

Method	Returns	Description
GetRecordingDuration()	`LckResult`<TimeSpan>	Gets the duration of the current recording.
GetStreamDuration()	`LckResult`<TimeSpan>	Gets the duration of the current stream.
StartRecording()	`LckResult`	Starts recording.
PauseRecording()	`LckResult`	Pauses recording.
ResumeRecording()	`LckResult`	Resumes recording.
StopRecording()	`LckResult`	Stops recording.
StartStreaming()	`LckResult`	Starts streaming.
StopStreaming()	`LckResult`	Stops streaming.
SetTrackFramerate(uint)	`LckResult`	Sets the capture framerate.
SetTrackDescriptor(CameraTrackDescriptor)	`LckResult`	Sets the track descriptor for capture.
SetTrackDescriptor(LckCaptureType, CameraTrackDescriptor)	`LckResult`	Sets the track descriptor for a given capture type.
SetTrackResolution(CameraResolutionDescriptor)	`LckResult`	Sets the capture resolution.
SetTrackBitrate(uint)	`LckResult`	Sets the video bitrate.
SetTrackAudioBitrate(uint)	`LckResult`	Sets the audio bitrate.
SetCameraOrientation(LckCameraOrientation)	`LckResult`	Sets the camera orientation.
GetActiveCaptureType()	`LckResult`<LckCaptureType>	Gets the currently active capture type.
SetActiveCaptureType(LckCaptureType)	`LckResult`	Sets the active capture type.
SetPreviewActive(bool)	`LckResult`	Enables or disables preview rendering.
IsRecording()	`LckResult`<bool>	Returns whether recording is active.
IsStreaming()	`LckResult`<bool>	Returns whether streaming is active.
IsCapturing()	`LckResult`<bool>	Returns whether capture is active.
SetGameAudioCaptureActive(bool)	`LckResult`	Enables/disables game audio capture.
SetMicrophoneCaptureActive(bool)	`LckResult`	Enables/disables microphone capture.
GetMicrophoneOutputLevel()	`LckResult`<float>	Gets the current microphone output level.
SetMicrophoneGain(float)	`LckResult`	Sets microphone gain.
SetGameAudioGain(float)	`LckResult`	Sets game audio gain.
GetGameOutputLevel()	`LckResult`<float>	Gets the current game audio output level.
IsGameAudioMute()	`LckResult`<bool>	Returns whether game audio is muted.
SetActiveCamera(string, string monitorId = null)	`LckResult`	Sets the active camera (and optional monitor).
PreloadDiscreetAudio(AudioClip, float, bool)	`LckResult`	Preloads an audio clip for discreet playback.
PlayDiscreetAudioClip(AudioClip)	`LckResult`	Plays a discreet audio clip.
StopAllDiscreetAudio()	`LckResult`	Stops all discreet audio playback.
GetDescriptor()	`LckResult`<`LckDescriptor`>	Gets the current descriptor.
CapturePhoto()	`LckResult`	Captures a photo.
Dispose()	void	Cleans up and disposes the service.

​Description

​Usage

​Example: Start a Recording

​Example: Switch Capture Settings

​Example: Control Audio

​Events

​Methods