Audio::WavFileParser Class Reference

#include <WavParser.h>

Inherits Audio::AudioFileParser.

Public Member Functions
size_t	ParseHeader (AZ::IO::FileIOStream &fileStream) override
bool	IsHeaderValid () const override
AudioInputSampleType	GetSampleType () const override
AZ::u32	GetNumChannels () const override
AZ::u32	GetSampleRate () const override
AZ::u32	GetByteRate () const override
AZ::u32	GetBitsPerSample () const override
AZ::u32	GetDataSize () const override
Public Member Functions inherited from Audio::AudioFileParser
	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

Type of AudioFileParser for Wav File Format. Parses header information from Wav files and stores it for retrieval.

Member Function Documentation

GetBitsPerSample()

AZ_INLINE AZ::u32 Audio::WavFileParser::GetBitsPerSample ( ) const

overridevirtual

Implements Audio::AudioFileParser.

GetByteRate()

AZ_INLINE AZ::u32 Audio::WavFileParser::GetByteRate ( ) const

overridevirtual

Implements Audio::AudioFileParser.

GetDataSize()

AZ_INLINE AZ::u32 Audio::WavFileParser::GetDataSize ( ) const

overridevirtual

Implements Audio::AudioFileParser.

GetNumChannels()

AZ_INLINE AZ::u32 Audio::WavFileParser::GetNumChannels ( ) const

overridevirtual

Implements Audio::AudioFileParser.

GetSampleRate()

AZ_INLINE AZ::u32 Audio::WavFileParser::GetSampleRate ( ) const

overridevirtual

Implements Audio::AudioFileParser.

GetSampleType()

AudioInputSampleType Audio::WavFileParser::GetSampleType ( ) const

overridevirtual

Implements Audio::AudioFileParser.

IsHeaderValid()

AZ_INLINE bool Audio::WavFileParser::IsHeaderValid ( ) const

overridevirtual

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.

Implements Audio::AudioFileParser.

ParseHeader()

size_t Audio::WavFileParser::ParseHeader ( AZ::IO::FileIOStream &  fileStream )

overridevirtual

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

fileStream

An opened file stream on the audio file.

Returns

Byte-offset into the file where audio data begins.

Implements Audio::AudioFileParser.

---

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

• Gems/AudioEngineWwise/Code/Source/Engine/AudioInput/WavParser.h