Audio.SetLooping

Audio.SetLooping (

number Channel,

boolean Looping = true )

Description

Turns looping on or off for an audio channel.

Note: When looping is turned on, any audio file that plays in that channel will restart automatically when it reaches the end.

Note: Looping only works using local files, and will not work with an audio file from a web address.

Parameters

Channel

(number) The audio channel to change:

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.

Looping

(boolean) Whether to make the audio file loop when it reaches the end:

Note: Looping only works using local files, and will not work with an audio file from a web address.

VALUE

DESCRIPTION

true

Loop. (Default)

false

Don't loop.

Returns

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

See also: Related Actions