Extract or replace the loop length of a PTSample
.
Usage
# S4 method for PTSample
loopLength(sample)
# S4 method for PTSample
loopLength(sample) <- value
Arguments
- sample
A
PTSample
for which the loop length needs to be extracted or replace.- value
An even
numeric
value giving the loop length in samples ranging from 2 up to 131070 (It can be 0 when the sample is empty). The sum of theloopStart
andloopLength
should not exceed thesampleLength
.Use a
value
of eithercharacter
"off"
orlogical
FALSE
, in order to turn off the loop all together.
Value
For loopLength
the loop length (in samples), represented by
an even integer
value ranging from 0 up to 131070, is returned.
For loopLength<-
A PTSample
sample
, updated
with the loop length value
, is returned.
Details
PTSample
s can have loops, marked by a starting position
and length of the loop (in samples), for more details see the
PTSample
. This method can be used to extract
the loop length or safely replace its value.
See also
Other loop.methods:
loopSample()
,
loopStart()
,
loopState()
Other sample.operations:
PTSample-class
,
PTSample-method
,
fineTune()
,
loopSample()
,
loopStart()
,
loopState()
,
name
,
playSample()
,
read.sample()
,
sampleLength()
,
volume()
,
waveform()
,
write.sample()