audio.getMinVolume()

Type Function
Library audio.*
Return value Number
Revision 2017.3179
Keywords audio, volume, max volume
See also audio.getMaxVolume()
audio.setMaxVolume()
audio.setVolume()
audio.getVolume()

Overview

Gets the minimum volume for a specific channel. There is no minimum volume for the master volume.

This function returns the channel minimum volume if requesting a channel volume, or the average minimum volume across all channels if { channel=0 } is specified.

Syntax

audio.getMinVolume( { channel=c } )
channel (optional)

Number. The channel number you want to get the minimum volume on. Valid channels are 1 to the maximum number of channels (currently 32). Specifying 0 will return the average volume across all channels.

Example

local channel1MinVolume = audio.getMinVolume( { channel=1 } )