UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::ISoundFileWriter Class Referenceabstract

#include <SoundFile.h>

+ Inheritance diagram for Audio::ISoundFileWriter:

Public Member Functions

virtual ~ISoundFileWriter ()
 
virtual ESoundFileError::Type Init (const FSoundFileDescription &FileDescription, const TArray< ESoundFileChannelMap::Type > &InChannelMap, double EncodingQuality)=0
 
virtual ESoundFileError::Type Release ()=0
 
virtual ESoundFileError::Type SeekFrames (SoundFileCount Offset, ESoundFileSeekMode::Type SeekMode, SoundFileCount &OutOffset)=0
 
virtual ESoundFileError::Type WriteFrames (const float *Data, SoundFileCount NumFrames, SoundFileCount &OutNumFramesWritten)=0
 
virtual ESoundFileError::Type WriteFrames (const double *Data, SoundFileCount NumFrames, SoundFileCount &OutNumFramesWritten)=0
 
virtual ESoundFileError::Type WriteSamples (const float *DataPtr, SoundFileCount NumSamples, SoundFileCount &OutNumSampleWritten)=0
 
virtual ESoundFileError::Type WriteSamples (const double *DataPtr, SoundFileCount NumSamples, SoundFileCount &OutNumSampleWritten)=0
 
virtual ESoundFileError::Type GetData (TArray< uint8 > **OutData)=0
 
virtual ESoundFileError::Type WriteOptionalChunks (const FSoundFileChunkArray &ChunkInfoArray)=0
 
virtual ESoundFileError::Type WriteByteArrayChunk (TArray< uint8 > &InSoundFileChunk)=0
 
virtual ESoundFileError::Type WriteCueCommandData (FSoundFileCues &InSoundFileData)=0
 

Constructor & Destructor Documentation

◆ ~ISoundFileWriter()

virtual Audio::ISoundFileWriter::~ISoundFileWriter ( )
inlinevirtual

Member Function Documentation

◆ GetData()

virtual ESoundFileError::Type Audio::ISoundFileWriter::GetData ( TArray< uint8 > **  OutData)
pure virtual

Implemented in Audio::FSoundFileWriter.

◆ Init()

virtual ESoundFileError::Type Audio::ISoundFileWriter::Init ( const FSoundFileDescription FileDescription,
const TArray< ESoundFileChannelMap::Type > &  InChannelMap,
double  EncodingQuality 
)
pure virtual

Implemented in Audio::FSoundFileWriter.

◆ Release()

virtual ESoundFileError::Type Audio::ISoundFileWriter::Release ( )
pure virtual

Implemented in Audio::FSoundFileWriter.

◆ SeekFrames()

virtual ESoundFileError::Type Audio::ISoundFileWriter::SeekFrames ( SoundFileCount  Offset,
ESoundFileSeekMode::Type  SeekMode,
SoundFileCount OutOffset 
)
pure virtual

Implemented in Audio::FSoundFileWriter.

◆ WriteByteArrayChunk()

virtual ESoundFileError::Type Audio::ISoundFileWriter::WriteByteArrayChunk ( TArray< uint8 > &  InSoundFileChunk)
pure virtual

Implemented in Audio::FSoundFileWriter.

◆ WriteCueCommandData()

virtual ESoundFileError::Type Audio::ISoundFileWriter::WriteCueCommandData ( FSoundFileCues InSoundFileData)
pure virtual

Implemented in Audio::FSoundFileWriter.

◆ WriteFrames() [1/2]

virtual ESoundFileError::Type Audio::ISoundFileWriter::WriteFrames ( const double Data,
SoundFileCount  NumFrames,
SoundFileCount OutNumFramesWritten 
)
pure virtual

Implemented in Audio::FSoundFileWriter.

◆ WriteFrames() [2/2]

virtual ESoundFileError::Type Audio::ISoundFileWriter::WriteFrames ( const float Data,
SoundFileCount  NumFrames,
SoundFileCount OutNumFramesWritten 
)
pure virtual

Implemented in Audio::FSoundFileWriter.

◆ WriteOptionalChunks()

virtual ESoundFileError::Type Audio::ISoundFileWriter::WriteOptionalChunks ( const FSoundFileChunkArray ChunkInfoArray)
pure virtual

Implemented in Audio::FSoundFileWriter.

◆ WriteSamples() [1/2]

virtual ESoundFileError::Type Audio::ISoundFileWriter::WriteSamples ( const double DataPtr,
SoundFileCount  NumSamples,
SoundFileCount OutNumSampleWritten 
)
pure virtual

Implemented in Audio::FSoundFileWriter.

◆ WriteSamples() [2/2]

virtual ESoundFileError::Type Audio::ISoundFileWriter::WriteSamples ( const float DataPtr,
SoundFileCount  NumSamples,
SoundFileCount OutNumSampleWritten 
)
pure virtual

Implemented in Audio::FSoundFileWriter.


The documentation for this class was generated from the following file: