 |
Paradox Game Engine
v1.0.0 beta06
|
|
Paradox Game Engine
v1.0.0 beta06
|
Represents a 3D audio emitter in the audio scene. This object, used in combination with an AudioListener, can simulate 3D audio localization effects for a given sound implementing the IPositionableSound interface. For more details take a look at the IPositionableSound.Apply3D function. More...
Public Member Functions | |
| AudioEmitter () | |
| Create a new instance of AudioEmitter. More... | |
Properties | |
| Vector3 | Position [get, set] |
| The position of the emitter in the 3D world. More... | |
| Vector3 | Velocity [get, set] |
| The velocity of the emitter in the 3D world. More... | |
| float | DopplerScale [get, set] |
| The scalar applied to the level of Doppler effect calculated between this and the listener More... | |
| float | DistanceScale [get, set] |
| Distance scale used to calculate the signal attenuation with the listener More... | |
Represents a 3D audio emitter in the audio scene. This object, used in combination with an AudioListener, can simulate 3D audio localization effects for a given sound implementing the IPositionableSound interface. For more details take a look at the IPositionableSound.Apply3D function.
Definition at line 17 of file AudioEmitter.cs.
| SiliconStudio.Paradox.Audio.AudioEmitter.AudioEmitter | ( | ) |
Create a new instance of AudioEmitter.
Definition at line 93 of file AudioEmitter.cs.
|
getset |
Distance scale used to calculate the signal attenuation with the listener
By default, this value is 1.0. This value represent the distance unit and determines how quicly the signal attenuates between this object and the AudioListener. Values below 1.0 exaggerate the attenuation to make it more apparent. Values above 1.0 scale down the attenuation. A value of 1.0 leaves the default attenuation unchanged. Note that this value modifies only the calculated attenuation between this object and a AudioListener. The calculated attenuation is a product of the relationship between AudioEmitter.Position and AudioListener.Position. If the calculation yields a result of no attenuation effect, this value has no effect.
| ArgumentOutOfRangeException | The distance scale of an audio emitter must be greater than zero. |
Definition at line 74 of file AudioEmitter.cs.
|
getset |
The scalar applied to the level of Doppler effect calculated between this and the listener
By default, this value is 1.0. This value determines how much to modify the calculated Doppler effect between this object and a AudioListener. Values below 1.0 scale down the Doppler effect to make it less apparent. Values above 1.0 exaggerate the Doppler effect. A value of 1.0 leaves the effect unmodified. Note that this value modifies only the calculated Doppler between this object and a AudioListener. The calculated Doppler is a product of the relationship between AudioEmitter.Velocity and AudioListener.Velocity. If the calculation yields a result of no Doppler effect, this value has no effect.
| ArgumentOutOfRangeException | The doppler scale of an audio emitter must be greater than or equal to zero. |
Definition at line 44 of file AudioEmitter.cs.
|
getset |
The position of the emitter in the 3D world.
Definition at line 22 of file AudioEmitter.cs.
|
getset |
The velocity of the emitter in the 3D world.
This is only used to calculate the doppler effect on the sound effect
Definition at line 28 of file AudioEmitter.cs.
1.8.7 
