SetVolume

setVolume

Available since: v3.0

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

Lua Syntax:

setVolume(type, volume)

Arguments

type

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

volume

int - New value for volume. Must be between 0 and 100.

Return Values

None.

Examples

Example 1: set speech volume to 50%

setVolume(eSpeechVolume, 50)