Struct sorceress::ugen::In

pub struct In { /* fields omitted */ }

Read signals from an audio or control bus.

In::ar and In::kr read signals from audio and control buses, respectively. (See the Buses chapter of the Getting Started tutorial series for details on buses.)

In::ar and In::kr behave slightly differently with respect to signals left on the bus in the previous calculation cycle.

In::ar can access audio signals that were generated in the current calculation cycle by Synth nodes located earlier in the node tree (see Order of execution). It does not read signals left on an audio bus from the previous calculation cycle. If synth A reads from audio bus 0 and synth B writes to audio bus 0, and synth A is earlier than synth B, In.ar in synth A will read 0’s (silence). This is to prevent accidental feedback. [InFeedback] supports audio signal feedback.

In::kr is for control buses. Control signals may be generated by Synth nodes within the server, or they may be set by the client and expected to hold steady. Therefore, In::kr does not distinguish between “new” and “old” data: it will always read the current value on the bus, whether it was generated earlier in this calculation cycle, left over from the last one, or set by the client.

The hardware input buses begin just after the hardware output buses and can be read from using In::ar (See Server Architecture for more details). The number of hardware input and output buses can vary depending on your Server’s options. For a convenient wrapper class which deals with this issue see SoundIn.

Implementations

impl In

pub fn ar() -> In

Create a UGen that calculates samples at audio rate.

pub fn kr() -> In

Create a UGen that calculates samples at control rate.

pub fn bus(self, value: impl Input) -> Self

The index of the bus to read in from.

pub fn number_of_channels(self, value: usize) -> Self

The number of channels (i.e. adjacent buses) to read in.

You cannot modulate this number by assigning it to an parameter in a synth definition. Defaults to 1.

Trait Implementations

impl Clone for In

fn clone(&self) -> In

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for In

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

Formats the value using the given formatter.

impl Input for In

fn into_value(self) -> Value

Converts the input into a Value.

fn add(self, rhs: impl Input) -> Value

Adds an Input to another.

fn sub(self, rhs: impl Input) -> Value

Subtracts an Input from another.

fn mul(self, rhs: impl Input) -> Value

Multiplies an Input by another.

fn div(self, rhs: impl Input) -> Value

Divides an Input by another using floating point division.

fn idiv(self, rhs: impl Input) -> Value

Divides an Input by another using integer division.

fn modulo(self, divisor: impl Input) -> Value

Modulo operator.

fn madd(self, mul: impl Input, add: impl Input) -> Value

Efficiently multiplies the signal by mul and adds add.

fn midicps(self) -> Value

Converts midi note numbers into cycles per seconds (Hz).

fn cpsmidi(self) -> Value

Converts cycles per seconds (Hz) into midi note numbers.

fn range(self, lo: impl Input, hi: impl Input) -> Value

Scales the output of this UGen to be within the range of lo and hi.

impl PartialEq<In> for In

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

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

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

This method tests for !=.

impl PartialOrd<In> for In

fn partial_cmp(&self, other: &In) -> 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 In