Urho3D::Sound Class Reference

Sound resource. More...

#include <Urho3D/Audio/Sound.h>

Inheritance diagram for Urho3D::Sound:

Collaboration diagram for Urho3D::Sound:

Public Member Functions
	Sound (Context *context)
	Construct.
virtual	~Sound ()
	Destruct and free sound data.
virtual bool	BeginLoad (Deserializer &source)
	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)
	Set loop on/off. If loop is enabled, sets the full sound as loop range.
void	SetLoop (unsigned repeatOffset, unsigned endOffset)
	Define loop.
SharedPtr< SoundStream >	GetDecoderStream () const
	Return a new instance of a decoder sound stream. Used by compressed sounds.
SharedArrayPtr< 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
	Return length in seconds.
unsigned	GetDataSize () const
	Return total sound data size.
unsigned	GetSampleSize () const
	Return sample size.
float	GetFrequency () const
	Return default frequency as a float.
unsigned	GetIntFrequency () const
	Return default frequency as an integer.
bool	IsLooped () const
	Return whether is looped.
bool	IsSixteenBit () const
	Return whether data is sixteen bit.
bool	IsStereo () const
	Return whether data is stereo.
bool	IsCompressed () const
	Return whether is compressed.
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::ResourceWithMetadata
	ResourceWithMetadata (Context *context)
	Construct.
void	AddMetadata (const String &name, const Variant &value)
	Add new metadata variable or overwrite old value.
void	RemoveMetadata (const String &name)
	Remove metadata variable.
void	RemoveAllMetadata ()
	Remove all metadata variables.
const Variant &	GetMetadata (const String &name) const
	Return metadata variable.
bool	HasMetadata () const
	Return whether the resource has metadata.
Public Member Functions inherited from Urho3D::Resource
	Resource (Context *context)
	Construct.
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 String &fileName)
	Load resource from file.
virtual bool	SaveFile (const String &fileName) const
	Save resource to file.
void	SetName (const String &name)
	Set 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.
const String &	GetName () const
	Return name.
StringHash	GetNameHash () const
	Return name hash.
unsigned	GetMemoryUse () const
	Return memory use in bytes, possibly approximate.
unsigned	GetUseTimer ()
	Return time since last use in milliseconds. If referred to elsewhere than in the resource cache, returns always zero.
AsyncLoadState	GetAsyncLoadState () const
	Return the asynchronous loading state.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
	Return type hash.
virtual const String &	GetTypeName () const =0
	Return type name.
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.
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	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 PODVector< 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.
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.
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.
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.

Static Public Member Functions
static void	RegisterObject (Context *context)
	Register object factory.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

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

Private Attributes
SharedArrayPtr< 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 Member Functions inherited from Urho3D::ResourceWithMetadata
void	LoadMetadataFromXML (const XMLElement &source)
	Load metadata from <metadata> children of XML element.
void	LoadMetadataFromJSON (const JSONArray &array)
	Load metadata from JSON array.
void	SaveMetadataToXML (XMLElement &destination) const
	Save as <metadata> children of XML element.
void	CopyMetadata (const ResourceWithMetadata &source)
	Copy metadata from another resource.
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

Sound resource.

---

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

• Source/Urho3D/Audio/Sound.h
• Source/Urho3D/Audio/Sound.cpp