Version
menu

Wwise SDK 2025.1.2
AkCmd_ControlOutputCapture Struct Reference

#include <AkCommandTypes.h>

Public Attributes

AkUInt32 isEnabled
 Whether the Sound Engine should capture the audio output to a file. More...
 

Detailed Description

Starts or stops recording the sound engine audio output.

The capture system outputs a wav file per current output device of the sound engine. If more than one device is active, the system will create multiple files in the same output directory and will append numbers at the end of the provided filename.

If no device is running yet, the command will return success AK_Success despite doing nothing. Use AK::SoundEngine::RegisterAudioDeviceStatusCallback to get notified when devices are created/destructed.

Remarks
The sound engine opens a stream for writing using AK::IAkStreamMgr::CreateStd(). If you are using the default implementation of the Stream Manager, file opening is executed in your implementation of the Low-Level IO interface AK::StreamMgr::IAkLowLevelIOHook::BatchOpen(). The following AkFileSystemFlags are passed: uCompanyID = AKCOMPANYID_AUDIOKINETIC and uCodecID = AKCODECID_PCM, and the AkOpenMode is AK_OpenModeWriteOvrwr. See File Location Resolving for more details on managing the deployment of your Wwise generated data.

When isEnabled is set, the Sound Engine expects a string to follow the command representing the name of the file to write. For example:

auto cmd = (AkCmd_ControlOutputCapture*)AK_CommandBuffer_Add(buffer, AkCommand_ControlOutputCapture);
cmd->isEnabled = 1;
AK_CommandBuffer_AddString(buffer, "myrecording.wav");

This command can fail for the following reasons:

Definition at line 1155 of file AkCommandTypes.h.


Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise