KX_Speaker
Class Range.types.KX_Speaker.
Not in the Range documentation
Section titled “Not in the Range documentation”These items exist in the engine but were not in the Range documentation. The ones marked new in Anastacio were added by Anastacio Engine.
GetActiveEffect()
Section titled “GetActiveEffect()”method
Active sound effect: 0 none, 1 reverb.
Returns: int
GetActiveEffectFilter()
Section titled “GetActiveEffectFilter()”method
Active filter: 0 none, 1 low-pass, 2 high-pass, 3 band-pass.
Returns: int
Pause()
Section titled “Pause()”method
Pauses the sound.
Play()
Section titled “Play()”method
Plays the sound.
RemoveEffect()
Section titled “RemoveEffect()”method
Removes the sound effect.
Restart()
Section titled “Restart()”method
Plays the sound from the beginning.
SetEffect(effectType, filterType=0)
Section titled “SetEffect(effectType, filterType=0)”method
Applies an effect: effectType 1 = reverb; filterType 0 none, 1 low-pass, 2 high-pass, 3 band-pass. After that, reverb areas leave this Speaker alone.
SetSound(sound, cache=False)
Section titled “SetSound(sound, cache=False)”method
Changes the sound (an aud.Sound). With cache=True, keeps the decoded sound in memory.
Stop()
Section titled “Stop()”method
Stops the sound.
attenuation
Section titled “attenuation”attribute
How much the volume drops with distance (3D sound).
catkey
Section titled “catkey”attribute
Sound category key in the playback manager, or None.
cone_angle_inner
Section titled “cone_angle_inner”attribute
Angle, in degrees, of the cone where the sound plays at full volume.
cone_angle_outer
Section titled “cone_angle_outer”attribute
Angle, in degrees, of the cone outside of which the volume is cone_volume_outer.
cone_volume_outer
Section titled “cone_volume_outer”attribute
Volume outside the outer cone.
distance_maximum
Section titled “distance_maximum”attribute
Distance after which the volume stops dropping.
distance_reference
Section titled “distance_reference”attribute
Distance at which the sound plays at normal volume.
filter_gain
Section titled “filter_gain”attribute
Overall filter gain.
filter_gainhf
Section titled “filter_gainhf”attribute
High frequency gain in the filter.
filter_gainlf
Section titled “filter_gainlf”attribute
Low frequency gain in the filter.
attribute · read-only
True if the sound is positional (3D).
attribute
Playback mode: 1 plays to the end, 2 loops, 3 ping-pong loop.
attribute
Sound pitch (speed). 1.0 is normal.
playbackManager
Section titled “playbackManager”attribute
Playback manager (aud.PlaybackManager) used by the Speaker, or None.
reverb_air_absorption_gain_hf
Section titled “reverb_air_absorption_gain_hf”attribute
Reverb: high frequency absorption by the air.
reverb_decay_hf_ratio
Section titled “reverb_decay_hf_ratio”attribute
Reverb: how much faster high frequencies fade than low ones.
reverb_decay_limit_hf
Section titled “reverb_decay_limit_hf”attribute
Reverb: limits the high frequency decay.
reverb_decay_time
Section titled “reverb_decay_time”attribute
Reverb: time in seconds the echo takes to fade.
reverb_density
Section titled “reverb_density”attribute
Reverb: echo density.
reverb_diffusion
Section titled “reverb_diffusion”attribute
Reverb: echo diffusion.
reverb_gain
Section titled “reverb_gain”attribute
Reverb: overall effect volume.
reverb_gain_hf
Section titled “reverb_gain_hf”attribute
Reverb: high frequency volume.
reverb_late_reverb_delay
Section titled “reverb_late_reverb_delay”attribute
Reverb: delay of the echo tail.
reverb_late_reverb_gain
Section titled “reverb_late_reverb_gain”attribute
Reverb: volume of the echo tail.
reverb_reflections_delay
Section titled “reverb_reflections_delay”attribute
Reverb: delay of the early reflections.
reverb_reflections_gain
Section titled “reverb_reflections_gain”attribute
Reverb: volume of the early reflections.
reverb_room_rolloff_factor
Section titled “reverb_room_rolloff_factor”attribute
Reverb: how much the effect drops with distance.
attribute
Current sound (aud.Sound), or None.
attribute
Current sound position, in seconds. Can be changed to seek.
volume
Section titled “volume”attribute
Sound volume.
volume_maximum
Section titled “volume_maximum”attribute
Maximum volume, even up close.
volume_minimum
Section titled “volume_minimum”attribute
Minimum volume, even far away.