Audio.Load

OverviewExamples

Audio.Load (

number Channel,

string Filename,

boolean PlayAutomatic = false,

boolean Loop = false )

Description

Loads an audio file into an audio channel.

Parameters

Channel

(number) The audio channel to load the file into:

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.

Filename

(string) The path to the audio file. Click the browse button to select a file. You can also stream an audio file from a web address, for example, http://www.indigorose.com/songs/myfile.ogg

Note: The following audio formats are supported in AutoPlay Media Studio: .wav, .raw, .ogg.

PlayAutomatic

(boolean) Whether to automatically start playing the audio file after it loads:

VALUE	DESCRIPTION
true	Automatically start playing the file.
false	Don't play the file until told to do so. (Default)

Loop

(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.
false	Don't loop. (Default)

Returns

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