Difference between revisions of "SoundChannel:setVolume"

From GiderosMobile
(removed language stuff)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[SoundChannel]]<br/>
  
<languages />
+
=== Description ===
 
+
Sets the volume of the sound channel.
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
 
'''<translate>Class</translate>:''' [[Special:MyLanguage/SoundChannel|SoundChannel]]<br/>
 
 
 
=== <translate>Description</translate> ===
 
<translate>Sets the volume of the sound channel.</translate>
 
<br/>
 
 
<source lang="lua">
 
<source lang="lua">
SoundChannel:setVolume(volume)
+
SoundChannel:setVolume(volume)
 
</source>
 
</source>
  
=== <translate>Example</translate> ===
+
=== Example ===
 
<source lang="lua">
 
<source lang="lua">
 
local bulletsnd = Sound.new("audio/shoot.wav")
 
local bulletsnd = Sound.new("audio/shoot.wav")
Line 20: Line 16:
 
</source>
 
</source>
  
=== <translate>Parameters</translate> ===
+
=== Parameters ===
'''volume''': (number) <translate>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.</translate>
+
'''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/>
<br/>
 
  
 
{{SoundChannel}}
 
{{SoundChannel}}

Revision as of 01:19, 3 September 2021

Available since: Gideros 2011.6
Class: SoundChannel

Description

Sets the volume of the sound channel.

SoundChannel:setVolume(volume)

Example

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

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