Packages

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

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

TGrains

PlayBuf

PanAz

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GrainBuf
  2. Serializable
  3. IsIndividual
  4. AudioRated
  5. MultiOut
  6. SomeOut
  7. Lazy
  8. GE
  9. UGenSource
  10. Expander
  11. Lazy
  12. Product
  13. Equals
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val buf: GE
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. val dur: GE
  8. val envBuf: GE
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. lazy val hashCode: Int
    Definition Classes
    UGenSource → AnyRef → Any
  12. val interp: GE
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def makeUGen(_args: Vec[UGenIn]): UGenInLike
    Attributes
    protected
    Definition Classes
    GrainBufUGenSource
  15. 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
    GrainBufExpander
  16. val maxGrains: GE
  17. final def name: String
    Definition Classes
    UGenSource
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. val numChannels: Int
  22. val pan: GE
  23. val pos: GE
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. final def rate: Rate
    Definition Classes
    AudioRated
  26. val speed: GE
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. val trig: GE
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

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