nCine

• Index

Contents

• Functions
• Tables
• EAX Reverb
• Chorus
• Distortion
• Echo
• Flanger
• Frequency Shifter
• Vocal Morpher
• Pitch Shifter
• Ring Modulator
• Auto Wah
• Compressor
• Equalizer

Modules

• ncine
• ncine.animated_sprite
• ncine.app_configuration
• ncine.application
• ncine.audio_buffer
• ncine.audio_buffer_player
• ncine.audio_device
• ncine.audio_effect
• ncine.audio_effect_properties
• ncine.audio_effect_slot
• ncine.audio_filter
• ncine.audio_player
• ncine.audio_stream_player
• ncine.base_sprite
• ncine.camera
• ncine.color
• ncine.drawable_node
• EFX_Presets
• ncine.font
• ncine.frame_timer
• ncine.fs
• ncine.gfx_device
• ncine.hash64
• ncine.input
• ncine.keys
• ncine.log
• ncine.mesh_sprite
• ncinelua
• ncine.particle_affector
• ncine.particle_system
• ncine.rect
• ncine.scenenode
• ncine.shader
• ncine.shaderstate
• ncine.sprite
• ncine.textnode
• ncine.texture
• ncine.timestamp
• ncine.vec2
• ncine.vec3
• ncine.vec4
• ncine.viewport

Topics

• readme

Module ncine.audio_effect_properties

The table containing audio effect properties related functions

Functions

ncine.audio_effect_properties.new ()	Constructs an audio effect properties object.
ncine.audio_effect_properties.delete (audio_effect_properties)	Destroys an audio effect properties object and releases its memory
ncine.audio_effect_properties.get_type (audio_effect_properties)	Returns the effect properties type
ncine.audio_effect_properties.set_type (audio_effect_properties, audio_effect_type)	Sets the effect properties type

Tables

audioeffectpropertiesObj

The light user data of an audio effect properties object

audio_reverb_properties	Properties of the reverb effect
ncine.audio_effect_properties.get_min_reverb_properties (audio_effect_properties)	Returns the minimum values for the reverb effect properties
ncine.audio_effect_properties.get_max_reverb_properties (audio_effect_properties)	Returns the maximum values for the reverb effect properties
ncine.audio_effect_properties.get_reverb_properties (audio_effect_properties)	Returns the current values for the reverb effect properties
ncine.audio_effect_properties.set_reverb_properties (audio_effect_properties, properties)	Sets all values for the reverb effect properties
ncine.audio_effect_properties.reset_reverb_properties (audio_effect_properties)	Resets all property values for the reverb effect to thir default

EAX Reverb

audio_eax_reverb_properties	Properties of the EAX reverb effect
ncine.audio_effect_properties.get_min_eax_reverb_properties (audio_effect_properties)	Returns the minimum values for the EAX reverb effect properties
ncine.audio_effect_properties.get_max_eax_reverb_properties (audio_effect_properties)	Returns the maximum values for the EAX reverb effect properties
ncine.audio_effect_properties.get_eax_reverb_properties (audio_effect_properties)	Returns the current values for the EAX reverb effect properties
ncine.audio_effect_properties.set_eax_reverb_properties (audio_effect_properties, properties)	Sets all values for the EAX reverb effect properties
ncine.audio_effect_properties.reset_eax_reverb_properties (audio_effect_properties)	Resets all property values for the EAX reverb effect to thir default
ncine.audio_effect_properties.load_efx_reverb_preset (audio_effect_properties, preset)	Loads and sets the effect properties from an EFX reverb preset

Chorus

audio_chorus_properties	Properties of the chorus effect
ncine.audio_effect_properties.get_min_chorus_properties (audio_effect_properties)	Returns the minimum values for the chorus effect properties
ncine.audio_effect_properties.get_max_chorus_properties (audio_effect_properties)	Returns the maximum values for the chorus effect properties
ncine.audio_effect_properties.get_chorus_properties (audio_effect_properties)	Returns the current values for the chorus effect properties
ncine.audio_effect_properties.set_chorus_properties (audio_effect_properties, properties)	Sets all values for the chorus effect properties
ncine.audio_effect_properties.reset_chorus_properties (audio_effect_properties)	Resets all property values for the chorus effect to thir default

Distortion

