Wwise SDK 2022.1.17

Offline Rendering

The Wwise Sound Engine offers offline rendering that allows for non-real-time, compute-intensive audio generation and the synchronization of audio processing with compute-intensive video generation.

Caution: Care must be taken when enabling offline rendering in applications that use the synchronous AK::SoundEngine::LoadBank and AK::SoundEngine::UnloadBank APIs. See Audio Rendering Thread for details.

An audio capture callback can be registered using AK::SoundEngine::RegisterCaptureCallback, which provides a mechanism for accessing the rendered audio buffers.

The following is an example that illustrates one possible implementation of offline rendering:

AK::SoundEngine::GetSampleRate

AKSOUNDENGINE_API AkUInt32 GetSampleRate()

Ak3DAudioSinkCapabilities

Definition: AkCommonDefs.h:419

AkAudioBuffer::NumChannels

AkForceInline AkUInt32 NumChannels() const

Get the number of channels.

Definition: AkCommonDefs.h:481

AkChannelConfig

Definition: AkSpeakerConfig.h:497

AK::SoundEngine::SetOfflineRenderingFrameTime

AKSOUNDENGINE_API AKRESULT SetOfflineRenderingFrameTime(AkReal32 in_fFrameTimeInSeconds)

AkAudioBuffer::uValidFrames

AkUInt16 uValidFrames

Number of valid sample frames in the audio buffer.

Definition: AkCommonDefs.h:646

AK::SoundEngine::GetOutputID

AKSOUNDENGINE_API AkOutputDeviceID GetOutputID(AkUniqueID in_idShareset, AkUInt32 in_idDevice)

AK::SoundEngine::GetOutputDeviceConfiguration

AKSOUNDENGINE_API AKRESULT GetOutputDeviceConfiguration(AkOutputDeviceID in_idOutput, AkChannelConfig &io_channelConfig, Ak3DAudioSinkCapabilities &io_capabilities)

AK::SoundEngine::RegisterCaptureCallback

AKSOUNDENGINE_API AKRESULT RegisterCaptureCallback(AkCaptureCallbackFunc in_pfnCallback, AkOutputDeviceID in_idOutput=AK_INVALID_OUTPUT_DEVICE_ID, void *in_pCookie=NULL)

AK::SoundEngine::RenderAudio

AKSOUNDENGINE_API AKRESULT RenderAudio(bool in_bAllowSyncRender=true)

AK::SoundEngine::UnregisterCaptureCallback

AKSOUNDENGINE_API AKRESULT UnregisterCaptureCallback(AkCaptureCallbackFunc in_pfnCallback, AkOutputDeviceID in_idOutput=AK_INVALID_OUTPUT_DEVICE_ID, void *in_pCookie=NULL)

AK_INVALID_OUTPUT_DEVICE_ID

static const AkUInt32 AK_INVALID_OUTPUT_DEVICE_ID

Invalid Device ID.

Definition: AkTypes.h:175

AK_INVALID_UNIQUE_ID

static const AkUniqueID AK_INVALID_UNIQUE_ID

Invalid unique 32-bit ID.

Definition: AkTypes.h:163

AK::SoundEngine::SetOfflineRendering

AKSOUNDENGINE_API AKRESULT SetOfflineRendering(bool in_bEnableOfflineRendering)

AkUInt32

uint32_t AkUInt32