UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FSoundFileWriter Class Reference
+ Inheritance diagram for Audio::FSoundFileWriter:

Public Member Functions

 FSoundFileWriter ()
 
 ~FSoundFileWriter ()
 
ESoundFileError::Type GetLengthBytes (SoundFileCount &OutLength) const override
 
ESoundFileError::Type SeekBytes (SoundFileCount Offset, ESoundFileSeekMode::Type SeekMode, SoundFileCount &OutOffset) override
 
ESoundFileError::Type ReadBytes (void *DataPtr, SoundFileCount NumBytes, SoundFileCount &OutNumBytesRead) override
 
ESoundFileError::Type WriteBytes (const void *DataPtr, SoundFileCount NumBytes, SoundFileCount &OutNumBytesWritten) override
 
ESoundFileError::Type GetOffsetBytes (SoundFileCount &OutOffset) const override
 
ESoundFileError::Type Init (const FSoundFileDescription &InDescription, const TArray< ESoundFileChannelMap::Type > &InChannelMap, double InEncodingQuality) override
 
ESoundFileError::Type Release () override
 
ESoundFileError::Type SeekFrames (SoundFileCount Offset, ESoundFileSeekMode::Type SeekMode, SoundFileCount &OutOffset) override
 
ESoundFileError::Type WriteFrames (const float *DataPtr, SoundFileCount NumFrames, SoundFileCount &OutNumFramesWritten) override
 
ESoundFileError::Type WriteFrames (const double *DataPtr, SoundFileCount NumFrames, SoundFileCount &OutNumFramesWritten) override
 
ESoundFileError::Type WriteSamples (const float *DataPtr, SoundFileCount NumSamples, SoundFileCount &OutNumSampleWritten) override
 
ESoundFileError::Type WriteSamples (const double *DataPtr, SoundFileCount NumSamples, SoundFileCount &OutNumSampleWritten) override
 
ESoundFileError::Type GetData (TArray< uint8 > **OutBulkData) override
 
ESoundFileError::Type WriteOptionalChunks (const FSoundFileChunkArray &ChunkInfoArray) override
 
ESoundFileError::Type WriteByteArrayChunk (TArray< uint8 > &InSoundFileChunk) override
 
ESoundFileError::Type WriteCueCommandData (FSoundFileCues &InSoundFileData) override
 
- Public Member Functions inherited from Audio::ISoundFileParser
virtual ~ISoundFileParser ()
 
- Public Member Functions inherited from Audio::ISoundFileWriter
virtual ~ISoundFileWriter ()
 

Constructor & Destructor Documentation

◆ FSoundFileWriter()

Audio::FSoundFileWriter::FSoundFileWriter ( )
inline

◆ ~FSoundFileWriter()

Audio::FSoundFileWriter::~FSoundFileWriter ( )
inline

Member Function Documentation

◆ GetData()

ESoundFileError::Type Audio::FSoundFileWriter::GetData ( TArray< uint8 > **  OutBulkData)
inlineoverridevirtual

◆ GetLengthBytes()

ESoundFileError::Type Audio::FSoundFileWriter::GetLengthBytes ( SoundFileCount OutLength) const
inlineoverridevirtual

◆ GetOffsetBytes()

ESoundFileError::Type Audio::FSoundFileWriter::GetOffsetBytes ( SoundFileCount OutOffset) const
inlineoverridevirtual

◆ Init()

ESoundFileError::Type Audio::FSoundFileWriter::Init ( const FSoundFileDescription InDescription,
const TArray< ESoundFileChannelMap::Type > &  InChannelMap,
double  InEncodingQuality 
)
inlineoverridevirtual

◆ ReadBytes()

ESoundFileError::Type Audio::FSoundFileWriter::ReadBytes ( void DataPtr,
SoundFileCount  NumBytes,
SoundFileCount OutNumBytesRead 
)
inlineoverridevirtual

◆ Release()

ESoundFileError::Type Audio::FSoundFileWriter::Release ( )
inlineoverridevirtual

◆ SeekBytes()

ESoundFileError::Type Audio::FSoundFileWriter::SeekBytes ( SoundFileCount  Offset,
ESoundFileSeekMode::Type  SeekMode,
SoundFileCount OutOffset 
)
inlineoverridevirtual

◆ SeekFrames()

ESoundFileError::Type Audio::FSoundFileWriter::SeekFrames ( SoundFileCount  Offset,
ESoundFileSeekMode::Type  SeekMode,
SoundFileCount OutOffset 
)
inlineoverridevirtual

◆ WriteByteArrayChunk()

ESoundFileError::Type Audio::FSoundFileWriter::WriteByteArrayChunk ( TArray< uint8 > &  InSoundFileChunk)
inlineoverridevirtual

◆ WriteBytes()

ESoundFileError::Type Audio::FSoundFileWriter::WriteBytes ( const void DataPtr,
SoundFileCount  NumBytes,
SoundFileCount OutNumBytesWritten 
)
inlineoverridevirtual

◆ WriteCueCommandData()

ESoundFileError::Type Audio::FSoundFileWriter::WriteCueCommandData ( FSoundFileCues InSoundFileData)
inlineoverridevirtual

◆ WriteFrames() [1/2]

ESoundFileError::Type Audio::FSoundFileWriter::WriteFrames ( const double DataPtr,
SoundFileCount  NumFrames,
SoundFileCount OutNumFramesWritten 
)
inlineoverridevirtual

◆ WriteFrames() [2/2]

ESoundFileError::Type Audio::FSoundFileWriter::WriteFrames ( const float DataPtr,
SoundFileCount  NumFrames,
SoundFileCount OutNumFramesWritten 
)
inlineoverridevirtual

◆ WriteOptionalChunks()

ESoundFileError::Type Audio::FSoundFileWriter::WriteOptionalChunks ( const FSoundFileChunkArray ChunkInfoArray)
inlineoverridevirtual

◆ WriteSamples() [1/2]

ESoundFileError::Type Audio::FSoundFileWriter::WriteSamples ( const double DataPtr,
SoundFileCount  NumSamples,
SoundFileCount OutNumSampleWritten 
)
inlineoverridevirtual

◆ WriteSamples() [2/2]

ESoundFileError::Type Audio::FSoundFileWriter::WriteSamples ( const float DataPtr,
SoundFileCount  NumSamples,
SoundFileCount OutNumSampleWritten 
)
inlineoverridevirtual

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