Difference between revisions of "SoundChannel:setVolume"

From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2011.6<br/> === Description === <br /> Sets the volume of the sound channel.<br /> <br /> <source lang="lua"> = SoundChannel:setVolume...")
 
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[SoundChannel]]<br/>
 +
 
=== Description ===
 
=== Description ===
<br />
+
Sets the volume of the sound channel.
Sets the volume of the sound channel.<br />
+
<syntaxhighlight lang="lua">
<br />
+
SoundChannel:setVolume(volume,balance)
<source lang="lua">
+
</syntaxhighlight>
= SoundChannel:setVolume(volume,)
+
 
</source>
+
=== Parameters ===
'''volume:''' (number) The new volume of the sound channel. Valid range of this parameter is between 0.0 and 1.0, where 1.0 is the maximum volume value. ''''''<br/>
+
'''volume''': (number) the sound channel new volume. Valid range of this parameter is between 0.0 and 1.0, where 1.0 is the maximum volume value<br/>
 +
'''balance''': (number) the sound channel new balance ('''new Gideros 2022.6''')<br/>
 +
 
 +
=== Example ===
 +
<syntaxhighlight lang="lua">
 +
local bulletsnd = Sound.new("audio/shoot.wav")
 +
local channel = bulletsnd:play()
 +
channel:setVolume(0.5)
 +
</syntaxhighlight>
 +
 
 +
{{SoundChannel}}

Latest revision as of 14:33, 13 July 2023

Available since: Gideros 2011.6
Class: SoundChannel

Description

Sets the volume of the sound channel.

SoundChannel:setVolume(volume,balance)

Parameters

volume: (number) the sound channel new volume. Valid range of this parameter is between 0.0 and 1.0, where 1.0 is the maximum volume value
balance: (number) the sound channel new balance (new Gideros 2022.6)

Example

local bulletsnd = Sound.new("audio/shoot.wav")
local channel = bulletsnd:play()
channel:setVolume(0.5)