Urho3D::SoundSource Class Reference

Sound source component with stereo position. A sound source needs to be created to a node to be considered "enabled" and be able to play, however that node does not need to belong to a scene. More...

#include <Urho3D/Audio/SoundSource.h>

Inheritance diagram for Urho3D::SoundSource:

Collaboration diagram for Urho3D::SoundSource:

Public Member Functions
	SoundSource (Context *context)
	Construct.
virtual	~SoundSource ()
	Destruct. Remove self from the audio subsystem.
void	Play (Sound *sound)
	Play a sound.
void	Play (Sound *sound, float frequency)
	Play a sound with specified frequency.
void	Play (Sound *sound, float frequency, float gain)
	Play a sound with specified frequency and gain.
void	Play (Sound *sound, float frequency, float gain, float panning)
	Play a sound with specified frequency, gain and panning.
void	Play (SoundStream *stream)
	Start playing a sound stream.
void	Stop ()
	Stop playback.
void	SetSoundType (const String &type)
	Set sound type, determines the master gain group.
void	SetFrequency (float frequency)
	Set frequency.
void	SetGain (float gain)
	Set gain. 0.0 is silence, 1.0 is full volume.
void	SetAttenuation (float attenuation)
	Set attenuation. 1.0 is unaltered. Used for distance attenuated playback.
void	SetPanning (float panning)
	Set stereo panning. -1.0 is full left and 1.0 is full right.
URHO3D_DEPRECATED void	SetAutoRemove (bool enable)
void	SetPlayPosition (signed char *pos)
	Set new playback position.
Sound *	GetSound () const
	Return sound.
volatile signed char *	GetPlayPosition () const
	Return playback position.
String	GetSoundType () const
	Return sound type, determines the master gain group.
float	GetTimePosition () const
	Return playback time position.
float	GetFrequency () const
	Return frequency.
float	GetGain () const
	Return gain.
float	GetAttenuation () const
	Return attenuation.
float	GetPanning () const
	Return stereo panning.
URHO3D_DEPRECATED bool	GetAutoRemove () const
bool	IsPlaying () const
	Return whether is playing.
virtual void	Update (float timeStep)
	Update the sound source. Perform subclass specific operations. Called by Audio.
void	Mix (int *dest, unsigned samples, int mixRate, bool stereo, bool interpolation)
	Mix sound source output to a 32-bit clipping buffer. Called by Audio.
void	UpdateMasterGain ()
	Update the effective master gain. Called internally and by Audio when the master gain changes.
void	SetSoundAttr (const ResourceRef &value)
	Set sound attribute.
void	SetPositionAttr (int value)
	Set sound position attribute.
ResourceRef	GetSoundAttr () const
	Return sound attribute.
void	SetPlayingAttr (bool value)
	Set sound playing attribute.
int	GetPositionAttr () const
	Return sound position attribute.
Public Member Functions inherited from Urho3D::Component
	Component (Context *context)
	Construct.
virtual	~Component ()
	Destruct.
virtual void	OnSetEnabled ()
	Handle enabled/disabled state change.
virtual bool	Save (Serializer &dest) const
	Save as binary data. Return true if successful.
virtual bool	SaveXML (XMLElement &dest) const
	Save as XML data. Return true if successful.
virtual bool	SaveJSON (JSONValue &dest) const
	Save as JSON data. Return true if successful.
virtual void	MarkNetworkUpdate ()
	Mark for attribute check on the next network update.
virtual void	GetDependencyNodes (PODVector< Node * > &dest)
	Return the depended on nodes to order network updates.
virtual void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
	Visualize the component as debug geometry.
void	SetEnabled (bool enable)
	Set enabled/disabled state.
void	Remove ()
	Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned	GetID () const
	Return ID.
Node *	GetNode () const
	Return scene node.
Scene *	GetScene () const
	Return the scene the node belongs to.
bool	IsEnabled () const
	Return whether is enabled.
bool	IsEnabledEffective () const
	Return whether is effectively enabled (node is also enabled.)
Component *	GetComponent (StringHash type) const
	Return component in the same scene node by type. If there are several, returns the first.
void	GetComponents (PODVector< Component * > &dest, StringHash type) const
	Return components in the same scene node by type.
template<class T >
T *	GetComponent () const
	Template version of returning a component in the same scene node by type.
template<class T >
void	GetComponents (PODVector< T * > &dest) const
	Template version of returning components in the same scene node by type.
void	AddReplicationState (ComponentReplicationState *state)
	Add a replication state that is tracking this component.
void	PrepareNetworkUpdate ()
	Prepare network update by comparing attributes and marking replication states dirty as necessary.
void	CleanupConnection (Connection *connection)
	Clean up all references to a network connection that is about to be removed.
Public Member Functions inherited from Urho3D::Animatable
	Animatable (Context *context)
	Construct.
