Volume Action

Declaration

<AMVOLUME DEVICE="text [options]" VOLUME="text [options]" LEFT="number" RIGHT="number" MUTE="text [options]" TONE="text [options]" BASS="number" TREBLE="number">

See Also

CD Player, Play Audio, Speak

Description

Changes volume and tone settings on the system. Note that the Tone settings are system wide and do not correspond to a selected device.

Practical Usage

See description.

Parameters

General Tab

Device

Text [options], Optional Default-"main"
MARKUP: DEVICE="cd"

Specifies the sound device on the system "mixer" should be acted upon.

The available options are:

Volume

Text [options], Optional Default - "none"
MARKUP: VOLUME="increase"

Specifies whether the volume should be set to a particular value or increased or decreased by a certain increment.

The available options are:

Left

Number, Required
MARKUP: LEFT="50"

Specifies the value that the left speaker should be set to. If the VOLUME= parameter is set to SET then the value represents a 0-100 number with 0 being volume all the way down, and 100 being maximum. If the VOLUME= parameter is set to increase or decrease then this number represents the amount of "ticks" that the volume should be incremented or decremented by.

Right

Number, Required
MARKUP: RIGHT="50"

Specifies the value that the right speaker should be set to. If the VOLUME= parameter is set to SET then the value represents a 0-100 number with 0 being volume all the way down, and 100 being maximum. If the VOLUME= parameter is set to increase or decrease then this number represents the amount of "ticks" that the volume should be incremented or decremented by.

Mute

text [options], Optional - Default - on
MARKUP: MUTE="on"

Turns mute on or off on the specified device.

The available options are:

Tone

Text [options], Optional Default - "none"
MARKUP: TONE="increase"

Specifies whether the tone should be set to a particular value or increased or decreased by a certain increment. Tone adjustments are not specific to one device.

The available options are:

Bass

Number, Required
MARKUP: VOLUME="60"

Specifies the value that the Treble should be set to. If the TONE= parameter is set to SET then the value represents a 0-100 number with 0 representing the bass all the way down, and 100 being maximum. If the TONE= parameter is set to increase or decrease then this number represents the amount of "ticks" that the bass should be incremented or decremented by.

Treble

Number, Required
MARKUP: VOLUME="60"

Specifies the value that the Treble should be set to. If the TONE= parameter is set to SET then the value represents a 0-100 number with 0 representing the treble all the way down, and 100 being maximum. If the TONE= parameter is set to increase or decrease then this number represents the amount of "ticks" that the treble should be incremented or decremented by.

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMVOLUME VOLUME="set" LEFT="68" RIGHT="68">

<AMVOLUME VOLUME="set" LEFT="68" RIGHT="68" TONE="increase" BASS="86" TREBLE="100">