_{Official ZPE/YASS documentation}System

Module description

Provides access to operating-system controls, desktop actions, audio controls, power information, input simulation, notifications, and session operations.

Availability: ZPE 1.14.11 is the first version to support the System module.

Module functions

The following is a list of all functions available in this module.

• audio_devices [1.14.11+]

  Lists audio output devices detected by the operating system.

• get_display_bit_depth [1.14.5+]

  Gets the bit-depth of the display.

• get_display_height [1.14.5+]

  Gets the height of the display.

• get_display_refresh_rate [1.14.5+]

  Gets the refresh rate of the display.

• get_display_width [1.14.5+]

  Gets the width of the display.

• get_environment_variables [1.14.5+]

  Returns a map of all environment variables and their values.

• get_mouse_position [1.14.5+]

  Returns the current mouse position.

• get_volume [1.14.11+]

  Returns the system output volume from 0 to 100.

• is_command_line [1.14.5+]

  Returns whether the application is running in command line mode.

• is_headless [1.14.5+]

  Returns whether the application is running in headless mode.

• is_native [1.14.5+]

  Returns whether the application is running in native image (ZPEX) mode.

• key_press [1.14.5+]

  Simulates a keyboard key press.

• lock_screen [1.14.5+]

  Locks the current user session.

• logout [1.14.11+]

  Logs out the current user session.

• mute [1.14.5+]

  Mutes or unmutes the system volume.

  This functionality was originally available as a predefined function from ZPE 1.1, before it became a function of the System module.

• notification [1.14.5+]

  Displays a desktop notification.

• open [1.14.11+]

  Opens a local path or URL using the operating system's default application.

• power_status [1.14.11+]

  Returns battery availability, charge level, charging state, and AC power state.

• set_audio_device [1.14.11+]

  Selects the named system audio output device.

• set_volume [1.14.11+]

  Alias for volume(). Sets the system output volume from 0 to 100.

• shutdown [1.14.5+]

  Runs a shutdown action using a System constant such as System::SHUTDOWN, System::RESTART, System::SLEEP, System::HIBERNATE, or System::ABORT_SHUTDOWN.

  This functionality was originally available as a predefined function from ZPE 1.1, before it became a function of the System module.

• volume [1.14.5+]

  Sets the system output volume from 0 to 100.

  This functionality was originally available as a predefined function from ZPE 1.1, before it became a function of the System module.

Module constants

The following is a list of all constants available in this module.

• ABORT_SHUTDOWN
• HIBERNATE
• RESTART
• SHUTDOWN
• SLEEP