virtual	~Animatable ()
	Destruct.
virtual bool	LoadXML (const XMLElement &source, bool setInstanceDefault=false)
	Load from XML data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
virtual bool	LoadJSON (const JSONValue &source, bool setInstanceDefault=false)
	Load from JSON data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
void	SetAnimationEnabled (bool enable)
	Set automatic update of animation, default true.
void	SetAnimationTime (float time)
	Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case.
void	SetObjectAnimation (ObjectAnimation *objectAnimation)
	Set object animation.
void	SetAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f)
	Set attribute animation.
void	SetAttributeAnimationWrapMode (const String &name, WrapMode wrapMode)
	Set attribute animation wrap mode.
void	SetAttributeAnimationSpeed (const String &name, float speed)
	Set attribute animation speed.
void	SetAttributeAnimationTime (const String &name, float time)
	Set attribute animation time position manually. Automatic update should be disabled in this case.
void	RemoveObjectAnimation ()
	Remove object animation. Same as calling SetObjectAnimation with a null pointer.
void	RemoveAttributeAnimation (const String &name)
	Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer.
bool	GetAnimationEnabled () const
	Return animation enabled.
ObjectAnimation *	GetObjectAnimation () const
	Return object animation.
ValueAnimation *	GetAttributeAnimation (const String &name) const
	Return attribute animation.
WrapMode	GetAttributeAnimationWrapMode (const String &name) const
	Return attribute animation wrap mode.
float	GetAttributeAnimationSpeed (const String &name) const
	Return attribute animation speed.
float	GetAttributeAnimationTime (const String &name) const
	Return attribute animation time position.
void	SetObjectAnimationAttr (const ResourceRef &value)
	Set object animation attribute.
ResourceRef	GetObjectAnimationAttr () const
	Return object animation attribute.
Public Member Functions inherited from Urho3D::Serializable
	Serializable (Context *context)
	Construct.
virtual	~Serializable ()
	Destruct.
virtual void	OnSetAttribute (const AttributeInfo &attr, const Variant &src)
	Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
virtual void	OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
	Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
virtual const Vector < AttributeInfo > *	GetAttributes () const
	Return attribute descriptions, or null if none defined.
virtual const Vector < AttributeInfo > *	GetNetworkAttributes () const
	Return network replication attribute descriptions, or null if none defined.
virtual bool	Load (Deserializer &source, bool setInstanceDefault=false)
	Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
virtual void	ApplyAttributes ()
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
virtual bool	SaveDefaultAttributes () const
	Return whether should save default-valued attributes into XML. Default false.
bool	SetAttribute (unsigned index, const Variant &value)
	Set attribute by index. Return true if successfully set.
bool	SetAttribute (const String &name, const Variant &value)
	Set attribute by name. Return true if successfully set.
void	ResetToDefault ()
	Reset all editable attributes to their default values.
void	RemoveInstanceDefault ()
	Remove instance's default values if they are set previously.
void	SetTemporary (bool enable)
	Set temporary flag. Temporary objects will not be saved.
void	SetInterceptNetworkUpdate (const String &attributeName, bool enable)
	Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction.
void	AllocateNetworkState ()
	Allocate network attribute state.
void	WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp)
	Write initial delta network update.
void	WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp)
	Write a delta network update according to dirty attribute bits.
void	WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp)
	Write a latest data network update.
bool	ReadDeltaUpdate (Deserializer &source)
	Read and apply a network delta update. Return true if attributes were changed.
bool	ReadLatestDataUpdate (Deserializer &source)
	Read and apply a network latest data update. Return true if attributes were changed.
Variant	GetAttribute (unsigned index) const
	Return attribute value by index. Return empty if illegal index.
Variant	GetAttribute (const String &name) const
	Return attribute value by name. Return empty if not found.
Variant	GetAttributeDefault (unsigned index) const
	Return attribute default value by index. Return empty if illegal index.
Variant	GetAttributeDefault (const String &name) const
	Return attribute default value by name. Return empty if not found.
unsigned	GetNumAttributes () const
	Return number of attributes.
unsigned	GetNumNetworkAttributes () const
	Return number of network replication attributes.
bool	IsTemporary () const
	Return whether is temporary.
bool	GetInterceptNetworkUpdate (const String &attributeName) const
	Return whether an attribute's network updates are being intercepted.
NetworkState *	GetNetworkState () const
	Return the network attribute state, if allocated.
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. More...
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.

Protected Attributes
WeakPtr< Audio >	audio_
	Audio subsystem.
String	soundType_
	SoundSource type, determines the master gain group.
StringHash	soundTypeHash_
	SoundSource type hash.
float	frequency_
	Frequency.
float	gain_
	Gain.
float	attenuation_
	Attenuation.
float	panning_
	Stereo panning.
float	autoRemoveTimer_
	Autoremove timer.
float	masterGain_
	Effective master gain.
