diff options
Diffstat (limited to 'doc/classes/AudioStream.xml')
| -rw-r--r-- | doc/classes/AudioStream.xml | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/classes/AudioStream.xml b/doc/classes/AudioStream.xml index 4abce3f1da..44edff122e 100644 --- a/doc/classes/AudioStream.xml +++ b/doc/classes/AudioStream.xml @@ -57,6 +57,18 @@ Override this method to customize the returned value of [method is_monophonic]. Should return [code]true[/code] if this audio stream only supports one channel. </description> </method> + <method name="can_be_sampled" qualifiers="const" experimental=""> + <return type="bool" /> + <description> + Returns if the current [AudioStream] can be used as a sample. Only static streams can be sampled. + </description> + </method> + <method name="generate_sample" qualifiers="const" experimental=""> + <return type="AudioSample" /> + <description> + Generates an [AudioSample] based on the current stream. + </description> + </method> <method name="get_length" qualifiers="const"> <return type="float" /> <description> @@ -69,6 +81,12 @@ Returns a newly created [AudioStreamPlayback] intended to play this audio stream. Useful for when you want to extend [method _instantiate_playback] but call [method instantiate_playback] from an internally held AudioStream subresource. An example of this can be found in the source code for [code]AudioStreamRandomPitch::instantiate_playback[/code]. </description> </method> + <method name="is_meta_stream" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if the stream is a collection of other streams, [code]false[/code] otherwise. + </description> + </method> <method name="is_monophonic" qualifiers="const"> <return type="bool" /> <description> |