final case class PlayBuf(rate: Rate, numChannels: Int, buf: GE, speed: GE = 1.0f, trig: GE = 1, offset: GE = 0.0f, loop: GE = 1, doneAction: GE = doNothing) extends MultiOut with HasSideEffect with IsIndividual with HasDoneFlag with Product with Serializable
A UGen to play back samples from a buffer in memory.
PlayBuf provides a kind of high-level interface to sample-playback, whereas
BufRd represents a kind of lower-level access. While BufRd has a
random-access-pointer in the form of a phase input, PlayBuf advances the phase
automatically based on a given playback speed. PlayBuf uses cubic
interpolation.
- numChannels
the number of channels that the buffer will be. Since this is a constant, a change in number of channels of the underlying bus must be reflected by creating different SynthDefs. If a buffer identifier is used of a buffer that has a different numChannels then specified in the PlayBuf, it will fail silently.
- buf
the identifier of the buffer to use
- speed
1 advances the play head by the server's sample rate each second. So 2 means doubling speed (and pitch), and 0.5 means half speed (and half pitch). Negative numbers can be used for backwards playback. If the underlying buffer represents a sound at a different sample rate, the rate should be multiplied by
BufRateScale.kr(buf)to obtain the correct speed.- trig
a trigger which causes a jump to the given
offset. A trigger occurs when a signal changes from non-positive to positive (e.g. <= 0 to > 0).- offset
sample frame to start playback. This is read when a trigger occurs. It may be fractional.
- loop
1 to loop after the play head reaches the buffer end, 0 to not loop. This can be modulated.
- doneAction
what to do when the play head reaches the buffer end. This is only effective when
loopis zero.
- Alphabetic
- By Inheritance
- PlayBuf
- Serializable
- Serializable
- HasDoneFlag
- IsIndividual
- HasSideEffect
- MultiOut
- SomeOut
- Lazy
- GE
- UGenSource
- Expander
- Lazy
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
PlayBuf(rate: Rate, numChannels: Int, buf: GE, speed: GE = 1.0f, trig: GE = 1, offset: GE = 0.0f, loop: GE = 1, doneAction: GE = doNothing)
- numChannels
the number of channels that the buffer will be. Since this is a constant, a change in number of channels of the underlying bus must be reflected by creating different SynthDefs. If a buffer identifier is used of a buffer that has a different numChannels then specified in the PlayBuf, it will fail silently.
- buf
the identifier of the buffer to use
- speed
1 advances the play head by the server's sample rate each second. So 2 means doubling speed (and pitch), and 0.5 means half speed (and half pitch). Negative numbers can be used for backwards playback. If the underlying buffer represents a sound at a different sample rate, the rate should be multiplied by
BufRateScale.kr(buf)to obtain the correct speed.- trig
a trigger which causes a jump to the given
offset. A trigger occurs when a signal changes from non-positive to positive (e.g. <= 0 to > 0).- offset
sample frame to start playback. This is read when a trigger occurs. It may be fractional.
- loop
1 to loop after the play head reaches the buffer end, 0 to not loop. This can be modulated.
- doneAction
what to do when the play head reaches the buffer end. This is only effective when
loopis zero.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val buf: GE
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
- val doneAction: GE
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
lazy val
hashCode: Int
- Definition Classes
- UGenSource → AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val loop: GE
-
def
makeUGen(_args: Vec[UGenIn]): UGenInLike
- Attributes
- protected
- Definition Classes
- PlayBuf → UGenSource
-
def
makeUGens: UGenInLike
Abstract method which must be implemented by creating the actual
UGens during expansion. -
final
def
name: String
- Definition Classes
- UGenSource
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val numChannels: Int
- val offset: GE
- val rate: Rate
- val speed: GE
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val trig: GE
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )