godot-docs/classes/class_audiostreamrandompitch.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioStreamRandomPitch.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_AudioStreamRandomPitch:

AudioStreamRandomPitch
======================

**Inherits:** :ref:`AudioStream<class_AudioStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

Plays audio with random pitch shifting.

Properties
----------

+---------------------------------------+-------------------------------------------------------------------------+------+
| :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_property_audio_stream>` | null |
+---------------------------------------+-------------------------------------------------------------------------+------+
| :ref:`float<class_float>`             | :ref:`random_pitch<class_AudioStreamRandomPitch_property_random_pitch>` | 1.1  |
+---------------------------------------+-------------------------------------------------------------------------+------+

Description
-----------

Randomly varies pitch on each start.

Property Descriptions
---------------------

.. _class_AudioStreamRandomPitch_property_audio_stream:

- :ref:`AudioStream<class_AudioStream>` **audio_stream**

+-----------+-------------------------+
| *Default* | null                    |
+-----------+-------------------------+
| *Setter*  | set_audio_stream(value) |
+-----------+-------------------------+
| *Getter*  | get_audio_stream()      |
+-----------+-------------------------+

The current :ref:`AudioStream<class_AudioStream>`.

.. _class_AudioStreamRandomPitch_property_random_pitch:

- :ref:`float<class_float>` **random_pitch**

+-----------+-------------------------+
| *Default* | 1.1                     |
+-----------+-------------------------+
| *Setter*  | set_random_pitch(value) |
+-----------+-------------------------+
| *Getter*  | get_random_pitch()      |
+-----------+-------------------------+

The intensity of random pitch variation.