playMod: Play PTModule objects

playModR Documentation

Play PTModule objects

Description

Converts PTModule objects into audio Waves, and plays them.

Usage

## S4 method for signature 'PTModule'
playMod(mod, wait = T, ...)

Arguments

mod

A PTModule object to be played.

wait

A logical value. When set to TRUE the playing routine will wait with executing any code until the playing is finished. When set to FALSE, subsequent R code will be executed while playing.

...

Arguments that are passed on to modToWave.

Details

Unfortunately, it was not feasible to create a routine that can directly interpret PTModule objects and play them simultaneously. Instead, the audio first needs to be rendered after which it can be played. This method therefore first calls modToWave and then playWave. Rendering may take some time and requires some balance between speed, quality and accuracy. See the documentation of the modToWave method for the control you have on these aspects.

Value

A Wave object, generated from the mod object, is returned.

Author(s)

Pepijn de Vries

See Also

Other play.audio.routines: playSample(), playWave()

Other module.operations: PTModule-class, appendPattern(), clearSamples(), clearSong(), deletePattern(), fix.PTModule(), modToWave(), moduleSize(), patternLength(), patternOrderLength(), patternOrder(), playingtable(), rawToPTModule(), read.module(), trackerFlag(), write.module()

Examples

## Not run: 
data("mod.intro")

## play the module and capture the audio Wave
wav <- playMod(mod.intro)

## End(Not run)

ProTrackR documentation built on Aug. 23, 2023, 1:07 a.m.