ADDRESS VOX Commands › Voice Commands › SETVOLUME Command

SETVOLUME Command

The SETVOLUME command adjusts a voice channel's volume level for all subsequent voice message plays (until you change or cancel the volume setting).

This command has the following format:

ADDRESS VOX "SETVOLUME CHANNEL(channelhandle) VOLUME(volumelevel)
  [SYSTEM(sysname)]"

CHANNEL

Specifies the specific, physical channel on which to adjust the volume. Valid values range from 1 through the number of lines installed.

VOLUME

Specifies the degree of volume adjustment (in decibels) between (-10) and (+10) at which CA Automation Point plays the voice file on the specified channel.

(The SETVOLUME command does not modify the voice file in any way.)

Specifies the volume adjustment values are absolute, not relative. Specifying VOLUME(0) resets the volume to the default level.

Default: 0

SYSTEM

(Optional) Specifies the name of the system that is running the notification server to which you want to direct the command.

The sysname value can contain up to eight alphanumeric characters.

Default: The local system name.

Return Information:

After the SETVOLUME command executes, it sets the special REXX return code variable RC.

• If the command executes successfully, the RC variable contains a value of zero.
• If the command does not execute successfully, the RC variable contains one of the following values: 5102, 5104, 5155, 5199, 5201. (See the Message Reference Guide for further information.) Additionally, the VOX.ERROR variable contains the complete VOX error message ID, which includes the four-digit return code and complete error message text.

Example:

The following REXX code illustrates how to use the SETVOLUME command to set a voice channel so that it plays voice messages at a higher volume level than the one at which it was recorded. After the specified voice messages play, the SETVOLUME command executes again to reset the voice channel.

/* Get exclusive access to a specific voice channel. */

address vox 'getchannel channelnum(1) prefix(handle)'
...

/* Set the volume adjustment on the associated channel so that */
/* voice files play 10 dB louder than they were recorded. */

address vox 'setvolume channel('handle') volume(10)'

/* Play messages from nonindexed voice files. */

address vox 'play channel('handle') file(atten.vox warning.vox)' 
...

/* Reset the volume adjustment on the associated channel so that */
/* voice files play at the volume at which they were recorded.   */

address vox 'setvolume channel('handle') volume(0)'
...

/* Release the voice channel. */

address vox 'releasechannel channel('handle')'