Rebel Fork Framework
Urho3D::Sound Class Reference

Sound resource. More...

#include <Urho3D/Audio/Sound.h>

Inheritance diagram for Urho3D::Sound:
Urho3D::ResourceWithMetadata Urho3D::Resource Urho3D::Object Urho3D::RefCounted

Public Member Functions

 Sound (Context *context)
 ~Sound () override
 Destruct and free sound data.
bool BeginLoad (Deserializer &source) override
 Load resource from stream. May be called from a worker thread. Return true if successful.
bool LoadRaw (Deserializer &source)
 Load raw sound data.
bool LoadWav (Deserializer &source)
 Load WAV format sound data.
bool LoadOggVorbis (Deserializer &source)
 Load Ogg Vorbis format sound data. Does not decode at load, but will rather be decoded while playing.
void SetSize (unsigned dataSize)
 Set sound size in bytes. Also resets the sound to be uncompressed and one-shot.
void SetData (const void *data, unsigned dataSize)
 Set uncompressed sound data.
void SetFormat (unsigned frequency, bool sixteenBit, bool stereo)
 Set uncompressed sound data format.
void SetLooped (bool enable)
void SetLoop (unsigned repeatOffset, unsigned endOffset)
 Define loop.
SharedPtr< SoundStreamGetDecoderStream () const
 Return a new instance of a decoder sound stream. Used by compressed sounds.
ea::shared_array< signed char > GetData () const
 Return shared sound data.
signed char * GetStart () const
 Return sound data start.
signed char * GetRepeat () const
 Return loop start.
signed char * GetEnd () const
 Return sound data end.
float GetLength () const
unsigned GetDataSize () const
 Return total sound data size.
unsigned GetSampleSize () const
float GetFrequency () const
unsigned GetIntFrequency () const
 Return default frequency as an integer.
bool IsLooped () const
bool IsSixteenBit () const
bool IsStereo () const
bool IsCompressed () const
void FixInterpolation ()
 Fix interpolation by copying data from loop start to loop end (looped), or adding silence (oneshot). Called internally, does not normally need to be called, unless the sound data is modified manually on the fly.
- Public Member Functions inherited from Urho3D::Resource
 Resource (Context *context)
bool Load (Deserializer &source)
 Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded.
virtual bool EndLoad ()
 Finish resource loading. Always called from the main thread. Return true if successful.
virtual bool Save (Serializer &dest) const
 Save resource. Return true if successful.
bool LoadFile (const FileIdentifier &fileName)
 Load resource from file.
virtual bool SaveFile (const FileIdentifier &fileName) const
 Save resource to file.
void SetName (const ea::string &name)
void SetMemoryUse (unsigned size)
 Set memory use in bytes, possibly approximate.
void ResetUseTimer ()
 Reset last used timer.
void SetAsyncLoadState (AsyncLoadState newState)
 Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.
void SetAbsoluteFileName (const ea::string &fileName)
 Set absolute file name.
const ea::string & GetName () const
StringHash GetNameHash () const
 Return name hash.
unsigned GetMemoryUse () const
unsigned GetUseTimer ()
AsyncLoadState GetAsyncLoadState () const
 Return the asynchronous loading state.
const ea::string & GetAbsoluteFileName () const
 Return absolute file name.
- 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 void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
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 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.

Static Public Member Functions

static void RegisterObject (Context *context)
- Static Public Member Functions inherited from Urho3D::Resource
static ResourceLoadFromCache (Context *context, StringHash type, const ea::string &name)
 Load resource by reference.
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.

Private Member Functions

 URHO3D_OBJECT (Sound, ResourceWithMetadata)
void LoadParameters ()
 Load optional parameters from an XML file.

Private Attributes

ea::shared_array< signed char > data_
 Sound data.
signed char * repeat_
 Loop start.
signed char * end_
 Sound data end.
unsigned dataSize_
 Sound data size in bytes.
unsigned frequency_
 Default frequency.
bool looped_
 Looped flag.
bool sixteenBit_
 Sixteen bit flag.
bool stereo_
 Stereo flag.
bool compressed_
 Compressed flag.
float compressedLength_
 Compressed sound length.

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.

Detailed Description

Sound resource.

Member Function Documentation

◆ GetFrequency()

float Urho3D::Sound::GetFrequency ( ) const

Return default frequency as a float.

◆ GetLength()

float Urho3D::Sound::GetLength ( ) const

Return length in seconds.

◆ GetSampleSize()

unsigned Urho3D::Sound::GetSampleSize ( ) const

Return sample size.

◆ IsCompressed()

bool Urho3D::Sound::IsCompressed ( ) const

Return whether is compressed.

◆ IsLooped()

bool Urho3D::Sound::IsLooped ( ) const

Return whether is looped.

◆ IsSixteenBit()

bool Urho3D::Sound::IsSixteenBit ( ) const

Return whether data is sixteen bit.

◆ IsStereo()

bool Urho3D::Sound::IsStereo ( ) const

Return whether data is stereo.

◆ RegisterObject()

void Urho3D::Sound::RegisterObject ( Context context)

Register object factory.

◆ SetLooped()

void Urho3D::Sound::SetLooped ( bool  enable)

Set loop on/off. If loop is enabled, sets the full sound as loop range.

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