Audio.SetVolume

Audio.SetVolume ( 

number Channel,

number Volume )

Description

Sets the volume level of an audio channel.

Parameters

Channel

(number) The audio channel to set the volume for:

CONSTANT

VALUE

DESCRIPTION

CHANNEL_BACKGROUND

5

Background audio channel.

CHANNEL_EFFECTS

0

Effects channel (used for mouse over, down, and click sounds).

CHANNEL_NARRATION

6

Narration channel (used for voice overs).

CHANNEL_USER1

1

User channel 1.

CHANNEL_USER2

2

User channel 2.

CHANNEL_USER3

3

User channel 3.

CHANNEL_USER4

4

User channel 4.

CHANNEL_ALL

-3

All audio channels.

Volume

(number) The volume level represented by a number between 0 and 255. The value 255 is the loudest.

Returns

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

See also: Related Actions