loopStart: The loop start position of a PTSample

In ProTrackR: Manipulate and Play 'ProTracker' Modules

The loop start position of a PTSample

Description

Extract or replace the loop start position of a PTSample.

Usage

## S4 method for signature 'PTSample'
loopStart(sample)

## S4 replacement method for signature 'PTSample'
loopStart(sample) <- value

Arguments

sample	A PTSample for which the loop start position needs to be extracted or replace.
value	An even numeric value giving the loop starting position in samples ranging from 0 up to 131070. The sum of the loopStart and loopLength should not exceed the sampleLength. Use a value of either character "off" or logical "FALSE", in order to turn off the loop all together.

Details

PTSamples can have loops, marked by a starting position and length of the loop (in samples), for more details see the PTSample-class. This method can be used to extract the loop starting position or safely replace its value.

Value

For loopStart the loop start position (in samples), represented by an even integer value ranging from 0 up to 131070, is returned.

For loopStart<- A PTSample sample, updated with the loop start position 'value', is returned.

Author(s)

Pepijn de Vries

See Also

Other sample.operations: PTSample-class, PTSample-method, fineTune(), loopLength(), loopSample(), loopState(), name, playSample(), read.sample(), sampleLength(), volume(), waveform(), write.sample()

Other loop.methods: loopLength(), loopSample(), loopState()

Examples

data("mod.intro")

## get the loop start position of the
## first sample of mod.intro:

loopStart(PTSample(mod.intro, 1))

## Let's change the starting position of
## the loop to 500

loopStart(PTSample(mod.intro, 1)) <- 500

## Let's turn off the loop all together:

loopStart(PTSample(mod.intro, 1)) <- FALSE

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