AudioStreamPlayer2D

Plays audio in 2D.

Plays audio that dampens with distance from screen center.

@GodotBaseClass

struct AudioStreamPlayer2D {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct _classBinding;

bool opEquals(AudioStreamPlayer2D other);

AudioStreamPlayer2D opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static AudioStreamPlayer2D _new();

void setStream(AudioStream stream);

Ref!AudioStream getStream();

void setVolumeDb(double volume_db);

double getVolumeDb();

void setPitchScale(double pitch_scale);

double getPitchScale();

void play(double from_position);

void seek(double to_position);

bool isPlaying();

double getPlaybackPosition();

void setBus(StringArg0 bus);

String getBus();

void setAutoplay(bool enable);

bool isAutoplayEnabled();

void _setPlaying(bool enable);

bool _isActive();

void setMaxDistance(double pixels);

double getMaxDistance();

void setAttenuation(double curve);

double getAttenuation();

void setAreaMask(long mask);

long getAreaMask();

void setStreamPaused(bool pause);

bool getStreamPaused();

void _busLayoutChanged();

AudioStream stream [@property getter];

AudioStream stream [@property setter];

double volumeDb [@property getter];

double volumeDb [@property setter];

double pitchScale [@property getter];

double pitchScale [@property setter];

bool playing [@property getter];

bool playing [@property setter];

bool autoplay [@property getter];

bool autoplay [@property setter];

bool streamPaused [@property getter];

bool streamPaused [@property setter];

double maxDistance [@property getter];

double maxDistance [@property setter];

double attenuation [@property getter];

double attenuation [@property setter];

String bus [@property getter];

String bus [@property setter];

long areaMask [@property getter];

long areaMask [@property setter];

}

Members

Aliases

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

Functions

_busLayoutChanged void _busLayoutChanged()
_isActive bool _isActive()
_setPlaying void _setPlaying(bool enable)
getAreaMask long getAreaMask()
getAttenuation double getAttenuation()
getBus String getBus()
getMaxDistance double getMaxDistance()
getPitchScale double getPitchScale()
getPlaybackPosition double getPlaybackPosition(): Returns the position in the AudioStream.
getStream Ref!AudioStream getStream()
getStreamPaused bool getStreamPaused()
getVolumeDb double getVolumeDb()
isAutoplayEnabled bool isAutoplayEnabled()
isPlaying bool isPlaying()
opAssign AudioStreamPlayer2D opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(AudioStreamPlayer2D 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)
setAttenuation void setAttenuation(double curve)
setAutoplay void setAutoplay(bool enable)
setBus void setBus(StringArg0 bus)
setMaxDistance void setMaxDistance(double pixels)
setPitchScale void setPitchScale(double pitch_scale)
setStream void setStream(AudioStream stream)
setStreamPaused void setStreamPaused(bool pause)
setVolumeDb void setVolumeDb(double volume_db)
stop void stop(): Stops the audio.

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

areaMask long areaMask [@property setter]: Areas in which this sound plays.
areaMask long areaMask [@property getter]: Areas in which this sound plays.
attenuation double attenuation [@property getter]
double attenuation [@property setter]: Dampens audio over distance with this as an exponent.
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.
maxDistance double maxDistance [@property getter]
double maxDistance [@property setter]: Maximum distance from which audio is still hearable.
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]
volumeDb double volumeDb [@property getter]
double volumeDb [@property setter]: Base volume without dampening.

Static functions

_new AudioStreamPlayer2D _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

Source

See Implementation

godot audiostreamplayer2d structs

AudioStreamPlayer2D