69 lines
3.6 KiB
XML
69 lines
3.6 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AudioStreamMP3" inherits="AudioStream" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
|
<brief_description>
|
|
MP3 audio stream driver.
|
|
</brief_description>
|
|
<description>
|
|
MP3 audio stream driver. See [member data] if you want to load an MP3 file at run-time. More info can be found in [ResourceImporterMP3].
|
|
[b]Note:[/b] This class can optionally support legacy MP1 and MP2 formats, provided that the engine is compiled with the [code]minimp3_extra_formats=yes[/code] SCons option. These extra formats are not enabled by default.
|
|
</description>
|
|
<tutorials>
|
|
<link title="Audio streams">$DOCS_URL/tutorials/audio/audio_streams.html</link>
|
|
<link title="Runtime file loading and saving">$DOCS_URL/tutorials/io/runtime_file_loading_and_saving.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="load_from_buffer" qualifiers="static">
|
|
<return type="AudioStreamMP3" />
|
|
<param index="0" name="stream_data" type="PackedByteArray" />
|
|
<description>
|
|
Creates a new [AudioStreamMP3] instance from the given buffer. The buffer must contain MP3 data.
|
|
</description>
|
|
</method>
|
|
<method name="load_from_file" qualifiers="static">
|
|
<return type="AudioStreamMP3" />
|
|
<param index="0" name="path" type="String" />
|
|
<description>
|
|
Creates a new [AudioStreamMP3] instance from the given file path. The file must be in MP3 format.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="bar_beats" type="int" setter="set_bar_beats" getter="get_bar_beats" default="4">
|
|
The number of beats within a single bar in the audio track.
|
|
</member>
|
|
<member name="beat_count" type="int" setter="set_beat_count" getter="get_beat_count" default="0">
|
|
The length of the audio track, in beats. The actual duration of the audio file might be longer than what is indicated by this property. It defines the end of the audio for looping, [AudioStreamPlaylist], and [AudioStreamInteractive].
|
|
</member>
|
|
<member name="bpm" type="float" setter="set_bpm" getter="get_bpm" default="0.0">
|
|
The tempo of the audio track, measured in beats per minute.
|
|
</member>
|
|
<member name="data" type="PackedByteArray" setter="set_data" getter="get_data" default="PackedByteArray()">
|
|
Contains the audio data in bytes.
|
|
You can load a file without having to import it beforehand using the code snippet below. Keep in mind that this snippet loads the whole file into memory and may not be ideal for huge files (hundreds of megabytes or more).
|
|
[codeblocks]
|
|
[gdscript]
|
|
func load_mp3(path):
|
|
var file = FileAccess.open(path, FileAccess.READ)
|
|
var sound = AudioStreamMP3.new()
|
|
sound.data = file.get_buffer(file.get_length())
|
|
return sound
|
|
[/gdscript]
|
|
[csharp]
|
|
public AudioStreamMP3 LoadMP3(string path)
|
|
{
|
|
using var file = FileAccess.Open(path, FileAccess.ModeFlags.Read);
|
|
var sound = new AudioStreamMP3();
|
|
sound.Data = file.GetBuffer(file.GetLength());
|
|
return sound;
|
|
}
|
|
[/csharp]
|
|
[/codeblocks]
|
|
</member>
|
|
<member name="loop" type="bool" setter="set_loop" getter="has_loop" default="false">
|
|
If [code]true[/code], the stream will play again from the specified [member loop_offset] once it reaches the end of the audio track, or once it reaches the end of the last beat according to the amount specified in [member beat_count]. Useful for ambient sounds and background music.
|
|
</member>
|
|
<member name="loop_offset" type="float" setter="set_loop_offset" getter="get_loop_offset" default="0.0">
|
|
Time in seconds at which the stream starts after being looped.
|
|
</member>
|
|
</members>
|
|
</class>
|