UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
Audio::FSoundFileReader Class Referencefinal
+ Inheritance diagram for Audio::FSoundFileReader:

Public Member Functions

 FSoundFileReader ()
 
 ~FSoundFileReader ()
 
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 (TSharedPtr< ISoundFile > InSoundFileData, bool bIsStreamed) override
 
ESoundFileError::Type Init (const TArray< uint8 > *InData)
 
ESoundFileError::Type Release () override
 
ESoundFileError::Type GetDescription (FSoundFileDescription &OutputDescription, TArray< ESoundFileChannelMap::Type > &OutChannelMap)
 
ESoundFileError::Type SeekFrames (SoundFileCount Offset, ESoundFileSeekMode::Type SeekMode, SoundFileCount &OutOffset) override
 
ESoundFileError::Type ReadFrames (float *DataPtr, SoundFileCount NumFrames, SoundFileCount &OutNumFramesRead) override
 
ESoundFileError::Type ReadFrames (double *DataPtr, SoundFileCount NumFrames, SoundFileCount &OutNumFramesRead) override
 
ESoundFileError::Type ReadSamples (float *DataPtr, SoundFileCount NumSamples, SoundFileCount &OutNumSamplesRead) override
 
ESoundFileError::Type ReadSamples (double *DataPtr, SoundFileCount NumSamples, SoundFileCount &OutNumSamplesRead) override
 
ESoundFileError::Type GetOptionalChunks (FSoundFileChunkArray &OutChunkInfoArray, const TSet< uint32 > &ChunkIdsToSkip={}) override
 
- Public Member Functions inherited from Audio::ISoundFileParser
virtual ~ISoundFileParser ()
 
- Public Member Functions inherited from Audio::ISoundFileReader
virtual ~ISoundFileReader ()
 

Constructor & Destructor Documentation

◆ FSoundFileReader()

Audio::FSoundFileReader::FSoundFileReader ( )
inline

◆ ~FSoundFileReader()

Audio::FSoundFileReader::~FSoundFileReader ( )
inline

Member Function Documentation

◆ GetDescription()

ESoundFileError::Type Audio::FSoundFileReader::GetDescription ( FSoundFileDescription &  OutputDescription,
TArray< ESoundFileChannelMap::Type > &  OutChannelMap 
)
inlinevirtual

Implements Audio::ISoundFileReader.

◆ GetLengthBytes()

ESoundFileError::Type Audio::FSoundFileReader::GetLengthBytes ( SoundFileCount &  OutLength) const
inlineoverridevirtual

Implements Audio::ISoundFileParser.

◆ GetOffsetBytes()

ESoundFileError::Type Audio::FSoundFileReader::GetOffsetBytes ( SoundFileCount &  OutOffset) const
inlineoverridevirtual

Implements Audio::ISoundFileParser.

◆ GetOptionalChunks()

ESoundFileError::Type Audio::FSoundFileReader::GetOptionalChunks ( FSoundFileChunkArray &  OutChunkInfoArray,
const TSet< uint32 > &  ChunkIdsToSkip = {} 
)
inlineoverridevirtual

Implements Audio::ISoundFileReader.

◆ Init() [1/2]

ESoundFileError::Type Audio::FSoundFileReader::Init ( const TArray< uint8 > *  InData)
inlinevirtual

Implements Audio::ISoundFileReader.

◆ Init() [2/2]

ESoundFileError::Type Audio::FSoundFileReader::Init ( TSharedPtr< ISoundFile >  InSoundFileData,
bool  bIsStreamed 
)
inlineoverridevirtual

Implements Audio::ISoundFileReader.

◆ ReadBytes()

ESoundFileError::Type Audio::FSoundFileReader::ReadBytes ( void *  DataPtr,
SoundFileCount  NumBytes,
SoundFileCount &  OutNumBytesRead 
)
inlineoverridevirtual

Implements Audio::ISoundFileParser.

◆ ReadFrames() [1/2]

ESoundFileError::Type Audio::FSoundFileReader::ReadFrames ( double *  DataPtr,
SoundFileCount  NumFrames,
SoundFileCount &  OutNumFramesRead 
)
inlineoverridevirtual

Implements Audio::ISoundFileReader.

◆ ReadFrames() [2/2]

ESoundFileError::Type Audio::FSoundFileReader::ReadFrames ( float *  DataPtr,
SoundFileCount  NumFrames,
SoundFileCount &  OutNumFramesRead 
)
inlineoverridevirtual

Implements Audio::ISoundFileReader.

◆ ReadSamples() [1/2]

ESoundFileError::Type Audio::FSoundFileReader::ReadSamples ( double *  DataPtr,
SoundFileCount  NumSamples,
SoundFileCount &  OutNumSamplesRead 
)
inlineoverridevirtual

Implements Audio::ISoundFileReader.

◆ ReadSamples() [2/2]

ESoundFileError::Type Audio::FSoundFileReader::ReadSamples ( float *  DataPtr,
SoundFileCount  NumSamples,
SoundFileCount &  OutNumSamplesRead 
)
inlineoverridevirtual

Implements Audio::ISoundFileReader.

◆ Release()

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

Implements Audio::ISoundFileReader.

◆ SeekBytes()

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

Implements Audio::ISoundFileParser.

◆ SeekFrames()

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

Implements Audio::ISoundFileReader.

◆ WriteBytes()

ESoundFileError::Type Audio::FSoundFileReader::WriteBytes ( const void *  DataPtr,
SoundFileCount  NumBytes,
SoundFileCount &  OutNumBytesWritten 
)
inlineoverridevirtual

Implements Audio::ISoundFileParser.

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