AudioStreamPlayer

Plays back audio non-positionally.

Plays an audio stream non-positionally. To play audio positionally, use AudioStreamPlayer2D or AudioStreamPlayer3D instead of AudioStreamPlayer.

@GodotBaseClass

struct AudioStreamPlayer {

enum string _GODOT_internal_name;

union __anonymous;

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

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(AudioStreamPlayer other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static AudioStreamPlayer _new();

enum MixTarget;

enum Constants;

void _busLayoutChanged();

bool _isActive();

void _setPlaying(bool enable);

String getBus();

AudioStreamPlayer.MixTarget getMixTarget();

double getPitchScale();

double getPlaybackPosition();

Ref!AudioStream getStream();

bool getStreamPaused();

Ref!AudioStreamPlayback getStreamPlayback();

double getVolumeDb();

bool isAutoplayEnabled();

bool isPlaying();

void play(double from_position);

void seek(double to_position);

void setAutoplay(bool enable);

void setBus(String bus);

void setMixTarget(long mix_target);

void setPitchScale(double pitch_scale);

void setStream(AudioStream stream);

void setStreamPaused(bool pause);

void setVolumeDb(double volume_db);

bool autoplay [@property getter];

bool autoplay [@property setter];

String bus [@property getter];

String bus [@property setter];

AudioStreamPlayer.MixTarget mixTarget [@property getter];

long mixTarget [@property setter];

double pitchScale [@property getter];

double pitchScale [@property setter];

bool playing [@property getter];

bool playing [@property setter];

AudioStream stream [@property getter];

AudioStream stream [@property setter];

bool streamPaused [@property getter];

bool streamPaused [@property setter];

double volumeDb [@property getter];

double volumeDb [@property setter];

}

Members

Aliases

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

Enums

Constants enum Constants
MixTarget enum MixTarget

Functions

_busLayoutChanged void _busLayoutChanged()
_isActive bool _isActive()
_setPlaying void _setPlaying(bool enable)
getBus String getBus()
getMixTarget AudioStreamPlayer.MixTarget getMixTarget()
getPitchScale double getPitchScale()
getPlaybackPosition double getPlaybackPosition(): Returns the position in the AudioStream in seconds.
getStream Ref!AudioStream getStream()
getStreamPaused bool getStreamPaused()
getStreamPlayback Ref!AudioStreamPlayback getStreamPlayback(): Returns the AudioStreamPlayback object associated with this AudioStreamPlayer.
getVolumeDb double getVolumeDb()
isAutoplayEnabled bool isAutoplayEnabled()
isPlaying bool isPlaying()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(AudioStreamPlayer other)
opEquals bool opEquals(typeof(null) n)
play void play(double from_position): Plays the audio from the given from_position, in seconds.
seek void seek(double to_position): Sets the position from which audio will be played, in seconds.
setAutoplay void setAutoplay(bool enable)
setBus void setBus(String bus)
setMixTarget void setMixTarget(long mix_target)
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.
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

autoplay bool autoplay [@property getter]
bool autoplay [@property setter]: If true, audio plays when added to scene tree.
bus String bus [@property getter]
String bus [@property setter]: Bus on which this audio is playing.
mixTarget AudioStreamPlayer.MixTarget mixTarget [@property getter]
long mixTarget [@property setter]: If the audio configuration has more than two speakers, this sets the target channels. See mixtarget constants.
pitchScale double pitchScale [@property getter]
double pitchScale [@property setter]: The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate.
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]: If true, the playback is paused. You can resume it by setting stream_paused to false.
volumeDb double volumeDb [@property getter]
double volumeDb [@property setter]: Volume of sound, in dB.

Static functions

_new AudioStreamPlayer _new(): Construct a new instance of AudioStreamPlayer. Note: use memnew!AudioStreamPlayer instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: 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 inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(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 audiostreamplayer structs

AudioStreamPlayer