Struct sorceress::server::BufferAllocateRead

pub struct BufferAllocateRead { /* fields omitted */ }

Allocate buffer space and reads a sound file.

Allocates buffer with the given number of channels and up to the given numer of frames, depending on the size of the file. Reads sound file data from the given starting frame in the file. If the number of frames argument is less than or equal to zero, the entire file is read. The sound file will determine how many channels are allocated for the buffer.

Asynchronous. Replies to the sender with a Reply::BufferAllocateReadDone message containing the same buffer number specified in this command when complete.

Implementations

impl BufferAllocateRead

pub fn new(
    buffer_number: i32,
    file_path: impl Into<String>
) -> BufferAllocateRead

Creates a new BufferAllocateRead command.

Arguments

• buffer_number - The buffer number.
• file_path - The path to a sound file on the SuperCollider server’s filesystem.

pub fn starting_frame(self, starting_frame: i32) -> BufferAllocateRead

The frame number in the file where SuperCollider will begin reading. Defaults to 0.

pub fn number_of_frames(self, number_of_frames: i32) -> BufferAllocateRead

The maximum number of frames to read from the file. Defaults to 0.

pub fn on_completion(self, message: Vec<u8>) -> BufferAllocateRead

An optional OSC message to execute on completion.

Trait Implementations

impl AsyncCommand for BufferAllocateRead

impl Clone for BufferAllocateRead

fn clone(&self) -> BufferAllocateRead

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Command for BufferAllocateRead

impl Debug for BufferAllocateRead

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<BufferAllocateRead> for BufferAllocateRead

fn eq(&self, other: &BufferAllocateRead) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BufferAllocateRead) -> bool

This method tests for !=.

impl PartialOrd<BufferAllocateRead> for BufferAllocateRead

fn partial_cmp(&self, other: &BufferAllocateRead) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for BufferAllocateRead