Open 3D Engine AudioEngineWwise Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
Audio::AudioFileParser Class Referenceabstract

#include <AudioInputFile.h>

Inherited by Audio::WavFileParser.

Public Member Functions

 AudioFileParser (const AudioFileParser &)=delete
 
AudioFileParser & operator= (const AudioFileParser &)=delete
 
virtual size_t ParseHeader (AZ::IO::FileIOStream &fileStream)=0
 
virtual bool IsHeaderValid () const =0
 
virtual AudioInputSampleType GetSampleType () const =0
 
virtual AZ::u32 GetNumChannels () const =0
 
virtual AZ::u32 GetSampleRate () const =0
 
virtual AZ::u32 GetByteRate () const =0
 
virtual AZ::u32 GetBitsPerSample () const =0
 
virtual AZ::u32 GetDataSize () const =0
 

Detailed Description

Base class for audio file parser. Any supported audio file types will have a parser implementation that will parse header information to extract the audio format.

Member Function Documentation

◆ IsHeaderValid()

virtual bool Audio::AudioFileParser::IsHeaderValid ( ) const
pure virtual

Check validity of the header info. This should only return true if the header was parsed and user can expect to see valid format data.

Returns
True if the header was parsed without error.

Implemented in Audio::WavFileParser.

◆ ParseHeader()

virtual size_t Audio::AudioFileParser::ParseHeader ( AZ::IO::FileIOStream &  fileStream)
pure virtual

Parse header from a file stream. Parses header of an audio file and returns the byte-offset into the file where the audio data begins.

Parameters
fileStreamAn opened file stream on the audio file.
Returns
Byte-offset into the file where audio data begins.

Implemented in Audio::WavFileParser.

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