Difference between revisions of "SoundChannel:setPitch"

From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight")
Line 5: Line 5:
 
=== Description ===
 
=== Description ===
 
Sets the pitch relative to the pitch of the original sound channel.
 
Sets the pitch relative to the pitch of the original sound channel.
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
SoundChannel:setPitch(pitch)
 
SoundChannel:setPitch(pitch)
 
</source>
 
</source>

Revision as of 15:31, 13 July 2023

Available since: Gideros 2012.09.3
Class: SoundChannel

Description

Sets the pitch relative to the pitch of the original sound channel. <syntaxhighlight lang="lua"> SoundChannel:setPitch(pitch) </source>

Default pitch is 1.

Setting pitch as 0.5 will make the pitch lower.

Setting pitch as 1.5 will make the pitch higher.

Note: you cannot set the pitch of a background music (mp3)

Parameters

pitch: (number) pitch relative to original (0 < lower pitch < 1 < higher pitch)