Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Sound/SampleBufferIO.h |
Include |
#include "Sound/SampleBufferIO.h" |
class FSoundWavePCMWriter
FSoundWavePCMWriter This class can be used to save a TSampleBuffer to either a wav file or a USoundWave using BeginGeneratingSoundWaveFromBuffer, BeginWriteToSoundWave, or BeginWriteToWavFile on the game thread. This class uses an async task to generate and write the file to disk.
Name | Description | |
---|---|---|
|
FSoundWavePCMWriter ( |
Name | Description | |
---|---|---|
|
~FSoundWavePCMWriter() |
Name | Description | ||
---|---|---|---|
|
BeginGeneratingSoundWaveFromBuffer ( |
This kicks off an operation to write InSampleBuffer to SoundWaveToSaveTo. |
|
|
BeginWriteToSoundWave ( |
This kicks off an operation to write InSampleBuffer to a USoundWave asset at the specified file path relative to the project directory. |
|
|
BeginWriteToWavFile ( |
This writes out the InSampleBuffer as a wav file at the path specified by FilePath and FileName. |
|
|
CancelWrite() |
Aborts the current write operation. |
|
|
float |
CheckStatus ( |
Call this on the game thread to continue the write operation. |
|
USoundWave &... |
GetFinishedSoundWave() |
Used to grab the a handle to the soundwave. |
|
IsDone() |
Whether we have finished the write operation, by either succeeding, failing, or being cancelled. |
|
|
Reset() |
Clean up all resources used. |
|
|
SaveFinishedSoundWaveToPath |
This function can be used after generating a USoundWave by calling BeginGeneratingSoundWaveFromBuffer to save the generated soundwave to an asset. |
|
|
USoundWave &... |
SynchronouslyWriteSoundWave ( |
This is a blocking call that will return the SoundWave generated from InSampleBuffer. |