BufferAllocRead

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

See also: BufferRead
BufferAllocReadChannel
BufferAlloc
BufferFree
Buffer#allocReadMsg

Linear Supertypes

Serializable, Serializable, Product, Equals, HasCompletion, AsyncSend, Send, ServerMessage, Message, Packet, AnyRef, Any

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val completion: Option[Packet]

Definition Classes
BufferAllocRead → HasCompletion
def encode(c: PacketCodec, b: ByteBuffer): Unit

Definition Classes
Message → Packet
def encodedSize(c: PacketCodec): Int

Definition Classes
Message → Packet
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(other: Any): Boolean

Definition Classes
Message → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
Message → AnyRef → Any
val id: Int

the identifier to use for the buffer.
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.
def isComparable(other: Any): Boolean

Attributes
protected
Definition Classes
Message
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def isSynchronous: Boolean

Definition Classes
AsyncSend → Send
val name: String

Definition Classes
Message → Packet
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val numFrames: Int

the number of frames to read which will be the size of the allocated buffer.
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).
val path: String

the path of the audio-file to read.
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.
val startFrame: Int

the offset in frames into the audio-file to begin reading from
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(): 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 Doc: package message

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

Instance Constructors

new BufferAllocRead(id: Int, path: String, startFrame: Int, numFrames: Int, completion: Option[Packet])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val args: Any*

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val completion: Option[Packet]

def encode(c: PacketCodec, b: ByteBuffer): Unit

def encodedSize(c: PacketCodec): Int

final def eq(arg0: AnyRef): Boolean

def equals(other: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

val id: Int

def isComparable(other: Any): Boolean

final def isInstanceOf[T0]: Boolean

final def isSynchronous: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val numFrames: Int

val path: String

val startFrame: Int

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

def toString(): String

def updateCompletion(completion: Option[Packet]): BufferAllocRead

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