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::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
 

Detailed Description

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

Member Function Documentation

◆ 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
fileStreamAn 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: