Struct nih_plug::audio_setup::PortNames

pub struct PortNames {
    pub layout: Option<&'static str>,
    pub main_input: Option<&'static str>,
    pub main_output: Option<&'static str>,
    pub aux_inputs: &'static [&'static str],
    pub aux_outputs: &'static [&'static str],
}

Contains names for the ports defined in an AudioIOLayout. Setting these is optional, but it makes working with multi-output plugins much more convenient.

All of these names should start with a capital letter to be consistent with automatically generated names.

Fields

layout: Option<&'static str>

The name for the audio IO layout as a whole. Useful when a plugin has multiple distinct layouts. Will be generated if not set.

main_input: Option<&'static str>

The name for the main input port. Will be generated if not set.

main_output: Option<&'static str>

The name for the main output port. Will be generated if not set.

aux_inputs: &'static [&'static str]

Names for auxiliary (sidechain) input ports. Will be generated if not set or if this slice does not contain enough names.

aux_outputs: &'static [&'static str]

Names for auxiliary output ports. Will be generated if not set or if this slice does not contain enough names.

Implementations

impl PortNames

pub const fn const_default() -> Self

PortNames::default(), but as a const function. Used when initializing Plugin::AUDIO_IO_LAYOUTS. (https://github.com/rust-lang/rust/issues/67792)

Trait Implementations

impl Clone for PortNames

fn clone(&self) -> PortNames

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PortNames

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

Formats the value using the given formatter.

impl Default for PortNames

fn default() -> PortNames

Returns the “default value” for a type.

impl Hash for PortNames

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<PortNames> for PortNames

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

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

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 Copy for PortNames

impl Eq for PortNames

impl StructuralEq for PortNames

impl StructuralPartialEq for PortNames