R/playlastrendering.R

In playitbyr: Representing and exploring data through sound

##' Play and save the last audio rendering of a \code{sonify} object
##' 
##' Whenever a \code{sonify} object is rendered, \code{playitbyr}
##' saves an \code{audioSample} object, \code{.LastRendering}, with
##' the audio rendering in the user's workspace for later playback or
##' manipulation.  \code{playLastRendering} and
##' \code{saveLastRendering} are convenience functions to play or save
##' this object, but it can also be manipulated via the functions in
##' the \code{audio} package.
##' 
##' These functions are simply convenience wrappers for
##' \code{\link[audio]{play}} and \code{\link[audio]{save.wave}} in the
##' \code{audio} package.
##' 
##' The behavior of \code{playLastRendering()} depends on the option
##' "audioRendering". If the option is "audio::pr-for-fdsalay",
##' \code{playLastRendering()} uses the \code{play} function from the
##' \code{audio} package (which does not work well on Linux
##' systems). If the option is anything else,
##' \code{playLastRendering()} looks for an audio player set with
##' \code{setPlayer}, renders the \code{audioSample} to a temporary
##' file, and plays it with the player given by
##' \code{\link{setPlayer}}.
##'
##' @rdname playLastRendering
##' @aliases .LastRendering playLastRendering saveLastRendering
##' @param filename A \code{.wav} file to save the \code{audioSample}
##' object to.
##' @return These functions are invoked for their side-effects, which
##' are to play or save the \code{.LastRendering} \code{audioSample}
##' object.
##' @seealso \code{\link[audio]{play}}, \code{\link[audio]{save.wave}},
##' \code{\link{audioSample}}, \code{\link{setPlayer}}
##'
##' @export
##' @usage playLastRendering()
playLastRendering <- function()  play_audioSample(.LastRendering)

##' @rdname playLastRendering
##' @export
saveLastRendering <- function(filename) save.wave(.LastRendering, filename)