ProTrackR2 (version 0.1.1)

play: Play a ProTrackR2 class objects as audio

Description

Renders a ProTrackR2 class object as audio::audioSample() and plays it.

Usage

# S3 method for pt2mod
play(x, duration = NA, options = pt2_render_options(), position = 0L, ...)
# S3 method for pt2samp
play(x, duration = 5, options = pt2_render_options(), note = "C-3", ...)
# S3 method for pt2patlist
play(x, duration = NA, options = pt2_render_options(), samples, ...)
# S3 method for pt2pat
play(x, duration = NA, options = pt2_render_options(), samples, ...)
# S3 method for pt2celllist
play(x, duration = 5, options = pt2_render_options(), samples, ...)
# S3 method for pt2cell
play(x, duration = 5, options = pt2_render_options(), samples, ...)

Value

Returns an [audio::$.audioInstance] object which allows you to control the playback (pause, resume, rewind).

Arguments

x

Object to be played.

duration

Duration of the rendered output in seconds. When set to NA the duration of the module is calculated and used for rendering.

options

A list of options used for rendering the audio. Use pt2_render_options() to obtain default options, or modify them.

position

Starting position in the pattern sequence table (pt2_pattern_table()). Should be a non negative value smaller than the mule length (pt2_length()).

...

Arguments passed to pt2_render().

note

Note to be played when x is a pt2samp class object. Defaults to "C-3".

samples

When rendering or playing patterns (or elements of it), samples are needed to interpret the pattern. Pass the samples as a sample list (class pt2samplist).

Author

Pepijn de Vries

Examples

if (interactive()) {
  mod <- pt2_read_mod(pt2_demo())

  ## ctrl will contain the audioInstance that will let
  ## you control the audio playback:
  ctrl <- play(mod)

  ## You can also play individual samples
  samp <- mod$samples[[3]]
  play(samp, note = "C-2")
  play(samp, note = "E-2")
  play(samp, note = "G-2")
  
  ## As well as an individual pattern
  play(mod$patterns[[1]], samples = mod$samples)
  
  ## Or a subset of a pattern
  play(mod$patterns[[1]][17:32, 1:2], samples = mod$samples)
  
  ## Or even an individual cell
  play(mod$patterns[[1]][1, 1][[1]], samples = mod$samples)
}