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

#include <SoundFile.h>

+ Inheritance diagram for Audio::ISoundFileReader:

Public Member Functions

virtual ~ISoundFileReader ()
 
virtual ESoundFileError::Type Init (TSharedPtr< ISoundFile > InSoundFileData, bool bIsStreamed)=0
 
virtual ESoundFileError::Type Init (const TArray< uint8 > *InData)=0
 
virtual ESoundFileError::Type Release ()=0
 
virtual ESoundFileError::Type SeekFrames (SoundFileCount Offset, ESoundFileSeekMode::Type SeekMode, SoundFileCount &OutOffset)=0
 
virtual ESoundFileError::Type ReadFrames (float *DataPtr, SoundFileCount NumFrames, SoundFileCount &OutNumFramesRead)=0
 
virtual ESoundFileError::Type ReadFrames (double *DataPtr, SoundFileCount NumFrames, SoundFileCount &OutNumFramesRead)=0
 
virtual ESoundFileError::Type ReadSamples (float *DataPtr, SoundFileCount NumSamples, SoundFileCount &OutNumSamplesRead)=0
 
virtual ESoundFileError::Type ReadSamples (double *DataPtr, SoundFileCount NumSamples, SoundFileCount &OutNumSamplesRead)=0
 
virtual ESoundFileError::Type GetDescription (FSoundFileDescription &OutputDescription, TArray< ESoundFileChannelMap::Type > &OutChannelMap)=0
 
virtual ESoundFileError::Type GetOptionalChunks (FSoundFileChunkArray &OutChunkInfoArray, const TSet< uint32 > &ChunkIdsToSkip={})=0
 

Constructor & Destructor Documentation

◆ ~ISoundFileReader()

virtual Audio::ISoundFileReader::~ISoundFileReader ( )
inlinevirtual

Member Function Documentation

◆ GetDescription()

virtual ESoundFileError::Type Audio::ISoundFileReader::GetDescription ( FSoundFileDescription OutputDescription,
TArray< ESoundFileChannelMap::Type > &  OutChannelMap 
)
pure virtual

◆ GetOptionalChunks()

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

◆ Init() [1/2]

virtual ESoundFileError::Type Audio::ISoundFileReader::Init ( const TArray< uint8 > *  InData)
pure virtual

◆ Init() [2/2]

virtual ESoundFileError::Type Audio::ISoundFileReader::Init ( TSharedPtr< ISoundFile InSoundFileData,
bool  bIsStreamed 
)
pure virtual

◆ ReadFrames() [1/2]

virtual ESoundFileError::Type Audio::ISoundFileReader::ReadFrames ( double DataPtr,
SoundFileCount  NumFrames,
SoundFileCount OutNumFramesRead 
)
pure virtual

◆ ReadFrames() [2/2]

virtual ESoundFileError::Type Audio::ISoundFileReader::ReadFrames ( float DataPtr,
SoundFileCount  NumFrames,
SoundFileCount OutNumFramesRead 
)
pure virtual

◆ ReadSamples() [1/2]

virtual ESoundFileError::Type Audio::ISoundFileReader::ReadSamples ( double DataPtr,
SoundFileCount  NumSamples,
SoundFileCount OutNumSamplesRead 
)
pure virtual

◆ ReadSamples() [2/2]

virtual ESoundFileError::Type Audio::ISoundFileReader::ReadSamples ( float DataPtr,
SoundFileCount  NumSamples,
SoundFileCount OutNumSamplesRead 
)
pure virtual

◆ Release()

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

◆ SeekFrames()

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

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