Difference between revisions of "SoundChannel:setVolume"
From GiderosMobile
(added example) |
m (Text replacement - "</source>" to "</syntaxhighlight>") |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | '''Available since:''' Gideros 2011.6<br/> | ||
| + | '''Class:''' [[SoundChannel]]<br/> | ||
| − | < | + | === Description === |
| + | Sets the volume of the sound channel. | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | SoundChannel:setVolume(volume,balance) | ||
| + | </syntaxhighlight> | ||
| − | ''' | + | === 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<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 bulletsnd = Sound.new("audio/shoot.wav") | ||
local channel = bulletsnd:play() | local channel = bulletsnd:play() | ||
channel:setVolume(0.5) | 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)
- SoundChannel:getPitch
- SoundChannel:getPosition
- SoundChannel:getStreamId
- SoundChannel:getVolume
- SoundChannel:isLooping
- SoundChannel:isPaused
- SoundChannel:isPlaying
- SoundChannel:setEffect
- SoundChannel:setLooping
- SoundChannel:setPaused
- SoundChannel:setPitch
- SoundChannel:setPosition
- SoundChannel:setVolume
- SoundChannel:setWorldPosition
- SoundChannel:stop
