Open 3D Engine AudioSystem Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Audio::SAudioInputConfig Struct Reference

Public Member Functions

 SAudioInputConfig (AudioInputSourceType sourceType, const char *filename, bool autoUnloadFile=true)
 
 SAudioInputConfig (AudioInputSourceType sourceType, AZ::u32 sampleRate, AZ::u32 numChannels, AZ::u32 bitsPerSample, AudioInputSampleType sampleType)
 
void SetBufferSizeFromFrameCount (AZ::u32 frameCount)
 
AZ::u32 GetSampleCountFromBufferSize () const
 

Public Attributes

TAudioSourceId m_sourceId { INVALID_AUDIO_SOURCE_ID }
 Source Id, this is set after the source is created with the manager.
 
AZ::u32 m_sampleRate { 0 }
 Sample rate of the source, e.g. 44100, 48000.
 
AZ::u32 m_numChannels { 0 }
 Number of channels, e.g. 1 = Mono, 2 = Stereo.
 
AZ::u32 m_bitsPerSample { 0 }
 Number of bits per sample, e.g. 16, 32.
 
AZ::u32 m_bufferSize { 0 }
 Size of the buffer in bytes.
 
AudioInputSourceType m_sourceType { AudioInputSourceType::Unsupported }
 The type of the source, e.g. File, Synthesis, Microphone.
 
AudioInputSampleType m_sampleType { AudioInputSampleType::Unsupported }
 The sample format, e.g. Int, Float.
 
AZStd::string m_sourceFilename {}
 The filename of the source (if any)
 
bool m_autoUnloadFile { false }
 For files, whether the file should unload after playback completes.
 

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