Skip to main content

API

Under construction

This section is under development. If you have signed up on the LIV Dashboard you will have an invite to our internal Discord where you can access developer support.

LckService​

The public LCK API is exposed through the LckService class. The general flow for using LCK is to first use the static function CreateService, passing in an LckDescriptor with the wanted track settings.

At which point you can call SetActiveCamera on the returned service, passing in the ID of the LCK Camera you wish to capture with.

Then the recording can be controlled with StartRecording and StopRecording.

Static Functions​

  • LckResult<LckService> CreateService(LckDescriptor descriptor)
  • LckResult<LckService> GetService()
  • LckResult DestroyService()

Events​

  • LckResultDelegate OnRecordingStarted
  • LckResultDelegate OnRecordingStopped
  • LckResultDelegate OnLowStorageSpace
  • LckRecordingDataDelegate OnRecordingSaved

Methods​

  • LckResult StartRecording()
  • LckResult StopRecording()
  • LckResult SetPreviewEnabled(bool enabled)
  • LckResult SetActiveCamera(string cameraId, string monitorId = null)
  • LckResult SetTrackResolution(CameraResolutionDescriptor cameraResolutionDescriptor)
  • LckResult SetTrackFramerate(uint framerate)
  • LckResult SetTrackBitrate(uint bitrate)
  • LckResult SetTrackAudioBitrate(uint bitrate)
  • LckResult SetTrackDescriptor(CameraTrackDescriptor descriptor)
  • LckResult SetGameAudioGain(float gain)
  • LckResult SetMicrophoneGain(float gain)
  • LckResult SetGameAudioCaptureActive(bool isActive)
  • LckResult SetMicrophoneCaptureActive(bool isActive)
  • LckResult PreloadDiscreetAudio(AudioClip audioClip)
  • LckResult PlayDiscreetAudioClip(AudioClip audioClip)
  • LckResult StopAllDiscreetAudio()
  • LckResult<TimeSpan> GetRecordingDuration()
  • LckResult<float> GetMicrophoneOutputLevel()
  • LckResult<float> GetGameOutputLevel()
  • LckResult<bool> IsRecording()
  • LckResult<bool> IsCapturing()
  • LckResult<bool> IsGameAudioMute()

LckResult​

All fallible calls to the LckService returns an LckResult either with a return value or without. This object can be queried for information about whether the action was successful, and can give important information in the case that the call fails.

LckDescriptor​