final case class BufferAllocRead(id: Int, path: String, startFrame: Int, numFrames: Int, completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable
The /b_allocRead message tells the server to allocate memory for a buffer and read
in a portion of an audio-file. The number of channels
and the sample-rate of the buffer are determined by that 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 less than or equal to zero denotes that the number of frames available in the file from the given offset is used (the entire file will be read).
- Alphabetic
- By Inheritance
- BufferAllocRead
- Serializable
- Product
- Equals
- HasCompletion
- AsyncSend
- Send
- ServerMessage
- Message
- Packet
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new BufferAllocRead(id: Int, path: String, startFrame: Int, numFrames: 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 less than or equal to zero denotes that the number of frames available in the file from the given offset is used (the entire file will be read).
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
- val args: Any*
- Definition Classes
- Message
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val completion: Option[Packet]
- Definition Classes
- BufferAllocRead → HasCompletion
- def encode(c: PacketCodec, b: ByteBuffer): Unit
- def encodedSize(c: PacketCodec): Int
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(other: Any): Boolean
- Definition Classes
- Message → AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- Message → AnyRef → Any
- val id: Int
- def isComparable(other: Any): Boolean
- Attributes
- protected
- Definition Classes
- Message
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def isSynchronous: Boolean
- val name: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val numFrames: Int
- val path: String
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val startFrame: Int
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- Message → AnyRef → Any
- def updateCompletion(completion: Option[Packet]): BufferAllocRead
- Definition Classes
- BufferAllocRead → HasCompletion
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated