Skip to main content
Module: LCKWwise | Version: 1.0 | Platforms: Win64, Android

Overview

LCKWwise provides integration with Audiokinetic Wwise, capturing game audio output for recording. This plugin hooks into the Wwise audio system to capture the final mixed output using an output device capture callback.

Supported Channels

Requirements

LCKWwise requires the Wwise plugin which must be downloaded separately from Audiokinetic. The LCKWwise plugin is disabled by default and will not compile without Wwise installed.
  • Wwise plugin for Unreal Engine
  • Wwise project configured in your game
  • Valid Wwise license

Dependencies

Automatic Integration

The plugin automatically:
  1. Detects Wwise plugin presence
  2. Registers output capture callback
  3. Registers with the LCK audio system

Source Implementation

FLCKWwiseSource

The core audio source class that captures game audio from the Wwise output stage:

WWise_CaptureCallback

A static callback function registered with the Wwise sound engine. When Wwise delivers audio buffers, this callback converts the data and fires OnAudioDataDelegate with ELCKAudioChannel::Game.

Capture Point

LCKWwise captures audio from the Wwise output stage after all processing:

Technical Details

Capture Callback Registration

The plugin registers a capture callback with the Wwise sound engine:

Ambisonic Support

The plugin supports 3rd-order ambisonic (16-channel) to stereo conversion:
Ambisonic decoding is limited to 3rd-order (16 channels). Higher-order ambisonics are not supported.

Capture Lifecycle

  1. StartCapture — Adds a secondary Wwise output configured for stereo, registers WWise_CaptureCallback, and queries the engine sample rate
  2. Audio callbackWWise_CaptureCallback receives buffers from Wwise, performs ambisonic decoding if needed, and fires OnAudioDataDelegate
  3. StopCapture — Unregisters the capture callback and removes the output device

Configuration

Sample Rate and Channel Configuration

We recommend setting Sample Rate to 48000 and Channel Config Type to Standard (rather than Anonymous or Ambisonic). Wwise configuration

Channel Settings

Setting Channels to 2 sometimes resolves audio issues. These settings need to be configured separately for Android and Windows, depending on your target platforms. Wwise channel settings
Voice chat and game audio must match in samplerate, otherwise audio distortion will occur in recordings.

Output Device Configuration

Ensure your Wwise project outputs to the appropriate device:
  1. In Wwise Authoring, configure the Audio Device Shareset
  2. Set output to match your game’s audio output
  3. Verify in Wwise Profiler that audio is flowing

Platform Support

Performance

Wwise Version Compatibility

Older Wwise versions may have different callback APIs. Check release notes for compatibility.

Troubleshooting

  1. Verify Wwise plugin is enabled and initialized
  2. Check Wwise Profiler for audio output
  3. Verify output callback is registered (check LogLCKWwise)
  4. Ensure OutputDeviceId is valid (not AK_INVALID_OUTPUT_DEVICE_ID)
  1. Verify AkAudio module is available
  2. Check plugin load order in .uproject
  3. Look for Wwise initialization errors
  1. Check Wwise project sample rate settings
  2. Verify encoder sample rate matches
  3. Consider resampling if rates differ
  1. Verify Wwise is configured for 3rd-order ambisonic (16 channels)
  2. Higher-order ambisonics are not supported
  3. Try setting Channel Config Type to Standard stereo instead

Log Category

See Also

Audio Overview

Audio system architecture

FMOD

Alternative middleware integration