Open 3D Engine MiniAudio 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.
MiniAudio::MiniAudioRequests Class Referenceabstract

Public Member Functions

 AZ_RTTI (MiniAudioRequests, "{3726A215-EF3D-44E0-8847-FBA15A8B1F84}")
 
virtual ma_engine * GetSoundEngine ()=0
 
virtual void SetGlobalVolume (float scale)=0
 
virtual float GetGlobalVolume () const =0
 
virtual void SetGlobalVolumeInDecibels (float decibels)=0
 
virtual AZ::u32 GetChannelCount () const =0
 

Member Function Documentation

◆ GetChannelCount()

virtual AZ::u32 MiniAudio::MiniAudioRequests::GetChannelCount ( ) const
pure virtual
Returns
the number of output channels for the sound engine

◆ GetGlobalVolume()

virtual float MiniAudio::MiniAudioRequests::GetGlobalVolume ( ) const
pure virtual
Returns
the current volume set for the whole sound engine

◆ SetGlobalVolume()

virtual void MiniAudio::MiniAudioRequests::SetGlobalVolume ( float  scale)
pure virtual

Sets the volume for the entire sound engine.

Parameters
scale0 resulting in silence and anything above 1 resulting in amplification

◆ SetGlobalVolumeInDecibels()

virtual void MiniAudio::MiniAudioRequests::SetGlobalVolumeInDecibels ( float  decibels)
pure virtual

Sets the volume for the entire sound engine using decibel scale.

Parameters
decibelsgain in decibels

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