Module ncine.audio_filter
The table containing audio filter related functions
Functions
ncine.audio_filter.new () | Constructs an audio filter object. |
ncine.audio_filter.delete (audio_filter) | Destroys an audio filter object and releases its memory |
ncine.audio_filter.get_type (audio_filter) | Returns the filter type |
ncine.audio_filter.get_filter_id (audio_filter) | Returns the OpenAL filter id |
ncine.audio_filter.apply_properties (audio_filter, properties) | Sets the filter type and all of its properties |
ncine.audio_filter.get_default_properties () | Returns a table with the default filter type and properties. |
Tables
audiofilterObj | The light user data of an audio filter object |
ncine.audio_filter_type | Audio filter types (enumeration) |
audio_filter_properties | A table with the audio filter properties |
Functions
- ncine.audio_filter.new ()
-
Constructs an audio filter object.
Don’t forget to call ncine.audio_filter.delete when you are done with it!
Returns:
-
audiofilterObj
A new audio filter object
- ncine.audio_filter.delete (audio_filter)
-
Destroys an audio filter object and releases its memory
Parameters:
- audio_filter audiofilterObj The audio filter object to be destroyed
- ncine.audio_filter.get_type (audio_filter)
-
Returns the filter type
Parameters:
- audio_filter audiofilterObj
Returns:
-
ncine.audio_filter_type
- ncine.audio_filter.get_filter_id (audio_filter)
-
Returns the OpenAL filter id
Parameters:
- audio_filter audiofilterObj
Returns:
-
integer
- ncine.audio_filter.apply_properties (audio_filter, properties)
-
Sets the filter type and all of its properties
Parameters:
- audio_filter audiofilterObj
- properties audio_filter_properties
- ncine.audio_filter.get_default_properties ()
-
Returns a table with the default filter type and properties.
The table is only returned as a reference.
Returns:
-
audio_filter_properties
Tables
- audiofilterObj
- The light user data of an audio filter object
- ncine.audio_filter_type
-
Audio filter types (enumeration)
Fields:
- NULL_FILTER
- LOWPASS
- HIGHPASS
- BANDPASS
- audio_filter_properties
-
A table with the audio filter properties
Fields:
- type (ncine.audio_filter_type)
- gain number
- gain_lf number
- gain_hf number