audio_distortion_properties	Properties of the distortion effect
ncine.audio_effect_properties.get_min_distortion_properties (audio_effect_properties)	Returns the minimum values for the distortion effect properties
ncine.audio_effect_properties.get_max_distortion_properties (audio_effect_properties)	Returns the maximum values for the distortion effect properties
ncine.audio_effect_properties.get_distortion_properties (audio_effect_properties)	Returns the current values for the distortion effect properties
ncine.audio_effect_properties.set_distortion_properties (audio_effect_properties, properties)	Sets all values for the distortion effect properties
ncine.audio_effect_properties.reset_distortion_properties (audio_effect_properties)	Resets all property values for the distortion effect to thir default

Echo

audio_echo_properties	Properties of the echo effect
ncine.audio_effect_properties.get_min_echo_properties (audio_effect_properties)	Returns the minimum values for the echo effect properties
ncine.audio_effect_properties.get_max_echo_properties (audio_effect_properties)	Returns the maximum values for the echo effect properties
ncine.audio_effect_properties.get_echo_properties (audio_effect_properties)	Returns the current values for the echo effect properties
ncine.audio_effect_properties.set_echo_properties (audio_effect_properties, properties)	Sets all values for the echo effect properties
ncine.audio_effect_properties.reset_echo_properties (audio_effect_properties)	Resets all property values for the echo effect to thir default

Flanger

audio_flanger_properties	Properties of the flanger effect
ncine.audio_effect_properties.get_min_flanger_properties (audio_effect_properties)	Returns the minimum values for the flanger effect properties
ncine.audio_effect_properties.get_max_flanger_properties (audio_effect_properties)	Returns the maximum values for the flanger effect properties
ncine.audio_effect_properties.get_flanger_properties (audio_effect_properties)	Returns the current values for the flanger effect properties
ncine.audio_effect_properties.set_flanger_properties (audio_effect_properties, properties)	Sets all values for the flanger effect properties
ncine.audio_effect_properties.reset_flanger_properties (audio_effect_properties)	Resets all property values for the flanger effect to thir default

Frequency Shifter

audio_frequency_shifter_properties	Properties of the frequency shifter effect
ncine.audio_effect_properties.get_min_frequency_shifter_properties (audio_effect_properties)	Returns the minimum values for the frequency shifter effect properties
ncine.audio_effect_properties.get_max_frequency_shifter_properties (audio_effect_properties)	Returns the maximum values for the frequency shifter effect properties
ncine.audio_effect_properties.get_frequency_shifter_properties (audio_effect_properties)	Returns the current values for the frequency shifter effect properties
ncine.audio_effect_properties.set_frequency_shifter_properties (audio_effect_properties, properties)	Sets all values for the frequency shifter effect properties
ncine.audio_effect_properties.reset_frequency_shifter_properties (audio_effect_properties)	Resets all property values for the frequency shifter effect to thir default

Vocal Morpher

audio_vocal_morpher_properties	Properties of the vocal morpher effect
ncine.audio_effect_properties.get_min_vocal_morpher_properties (audio_effect_properties)	Returns the minimum values for the vocal morpher effect properties
ncine.audio_effect_properties.get_max_vocal_morpher_properties (audio_effect_properties)	Returns the maximum values for the vocal morpher effect properties
ncine.audio_effect_properties.get_vocal_morpher_properties (audio_effect_properties)	Returns the current values for the vocal morpher effect properties
ncine.audio_effect_properties.set_vocal_morpher_properties (audio_effect_properties, properties)	Sets all values for the vocal morpher effect properties
ncine.audio_effect_properties.reset_vocal_morpher_properties (audio_effect_properties)	Resets all property values for the vocal morpher effect to thir default

Pitch Shifter

audio_pitch_shifter_properties	Properties of the pitch shifter effect
ncine.audio_effect_properties.get_min_pitch_shifter_properties (audio_effect_properties)	Returns the minimum values for the pitch shifter effect properties
ncine.audio_effect_properties.get_max_pitch_shifter_properties (audio_effect_properties)	Returns the maximum values for the pitch shifter effect properties
ncine.audio_effect_properties.get_pitch_shifter_properties (audio_effect_properties)	Returns the current values for the pitch shifter effect properties
ncine.audio_effect_properties.set_pitch_shifter_properties (audio_effect_properties, properties)	Sets all values for the pitch shifter effect properties
ncine.audio_effect_properties.reset_pitch_shifter_properties (audio_effect_properties)	Resets all property values for the pitch shifter effect to thir default

