Base class for audio streams.
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.
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).
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).
Override this method to customize the returned value of get_length(). Should return the length of this audio stream, in seconds.
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.
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.
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).
Override this method to customize the returned value of is_monophonic(). Should return true if this audio stream only supports one channel.
Returns if the current AudioStream can be used as a sample. Only static streams can be sampled.
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.
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.
Returns true if this audio stream only supports one channel (monophony), or false if the audio stream supports two or more channels (polyphony).