Documentation
Public Member Functions |
Static Public Member Functions |
Protected Attributes |
Private Member Functions |
Private Attributes |
List of all members
Urho3D::SoundSource Class Reference
Sound source component with stereo position. More...
#include <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. | |
void | SetAutoRemove (bool enable) |
Set whether sound source will be automatically removed from the scene node when playback stops. | |
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. | |
bool | GetAutoRemove () const |
Return autoremove mode. | |
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. | |
![]() | |
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 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. | |
![]() | |
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. | |
void | SetAnimationEnabled (bool enable) |
Set animation enabled. | |
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. | |
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. | |
void | SetObjectAnimationAttr (const ResourceRef &value) |
Set object animation attribute. | |
ResourceRef | GetObjectAnimationAttr () const |
Return object animation attribute. | |
![]() | |
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. | |
![]() | |
Object (Context *context) | |
Construct. | |
virtual | ~Object () |
Destruct. Clean up self from event sender & receiver structures. | |
virtual Urho3D::StringHash | GetType () const =0 |
Return type hash. | |
virtual Urho3D::StringHash | GetBaseType () const =0 |
Return base class type hash. | |
virtual const Urho3D::String & | GetTypeName () const =0 |
Return type name. | |
virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
Handle event. | |
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. | |
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. | |
![]() | |
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. | |
![]() | |
Node * | node_ |
Scene node. | |
unsigned | id_ |
Unique ID within the scene. | |
bool | networkUpdate_ |
Network update queued flag. | |
bool | enabled_ |
Enabled flag. | |
![]() | |
bool | animationEnabled_ |
Animation enabled. | |
SharedPtr< ObjectAnimation > | objectAnimation_ |
Animation. | |
HashSet< const AttributeInfo * > | animatedNetworkAttributes_ |
Animated network attribute set. | |
HashMap< String, SharedPtr < AttributeAnimationInfo > > | attributeAnimationInfos_ |
Attribute animation infos. | |
![]() | |
NetworkState * | networkState_ |
Network attribute state. | |
![]() | |
Context * | context_ |
Execution context. | |
Private Member Functions | |
OBJECT (SoundSource) | |
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 | |
![]() | |
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 | 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. | |
Detailed Description
Sound source component with stereo position.
The documentation for this class was generated from the following files:
- /home/travis/build/urho3d/Urho3D/Source/Urho3D/Audio/SoundSource.h
- /home/travis/build/urho3d/Urho3D/Source/Urho3D/Audio/SoundSource.cpp