classref: Sync with current master branch (8a6c1e8)

This commit is contained in:
Godot Organization
2024-06-22 03:20:34 +00:00
parent 424f8c090a
commit 9ce85882b9
29 changed files with 559 additions and 90 deletions

View File

@@ -59,10 +59,16 @@ Methods
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_is_monophonic<class_AudioStream_private_method__is_monophonic>`\ (\ ) |virtual| |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_be_sampled<class_AudioStream_method_can_be_sampled>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`AudioSample<class_AudioSample>` | :ref:`generate_sample<class_AudioStream_method_generate_sample>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_AudioStream_method_get_length>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` | :ref:`instantiate_playback<class_AudioStream_method_instantiate_playback>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_meta_stream<class_AudioStream_method_is_meta_stream>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monophonic<class_AudioStream_method_is_monophonic>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
@@ -180,6 +186,34 @@ Override this method to customize the returned value of :ref:`is_monophonic<clas
----
.. _class_AudioStream_method_can_be_sampled:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **can_be_sampled**\ (\ ) |const| :ref:`🔗<class_AudioStream_method_can_be_sampled>`
**Experimental:** This method may be changed or removed in future versions.
Returns if the current **AudioStream** can be used as a sample. Only static streams can be sampled.
.. rst-class:: classref-item-separator
----
.. _class_AudioStream_method_generate_sample:
.. rst-class:: classref-method
:ref:`AudioSample<class_AudioSample>` **generate_sample**\ (\ ) |const| :ref:`🔗<class_AudioStream_method_generate_sample>`
**Experimental:** This method may be changed or removed in future versions.
Generates an :ref:`AudioSample<class_AudioSample>` based on the current stream.
.. rst-class:: classref-item-separator
----
.. _class_AudioStream_method_get_length:
.. rst-class:: classref-method
@@ -204,6 +238,18 @@ Returns a newly created :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` in
----
.. _class_AudioStream_method_is_meta_stream:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_meta_stream**\ (\ ) |const| :ref:`🔗<class_AudioStream_method_is_meta_stream>`
Returns ``true`` if the stream is a collection of other streams, ``false`` otherwise.
.. rst-class:: classref-item-separator
----
.. _class_AudioStream_method_is_monophonic:
.. rst-class:: classref-method