Ring Modulator

audio_ring_modulator_properties	Properties of the ring modulator effect
ncine.audio_effect_properties.get_min_ring_modulator_properties (audio_effect_properties)	Returns the minimum values for the ring modulator effect properties
ncine.audio_effect_properties.get_max_ring_modulator_properties (audio_effect_properties)	Returns the maximum values for the ring modulator effect properties
ncine.audio_effect_properties.get_ring_modulator_properties (audio_effect_properties)	Returns the current values for the ring modulator effect properties
ncine.audio_effect_properties.set_ring_modulator_properties (audio_effect_properties, properties)	Sets all values for the ring modulator effect properties
ncine.audio_effect_properties.reset_ring_modulator_properties (audio_effect_properties)	Resets all property values for the ring modulator effect to thir default

Auto Wah

audio_auto_wah_properties	Properties of the auto wah effect
ncine.audio_effect_properties.get_min_auto_wah_properties (audio_effect_properties)	Returns the minimum values for the auto wah effect properties
ncine.audio_effect_properties.get_max_auto_wah_properties (audio_effect_properties)	Returns the maximum values for the auto wah effect properties
ncine.audio_effect_properties.get_auto_wah_properties (audio_effect_properties)	Returns the current values for the auto wah effect properties
ncine.audio_effect_properties.set_auto_wah_properties (audio_effect_properties, properties)	Sets all values for the auto wah effect properties
ncine.audio_effect_properties.reset_auto_wah_properties (audio_effect_properties)	Resets all property values for the auto wah effect to thir default

Compressor

audio_compressor_properties	Properties of the compressor effect
ncine.audio_effect_properties.get_min_compressor_properties (audio_effect_properties)	Returns the minimum values for the compressor effect properties
ncine.audio_effect_properties.get_max_compressor_properties (audio_effect_properties)	Returns the maximum values for the compressor effect properties
ncine.audio_effect_properties.get_compressor_properties (audio_effect_properties)	Returns the current values for the compressor effect properties
ncine.audio_effect_properties.set_compressor_properties (audio_effect_properties, properties)	Sets all values for the compressor effect properties
ncine.audio_effect_properties.reset_compressor_properties (audio_effect_properties)	Resets all property values for the compressor effect to thir default

Equalizer

audio_equalizer_properties	Properties of the equalizer effect
ncine.audio_effect_properties.get_min_equalizer_properties (audio_effect_properties)	Returns the minimum values for the equalizer effect properties
ncine.audio_effect_properties.get_max_equalizer_properties (audio_effect_properties)	Returns the maximum values for the equalizer effect properties
ncine.audio_effect_properties.get_equalizer_properties (audio_effect_properties)	Returns the current values for the equalizer effect properties
ncine.audio_effect_properties.set_equalizer_properties (audio_effect_properties, properties)	Sets all values for the equalizer effect properties
ncine.audio_effect_properties.reset_equalizer_properties (audio_effect_properties)	Resets all property values for the equalizer effect to thir default

Functions

ncine.audio_effect_properties.new ()

Constructs an audio effect properties object.

Don’t forget to call ncine.audio_effect_properties.delete when you are done with it!

Returns:

audioeffectpropertiesObj A new audio effect properties object

ncine.audio_effect_properties.delete (audio_effect_properties)

Destroys an audio effect properties object and releases its memory

Parameters:

• audio_effect_properties audioeffectpropertiesObj The audio effect properties object to be destroyed

ncine.audio_effect_properties.get_type (audio_effect_properties)

Returns the effect properties type

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

ncine.audio_effect_type

ncine.audio_effect_properties.set_type (audio_effect_properties, audio_effect_type)

Sets the effect properties type

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• audio_effect_type ncine.audio_effect_type

Tables

audioeffectpropertiesObj

The light user data of an audio effect properties object

audio_reverb_properties

Properties of the reverb effect

Fields:

• density number number
• diffusion number number
• gain number number
• gain_hf number number
• decay_time number number
• decay_hf_ratio number number
• reflections_gain number number
• reflections_delay number number
• late_reverb_gain number number
• late_reverb_delay number number
• air_absorption_gain_hf number number
• room_rolloff_factor number number
• decay_hf_limit integer integer

ncine.audio_effect_properties.get_min_reverb_properties (audio_effect_properties)

