Difference between revisions of "SoundChannel:setPitch"

Latest revision as of 15:33, 13 July 2023

Available since: Gideros 2012.09.3
Class: SoundChannel

Sets the pitch relative to the pitch of the original sound channel.

SoundChannel:setPitch(pitch)

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)

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

@@ Line 1: / Line 1: @@
 __NOTOC__
 '''Available since:''' Gideros 2012.09.3<br/>
+'''Class:''' [[SoundChannel]]<br/>
 === Description ===
-<br />
+Sets the pitch relative to the pitch of the original sound channel.
-Sets the pitch relative to the pitch of the original sound channel.
+<syntaxhighlight lang="lua">
+SoundChannel:setPitch(pitch)
+</syntaxhighlight>
 Default pitch is 1.
-Setting pitch as 0.5 will make the pitch lower
-Setting pitch as 1.5 will make the pitch higher
+Setting pitch as 0.5 will make the pitch lower.
-You cannot set the pitch of a background music (mp3).<br />
-<br />
+Setting pitch as 1.5 will make the pitch higher.
-<source lang="lua">
- SoundChannel:setPitch(pitch)
+'''Note''': you cannot set the pitch of a background music (mp3)
-</source>
-'''pitch''': (number) pitch relative to original (1 < - higher pitch, 1 > 0 lower pitch) ''''''<br/>
+=== Parameters ===
+'''pitch''': (number) pitch relative to original (0 < lower pitch < 1 < higher pitch)<br/>
+{{SoundChannel}}