godot/modules/vorbis/doc_classes/AudioStreamOggVorbis.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamOggVorbis" inherits="AudioStream" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		A class representing an Ogg Vorbis audio stream.
	</brief_description>
	<description>
		The AudioStreamOggVorbis class is a specialized [AudioStream] for handling Ogg Vorbis file formats. It offers functionality for loading and playing back Ogg Vorbis files, as well as managing looping and other playback properties. This class is part of the audio stream system, which also supports WAV files through the [AudioStreamWAV] class.
	</description>
	<tutorials>
		<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="AudioStreamOggVorbis" />
			<param index="0" name="buffer" type="PackedByteArray" />
			<description>
				Creates a new AudioStreamOggVorbis instance from the given buffer. The buffer must contain Ogg Vorbis data.
			</description>
		</method>
		<method name="load_from_file" qualifiers="static">
			<return type="AudioStreamOggVorbis" />
			<param index="0" name="path" type="String" />
			<description>
				Creates a new AudioStreamOggVorbis instance from the given file path. The file must be in Ogg Vorbis format.
			</description>
		</method>
	</methods>
	<members>
		<member name="bar_beats" type="int" setter="set_bar_beats" getter="get_bar_beats" default="4">
		</member>
		<member name="beat_count" type="int" setter="set_beat_count" getter="get_beat_count" default="0">
		</member>
		<member name="bpm" type="float" setter="set_bpm" getter="get_bpm" default="0.0">
		</member>
		<member name="loop" type="bool" setter="set_loop" getter="has_loop" default="false">
			If [code]true[/code], the audio will play again from the specified [member loop_offset] once it is done playing. 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>
		<member name="packet_sequence" type="OggPacketSequence" setter="set_packet_sequence" getter="get_packet_sequence">
			Contains the raw Ogg data for this stream.
		</member>
	</members>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 08:08:05 +00:00			`<class name="AudioStreamOggVorbis" inherits="AudioStream" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<brief_description>`
Load OGGs from file system 2022-11-11 19:42:56 +00:00			`A class representing an Ogg Vorbis audio stream.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</brief_description>`
			`<description>`
Load OGGs from file system 2022-11-11 19:42:56 +00:00			`The AudioStreamOggVorbis class is a specialized [AudioStream] for handling Ogg Vorbis file formats. It offers functionality for loading and playing back Ogg Vorbis files, as well as managing looping and other playback properties. This class is part of the audio stream system, which also supports WAV files through the [AudioStreamWAV] class.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</description>`
			`<tutorials>`
Link to runtime loading/saving tutorial and improve Image documentation 2023-11-13 13:37:27 +00:00			`<link title="Runtime file loading and saving">$DOCS_URL/tutorials/io/runtime_file_loading_and_saving.html</link>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</tutorials>`
Load OGGs from file system 2022-11-11 19:42:56 +00:00			`<methods>`
			`<method name="load_from_buffer" qualifiers="static">`
			`<return type="AudioStreamOggVorbis" />`
			`<param index="0" name="buffer" type="PackedByteArray" />`
			`<description>`
			`Creates a new AudioStreamOggVorbis instance from the given buffer. The buffer must contain Ogg Vorbis data.`
			`</description>`
			`</method>`
			`<method name="load_from_file" qualifiers="static">`
			`<return type="AudioStreamOggVorbis" />`
			`<param index="0" name="path" type="String" />`
			`<description>`
			`Creates a new AudioStreamOggVorbis instance from the given file path. The file must be in Ogg Vorbis format.`
			`</description>`
			`</method>`
			`</methods>`
Update docs [ci skip] 2018-01-11 22:38:35 +00:00			`<members>`
Implement BPM support Based on #62896, only implements the BPM support part. * Implements BPM support in the AudioStreamOGG/MP3 importers. * Can select BPM/Bar Size and total beats in a song file, as well as edit looping points. * Looping is now BPM aware * Added a special importer UI for configuring this. * Added a special preview showing the audio waveform as well as the playback position in the resource picker. * Renamed `AudioStream::instance` to `instantiate` for correctness. 2022-07-20 23:00:58 +00:00			`<member name="bar_beats" type="int" setter="set_bar_beats" getter="get_bar_beats" default="4">`
			`</member>`
			`<member name="beat_count" type="int" setter="set_beat_count" getter="get_beat_count" default="0">`
			`</member>`
			`<member name="bpm" type="float" setter="set_bpm" getter="get_bpm" default="0.0">`
			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="loop" type="bool" setter="set_loop" getter="has_loop" default="false">`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 20:34:34 +00:00			`If [code]true[/code], the audio will play again from the specified [member loop_offset] once it is done playing. Useful for ambient sounds and background music.`
Update docs [ci skip] 2018-01-11 22:38:35 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="loop_offset" type="float" setter="set_loop_offset" getter="get_loop_offset" default="0.0">`
Complete documentation of various classes 2020-01-08 21:51:16 +00:00			`Time in seconds at which the stream starts after being looped.`
Update docs [ci skip] 2018-01-11 22:38:35 +00:00			`</member>`
Rename every instance of "OGG" to "Ogg" 2022-07-28 18:34:41 +00:00			`<member name="packet_sequence" type="OggPacketSequence" setter="set_packet_sequence" getter="get_packet_sequence">`
			`Contains the raw Ogg data for this stream.`
Replace stb_vorbis with libogg+libvorbis 2021-09-10 01:54:18 +00:00			`</member>`
Update docs [ci skip] 2018-01-11 22:38:35 +00:00			`</members>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</class>`