Returns the minimum values for the reverb effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_reverb_properties

ncine.audio_effect_properties.get_max_reverb_properties (audio_effect_properties)

Returns the maximum values for the reverb effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_reverb_properties

ncine.audio_effect_properties.get_reverb_properties (audio_effect_properties)

Returns the current values for the reverb effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_reverb_properties

ncine.audio_effect_properties.set_reverb_properties (audio_effect_properties, properties)

Sets all values for the reverb effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_reverb_properties

ncine.audio_effect_properties.reset_reverb_properties (audio_effect_properties)

Resets all property values for the reverb effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj

EAX Reverb

audio_eax_reverb_properties

Properties of the EAX reverb effect

Fields:

• reflections_pan (ncine.vec3)
• late_reverb_pan (ncine.vec3)
• density number
• diffusion number
• gain number
• gain_hf number
• gain_lf number
• decay_time number
• decay_hf_ratio number
• decay_lf_ratio number
• reflections_gain number
• reflections_delay number
• late_reverb_gain number
• late_reverb_delay number
• echo_time number
• echo_depth number
• modulation_time number
• modulation_depth number
• air_absorption_gain_hf number
• hf_reference number
• lf_reference number
• room_rolloff_factor number
• decay_hf_limit integer

ncine.audio_effect_properties.get_min_eax_reverb_properties (audio_effect_properties)

Returns the minimum values for the EAX reverb effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_eax_reverb_properties

ncine.audio_effect_properties.get_max_eax_reverb_properties (audio_effect_properties)

Returns the maximum values for the EAX reverb effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_eax_reverb_properties

ncine.audio_effect_properties.get_eax_reverb_properties (audio_effect_properties)

Returns the current values for the EAX reverb effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_eax_reverb_properties

ncine.audio_effect_properties.set_eax_reverb_properties (audio_effect_properties, properties)

Sets all values for the EAX reverb effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_eax_reverb_properties

ncine.audio_effect_properties.reset_eax_reverb_properties (audio_effect_properties)

Resets all property values for the EAX reverb effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj

ncine.audio_effect_properties.load_efx_reverb_preset (audio_effect_properties, preset)

Loads and sets the effect properties from an EFX reverb preset

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• preset ncine.efx_reverb_presets

See also:

EFX_Presets

Chorus

audio_chorus_properties

Properties of the chorus effect

Fields:

• waveform integer —-0 for sinusoid, 1 for triangle
• phase integer
• rate number
• depth number
• feedback number
• delay number

ncine.audio_effect_properties.get_min_chorus_properties (audio_effect_properties)

Returns the minimum values for the chorus effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_chorus_properties

ncine.audio_effect_properties.get_max_chorus_properties (audio_effect_properties)

Returns the maximum values for the chorus effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_chorus_properties

ncine.audio_effect_properties.get_chorus_properties (audio_effect_properties)

Returns the current values for the chorus effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_chorus_properties

ncine.audio_effect_properties.set_chorus_properties (audio_effect_properties, properties)

Sets all values for the chorus effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_chorus_properties

ncine.audio_effect_properties.reset_chorus_properties (audio_effect_properties)

Resets all property values for the chorus effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Distortion

audio_distortion_properties

Properties of the distortion effect

Fields:

• edge number
• gain number
• lowpass_cutoff number
• eq_center number
• eq_bandwidth number

ncine.audio_effect_properties.get_min_distortion_properties (audio_effect_properties)

Returns the minimum values for the distortion effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_distortion_properties

ncine.audio_effect_properties.get_max_distortion_properties (audio_effect_properties)

Returns the maximum values for the distortion effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_distortion_properties

ncine.audio_effect_properties.get_distortion_properties (audio_effect_properties)

Returns the current values for the distortion effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_distortion_properties

ncine.audio_effect_properties.set_distortion_properties (audio_effect_properties, properties)

Sets all values for the distortion effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_distortion_properties

ncine.audio_effect_properties.reset_distortion_properties (audio_effect_properties)

Resets all property values for the distortion effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Echo

audio_echo_properties

Properties of the echo effect

Fields:

• delay number
• lr_delay number
• damping number
• feedback number
• spread number

ncine.audio_effect_properties.get_min_echo_properties (audio_effect_properties)

