Skip to main content

RestartFlags

Struct RestartFlags 

Source
pub struct RestartFlags(/* private fields */);
Expand description

What a plugin asked the host to re-read, reported through IComponentHandler::restartComponent and drained with Plugin::take_restart_flags.

A plugin raises these when something about it changed behind the host’s back — a preset load that renamed its parameters, a mode switch that changed its latency, an oversampling toggle that changed its bus layout. Poll this alongside Plugin::take_parameter_edits and respond directly, or use Plugin::service_host_requests for lifecycle-sensitive changes:

Implementations§

Source§

impl RestartFlags

Source

pub fn bits(self) -> i32

The raw VST3 bitmask (Steinberg::Vst::RestartFlags), for flags this type doesn’t name.

Source

pub fn is_empty(self) -> bool

True when the plugin raised no flags since the last drain.

Source

pub fn param_values_changed(self) -> bool

kParamValuesChanged: parameter values changed (e.g. a preset was loaded).

Source

pub fn reload_component(self) -> bool

kReloadComponent: the component must be recreated by the outer host.

Source

pub fn param_titles_changed(self) -> bool

kParamTitlesChanged: the parameter list itself changed (ids, names, ranges, count).

Source

pub fn latency_changed(self) -> bool

kLatencyChanged: the plugin’s reported latency changed.

Source

pub fn io_changed(self) -> bool

kIoChanged: the plugin’s bus configuration changed.

Source

pub fn midi_cc_assignment_changed(self) -> bool

kMidiCCAssignmentChanged: controller-to-parameter mappings changed.

Source

pub fn note_expression_changed(self) -> bool

kNoteExpressionChanged: note-expression metadata changed.

Source

pub fn io_titles_changed(self) -> bool

kIoTitlesChanged: bus names changed.

Source

pub fn prefetchable_support_changed(self) -> bool

kPrefetchableSupportChanged: prefetch support changed.

Source

pub fn routing_info_changed(self) -> bool

kRoutingInfoChanged: routing metadata changed.

Source

pub fn keyswitch_changed(self) -> bool

kKeyswitchChanged: keyswitch metadata changed.

Source

pub fn param_id_mapping_changed(self) -> bool

kParamIDMappingChanged: processor/controller parameter-id mappings changed.

Trait Implementations§

Source§

impl Clone for RestartFlags

Source§

fn clone(&self) -> RestartFlags

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RestartFlags

Source§

impl Debug for RestartFlags

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RestartFlags

Source§

fn default() -> RestartFlags

Returns the “default value” for a type. Read more
Source§

impl Eq for RestartFlags

Source§

impl PartialEq for RestartFlags

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RestartFlags

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

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

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 T
where T: Clone,

Source§

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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.