Warcraft: Play a short sound from Warcraft

In wolfm4ne/geekr: geekr: Audible Task Notifications

Play a short sound from Warcraft

Description

warcraft plays a short sound which is useful if you want to get notified, for example, when a script has finished. As an added bonus there are a number of different sounds to choose from. If warcraft is not able to play the sound a warning is issued rather than an error. This is in order to not risk aborting or stopping the process that you wanted to get notified about.

Usage

warcraft(sound = 1, expr = NULL)

Arguments

sound

character string or number specifying what sound to be played by either specifying one of the built in sounds, specifying the path to a wav file or specifying an url. The default is 1. Possible sounds are: "jobsdone" "hello" "peasant" "err" "peon" "notready" "complete" "gold" "blacksmith" "lumber" If sound does not match any of the sounds above, or is a valid path or url, a random sound will be played. Currently warcraft can only handle http urls, https is not supported.

expr

An optional expression to be excecuted before the sound.

Examples

# Play an "jobsdone" sound
warcraft()

## Not run: 
# Play "hello" instead of a "jobsdone".
warcraft("hello")
# or
warcraft(2)

# Play a random sound
warcraft(0)

# Update all packages and "ping" when it's ready
update.packages(ask=FALSE); warcraft()

## End(Not run)

wolfm4ne/geekr documentation built on Oct. 3, 2023, 4:44 p.m.