Open 3D Engine AudioEngineWwise 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::AudioInputMicrophone Class Reference

Inherits Audio::AudioInputSource.

Public Member Functions

 AudioInputMicrophone (const SAudioInputConfig &sourceConfig)
 
void ReadInput (const AudioStreamData &data) override
 
void WriteOutput (AkAudioBuffer *akBuffer) override
 
bool IsOk () const override
 
void OnDeactivated () override
 
- Public Member Functions inherited from Audio::AudioInputSource
virtual void ReadInput (const AudioStreamData &data)=0
 
virtual void WriteOutput (AkAudioBuffer *akBuffer)=0
 
virtual bool IsOk () const =0
 
virtual bool IsFormatValid () const
 
virtual void OnActivated ()
 
virtual void OnDeactivated ()
 
void SetFormat (AkAudioFormat &format)
 
void SetSourceId (TAudioSourceId sourceId)
 
TAudioSourceId GetSourceId () const
 

Additional Inherited Members

- Protected Attributes inherited from Audio::AudioInputSource
SAudioInputConfig m_config
 Configuration information for the source type.
 
AkPlayingID m_playingId = AK_INVALID_PLAYING_ID
 Playing ID of the source.
 

Member Function Documentation

◆ IsOk()

bool Audio::AudioInputMicrophone::IsOk ( ) const
overridevirtual

◆ OnDeactivated()

void Audio::AudioInputMicrophone::OnDeactivated ( )
overridevirtual

Reimplemented from Audio::AudioInputSource.

◆ ReadInput()

void Audio::AudioInputMicrophone::ReadInput ( const AudioStreamData &  data)
overridevirtual

◆ WriteOutput()

void Audio::AudioInputMicrophone::WriteOutput ( AkAudioBuffer *  akBuffer)
overridevirtual

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