bool	autoRemove_
	Autoremove flag.
bool	sendFinishedEvent_
	Whether finished event should be sent on playback stop.
Protected Attributes inherited from Urho3D::Component
Node *	node_
	Scene node.
unsigned	id_
	Unique ID within the scene.
bool	networkUpdate_
	Network update queued flag.
bool	enabled_
	Enabled flag.
Protected Attributes inherited from Urho3D::Animatable
bool	animationEnabled_
	Animation enabled.
SharedPtr< ObjectAnimation >	objectAnimation_
	Animation.
HashSet< const AttributeInfo * >	animatedNetworkAttributes_
	Animated network attribute set.
HashMap< String, SharedPtr < AttributeAnimationInfo > >	attributeAnimationInfos_
	Attribute animation infos.
Protected Attributes inherited from Urho3D::Serializable
NetworkState *	networkState_
	Network attribute state.
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Private Member Functions
	URHO3D_OBJECT (SoundSource, Component)
void	PlayLockless (Sound *sound)
	Play a sound without locking the audio mutex. Called internally.
void	PlayLockless (SharedPtr< SoundStream > stream)
	Play a sound stream without locking the audio mutex. Called internally.
void	StopLockless ()
	Stop sound without locking the audio mutex. Called internally.
void	SetPlayPositionLockless (signed char *position)
	Set new playback position without locking the audio mutex. Called internally.
void	MixMonoToMono (Sound *sound, int *dest, unsigned samples, int mixRate)
	Mix mono sample to mono buffer.
void	MixMonoToStereo (Sound *sound, int *dest, unsigned samples, int mixRate)
	Mix mono sample to stereo buffer.
void	MixMonoToMonoIP (Sound *sound, int *dest, unsigned samples, int mixRate)
	Mix mono sample to mono buffer interpolated.
void	MixMonoToStereoIP (Sound *sound, int *dest, unsigned samples, int mixRate)
	Mix mono sample to stereo buffer interpolated.
void	MixStereoToMono (Sound *sound, int *dest, unsigned samples, int mixRate)
	Mix stereo sample to mono buffer.
void	MixStereoToStereo (Sound *sound, int *dest, unsigned samples, int mixRate)
	Mix stereo sample to stereo buffer.
void	MixStereoToMonoIP (Sound *sound, int *dest, unsigned samples, int mixRate)
	Mix stereo sample to mono buffer interpolated.
void	MixStereoToStereoIP (Sound *sound, int *dest, unsigned samples, int mixRate)
	Mix stereo sample to stereo buffer interpolated.
void	MixZeroVolume (Sound *sound, unsigned samples, int mixRate)
	Advance playback pointer without producing audible output.
void	MixNull (float timeStep)
	Advance playback pointer to simulate audio playback in headless mode.

Private Attributes
SharedPtr< Sound >	sound_
	Sound that is being played.
SharedPtr< SoundStream >	soundStream_
	Sound stream that is being played.
volatile signed char *	position_
	Playback position.
volatile int	fractPosition_
	Playback fractional position.
volatile float	timePosition_
	Playback time position.
SharedPtr< Sound >	streamBuffer_
	Decode buffer.
int	unusedStreamSize_
	Unused stream bytes from previous frame.

Additional Inherited Members
Protected Member Functions inherited from Urho3D::Component
virtual void	OnAttributeAnimationAdded ()
	Handle attribute animation added.
virtual void	OnAttributeAnimationRemoved ()
	Handle attribute animation removed.
virtual void	OnNodeSet (Node *node)
	Handle scene node being assigned at creation.
virtual void	OnSceneSet (Scene *scene)
	Handle scene being assigned. This may happen several times during the component's lifetime. Scene-wide subsystems and events are subscribed to here.
virtual void	OnMarkedDirty (Node *node)
	Handle scene node transform dirtied.
virtual void	OnNodeSetEnabled (Node *node)
	Handle scene node enabled status changing.
void	SetID (unsigned id)
	Set ID. Called by Scene.
void	SetNode (Node *node)
	Set scene node. Called by Node when creating the component.
void	HandleAttributeAnimationUpdate (StringHash eventType, VariantMap &eventData)
	Handle scene attribute animation update event.
Component *	GetFixedUpdateSource ()
	Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.

Detailed Description

Sound source component with stereo position. A sound source needs to be created to a node to be considered "enabled" and be able to play, however that node does not need to belong to a scene.

Member Function Documentation

URHO3D_DEPRECATED bool Urho3D::SoundSource::GetAutoRemove ( ) const

inline

Deprecated:

Return autoremove mode.

void Urho3D::SoundSource::SetAutoRemove

(

bool

enable

)

Deprecated:

Set whether sound source will be automatically removed from the scene node when playback stops. Note: this is deprecated, consider subscribing to the SoundFinished event instead.

---

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

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