RINGTONE Play a ringtone or ringtone file. A ringtone is [a RTTTL format](/wifi-pineapple-pager/device/ringtones/) monophonic series of notes.

When to use it

Use RINGTONE to play a custom (or pre-installed system) ringtone, with optional vibration. Ringtones volume will still be controlled by the users volume preferences.

Syntax

RINGTONE {vibrate} [rtttl or filename]

vibrate

Vibrate in sync with the ringtone. Each note will be treated as a short-duration vibration for the vibration motor.

rtttl or filename required

Play the supplied RTTTL ringtone, or play a RTTTL file.

To play a custom ringtone, use the entire RTTTL ringtone here.

To play a ringtone file, pass the name of the file here. RINGTONE looks for ringtone files in /root/ringtones/.

Results

RINGTONE will exit with an error if another ringtone (or vibration pattern) is currently playing.

Examples

  # Play the default `alert.rtttl` ringtone, with vibration
RINGTONE --vibrate "alert"
  
  # Play a custom ringtone
RINGTONE "custom:d=16,o=4,b=200:8e4,8g4,8a#4,8d5,8b6"