Multimedia - Set volume

Declaration

<AMMULTIMEDIA ACTIVITY="volume" DEVICE="text (options)" VOLUME="text (options)" MUTE="on/off" VALUE="number" />

Related Topics   

Description

Changes volume settings on the computer. Optionally, allows you turn mute on or off.

Practical Usage

See description.

Parameters

General

Property

Type

Required

Default

Markup

Description

Device

Text (options)

Yes

Main Volume

  1. DEVICE="main_volume"

  2. DEVICE="window_sound"

The sound device on the system that should be acted upon. The available options are:

  • Main volume (default) - The master volume control should be adjusted (affects all devices).

  • Window sound - The Windows volume control should be adjusted.

Set volume

Text (options)

No

(Disabled)

  1. VOLUME="set"

  2. VOLUME="increase"

  3. VOLUME="decrease"

If enabled, specifies that the volume should be set to a particular value or increased/decreased by a certain increment. This parameter is disabled by default. The available options are:

  • Set to value - Sets the volume to a particular position as specified in the Adjust parameter. The range is 0-100.

  • Increase - Increases the volume by a the increment specified in the Adjust parameter.

  • Decrease - Decreases the volume by a the increment specified in the Adjust parameter.

Set mute

Text (options)

No

Disabled

  1. MUTE="on"

  2. MUTE="off"

If enabled, turns mute on or off on the specified device. This parameter is disabled by default. The available options are:

  • On - The mute setting will be turned on at runtime.

  • Off - The mute setting will be turned off at runtime.

Adjust

Number

No

Current  

VALUE="50"

The value that the volume should be adjusted in correspondence with the Set volume parameter.

Current

        

Press this button to set the volume to the value currently set for the system. This is a design time parameter, therefore, contains no markups.

Description

Error Causes

On Error

Example

NOTE:
  • The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
  • Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.

Description

This sample task decreases the volume level by 51.

Copy 
<AMMULTIMEDIA ACTIVITY="volume" DEVICE="window_sound" VOLUME="decrease" VALUE="51" />