Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiSetBeepVolume

hiSetBeepVolume( 
[ x_loudness ]
) 
=> t

Description

Sets the loudness of the beep when a default in the system is detected.

Argument

x_loudness

An integer representing the loudness of the beep. x_loudness ranges from -100 (silence) to 100 (full volume).

The default is zero. Setting x_loudness to zero causes the beep to be at the system default loudness. The absolute value of a negative number is the percentage from the system default loudness toward silence, and a positive number is the percentage from the system default loudness toward full volume. The amount of loudness control is system dependent. For example, Sun systems have the same volume for values -99 through 100, but other systems may have a wide range of volume.

If you set x_loudness to an integer less than -100, it is set to -100. If you set it to an integer more than 100, it is set to 100.

Related Topics

General Environmental Functions


Return to top
 ⠀
X