Module ncine.audio_effect
The table containing audio effect related functions
Functions
| ncine.audio_effect.new () | Constructs an audio effect object. |
| ncine.audio_effect.delete (audio_effect) | Destroys an audio effect object and releases its memory |
| ncine.audio_effect.get_type (audio_effect) | Returns the effect type |
| ncine.audio_effect.get_effect_id (audio_effect) | Returns the OpenAL effect id |
| ncine.audio_effect.apply_properties (audio_effect, properties) | Sets an effect type with all of its properties |
Tables
| audioeffectObj | The light user data of an audio effect object |
| ncine.audio_effect_type | Audio effect types (enumeration) |
Functions
- ncine.audio_effect.new ()
-
Constructs an audio effect object.
Don’t forget to call ncine.audio_effect.delete when you are done with it!
Returns:
-
audioeffectObj
A new audio effect object
- ncine.audio_effect.delete (audio_effect)
-
Destroys an audio effect object and releases its memory
Parameters:
- audio_effect audioeffectObj The audio effect object to be destroyed
- ncine.audio_effect.get_type (audio_effect)
-
Returns the effect type
Parameters:
- audio_effect audioeffectObj
Returns:
-
ncine.audio_effect_type
- ncine.audio_effect.get_effect_id (audio_effect)
-
Returns the OpenAL effect id
Parameters:
- audio_effect audioeffectObj
Returns:
-
integer
- ncine.audio_effect.apply_properties (audio_effect, properties)
-
Sets an effect type with all of its properties
Parameters:
- audio_effect audioeffectObj
- properties audioeffectpropertiesObj