◆ StartOutputCapture()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::StartOutputCapture ( const AkOSChar * in_CaptureFileName )

Starts recording the sound engine audio output. StartOutputCapture 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 system will return success AK_Success despite doing nothing. Use RegisterAudioDeviceStatusCallback to get notified when devices are created/destructed.

Returns: AK_Success if successful, AK_Fail if there was a problem starting the output capture.

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::IAkFileLocationResolver::Open(). The following AkFileSystemFlags are passed: uCompanyID = AKCOMPANYID_AUDIOKINETIC and uCodecID = AKCODECID_PCM, and the AkOpenMode is AK_OpenModeWriteOvrwr. Refer to File Location Resolving for more details on managing the deployment of your Wwise generated data.

Returns

AK_Success when successful
AK_InvalidParameter if in_CaptureFileName is null.
AK_InsufficientMemory if not enough memory is available.

See also

Parameters

in_CaptureFileName Name of the output capture file

Wwise SDK

StartOutputCapture

◆ StartOutputCapture()

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.