Struct reaper_medium::VstPluginContext

source · [−]

pub struct VstPluginContext<'a> { /* private fields */ }

Expand description

Additional data available in the context of VST plug-ins.

Implementations

source

impl<'a> VstPluginContext<'a>

source

pub fn new(low: &'a VstPluginContext) -> Self

Creates a medium-level VST plug-in context from the given low-level VST plug-in context.

source

pub unsafe fn host_callback(
    self,
    effect: mut AEffect,
    opcode: i32,
    index: i32,
    value: isize,
    ptr: mut c_void,
    opt: f32
) -> isize

Generic host callback function for communicating with REAPER from the VST plug-in.

This is just a pass-through to the VST host callback.

Safety

REAPER can crash if you pass an invalid pointer.

source

pub unsafe fn request_containing_project(
self,
effect: NonNull<AEffect>
) -> ReaProject

Returns the REAPER project in which the given VST plug-in is running.

Safety

REAPER can crash if you pass an invalid pointer.

source

pub unsafe fn request_containing_track(
self,
effect: NonNull<AEffect>
) -> Option<MediaTrack>

Returns the REAPER track on which the given VST plug-in resides.

Returns None if the given plug-in is not running as track FX.

Safety

REAPER can crash if you pass an invalid pointer.

source

pub unsafe fn request_containing_take(
self,
effect: NonNull<AEffect>
) -> Option<MediaItemTake>

Returns the REAPER take in which the given VST plug-in resides.

Returns None if the given plug-in is not running as take FX.

Safety

REAPER can crash if you pass an invalid pointer.

source

pub unsafe fn request_containing_fx_location(
self,
effect: NonNull<AEffect>
) -> Option<TrackFxLocation>

Returns the location in the FX chain at which the given VST plug-in currently resides.

Supported since REAPER v6.11. Returns None if not supported.

Don’t let the fact that this returns a TrackFxLocation confuse you. It also works for take and monitoring FX. If this is a take FX, it will return the index as variant NormalFxChain. If this is a monitoring FX, it will return the index as variant InputFxChain.

Safety

REAPER can crash if you pass an invalid pointer.

source

pub unsafe fn request_containing_track_channel_count(
self,
effect: NonNull<AEffect>
) -> i32

Returns the channel count of the REAPER track which contains the given VST plug-in.

Returns 0 if the given plug-in is not running as track FX.

Safety

REAPER can crash if you pass an invalid pointer.

Trait Implementations

source

impl<'a> Clone for VstPluginContext<'a>

source

fn clone(&self) -> VstPluginContext<'a>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<'a> Debug for VstPluginContext<'a>

source

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

Formats the value using the given formatter. Read more

source

impl<'a> PartialEq<VstPluginContext<'a>> for VstPluginContext<'a>

source

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

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

1.0.0 · source

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. Read more

source

impl<'a> StructuralPartialEq for VstPluginContext<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for VstPluginContext<'a>

impl<'a> Send for VstPluginContext<'a>

impl<'a> Sync for VstPluginContext<'a>

impl<'a> Unpin for VstPluginContext<'a>

impl<'a> UnwindSafe for VstPluginContext<'a>

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> Downcast for Twhere
T: Any,

source

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

source

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

source

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

source

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

source

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct reaper_medium::VstPluginContext

Implementations

impl<'a> VstPluginContext<'a>

pub fn new(low: &'a VstPluginContext) -> Self

pub unsafe fn host_callback( self, effect: *mut AEffect, opcode: i32, index: i32, value: isize, ptr: *mut c_void, opt: f32) -> isize

pub unsafe fn request_containing_project( self, effect: NonNull<AEffect>) -> ReaProject

pub unsafe fn request_containing_track( self, effect: NonNull<AEffect>) -> Option<MediaTrack>

pub unsafe fn request_containing_take( self, effect: NonNull<AEffect>) -> Option<MediaItemTake>

pub unsafe fn request_containing_fx_location( self, effect: NonNull<AEffect>) -> Option<TrackFxLocation>

pub unsafe fn request_containing_track_channel_count( self, effect: NonNull<AEffect>) -> i32

Trait Implementations

impl<'a> Clone for VstPluginContext<'a>

fn clone(&self) -> VstPluginContext<'a>

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

impl<'a> Debug for VstPluginContext<'a>

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

impl<'a> PartialEq<VstPluginContext<'a>> for VstPluginContext<'a>

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

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

impl<'a> Copy for VstPluginContext<'a>

impl<'a> Eq for VstPluginContext<'a>

impl<'a> StructuralEq for VstPluginContext<'a>

impl<'a> StructuralPartialEq for VstPluginContext<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for VstPluginContext<'a>

impl<'a> Send for VstPluginContext<'a>

impl<'a> Sync for VstPluginContext<'a>

impl<'a> Unpin for VstPluginContext<'a>

impl<'a> UnwindSafe for VstPluginContext<'a>

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub unsafe fn host_callback(
self,
effect: mut AEffect,
opcode: i32,
index: i32,
value: isize,
ptr: mut c_void,
opt: f32
) -> isize

pub unsafe fn request_containing_project(
self,
effect: NonNull<AEffect>
) -> ReaProject

pub unsafe fn request_containing_track(
self,
effect: NonNull<AEffect>
) -> Option<MediaTrack>

pub unsafe fn request_containing_take(
self,
effect: NonNull<AEffect>
) -> Option<MediaItemTake>

pub unsafe fn request_containing_fx_location(
self,
effect: NonNull<AEffect>
) -> Option<TrackFxLocation>

pub unsafe fn request_containing_track_channel_count(
self,
effect: NonNull<AEffect>
) -> i32

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T> Downcast for Twhere
T: Any,

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,