Volume
(number) The volume level represented by a number between 0 and 255. The value 255 is the loudest.
Re t u r n s
Nothing. You can use Application.GetLastError to determine whether this action failed, and why.
See also: Related Actions
Audio.Stop
OverviewExamples
Audio.Stop ( number Channel )
De s cr ip t ion
Stops playing an audio channel.
P arame t er s
Channel
(number) The audio channel to stop:
|
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. |
Re t u r n s
Nothing. You can use Application.GetLastError to determine whether this action failed, and why.
See also: Related Actions
Audio.ToggleMute
OverviewExamples
Audio.ToggleMute ( number Channel )
De s cr ip t ion
Toggles the sound on or off for the specified audio channels.
P arame t er s
Channel
(number) The audio channel to toggle:
|
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. |
Re t u r n s
Nothing. You can use Application.GetLastError to determine whether this action failed, and why.
See also: Related Actions
Audio.TogglePlay
OverviewExamples
Audio.TogglePlay ( number Channel )
De s cr ip t ion
Toggles an audio channel's playback between playing and paused.
P arame t er s
Channel
(number) The audio channel to play or pause:
|
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. |
Re t u r n s
Nothing. You can use Application.GetLastError to determine whether this action failed, and why.
See also: Related Actions
B u tt o n
Button.GetPos
OverviewExamples
table Button.GetPos ( string ObjectName )
De s cr ip t ion
Returns the X and Y page or dialog coordinates of a button object in pixels. This coordinate refers to the upper left hand corner of the object's bounding box relative to the page or dialog.
Note: The upper left hand corner of a page or dialog has X and Y coordinates of 0.
P arame t er s
ObjectName
(string) The name of the button object.
Re t u r n s
(table) A table containing the object's current coordinates, indexed by values X and Y. If the object cannot be found, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.