This function is used in Python Scripting.

Description

Tells the computer where the script is running to make a "beep" sound. The computer must have a way of producing sound.

A Word on Scope

While this function is technically scoped for Gateway and Perspective Sessions, it's intended for use in Vision Clients. 

When calling this function from the Gateway scope, the sound will not play unless the operating system has been configured to allow services to play sounds (an uncommon scenario).

When calling this function from Perspective, the script also executes on the Gateway, meaning the caveat above about allowing services to play sounds is a factor. In addition, the sound will play on the Gateway, not the session. To play sounds from a Perspective Session, it's recommended to use the play() component method on the  Perspective Audio  component. 

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.util.beep()

  • Parameters

Nothing

  • Returns

Nothing

  • Scope

Gateway*, Vision Client, Perspective Session*

See A Word on Scope above. 

Code Examples
# This will simply cause the system where the script is being executed to emit a beep sound.
# That system must have a way to produce sound, such as speakers or headphones.

system.util.beep()
Keywords

system util beep, util.beep