virtualx-engine/doc/classes/AudioStream.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStream" inherits="Resource" version="4.0">
	<brief_description>
		Base class for audio streams.
	</brief_description>
	<description>
		Base class for audio streams. Audio streams are used for sound effects and music playback, and support WAV (via [AudioStreamSample]) and OGG (via [AudioStreamOGGVorbis]) file formats.
	</description>
	<tutorials>
		<link title="Audio streams">https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link>
		<link title="Audio Generator Demo">https://godotengine.org/asset-library/asset/526</link>
		<link title="Audio Mic Record Demo">https://godotengine.org/asset-library/asset/527</link>
		<link title="Audio Spectrum Demo">https://godotengine.org/asset-library/asset/528</link>
	</tutorials>
	<methods>
		<method name="_get_length" qualifiers="virtual const">
			<return type="float" />
			<description>
			</description>
		</method>
		<method name="_get_stream_name" qualifiers="virtual const">
			<return type="String" />
			<description>
			</description>
		</method>
		<method name="_instance_playback" qualifiers="virtual const">
			<return type="AudioStreamPlayback" />
			<description>
			</description>
		</method>
		<method name="get_length" qualifiers="const">
			<return type="float" />
			<description>
				Returns the length of the audio stream in seconds.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</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 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Update docs to version 4.0 2020-02-01 02:03:48 +01:00			`<class name="AudioStream" inherits="Resource" version="4.0">`
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 22:42:36 +02:00			`<brief_description>`
			`Base class for audio streams.`
			`</brief_description>`
			`<description>`
doc: Fix wrong references found by new makerst.py Thanks @PJB3005 2019-01-07 10:02:04 +01:00			`Base class for audio streams. Audio streams are used for sound effects and music playback, and support WAV (via [AudioStreamSample]) and OGG (via [AudioStreamOGGVorbis]) file formats.`
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 22:42:36 +02:00			`</description>`
			`<tutorials>`
Add link titles for all links in the class reference This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.) 2020-08-05 14:43:40 +02:00			`<link title="Audio streams">https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link>`
Link to demos from within the class reference 2020-10-01 10:34:47 +02:00			`<link title="Audio Generator Demo">https://godotengine.org/asset-library/asset/526</link>`
			`<link title="Audio Mic Record Demo">https://godotengine.org/asset-library/asset/527</link>`
			`<link title="Audio Spectrum Demo">https://godotengine.org/asset-library/asset/528</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 22:42:36 +02:00			`</tutorials>`
			`<methods>`
Implement NativeExtension pointer arguments * Allows calling into native extensions directly with a pointer * Makes it easier to implement some APIs more efficiently * Appears with a "" in the documentation for the argument. Implementing the pointer handling is entirely up to the implementation, although the extension API provides some hint. * AudioStream has been implemented as an example, allowing to create NativeExtension based AudioStreams. 2021-08-23 19:53:27 +02:00			`<method name="_get_length" qualifiers="virtual const">`
			`<return type="float" />`
			`<description>`
			`</description>`
			`</method>`
			`<method name="_get_stream_name" qualifiers="virtual const">`
			`<return type="String" />`
			`<description>`
			`</description>`
			`</method>`
			`<method name="_instance_playback" qualifiers="virtual const">`
			`<return type="AudioStreamPlayback" />`
			`<description>`
			`</description>`
			`</method>`
doc: Sync classref with current source 2018-02-19 10:47:16 +01:00			`<method name="get_length" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 15:28:05 +02:00			`<return type="float" />`
doc: Sync classref with current source 2018-02-19 10:47:16 +01:00			`<description>`
Added description and measurement 2018-07-31 21:20:27 +02:00			`Returns the length of the audio stream in seconds.`
doc: Sync classref with current source 2018-02-19 10:47:16 +01:00			`</description>`
			`</method>`
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 22:42:36 +02:00			`</methods>`
			`<constants>`
			`</constants>`
			`</class>`