Module ncine.audio_effect_slot
The table containing audio effect slot related functions
Functions
| ncine.audio_effect_slot.new () | Constructs an audio effect slot object. |
| ncine.audio_effect_slot.delete (audio_effect_slot) | Destroys an audio effect slot object and releases its memory |
| ncine.audio_effect_slot.get_effect_slot_id (audio_effect_slot) | Returns the OpenAL auxilary effect slot id |
| ncine.audio_effect_slot.get_gain (audio_effect_slot) | Returns the gain output level of the auxilary effect slot |
| ncine.audio_effect_slot.set_gain (audio_effect_slot, gain) | Sets the gain output level of the auxilary effect slot |
| ncine.audio_effect_slot.get_aux_send_auto (audio_effect_slot) | Returns the state of the auxilary slot send auto flag. |
| ncine.audio_effect_slot.set_aux_send_auto (audio_effect_slot, aux_send_auto) | Sets the state of the auxilary slot send auto flag. |
| ncine.audio_effect_slot.apply_effect (audio_effect_slot, audio_effect) | Applies the effect parameters from an effect object |
Tables
| audioeffectslotObj | The light user data of an audio effect slot object |
Functions
- ncine.audio_effect_slot.new ()
-
Constructs an audio effect slot object.
Don’t forget to call ncine.audio_effect_slot.delete when you are done with it!
Returns:
-
audioeffectslotObj
A new audio effect slot object
- ncine.audio_effect_slot.delete (audio_effect_slot)
-
Destroys an audio effect slot object and releases its memory
Parameters:
- audio_effect_slot audioeffectslotObj The audio effect slot object to be destroyed
- ncine.audio_effect_slot.get_effect_slot_id (audio_effect_slot)
-
Returns the OpenAL auxilary effect slot id
Parameters:
- audio_effect_slot audioeffectslotObj
Returns:
-
integer
- ncine.audio_effect_slot.get_gain (audio_effect_slot)
-
Returns the gain output level of the auxilary effect slot
Parameters:
- audio_effect_slot audioeffectslotObj
Returns:
-
number
- ncine.audio_effect_slot.set_gain (audio_effect_slot, gain)
-
Sets the gain output level of the auxilary effect slot
Parameters:
- audio_effect_slot audioeffectslotObj
- gain number
- ncine.audio_effect_slot.get_aux_send_auto (audio_effect_slot)
-
Returns the state of the auxilary slot send auto flag.
The property is used to enable or disable automatic send adjustments based on the physical positions of the sources and the listener.
Parameters:
- audio_effect_slot audioeffectslotObj
Returns:
-
boolean
- ncine.audio_effect_slot.set_aux_send_auto (audio_effect_slot, aux_send_auto)
-
Sets the state of the auxilary slot send auto flag.
The property is used to enable or disable automatic send adjustments based on the physical positions of the sources and the listener.
Parameters:
- audio_effect_slot audioeffectslotObj
- aux_send_auto boolean
- ncine.audio_effect_slot.apply_effect (audio_effect_slot, audio_effect)
-
Applies the effect parameters from an effect object
Parameters:
- audio_effect_slot audioeffectslotObj
- audio_effect ncine.audio_effect.audioeffectObj