SoundChannel:setPitch: Difference between revisions

From GiderosMobile
No edit summary
m Text replacement - "</source>" to "</syntaxhighlight>"
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
'''Available since:''' Gideros 2012.09.3<br/>
'''Available since:''' Gideros 2012.09.3<br/>
'''Class:''' [[SoundChannel]]<br/>
=== Description ===
=== 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.  
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}}

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)