BufferOps

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   Any

2. final def ##(): Int

   

   Definition Classes

   Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   Any

4. def alloc(numFrames: Int, numChannels: Int = 1, completion: Optional[Packet] = None): Future[Unit]

   

5. def allocRead(path: String, startFrame: Int = 0, numFrames: Int = 1, completion: Optional[Packet] = None): Future[Unit]

   

6. def allocReadChannel(path: String, startFrame: Int = 0, numFrames: Int = 1, channels: Seq[Int], completion: Optional[Packet] = None): Future[Unit]

   

7. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

8. def close(completion: Optional[Packet] = None): Unit

   

9. def fill(data: FillRange*): Unit

   

10. def fill(value: Double): Unit

    

11. def free(completion: Optional[Packet] = None): Unit

    

12. def gen(command: Command): Future[Unit]

    

13. def get(indices: Int*): Future[IndexedSeq[Float]]

    

14. def getClass(): Class[_ <: AnyVal]

    

    Definition Classes

    AnyVal → Any

15. def getData(offset: Int = 0, num: Int = 1): Future[IndexedSeq[Float]]

    

    Retrieves the entire buffer contents.

    Retrieves the entire buffer contents. This is similar to getToFloatArray in sclang. If multiple packets must be sent due to the size, they will be scheduled strictly sequentially. This is safe but potentially slow for large buffers.

    offset

    offset into the buffer in samples; for multi-channel buffers to indicate a specific frame the frame index must be multiplied by the number of channels

    num

    the number of samples to get; for multi-channel buffers to indicate a specific number of frames, the number must be multiplied by the number of channels. The special value -1 means that all samples should be retrieved

16. def getn(pairs: Range*): Future[IndexedSeq[Float]]

    

    Gets ranges of the buffer content and returns them as a future flattened collection.

17. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

18. def play(loop: Boolean = false, amp: Double = 1.0, out: Int = 0): Synth

    

19. def read(path: String, fileStartFrame: Int = 0, numFrames: Int = 1, bufStartFrame: Int = 0, leaveOpen: Boolean = false, completion: Optional[Packet] = None): Future[Unit]

    

20. def readChannel(path: String, fileStartFrame: Int = 0, numFrames: Int = 1, bufStartFrame: Int = 0, leaveOpen: Boolean = false, channels: Seq[Int], completion: Optional[Packet] = None): Future[Unit]

    

21. def set(pairs: FillValue*): Unit

    

    Sets the contents of the buffer by replacing individual sample values.

    Sets the contents of the buffer by replacing individual sample values. An error is thrown if any of the given offsets is out of range.

    pairs

    a list of modifications to the buffer contents, each element being a sample offset and the sample value. The sample offset ranges from zero to the number of samples in the buffer (exclusive), i.e. numChannels * numFrames. For instance, in a stereo-buffer, the offset for the right channel's fifth frame is (5-1) * 2 + 1 = 9.

22. def setData(values: IndexedSeq[Float], offset: Int = 0): Future[Unit]

    

    Transmits a collection to fill the entire buffer contents.

    Transmits a collection to fill the entire buffer contents. This is similar to sendCollection in sclang, If multiple packets must be sent due to the size, they will be scheduled strictly sequentially. This is safe but potentially slow for large buffers.

    values

    the collection to copy into the buffer; values are assumed to be de-interleaved if the buffer has multiple channels.

    offset

    offset into the buffer in samples; for multi-channel buffers to indicate a specific frame the frame index must be multiplied by the number of channels

23. def setn(pairs: (Int, IndexedSeq[Float])*): Unit

    

    Sets the contents of the buffer by replacing individual contiguous chunks of data.

    Sets the contents of the buffer by replacing individual contiguous chunks of data. An error is thrown if any of the given ranges lies outside the valid range of the entire buffer.

    pairs

    a list of modifications to the buffer contents, each element being a sample offset and a chunk of values. The data is channel-interleaved, e.g. for a stereo-buffer, the offset for the right channel's fifth frame is (5-1) * 2 + 1 = 9. Accordingly, values in the float-sequences are considered channel-interleaved, i.e. for a stereo buffer and an even offset, the first element of the sequence refers to frame offset / 2 of the left channel, the second element to frame offset / 2 of the right channel, followed by frame offset / 2 + 1 of the left channel, and so on.

24. def setn(v: IndexedSeq[Float]): Unit

    

    Sets the entire contents of the buffer.

    Sets the entire contents of the buffer. An error is thrown if the number of given values does not match the number of samples in the buffer.

    v

    the new content of the buffer. the size of the sequence must be exactly the number of samples in the buffer, i.e. numChannels * numFrames. Values are channel-interleaved, that is for a stereo-buffer the first element specifies the value of the first frame of the left channel, the second element specifies the value of the first frame of the right channel, followed by the second frame of the left channel, etc.

25. val this: Buffer

    

26. def toString(): String

    

    Definition Classes

    Any

27. def write(path: String, fileType: AudioFileType = io.AudioFileType.AIFF, sampleFormat: SampleFormat = io.SampleFormat.Float, numFrames: Int = 1, startFrame: Int = 0, leaveOpen: Boolean = false, completion: Optional[Packet] = None): Future[Unit]

    

28. def zero(completion: Optional[Packet] = None): Future[Unit]