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:

Public Member Functions
	SoundSource (Context *context)
	Construct.

	~SoundSource () override
	Destruct. Remove self from the audio subsystem.

void	Seek (float seekTime)
	Seek to time.

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 ea::string &type)

void	SetFrequency (float frequency)

void	SetGain (float gain)

void	SetAttenuation (float attenuation)
	Set attenuation. 1.0 is unaltered. Used for distance attenuated playback.

void	SetPanning (float panning)

void	SetReach (float reach)

void	SetLowFrequency (bool state)

void	SetAutoRemoveMode (AutoRemoveMode mode)

void	SetPlayPosition (signed char *pos)
	Set new playback position.

void	SetIgnoreSceneTimeScale (bool ignoreSceneTimeScale)
	Enable or disable ignore scene time scale mode.

Sound *	GetSound () const

volatile signed char *	GetPlayPosition () const
	Return playback position.

ea::string	GetSoundType () const

float	GetTimePosition () const

float	GetFrequency () const

float	GetGain () const

float	GetAttenuation () const

float	GetPanning () const

float	GetReach () const

bool	IsLowFrequency () const

AutoRemoveMode	GetAutoRemoveMode () const

bool	GetIgnoreSceneTimeScale () const
	Return true if sound source ignores scene time scale.

bool	IsPlaying () const

virtual void	Update (float timeStep)
	Update the sound source. Perform subclass specific operations. Called by Audio.

void	Mix (int dest[], unsigned samples, int mixRate, SpeakerMode mode, 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.

	~Component () override
	Destruct.

virtual void	OnSetEnabled ()
	Handle enabled/disabled state change.

AttributeScopeHint	GetEffectiveScopeHint () const

bool	Save (Serializer &dest) const override
	Save as binary data. Return true if successful.

bool	SaveXML (XMLElement &dest) const override
	Save as XML data. Return true if successful.

bool	SaveJSON (JSONValue &dest) const override
	Save as JSON data. Return true if successful.

virtual void	GetDependencyNodes (ea::vector< Node * > &dest)
	Return the depended on nodes to order network updates.

virtual void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
	Visualize the component as debug geometry.

virtual bool	HasAuxiliaryData () const

virtual void	SerializeAuxiliaryData (Archive &archive)
	Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException.

void	SetEnabled (bool enable)

void	Remove ()
	Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.

unsigned	GetID () const

Node *	GetNode () const

Scene *	GetScene () const
	Return the scene the node belongs to.

bool	IsEnabled () const

bool	IsEnabledEffective () const

ea::string	GetFullNameDebug () const
	Return full component name for debugging. Unique for each component in the scene. Slow!

Component *	GetComponent (StringHash type) const
	Return component in the same scene node by type. If there are several, returns the first.

template<class T >
T *	GetComponent () const
	Template version of returning a component in the same scene node by type.

unsigned	GetIndexInParent () const
	Return index of this component in the node.

Public Member Functions inherited from Urho3D::Serializable
	Serializable (Context *context)
	Construct.

	~Serializable () override
	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 ObjectReflection *	GetReflection () const
	Return reflection used for serialization.

virtual const ea::vector< AttributeInfo > *	GetAttributes () const
	Return attribute descriptions, or null if none defined.

void	SerializeInBlock (Archive &archive) override
	Serialize content from/to archive. May throw ArchiveException.

void	SerializeInBlock (Archive &archive, bool serializeTemporary)

virtual bool	Load (Deserializer &source)
	Load from binary data. Return true if successful.

virtual bool	LoadXML (const XMLElement &source)
	Load from XML data. Return true if successful.

virtual bool	LoadJSON (const JSONValue &source)
	Load from JSON data. Return true if successful.

virtual bool	Load (const ea::string &resourceName)
	Load from binary resource.

virtual bool	LoadXML (const ea::string &resourceName)
	Load from XML resource.

virtual bool	LoadJSON (const ea::string &resourceName)
	Load from JSON resource.

virtual bool	LoadFile (const ea::string &resourceName)
	Load from resource of automatically detected type.

virtual void	ApplyAttributes ()
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.

virtual bool	SaveDefaultAttributes (const AttributeInfo &attr) const
	Return whether should save default-valued attributes into XML. Default false.

bool	SetAttribute (unsigned index, const Variant &value)

bool	SetAttribute (const ea::string &name, const Variant &value)
	Set attribute by name. Return true if successfully set.

void	SetInstanceDefault (bool enable)
	(Internal use) Set instance-level default flag.

void	SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
	(Internal use) Set instance-level default value. Allocate the internal data structure as necessary.

virtual Variant	GetInstanceDefault (const ea::string &name) const
	(Internal use) Get instance-level default value.

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)

