Index · Object → RefCounted → Resource → AudioStream

AudioStream

Base class for audio streams.

Inherited by (10): AudioStreamGeneratorAudioStreamInteractiveAudioStreamMicrophoneAudioStreamMP3AudioStreamOggVorbisAudioStreamPlaylistAudioStreamPolyphonicAudioStreamRandomizerAudioStreamSynchronizedAudioStreamWAV
Class Description

Base class for audio streams. Audio streams are used for sound effects and music playback, and support WAV (via AudioStreamWAV), Ogg (via AudioStreamOggVorbis), and MP3 (via AudioStreamMP3) file formats.

Properties

Inherited from Resource (4)

Methods

func _get_bar_beats() -> int

Override this method to return the bar beats of this stream.

func _get_beat_count() -> int

Overridable method. Should return the total number of beats of this audio stream. Used by the engine to determine the position of every beat.

Ideally, the returned value should be based off the stream's sample rate (AudioStreamWAV.mix_rate, for example).

func _get_bpm() -> float

Overridable method. Should return the tempo of this audio stream, in beats per minute (BPM). Used by the engine to determine the position of every beat.

Ideally, the returned value should be based off the stream's sample rate (AudioStreamWAV.mix_rate, for example).

func _get_length() -> float

Override this method to customize the returned value of get_length(). Should return the length of this audio stream, in seconds.

func _get_parameter_list() -> Dictionary[]

Return the controllable parameters of this stream. This array contains dictionaries with a property info description format (see Object.get_property_list()). Additionally, the default value for this parameter must be added tho each dictionary in "default_value" field.

func _get_stream_name() -> String

Override this method to customize the name assigned to this audio stream. Unused by the engine.

func _get_tags() -> Dictionary

Override this method to customize the tags for this audio stream. Should return a Dictionary of strings with the tag as the key and its content as the value.

Commonly used tags include title, artist, album, tracknumber, and date.

func _has_loop() -> bool

Override this method to return true if this stream has a loop.

func _instantiate_playback() -> AudioStreamPlayback

Override this method to customize the returned value of instantiate_playback(). Should return a new AudioStreamPlayback created when the stream is played (such as by an AudioStreamPlayer).

func _is_monophonic() -> bool

Override this method to customize the returned value of is_monophonic(). Should return true if this audio stream only supports one channel.

func can_be_sampled() -> bool

Returns if the current AudioStream can be used as a sample. Only static streams can be sampled.

func generate_sample() -> AudioSample

Generates an AudioSample based on the current stream.

func get_length() -> float

Returns the length of the audio stream in seconds. If this stream is an AudioStreamRandomizer, returns the length of the last played stream. If this stream has an indefinite length (such as for AudioStreamGenerator and AudioStreamMicrophone), returns 0.0.

func instantiate_playback() -> AudioStreamPlayback

Returns a newly created AudioStreamPlayback intended to play this audio stream. Useful for when you want to extend _instantiate_playback() but call instantiate_playback() from an internally held AudioStream subresource. An example of this can be found in the source code for AudioStreamRandomPitch::instantiate_playback.

func is_meta_stream() -> bool

Returns true if the stream is a collection of other streams, false otherwise.

func is_monophonic() -> bool

Returns true if this audio stream only supports one channel (monophony), or false if the audio stream supports two or more channels (polyphony).

Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

signal parameter_list_changed()

Signal to be emitted to notify when the parameter list changed.

Inherited from Resource (2)
signal changed()
Inherited from Object (2)