AudioStreamPlayer3D

Plays 3D sound in 3D space.

Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space.

@GodotBaseClass
struct AudioStreamPlayer3D {}

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Enums

AttenuationModel
enum AttenuationModel
Constants
enum Constants
DopplerTracking
enum DopplerTracking
OutOfRangeMode
enum OutOfRangeMode

Functions

_busLayoutChanged
void _busLayoutChanged()
_isActive
bool _isActive()
_setPlaying
void _setPlaying(bool enable)
getAreaMask
long getAreaMask()
getAttenuationFilterCutoffHz
double getAttenuationFilterCutoffHz()
getAttenuationFilterDb
double getAttenuationFilterDb()
getAttenuationModel
AudioStreamPlayer3D.AttenuationModel getAttenuationModel()
getBus
String getBus()
getDopplerTracking
AudioStreamPlayer3D.DopplerTracking getDopplerTracking()
getEmissionAngle
double getEmissionAngle()
getEmissionAngleFilterAttenuationDb
double getEmissionAngleFilterAttenuationDb()
getMaxDb
double getMaxDb()
getMaxDistance
double getMaxDistance()
getOutOfRangeMode
AudioStreamPlayer3D.OutOfRangeMode getOutOfRangeMode()
getPitchScale
double getPitchScale()
getPlaybackPosition
double getPlaybackPosition()

Returns the position in the AudioStream.

getStream
Ref!AudioStream getStream()
getStreamPaused
bool getStreamPaused()
getUnitDb
double getUnitDb()
getUnitSize
double getUnitSize()
isAutoplayEnabled
bool isAutoplayEnabled()
isEmissionAngleEnabled
bool isEmissionAngleEnabled()
isPlaying
bool isPlaying()
opAssign
AudioStreamPlayer3D opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(AudioStreamPlayer3D other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
play
void play(double from_position)

Plays the audio from the given position 'from_position', in seconds.

seek
void seek(double to_position)

Sets the position from which audio will be played, in seconds.

setAreaMask
void setAreaMask(long mask)
setAttenuationFilterCutoffHz
void setAttenuationFilterCutoffHz(double degrees)
setAttenuationFilterDb
void setAttenuationFilterDb(double db)
setAttenuationModel
void setAttenuationModel(long model)
setAutoplay
void setAutoplay(bool enable)
setBus
void setBus(StringArg0 bus)
setDopplerTracking
void setDopplerTracking(long mode)
setEmissionAngle
void setEmissionAngle(double degrees)
setEmissionAngleEnabled
void setEmissionAngleEnabled(bool enabled)
setEmissionAngleFilterAttenuationDb
void setEmissionAngleFilterAttenuationDb(double db)
setMaxDb
void setMaxDb(double max_db)
setMaxDistance
void setMaxDistance(double metres)
setOutOfRangeMode
void setOutOfRangeMode(long mode)
setPitchScale
void setPitchScale(double pitch_scale)
setStream
void setStream(AudioStream stream)
setStreamPaused
void setStreamPaused(bool pause)
setUnitDb
void setUnitDb(double unit_db)
setUnitSize
void setUnitSize(double unit_size)
stop
void stop()

Stops the audio.

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

areaMask
long areaMask [@property getter]
long areaMask [@property setter]

Areas in which this sound plays.

attenuationFilterCutoffHz
double attenuationFilterCutoffHz [@property getter]
double attenuationFilterCutoffHz [@property setter]

Dampens audio above this frequency, in Hz.

attenuationFilterDb
double attenuationFilterDb [@property getter]
double attenuationFilterDb [@property setter]

Amount how much the filter affects the loudness, in dB.

attenuationModel
AudioStreamPlayer3D.AttenuationModel attenuationModel [@property getter]
long attenuationModel [@property setter]

Decides if audio should get quieter with distance linearly, quadratically or logarithmically.

autoplay
bool autoplay [@property getter]
bool autoplay [@property setter]

If true audio plays when added to scene tree. Default value: false.

bus
String bus [@property getter]
String bus [@property setter]

Bus on which this audio is playing.

dopplerTracking
AudioStreamPlayer3D.DopplerTracking dopplerTracking [@property getter]
long dopplerTracking [@property setter]

Decides in which step the Doppler effect should be calculated.

emissionAngleDegrees
double emissionAngleDegrees [@property getter]
double emissionAngleDegrees [@property setter]

The angle in which the audio reaches cameras undampened.

emissionAngleEnabled
bool emissionAngleEnabled [@property getter]
bool emissionAngleEnabled [@property setter]

If true the audio should be dampened according to the direction of the sound.

emissionAngleFilterAttenuationDb
double emissionAngleFilterAttenuationDb [@property getter]
double emissionAngleFilterAttenuationDb [@property setter]

dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB.

maxDb
double maxDb [@property getter]
double maxDb [@property setter]

Sets the absolute maximum of the soundlevel, in dB.

maxDistance
double maxDistance [@property getter]
double maxDistance [@property setter]

Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0.

outOfRangeMode
AudioStreamPlayer3D.OutOfRangeMode outOfRangeMode [@property getter]
long outOfRangeMode [@property setter]

Decides if audio should pause when source is outside of 'max_distance' range.

pitchScale
double pitchScale [@property getter]
double pitchScale [@property setter]

Changes the pitch and the tempo of the audio.

playing
bool playing [@property getter]
bool playing [@property setter]

If true, audio is playing.

stream
AudioStream stream [@property getter]
AudioStream stream [@property setter]

The AudioStream object to be played.

streamPaused
bool streamPaused [@property getter]
bool streamPaused [@property setter]
unitDb
double unitDb [@property getter]
double unitDb [@property setter]

Base sound level unaffected by dampening, in dB.

unitSize
double unitSize [@property getter]
double unitSize [@property setter]

Factor for the attenuation effect.

Static functions

_new
AudioStreamPlayer3D _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
ToRef as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta