80 lines
2.8 KiB
ReStructuredText
80 lines
2.8 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioStreamRandomPitch.xml.
|
|
|
|
.. _class_AudioStreamRandomPitch:
|
|
|
|
AudioStreamRandomPitch
|
|
======================
|
|
|
|
**Inherits:** :ref:`AudioStream<class_AudioStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
Plays audio with random pitch shifting.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Randomly varies pitch on each start.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------------------+-------------------------------------------------------------------------+---------+
|
|
| :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_property_audio_stream>` | |
|
|
+---------------------------------------+-------------------------------------------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomPitch_property_random_pitch>` | ``1.1`` |
|
|
+---------------------------------------+-------------------------------------------------------------------------+---------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_AudioStreamRandomPitch_property_audio_stream:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`AudioStream<class_AudioStream>` **audio_stream**
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_audio_stream** **(** :ref:`AudioStream<class_AudioStream>` value **)**
|
|
- :ref:`AudioStream<class_AudioStream>` **get_audio_stream** **(** **)**
|
|
|
|
The current :ref:`AudioStream<class_AudioStream>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamRandomPitch_property_random_pitch:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **random_pitch** = ``1.1``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_random_pitch** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_random_pitch** **(** **)**
|
|
|
|
The intensity of random pitch variation.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|