Zelda: Play a short sound from Zelda

In wolfm4ne/geekr: geekr: Audible Task Notifications

Play a short sound from Zelda

Description

zelda 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 zelda 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

zelda(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: "fanfare" "agahnim" "mudora" "chest" "flute" "heartcontainer" "mushroom" "warp" If sound does not match any of the sounds above, or is a valid path or url, a random sound will be played. Currently zelda can only handle http urls, https is not supported.

expr

An optional expression to be excecuted before the sound.

Examples

# Play a "fanfare" sound
zelda()

## Not run: 
# Play "warp" instead of a "fanfare".
zelda("warp")
# or
zelda(8)

# Play a random sound
zelda(0)

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

## End(Not run)

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