GetVolume

getVolume

Available since: v3.0

Returns the general volume for background music, sound or speech output.

Lua Syntax:

getVolume(type)

Arguments

type

int - The type of volume to return: eMusicVolume (0), eSoundVolume (1), eSpeechVolume (2), eMovieVolume (3) or eGlobalVolume (4).

Return Values

volume

The queried volume.

Examples

Example 1:

-- is music volume over 50%?
if getVolume(eMusicVolume) > 50 then
-- do some action
end

Example 2:

-- is speech volume more than or equal to 80%?
if getVolume(eSpeechVolume) >= 80 then
-- do some action
end

Example 3:

-- is global (master) volume not equal to 50%?
if getVolume(eGlobalVolume) ~= 50 then
-- do some action
end