GrainBuf

A granular synthesis UGen taking sound stored in a buffer. Another buffer can be used to provide an amplitude envelope. The input sound buffer must be monophonic, but output may be multi-channel, using a panorama control.

All arguments except numChannels and maxGrain are polled at grain creation (trigger) time.

numChannels: the number of channels to output. If 1 , a monophonic signal is returned and the pan argument is ignored.
trig: a control- or audio-rate trigger to start a new grain. For audio-rate, timing is sample frame accurate.
dur: grain duration in seconds
buf: buffer holding a mono audio signal portions of which are read as grains
speed: playback speed of the grain, where 1.0 is original rate, 0.5 is half speed etc.
pos: grain start position, where 0 is beginning and 1 is the end of the input buffer
interp: interpolation type when using pitch-shifting via speed . 1 for no interpolation (nearest sample), 2 for linear interpolation, and 4 for cubic interpolation.
pan: panning position when numChannels is greater than one. Equivalent to the pan position of Pan2 (for stereo output) or PanAz (for more than two channels)
envBuf: identifier of a buffer containing a signal to use for the grain envelope. The default value of -1 means that a built-in Hann envelope is used.
maxGrains: maximum number of overlapping grains that can be used at a given time. This value is set at the UGens init time and cannot be modified later. Lower value mean that less memory is used.

See also: PanAz
PlayBuf
TGrains

Linear Supertypes

Serializable, Serializable, IsIndividual, AudioRated, MultiOut, SomeOut, GE.Lazy, GE, UGenSource[UGenInLike], Expander[UGenInLike], Lazy, Product, Equals, AnyRef, Any

Instance Constructors

new GrainBuf(numChannels: Int = 1, trig: GE, dur: GE = 1.0f, buf: GE, speed: GE = 1.0f, pos: GE = 0.0f, interp: GE = 2, pan: GE = 0.0f, envBuf: GE = 1, maxGrains: GE = 512)

numChannels
the number of channels to output. If 1 , a monophonic signal is returned and the pan argument is ignored.
trig
a control- or audio-rate trigger to start a new grain. For audio-rate, timing is sample frame accurate.
dur
grain duration in seconds
buf
buffer holding a mono audio signal portions of which are read as grains
speed
playback speed of the grain, where 1.0 is original rate, 0.5 is half speed etc.
pos
grain start position, where 0 is beginning and 1 is the end of the input buffer
interp
interpolation type when using pitch-shifting via speed . 1 for no interpolation (nearest sample), 2 for linear interpolation, and 4 for cubic interpolation.
pan
panning position when numChannels is greater than one. Equivalent to the pan position of Pan2 (for stereo output) or PanAz (for more than two channels)
envBuf
identifier of a buffer containing a signal to use for the grain envelope. The default value of -1 means that a built-in Hann envelope is used.
maxGrains
maximum number of overlapping grains that can be used at a given time. This value is set at the UGens init time and cannot be modified later. Lower value mean that less memory is used.

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

buffer holding a mono audio signal portions of which are read as grains
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val dur: GE

grain duration in seconds
val envBuf: GE

identifier of a buffer containing a signal to use for the grain envelope.
identifier of a buffer containing a signal to use for the grain envelope. The default value of -1 means that a built-in Hann envelope is used.
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
val interp: GE

interpolation type when using pitch-shifting via speed .
interpolation type when using pitch-shifting via speed . 1 for no interpolation (nearest sample), 2 for linear interpolation, and 4 for cubic interpolation.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def makeUGens: UGenInLike

Abstract method which must be implemented by creating the actual UGens during expansion.
Abstract method which must be implemented by creating the actual UGens during expansion. This method is at most called once during graph expansion
returns
the expanded object (depending on the type parameter U)

Attributes
protected
Definition Classes
GrainBuf → Expander
val maxGrains: GE

maximum number of overlapping grains that can be used at a given time.
maximum number of overlapping grains that can be used at a given time. This value is set at the UGens init time and cannot be modified later. Lower value mean that less memory is used.
final def name: String

Definition Classes
UGenSource
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val numChannels: Int

the number of channels to output.
the number of channels to output. If 1 , a monophonic signal is returned and the pan argument is ignored.
val pan: GE

panning position when numChannels is greater than one.
panning position when numChannels is greater than one. Equivalent to the pan position of Pan2 (for stereo output) or PanAz (for more than two channels)
val pos: GE

grain start position, where 0 is beginning and 1 is the end of the input buffer
final def rate: Rate

Definition Classes
AudioRated
val speed: GE

playback speed of the grain, where 1.0 is original rate, 0.5 is half speed etc.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val trig: GE

a control- or audio-rate trigger to start a new grain.
a control- or audio-rate trigger to start a new grain. For audio-rate, timing is sample frame accurate.
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
@throws( ... )

Related Docs: object GrainBuf | package ugen

final case class GrainBuf(numChannels: Int = 1, trig: GE, dur: GE = 1.0f, buf: GE, speed: GE = 1.0f, pos: GE = 0.0f, interp: GE = 2, pan: GE = 0.0f, envBuf: GE = 1, maxGrains: GE = 512) extends MultiOut with AudioRated with IsIndividual with Product with Serializable

Instance Constructors

new GrainBuf(numChannels: Int = 1, trig: GE, dur: GE = 1.0f, buf: GE, speed: GE = 1.0f, pos: GE = 0.0f, interp: GE = 2, pan: GE = 0.0f, envBuf: GE = 1, maxGrains: GE = 512)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val buf: GE

def clone(): AnyRef

val dur: GE

val envBuf: GE

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val interp: GE

final def isInstanceOf[T0]: Boolean

def makeUGens: UGenInLike

val maxGrains: GE

final def name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val numChannels: Int

val pan: GE

val pos: GE

final def rate: Rate

val speed: GE

final def synchronized[T0](arg0: ⇒ T0): T0

val trig: GE

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from IsIndividual

Inherited from AudioRated

Inherited from MultiOut

Inherited from SomeOut

Inherited from GE.Lazy

Inherited from GE

Inherited from UGenSource[UGenInLike]

Inherited from Expander[UGenInLike]

Inherited from Lazy

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped