Rebel Fork Framework
Urho3D::Audio Class Reference

Audio subsystem. More...

#include <Urho3D/Audio/Audio.h>

Inheritance diagram for Urho3D::Audio:
Urho3D::Object Urho3D::RefCounted

Public Member Functions

 Audio (Context *context)
 ~Audio () override
 Destruct. Terminate the audio thread and free the audio buffer.
bool SetMode (int bufferLengthMSec, int mixRate, SpeakerMode mode, bool interpolation=true)
 Initialize sound output with specified buffer length and output mode.
bool RefreshMode ()
 Re-initialize sound output with same parameters.
void Close ()
 Shutdown this audio device, likely because we've lost it.
void Update (float timeStep)
 Run update on sound sources. Not required for continued playback, but frees unused sound sources & sounds and updates 3D positions.
bool Play ()
 Restart sound output.
void Stop ()
 Suspend sound output.
void SetMasterGain (const ea::string &type, float gain)
void PauseSoundType (const ea::string &type)
 Pause playback of specific sound type. This allows to suspend e.g. sound effects or voice when the game is paused. By default all sound types are unpaused.
void ResumeSoundType (const ea::string &type)
 Resume playback of specific sound type.
void ResumeAll ()
 Resume playback of all sound types.
void SetListener (SoundListener *listener)
void StopSound (Sound *sound)
 Stop any sound source playing a certain sound clip.
unsigned GetSampleSize () const
int GetMixRate () const
unsigned GetBufferLengthMS () const
bool GetInterpolation () const
SpeakerMode GetSpeakerMode () const
bool IsPlaying () const
bool IsInitialized () const
float GetMasterGain (const ea::string &type) const
bool IsSoundTypePaused (const ea::string &type) const
 Return whether specific sound type has been paused.
SoundListenerGetListener () const
const ea::vector< SoundSource * > & GetSoundSources () const
 Return all sound sources.
bool HasMasterGain (const ea::string &type) const
 Return whether the specified master gain has been defined.
void AddSoundSource (SoundSource *soundSource)
 Add a sound source to keep track of. Called by SoundSource.
void RemoveSoundSource (SoundSource *soundSource)
 Remove a sound source. Called by SoundSource.
MutexGetMutex ()
 Return audio thread mutex.
float GetSoundSourceMasterGain (StringHash typeHash) const
 Return sound type specific gain multiplied by master gain.
void MixOutput (void *dest, unsigned samples)
 Mix sound sources into the buffer.
StringVector EnumerateMicrophones () const
 Returns a pretty-name list of all attached microphones.
SharedPtr< MicrophoneCreateMicrophone (const ea::string &name, bool forSpeechRecog, unsigned wantedFreq, unsigned silenceLevelLimit=0)
 Constructs a microphone from a pretty-name (found via EnumerateMicrophones()).
void CloseMicrophoneForLoss (unsigned which)
 Disables a microphone that has been lost.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
virtual const ea::string & GetTypeName () const =0
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
virtual bool IsInstanceOf (StringHash type) const =0
 Check whether current instance implements specified type.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
template<typename T >
const T * Cast () const
 Cast the object to specified most derived class.
void SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T handler)
 Subscribe to a specific sender's event.
void UnsubscribeFromEvent (StringHash eventType)
 Unsubscribe from an event.
void UnsubscribeFromEvent (Object *sender, StringHash eventType)
 Unsubscribe from a specific sender's event.
void UnsubscribeFromEvents (Object *sender)
 Unsubscribe from a specific sender's events.
void UnsubscribeFromAllEvents ()
 Unsubscribe from all events.
void UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
void SendEvent (StringHash eventType)
 Send event to all subscribers.
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void SendEvent (StringHash eventType, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
ContextGetContext () const
 Return execution context.
const VariantGetGlobalVar (StringHash key) const
const VariantMapGetGlobalVars () const
void SetGlobalVar (StringHash key, const Variant &value)
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
EventHandlerGetEventHandler () const
 Return active event handler. Null outside event handling.
bool HasSubscribedToEvent (StringHash eventType) const
 Return whether has subscribed to an event without specific sender.
bool HasSubscribedToEvent (Object *sender, StringHash eventType) const
 Return whether has subscribed to a specific sender's event.
bool HasEventHandlers () const
 Return whether has subscribed to any event.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
const ea::string & GetCategory () const
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
int AddRef ()
int ReleaseRef ()
int Refs () const
int WeakRefs () const
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
bool IsScriptStrongRef () const
 Return true if script reference is strong.

Private Member Functions

 URHO3D_OBJECT (Audio, Object)
void HandleRenderUpdate (StringHash eventType, VariantMap &eventData)
 Handle render update event.
void Release ()
 Stop sound output and release the sound buffer.
void UpdateInternal (float timeStep)
 Actually update sound sources with the specific timestep. Called internally.

Private Attributes

ea::unique_ptr< int[]> clipBuffer_
 Clipping buffer for mixing.
Mutex audioMutex_
 Audio thread mutex.
unsigned deviceID_ {}
 SDL audio device ID.
unsigned sampleSize_ {}
 Sample size.
unsigned fragmentSize_ {}
 Clip buffer size in samples.
unsigned bufferLengthMSec_ {}
 Clip buffer size in milliseconds.
int mixRate_ {}
 Mixing rate.
bool interpolation_ {}
 Mixing interpolation flag.
SpeakerMode speakerMode_ {SpeakerMode::SPK_AUTO}
 Speaker configuration.
bool playing_ {}
 Playing flag.
ea::unordered_map< StringHash, VariantmasterGain_
 Master gain by sound source type.
ea::hash_set< StringHashpausedSoundTypes_
 Paused sound types.
ea::vector< SoundSource * > soundSources_
 Sound sources.
WeakPtr< SoundListenerlistener_
 Sound listener.
ea::vector< WeakPtr< Microphone > > microphones_
 List of microphones being tracked.

Additional Inherited Members

- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
- Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 > TypeHierarchy {}
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.

Detailed Description

Audio subsystem.

Member Function Documentation

◆ GetBufferLengthMS()

unsigned Urho3D::Audio::GetBufferLengthMS ( ) const

Return millseconds of buffer length.

◆ GetInterpolation()

bool Urho3D::Audio::GetInterpolation ( ) const

Return whether output is interpolated.

◆ GetListener()

SoundListener * Urho3D::Audio::GetListener ( ) const

Return active sound listener.

◆ GetMasterGain()

float Urho3D::Audio::GetMasterGain ( const ea::string &  type) const

Return master gain for a specific sound source type. Unknown sound types will return full gain (1).

◆ GetMixRate()

int Urho3D::Audio::GetMixRate ( ) const

Return mixing rate.

◆ GetSampleSize()

unsigned Urho3D::Audio::GetSampleSize ( ) const

Return byte size of one sample.

◆ GetSpeakerMode()

SpeakerMode Urho3D::Audio::GetSpeakerMode ( ) const

Return mode of output.

◆ IsInitialized()

bool Urho3D::Audio::IsInitialized ( ) const

Return whether an audio stream has been reserved.

◆ IsPlaying()

bool Urho3D::Audio::IsPlaying ( ) const

Return whether audio is being output.

◆ SetListener()

void Urho3D::Audio::SetListener ( SoundListener listener)

Set active sound listener for 3D sounds.

◆ SetMasterGain()

void Urho3D::Audio::SetMasterGain ( const ea::string &  type,
float  gain 

Set master gain on a specific sound type such as sound effects, music or voice.

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