Fine tune a PTSample

Extract or replace the fine tune value of a PTSample.

Usage

# S4 method for PTSample
fineTune(sample)

# S4 method for PTSample,numeric
fineTune(sample) <- value

Arguments

sample

A PTSample for which the fine tune value needs to be extracted or replace.

value

A numeric value ranging from -8 up to 7, representing the fine tune.

Value

For fineTune the fine tune value, represented by an integer value ranging from -8 up to 7, is returned.

For fineTune<- A PTSample

sample, updated with the fine tune value, is returned.

Details

PTSamples can be tuned with their fine tune values. The values range from -8 up to 7 and affect the playback sample rate of specific notes (see period_table). This method can be used to extract this value, or to safely replace it.

See also

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

Author

Pepijn de Vries

Examples

data("mod.intro")

## get the finetune of the first sample of mod.intro:

fineTune(PTSample(mod.intro, 1))
#> [1] 0

## Let's tweak the finetune of the first sample of
## mod.intro to -1:

fineTune(PTSample(mod.intro, 1)) <- -1