SoundChannel:setPitch: Difference between revisions

From GiderosMobile
removed language stuff
m Text replacement - "</source>" to "</syntaxhighlight>"
 
(2 intermediate revisions by 2 users not shown)
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>
</syntaxhighlight>


Default pitch is 1.  
Default pitch is 1.  
Line 18: Line 18:


=== Parameters ===
=== Parameters ===
'''pitch''': (number) pitch relative to original (1 < - higher pitch, 1 > 0 lower pitch)<br/>
'''pitch''': (number) pitch relative to original (0 < lower pitch < 1 < higher pitch)<br/>


{{SoundChannel}}
{{SoundChannel}}

Latest revision as of 13:33, 13 July 2023

Available since: Gideros 2012.09.3
Class: SoundChannel

Description

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)

Parameters

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