Variant	GetAttribute (unsigned index) const

Variant	GetAttribute (const ea::string &name) const
	Return attribute value by name. Return empty if not found.

Variant	GetAttributeDefault (unsigned index) const

Variant	GetAttributeDefault (const ea::string &name) const
	Return attribute default value by name. Return empty if not found.

unsigned	GetNumAttributes () const

void	CopyAttributes (const Serializable *source, bool resetToDefault=true)
	Copy all attributes from another serializable.

SharedPtr< Serializable >	Clone (bool resetToDefault=true) const
	Clone this serializable.

bool	IsTemporary () const

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

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () 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.

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.

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, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &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 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.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () 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::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Protected Attributes
WeakPtr< Audio >	audio_
	Audio subsystem.

ea::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	reach_ {0.0f}
	Surround sound forward/back reach.

float	masterGain_ {}
	Effective master gain.

bool	sendFinishedEvent_
	Whether finished event should be sent on playback stop.

bool	lowFrequency_ { false }
	Whether this source should output to the LFE.

AutoRemoveMode	autoRemove_
	Automatic removal mode.

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::Serializable
ea::unique_ptr< VariantMap >	instanceDefaultValues_
	Attribute default value at each instance level.

bool	setInstanceDefault_
	When true, store the attribute value as instance's default value (internal use only).

bool	temporary_
	Temporary flag.

Protected Attributes inherited from Urho3D::Object
WeakPtr< 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 (const 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 *pos)
	Set new playback position without locking the audio mutex. Called internally.

void	MixMonoToMono (Sound *sound, int dest[], unsigned samples, int mixRate, float effectiveFrequency, int channel=0, int channelCount=1)
	Mix mono sample to mono buffer.

void	MixMonoToStereo (Sound *sound, int dest[], unsigned samples, int mixRate, float effectiveFrequency)
	Mix mono sample to stereo buffer.

void	MixMonoToMonoIP (Sound *sound, int dest[], unsigned samples, int mixRate, float effectiveFrequency, int channel=0, int channelCount=1)
	Mix mono sample to mono buffer interpolated.

void	MixMonoToStereoIP (Sound *sound, int dest[], unsigned samples, int mixRate, float effectiveFrequency)
	Mix mono sample to stereo buffer interpolated.

void	MixStereoToMono (Sound *sound, int dest[], unsigned samples, int mixRate, float effectiveFrequency)
	Mix stereo sample to mono buffer.

void	MixStereoToStereo (Sound *sound, int dest[], unsigned samples, int mixRate, float effectiveFrequency)
	Mix stereo sample to stereo buffer.

void	MixStereoToMonoIP (Sound *sound, int dest[], unsigned samples, int mixRate, float effectiveFrequency)
	Mix stereo sample to mono buffer interpolated.

void	MixStereoToStereoIP (Sound *sound, int dest[], unsigned samples, int mixRate, float effectiveFrequency)
	Mix stereo sample to stereo buffer interpolated.

void	MixMonoToSurround (Sound sound, int dest, unsigned samples, int mixRate, float effectiveFrequency, SpeakerMode speakers)
	Mix a mono track to surround buffer.

void	MixMonoToSurroundIP (Sound sound, int dest, unsigned samples, int mixRate, float effectiveFrequency, SpeakerMode speakers)
	Mix a mono track into a surround buffer.

void	MixStereoToMulti (Sound sound, int dest, unsigned samples, int mixRate, float effectiveFrequency, SpeakerMode speakers)
	Mix stereo sample into multichannel. Front-center and LFE are ommitted.

void	MixStereoToMultiIP (Sound sound, int dest, unsigned samples, int mixRate, float effectiveFrequency, SpeakerMode speakers)
	Mix stereo sample into multichannel. Front-center and LFE are ommitted.

