Struct rea_rs::envelope::AutomationItem

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

Implementations

impl<'a, P: KnowsProject, T: ProbablyMutable> AutomationItem<'a, P, T>

pub fn index(&self) -> usize

pub fn n_points(&self, only_visible: bool) -> usize

pub fn get_point(
    &self,
    only_visible: bool,
    point_index: usize
) -> ReaperStaticResult<EnvelopePoint>

if only_visible == true, points will be presented as they are seen in project, including loop, if enabled.

otherwise — raw representation, including those, that are truncated by item bounds.

pub fn get_point_by_time(
    &self,
    only_visible: bool,
    position: impl Into<Position>
) -> ReaperStaticResult<EnvelopePoint>

Get the last point before the given time.

if only_visible == true, points will be presented as they are seen in project, including loop, if enabled.

otherwise — raw representation, including those, that are truncated by item bounds.

pub fn pool_id(&self) -> usize

automation item pool ID (as an integer)

edits are propagated to all other automation items that share a pool ID

pub fn position(&self) -> Position

pub fn length(&self) -> Duration

pub fn start_offset(&self) -> Duration

pub fn play_rate(&self) -> f64

pub fn base_line(&self) -> f64

pub fn amplitude(&self) -> f64

pub fn is_looped(&self) -> bool

pub fn is_selected(&self) -> bool

pub fn pool_length_in_quarters(&self) -> f64

impl<'a, P: KnowsProject> AutomationItem<'a, P, Mutable>

pub fn set_pool_id(&mut self, id: usize)

automation item pool ID (as an integer)

edits are propagated to all other automation items that share a pool ID

pub fn set_position(&mut self, position: Position)

pub fn set_length(&mut self, length: impl GetLength)

pub fn set_play_rate(&mut self, rate: f64)

pub fn set_base_line(&mut self, base_line: f64)

Whatever this means, it should be in range of 0.0 .. 1.0

base line seems to work from API (I can set and read it). But it is not set in interface, and didn’t affected to points in tests.

pub fn set_amplitude(&mut self, amplitude: f64)

Amplitude should be in range of -1.0 .. 1.0

pub fn set_start_offset(&mut self, offset: Duration)

pub fn set_looped(&mut self, looped: bool)

pub fn set_selected(&mut self, selected: bool)

pub fn set_pool_length_in_quarters(&mut self, pool_length_in_quarters: f64)

automation item pooled source length in quarter notes

(setting will affect all pooled instances)

pub fn set_point(
    &mut self,
    only_visible: bool,
    point_index: usize,
    position: Option<Position>,
    point: EnvelopePoint,
    sort: bool
) -> ReaperStaticResult<()>

if only_visible == true, points will be presented as they are seen in project, including loop, if enabled.

otherwise — raw representation, including those, that are truncated by item bounds.

Probably, if position == None — it can lead to moving point to the beginning

pub fn insert_point(
    &mut self,
    only_visible: bool,
    position: Position,
    point: EnvelopePoint,
    sort: bool
) -> ReaperStaticResult<()>

if only_visible == true, points will be presented as they are seen in project, including loop, if enabled.

otherwise — raw representation, including those, that are truncated by item bounds.

pub fn delete_point(
    &mut self,
    only_visible: bool,
    index: usize
) -> ReaperStaticResult<()>

if only_visible == true, points will be presented as they are seen in project, including loop, if enabled.

otherwise — raw representation, including those, that are truncated by item bounds.

pub fn delete_point_range(
    &mut self,
    only_visible: bool,
    start: impl Into<Position>,
    end: impl Into<Position>
) -> ReaperStaticResult<()>

if only_visible == true, points will be presented as they are seen in project, including loop, if enabled.

otherwise — raw representation, including those, that are truncated by item bounds.

pub fn sort_points(&mut self)

Trait Implementations

impl<'a, P: Debug + KnowsProject, T: Debug + ProbablyMutable> Debug for AutomationItem<'a, P, T>

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

Formats the value using the given formatter.