Returns the minimum values for the echo effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_echo_properties

ncine.audio_effect_properties.get_max_echo_properties (audio_effect_properties)

Returns the maximum values for the echo effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_echo_properties

ncine.audio_effect_properties.get_echo_properties (audio_effect_properties)

Returns the current values for the echo effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_echo_properties

ncine.audio_effect_properties.set_echo_properties (audio_effect_properties, properties)

Sets all values for the echo effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_echo_properties

ncine.audio_effect_properties.reset_echo_properties (audio_effect_properties)

Resets all property values for the echo effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Flanger

audio_flanger_properties

Properties of the flanger effect

Fields:

• waveform integer —-0 for sinusoid, 1 for triangle
• phase integer
• rate number
• depth number
• feedback number
• delay number

ncine.audio_effect_properties.get_min_flanger_properties (audio_effect_properties)

Returns the minimum values for the flanger effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_flanger_properties

ncine.audio_effect_properties.get_max_flanger_properties (audio_effect_properties)

Returns the maximum values for the flanger effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_flanger_properties

ncine.audio_effect_properties.get_flanger_properties (audio_effect_properties)

Returns the current values for the flanger effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_flanger_properties

ncine.audio_effect_properties.set_flanger_properties (audio_effect_properties, properties)

Sets all values for the flanger effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_flanger_properties

ncine.audio_effect_properties.reset_flanger_properties (audio_effect_properties)

Resets all property values for the flanger effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Frequency Shifter

audio_frequency_shifter_properties

Properties of the frequency shifter effect

Fields:

• frequency number
• left_direction integer —-From 0 to 2
• right_direction integer —-From 0 to 2

ncine.audio_effect_properties.get_min_frequency_shifter_properties (audio_effect_properties)

Returns the minimum values for the frequency shifter effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_frequency_shifter_properties

ncine.audio_effect_properties.get_max_frequency_shifter_properties (audio_effect_properties)

Returns the maximum values for the frequency shifter effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_frequency_shifter_properties

ncine.audio_effect_properties.get_frequency_shifter_properties (audio_effect_properties)

Returns the current values for the frequency shifter effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_frequency_shifter_properties

ncine.audio_effect_properties.set_frequency_shifter_properties (audio_effect_properties, properties)

Sets all values for the frequency shifter effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_frequency_shifter_properties

ncine.audio_effect_properties.reset_frequency_shifter_properties (audio_effect_properties)

Resets all property values for the frequency shifter effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Vocal Morpher

audio_vocal_morpher_properties

Properties of the vocal morpher effect

Fields:

• phoneme_a integer —-From 0 to 29 (A to Z)
• phoneme_a_coarse_tuning integer —-From -24 to 24
• phoneme_b integer —-From 0 to 29 (A to Z)
• phoneme_b_coarse_tuning integer —-From -24 to 24
• waveform integer —-0 for sinusoid, 1 for triangle, 2 for sawtooth
• rate number

ncine.audio_effect_properties.get_min_vocal_morpher_properties (audio_effect_properties)

Returns the minimum values for the vocal morpher effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_vocal_morpher_properties

ncine.audio_effect_properties.get_max_vocal_morpher_properties (audio_effect_properties)

Returns the maximum values for the vocal morpher effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_vocal_morpher_properties

ncine.audio_effect_properties.get_vocal_morpher_properties (audio_effect_properties)

Returns the current values for the vocal morpher effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_vocal_morpher_properties

ncine.audio_effect_properties.set_vocal_morpher_properties (audio_effect_properties, properties)

Sets all values for the vocal morpher effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_vocal_morpher_properties

ncine.audio_effect_properties.reset_vocal_morpher_properties (audio_effect_properties)

Resets all property values for the vocal morpher effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Pitch Shifter

audio_pitch_shifter_properties

Properties of the pitch shifter effect

Fields:

• coarse_tune integer integer —-From -12 to 12
• fineTune integer integer —-From -50 to 50

ncine.audio_effect_properties.get_min_pitch_shifter_properties (audio_effect_properties)

Returns the minimum values for the pitch shifter effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_pitch_shifter_properties

ncine.audio_effect_properties.get_max_pitch_shifter_properties (audio_effect_properties)

Returns the maximum values for the pitch shifter effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_pitch_shifter_properties

