Audio subsystem. More...
#include </home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Audio/Audio.h>
Inheritance diagram for Urho3D::Audio:
Public Member Functions | |
| Audio (Context *context) | |
| Construct. | |
| ~Audio () override | |
| Destruct. Terminate the audio thread and free the audio buffer. | |
| bool | SetMode (i32 bufferLengthMSec, i32 mixRate, bool stereo, bool interpolation=true) |
| Initialize sound output with specified buffer length and output mode. | |
| 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 String &type, float gain) |
| Set master gain on a specific sound type such as sound effects, music or voice. | |
| void | PauseSoundType (const 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 String &type) |
| Resume playback of specific sound type. | |
| void | ResumeAll () |
| Resume playback of all sound types. | |
| void | SetListener (SoundListener *listener) |
| Set active sound listener for 3D sounds. | |
| void | StopSound (Sound *sound) |
| Stop any sound source playing a certain sound clip. | |
| u32 | GetSampleSize () const |
| Return byte size of one sample. | |
| i32 | GetMixRate () const |
| Return mixing rate. | |
| bool | GetInterpolation () const |
| Return whether output is interpolated. | |
| bool | IsStereo () const |
| Return whether output is stereo. | |
| bool | IsPlaying () const |
| Return whether audio is being output. | |
| bool | IsInitialized () const |
| Return whether an audio stream has been reserved. | |
| float | GetMasterGain (const String &type) const |
| Return master gain for a specific sound source type. Unknown sound types will return full gain (1). | |
| bool | IsSoundTypePaused (const String &type) const |
| Return whether specific sound type has been paused. | |
| SoundListener * | GetListener () const |
| Return active sound listener. | |
| const Vector< SoundSource * > & | GetSoundSources () const |
| Return all sound sources. | |
| bool | HasMasterGain (const 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. | |
| Mutex & | GetMutex () |
| Return audio thread mutex. | |
| float | GetSoundSourceMasterGain (StringHash typeHash) const |
| Return sound type specific gain multiplied by master gain. | |
| void | MixOutput (void *dest, u32 samples) |
| Mix sound sources into the buffer. | |
 Public Member Functions inherited from Urho3D::Object | |
| Object (Context *context) | |
| Construct. | |
| ~Object () override | |
| Destruct. Clean up self from event sender & receiver structures. | |
| virtual StringHash | GetType () const =0 |
| Return type hash. More... | |
| virtual const String & | GetTypeName () const =0 |
| Return type name. More... | |
| virtual const TypeInfo * | GetTypeInfo () const =0 |
| Return type info. | |
| virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event. | |
| bool | IsInstanceOf (StringHash type) const |
| Check current instance is type of specified type. | |
| bool | IsInstanceOf (const TypeInfo *typeInfo) const |
| Check current instance is type of specified type. | |
| 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 | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event. | |
| void | SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| 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 Vector< StringHash > &exceptions, bool onlyUserData) |
| Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events). | |
| void | SendEvent (StringHash eventType) |
| Send event to all subscribers. | |
| void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers. | |
| VariantMap & | GetEventDataMap () 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, Args... args) |
| Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another. | |
| Context * | GetContext () const |
| Return execution context. | |
| const Variant & | GetGlobalVar (StringHash key) const |
| Return global variable based on key. | |
| const VariantMap & | GetGlobalVars () const |
| Return all global variables. | |
| void | SetGlobalVar (StringHash key, const Variant &value) |
| Set global variable with the respective key and value. | |
| Object * | GetSubsystem (StringHash type) const |
| Return subsystem by type. | |
| Object * | GetEventSender () const |
| Return active event sender. Null outside event handling. | |
| EventHandler * | GetEventHandler () 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 String & | GetCategory () const |
| Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. | |
| 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. | |
| RefCounted & | operator= (const RefCounted &rhs)=delete |
| Prevent assignment. | |
| void | AddRef () |
| Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. | |
| void | ReleaseRef () |
| Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. | |
| int | Refs () const |
| Return reference count. | |
| int | WeakRefs () const |
| Return weak reference count. | |
| RefCount * | RefCountPtr () |
| Return pointer to the reference count structure. | |
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 | |
| SharedArrayPtr< i32 > | clipBuffer_ |
| Clipping buffer for mixing. | |
| Mutex | audioMutex_ |
| Audio thread mutex. | |
| u32 | deviceID_ {} |
| SDL audio device ID. | |
| u32 | sampleSize_ {} |
| Sample size. | |
| u32 | fragmentSize_ {} |
| Clip buffer size in samples. | |
| i32 | mixRate_ {} |
| Mixing rate. | |
| bool | interpolation_ {} |
| Mixing interpolation flag. | |
| bool | stereo_ {} |
| Stereo flag. | |
| bool | playing_ {} |
| Playing flag. | |
| HashMap< StringHash, Variant > | masterGain_ |
| Master gain by sound source type. | |
| HashSet< StringHash > | pausedSoundTypes_ |
| Paused sound types. | |
| Vector< SoundSource * > | soundSources_ |
| Sound sources. | |
| WeakPtr< SoundListener > | listener_ |
| Sound listener. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Urho3D::Object | |
| static const TypeInfo * | GetTypeInfoStatic () |
| Return type info static. | |
| Protected Attributes inherited from Urho3D::Object | |
| Context * | context_ |
| Execution context. | |
Detailed Description
Audio subsystem.
The documentation for this class was generated from the following files:
- /home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Audio/Audio.h
- /home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Audio/Audio.cpp
