Packages

c

de.sciss.synth.message

BufferAllocReadChannel

final case class BufferAllocReadChannel(id: Int, path: String, startFrame: Int, numFrames: Int, channels: List[Int], completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

The /b_allocReadChannel message tells the server to allocate memory for a buffer and read in a portion of an audio-file, selecting a subset of its channels. The number of channels is given by the size of the channels argument, and the sample-rate of the buffer is determined by the audio-file.

id

the identifier to use for the buffer. It must denote a currently un-allocated buffer and be greater than or equal to zero and less than the maximum number of buffers.

path

the path of the audio-file to read. Since the server is an independent process, this must resolve with respect to the server's current working directory. If the server is running on a remote node, the path will be resolved in the server's local file system.

startFrame

the offset in frames into the audio-file to begin reading from

numFrames

the number of frames to read which will be the size of the allocated buffer. The special value of -1 denotes that the number of frames available in the file from the given offset is used (the entire file will be read).

channels

a sequence of channel indices to read. Zero corresponds to the first channel of the file.

See also

Buffer#allocReadChannelMsg

BufferFree

BufferAlloc

BufferAllocRead

BufferReadChannel

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BufferAllocReadChannel
  2. Serializable
  3. Product
  4. Equals
  5. HasCompletion
  6. AsyncSend
  7. Send
  8. ServerMessage
  9. Message
  10. Packet
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BufferAllocReadChannel(id: Int, path: String, startFrame: Int, numFrames: Int, channels: List[Int], completion: Option[Packet])

    id

    the identifier to use for the buffer. It must denote a currently un-allocated buffer and be greater than or equal to zero and less than the maximum number of buffers.

    path

    the path of the audio-file to read. Since the server is an independent process, this must resolve with respect to the server's current working directory. If the server is running on a remote node, the path will be resolved in the server's local file system.

    startFrame

    the offset in frames into the audio-file to begin reading from

    numFrames

    the number of frames to read which will be the size of the allocated buffer. The special value of -1 denotes that the number of frames available in the file from the given offset is used (the entire file will be read).

    channels

    a sequence of channel indices to read. Zero corresponds to the first channel of the file.

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. val args: Any*
    Definition Classes
    Message
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val channels: List[Int]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. val completion: Option[Packet]
  9. def encode(c: PacketCodec, b: ByteBuffer): Unit
    Definition Classes
    MessagePacket
  10. def encodedSize(c: PacketCodec): Int
    Definition Classes
    MessagePacket
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(other: Any): Boolean
    Definition Classes
    Message → AnyRef → Any
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    Message → AnyRef → Any
  15. val id: Int
  16. def isComparable(other: Any): Boolean
    Attributes
    protected
    Definition Classes
    Message
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def isSynchronous: Boolean
    Definition Classes
    AsyncSendSend
  19. val name: String
    Definition Classes
    MessagePacket
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. val numFrames: Int
  24. val path: String
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. val startFrame: Int
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    Message → AnyRef → Any
  29. def updateCompletion(completion: Option[Packet]): BufferAllocReadChannel
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. 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 Product

Inherited from Equals

Inherited from HasCompletion

Inherited from AsyncSend

Inherited from Send

Inherited from ServerMessage

Inherited from Message

Inherited from Packet

Inherited from AnyRef

Inherited from Any

Ungrouped