ncine.audio_effect_properties.get_pitch_shifter_properties (audio_effect_properties)

Returns the current values for the pitch shifter effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_pitch_shifter_properties

ncine.audio_effect_properties.set_pitch_shifter_properties (audio_effect_properties, properties)

Sets all values for the pitch shifter effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_pitch_shifter_properties

ncine.audio_effect_properties.reset_pitch_shifter_properties (audio_effect_properties)

Resets all property values for the pitch shifter effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Ring Modulator

audio_ring_modulator_properties

Properties of the ring modulator effect

Fields:

• frequency number
• highpass_cutoff number
• waveform integer —-0 for sinusoid, 1 for sawtooth, 2 for square

ncine.audio_effect_properties.get_min_ring_modulator_properties (audio_effect_properties)

Returns the minimum values for the ring modulator effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_ring_modulator_properties

ncine.audio_effect_properties.get_max_ring_modulator_properties (audio_effect_properties)

Returns the maximum values for the ring modulator effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_ring_modulator_properties

ncine.audio_effect_properties.get_ring_modulator_properties (audio_effect_properties)

Returns the current values for the ring modulator effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_ring_modulator_properties

ncine.audio_effect_properties.set_ring_modulator_properties (audio_effect_properties, properties)

Sets all values for the ring modulator effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_ring_modulator_properties

ncine.audio_effect_properties.reset_ring_modulator_properties (audio_effect_properties)

Resets all property values for the ring modulator effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Auto Wah

audio_auto_wah_properties

Properties of the auto wah effect

Fields:

• attack_time number
• release_time number
• resonance number
• peak_gain number

ncine.audio_effect_properties.get_min_auto_wah_properties (audio_effect_properties)

Returns the minimum values for the auto wah effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_auto_wah_properties

ncine.audio_effect_properties.get_max_auto_wah_properties (audio_effect_properties)

Returns the maximum values for the auto wah effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_auto_wah_properties

ncine.audio_effect_properties.get_auto_wah_properties (audio_effect_properties)

Returns the current values for the auto wah effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_auto_wah_properties

ncine.audio_effect_properties.set_auto_wah_properties (audio_effect_properties, properties)

Sets all values for the auto wah effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_auto_wah_properties

ncine.audio_effect_properties.reset_auto_wah_properties (audio_effect_properties)

Resets all property values for the auto wah effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Compressor

audio_compressor_properties

Properties of the compressor effect

Fields:

• on_off integer —-0 or 1

ncine.audio_effect_properties.get_min_compressor_properties (audio_effect_properties)

Returns the minimum values for the compressor effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_compressor_properties

ncine.audio_effect_properties.get_max_compressor_properties (audio_effect_properties)

Returns the maximum values for the compressor effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_compressor_properties

ncine.audio_effect_properties.get_compressor_properties (audio_effect_properties)

Returns the current values for the compressor effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_compressor_properties

ncine.audio_effect_properties.set_compressor_properties (audio_effect_properties, properties)

Sets all values for the compressor effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_compressor_properties

ncine.audio_effect_properties.reset_compressor_properties (audio_effect_properties)

Resets all property values for the compressor effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Equalizer

audio_equalizer_properties

Properties of the equalizer effect

Fields:

• low_gain number
• low_cutoff number
• mid1_gain number
• mid1_center number
• mid1_width number
• mid2_gain number
• mid2_center number
• mid2_width number
• high_gain number
• high_cutoff number

ncine.audio_effect_properties.get_min_equalizer_properties (audio_effect_properties)

Returns the minimum values for the equalizer effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_equalizer_properties

ncine.audio_effect_properties.get_max_equalizer_properties (audio_effect_properties)

Returns the maximum values for the equalizer effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_equalizer_properties

ncine.audio_effect_properties.get_equalizer_properties (audio_effect_properties)

Returns the current values for the equalizer effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj

Returns:

audio_equalizer_properties

ncine.audio_effect_properties.set_equalizer_properties (audio_effect_properties, properties)

Sets all values for the equalizer effect properties

Parameters:

• audio_effect_properties audioeffectpropertiesObj
• properties audio_equalizer_properties

ncine.audio_effect_properties.reset_equalizer_properties (audio_effect_properties)

Resets all property values for the equalizer effect to thir default

Parameters:

• audio_effect_properties audioeffectpropertiesObj