Improve `pitch_scale` descriptions in AudioStreamPlayer documentation
This closes #29439.
Co-authored-by: Cheeseness <contact@jbushproductions.com>
(cherry picked from commit 4751dee7f4
)
This commit is contained in:
parent
93ba25cfcb
commit
ae0bc06eba
|
@ -61,7 +61,7 @@
|
||||||
If the audio configuration has more than two speakers, this sets the target channels. See [enum MixTarget] constants.
|
If the audio configuration has more than two speakers, this sets the target channels. See [enum MixTarget] constants.
|
||||||
</member>
|
</member>
|
||||||
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">
|
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">
|
||||||
Changes the pitch and the tempo of the audio.
|
The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate.
|
||||||
</member>
|
</member>
|
||||||
<member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">
|
<member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">
|
||||||
If [code]true[/code], audio is playing.
|
If [code]true[/code], audio is playing.
|
||||||
|
|
|
@ -67,7 +67,7 @@
|
||||||
Maximum distance from which audio is still hearable.
|
Maximum distance from which audio is still hearable.
|
||||||
</member>
|
</member>
|
||||||
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">
|
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">
|
||||||
Changes the pitch and the tempo of the audio.
|
The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate.
|
||||||
</member>
|
</member>
|
||||||
<member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">
|
<member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">
|
||||||
If [code]true[/code], audio is playing.
|
If [code]true[/code], audio is playing.
|
||||||
|
|
|
@ -91,7 +91,7 @@
|
||||||
Decides if audio should pause when source is outside of [member max_distance] range.
|
Decides if audio should pause when source is outside of [member max_distance] range.
|
||||||
</member>
|
</member>
|
||||||
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">
|
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">
|
||||||
Changes the pitch and the tempo of the audio.
|
The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate.
|
||||||
</member>
|
</member>
|
||||||
<member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">
|
<member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">
|
||||||
If [code]true[/code], audio is playing.
|
If [code]true[/code], audio is playing.
|
||||||
|
|
Loading…
Reference in New Issue