void	MixZeroVolume (Sound *sound, unsigned samples, int mixRate, float effectiveFrequency)
	Advance playback pointer without producing audible output.

void	MixNull (float timeStep, float effectiveFrequency)
	Advance playback pointer to simulate audio playback in headless mode.

float	GetEffectiveTimeScale () const
	Get effective time scale or 0.0 if scene is not set or paused.

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.

bool	ignoreSceneTimeScale_ {false}
	Ignore scene time scale and play sound even if scene is paused.

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Protected Member Functions inherited from Urho3D::Component
virtual void	OnNodeSet (Node previousNode, Node currentNode)
	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)

void	SetNode (Node *node)
	Set scene node. Called by Node when creating the component.

Component *	GetFixedUpdateSource ()
	Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.

void	DoAutoRemove (AutoRemoveMode mode)
	Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.

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

◆ GetAttenuation()

float Urho3D::SoundSource::GetAttenuation ( ) const

inline

Return attenuation.

◆ GetAutoRemoveMode()

AutoRemoveMode Urho3D::SoundSource::GetAutoRemoveMode ( ) const

inline

Return automatic removal mode on sound playback completion.

◆ GetFrequency()

float Urho3D::SoundSource::GetFrequency ( ) const

inline

Return frequency.

◆ GetGain()

float Urho3D::SoundSource::GetGain ( ) const

inline

Return gain.

◆ GetPanning()

float Urho3D::SoundSource::GetPanning ( ) const

inline

Return stereo panning.

◆ GetReach()

float Urho3D::SoundSource::GetReach ( ) const

inline

Return surround sound forward/back reach.

◆ GetSound()

Sound* Urho3D::SoundSource::GetSound ( ) const

inline

Return sound.

◆ GetSoundType()

ea::string Urho3D::SoundSource::GetSoundType ( ) const

inline

Return sound type, determines the master gain group.

◆ GetTimePosition()

float Urho3D::SoundSource::GetTimePosition ( ) const

inline

Return playback time position.

◆ IsLowFrequency()

bool Urho3D::SoundSource::IsLowFrequency ( ) const

inline

Return whether this is a LFE output.

◆ IsPlaying()

bool Urho3D::SoundSource::IsPlaying ( ) const

Return whether is playing.

◆ RegisterObject()

void Urho3D::SoundSource::RegisterObject ( Context * context )

static

Register object factory.

◆ SetAutoRemoveMode()

void Urho3D::SoundSource::SetAutoRemoveMode ( AutoRemoveMode mode )

Set to remove either the sound source component or its owner node from the scene automatically on sound playback completion. Disabled by default.

◆ SetFrequency()

void Urho3D::SoundSource::SetFrequency ( float frequency )

Set frequency.

◆ SetGain()

void Urho3D::SoundSource::SetGain ( float gain )

Set gain. 0.0 is silence, 1.0 is full volume.

◆ SetLowFrequency()

void Urho3D::SoundSource::SetLowFrequency ( bool state )

Set whether this is a LFE output.

◆ SetPanning()

void Urho3D::SoundSource::SetPanning ( float panning )

Set stereo panning. -1.0 is full left and 1.0 is full right.

◆ SetReach()

void Urho3D::SoundSource::SetReach ( float reach )

Set surround sound forward/back reach. -1.0 is full back and 1.0 is full front.

◆ SetSoundType()

void Urho3D::SoundSource::SetSoundType ( const ea::string & type )

Set sound type, determines the master gain group.

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

Urho3D/Audio/SoundSource.h
Urho3D/Audio/SoundSource.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetAttenuation()

◆ GetAutoRemoveMode()

◆ GetFrequency()

◆ GetGain()

◆ GetPanning()

◆ GetReach()

◆ GetSound()

◆ GetSoundType()

◆ GetTimePosition()

◆ IsLowFrequency()

◆ IsPlaying()

◆ RegisterObject()

◆ SetAutoRemoveMode()

◆ SetFrequency()

◆ SetGain()

◆ SetLowFrequency()

◆ SetPanning()

◆ SetReach()

◆ SetSoundType()