asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/AudioStream.xml

56 lines
2.2 KiB
XML
Raw Normal View History

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" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 14:18:53 +01:00
<class name="AudioStream" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../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 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>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 10:43:07 +01:00
<link title="Audio streams">$DOCS_URL/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>
Add polyphony to Audio Stream Player nodes
2021-08-28 06:51:03 +02:00
<method name="_is_monophonic" qualifiers="virtual const">
<return type="bool" />
<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>
Add missing binding to AudioStream class This allows for the extension of AudioStream where you can call `instance_plackback` on child AudioStream instances within gdscript, much like the implementation of some child classes in C++. See `AudioStreamRandomPitch` for an example of how this can be used.
2022-02-11 06:01:04 +01:00
<method name="instance_playback">
<return type="AudioStreamPlayback" />
<description>
Returns an AudioStreamPlayback. Useful for when you want to extend `_instance_playback` but call `instance_playback` from an internally held AudioStream subresource. An example of this can be found in the source files for `AudioStreamRandomPitch::instance_playback`.
</description>
</method>
Add polyphony to Audio Stream Player nodes
2021-08-28 06:51:03 +02:00
<method name="is_monophonic" qualifiers="const">
<return type="bool" />
<description>
Returns true if this audio stream only supports monophonic playback, or false if the audio stream supports polyphony.
</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>
</class>
Reference in a new issue Copy permalink