Struct rea_rs::send::TrackSend

pub struct TrackSend<'a, T: ProbablyMutable> { /* private fields */ }

Main Send type, that commonly used.

Use this struct to construct new sends from one Track to another.

Implementations

impl<'a> TrackSend<'a, Mutable>

pub fn create_new(
    source: &Track<'_, Immutable>,
    destination: &Track<'_, Immutable>
) -> Self

The only way to make TrackSend from one track to another.

It should guarantee, that no track, no project itself are not borrowed as mutable (Track<Mutable>). But, actually, it mutates source or destination track.

As TrackSend mutates only the field it responses to, and it almost can not affect other objects state — It uses a hack to mutate <Immutable> tracks. Keep this in mind.

Trait Implementations

impl<'a, T: Debug + ProbablyMutable> Debug for TrackSend<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: ProbablyMutable> GenericSend<'a, T> for TrackSend<'a, T>

fn parent_track(&self) -> &Track<'_, T>

Track that sends outside

fn new(track: &'a Track<'_, T>, index: usize) -> Self

fn index(&self) -> usize

fn get_info_value(&self, param: impl Into<String>) -> f64

Core method to retrieve send properties. With probability of 99% you shouldn’t use it.

fn is_mute(&self) -> bool

fn phase_flipped(&self) -> bool

Phase flipped if true.

fn is_mono(&self) -> bool

Note, that mono parameter is not equal to SendDestChannels and SendSourceChannels is_mono parameters.

fn volume(&self) -> Volume

fn pan(&self) -> Pan

fn pan_law(&self) -> PanLaw

fn send_mode(&self) -> SendMode

fn automation_mode(&self) -> AutomationMode

fn source_channels(&self) -> Option<SendSourceChannels>

If None returned — the audio is off.

fn dest_channels(&self) -> Option<SendDestChannels>

Returns None if source_channels are None.

fn midi_properties(&self) -> Option<SendMIDIProps>

If None is returned — MIDI is off.

fn dest_track(&'a self) -> Option<Track<'_, Immutable>>

fn source_track(&'a self) -> Option<Track<'_, Immutable>>

fn get_envelope(
    &'a self,
    selector: impl Into<EnvelopeSelector>
) -> Option<Envelope<'_, Track<'_, T>, T>>

Selector is either EnvelopeChunk or GUID.

impl<'a> GenericSendMut<'a> for TrackSend<'a, Mutable>

fn delete(self) -> ReaperResult<()>where
    Self: Sized,

Remove send from track. This also drops the value.

fn set_info_value(
    &mut self,
    param: impl Into<String>,
    value: f64
) -> ReaperResult<()>

Core method to set send properties. With probability of 99% you shouldn’t use it.

fn set_mute(&mut self, mute: bool) -> ReaperResult<()>

fn set_phase(&mut self, phase: bool) -> ReaperResult<()>

Phase flipped if true.

fn set_mono(&mut self, mono: bool) -> ReaperResult<()>

fn set_volume(&mut self, volume: impl Into<Volume>) -> ReaperResult<()>

fn set_pan(&mut self, pan: impl Into<Pan>) -> ReaperResult<()>

fn set_pan_law(&mut self, pan_law: PanLaw) -> ReaperResult<()>

fn set_send_mode(&mut self, send_mode: SendMode) -> ReaperResult<()>

fn set_automation_mode(
    &mut self,
    automation_mode: AutomationMode
) -> ReaperResult<()>

Can not set Bypass Use None for default track mode.

fn set_source_channels(
    &mut self,
    channels: Option<SendSourceChannels>
) -> ReaperResult<()>

Pass None if want to turn audio off.

fn set_dest_channels(&mut self, channels: SendDestChannels) -> ReaperResult<()>

If source channels are off it will return ReaperError::InvalidObject

fn set_midi_properties(
    &mut self,
    properties: impl Into<Option<SendMIDIProps>>
) -> ReaperResult<()>

Pass None if want to turn MIDI off.

impl<'a> HasExtState for TrackSend<'a, Mutable>

fn set_ext_value(&self, section: &CStr, key: &CStr, value: *mut i8)

fn get_ext_value(
    &self,
    section: &CStr,
    key: &CStr,
    buf_size: usize
) -> Option<CString>

fn delete_ext_value(&self, section: &CStr, key: &CStr)

impl<'a, T: PartialEq + ProbablyMutable> PartialEq<TrackSend<'a, T>> for TrackSend<'a, T>

fn eq(&self, other: &TrackSend<'a, T>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T: ProbablyMutable> SendIntType for TrackSend<'a, T>

fn as_int_static() -> i32

<0 for receives, 0=sends, >0 for hardware outputs.

fn as_int(&self) -> i32

<0 for receives, 0=sends, >0 for hardware outputs.

impl<'a, T: ProbablyMutable> StructuralPartialEq for TrackSend<'a, T>