Struct Sound 

pub struct Sound {
    pub id: String,
    pub name: String,
    pub kind: SoundKind,
    pub path: PathBuf,
    pub plugin_id: Option<String>,
    pub instrument: bool,
    pub category: Option<String>,
    pub tags: Vec<String>,
    pub origin: String,
    pub registry_id: Option<String>,
}

One usable sound.

Fields

id: String

Stable identifier: the plugin id, or a slug of the file name.

name: String

kind: SoundKind

path: PathBuf

The bundle, .sf2, .sfz, or IR file.

plugin_id: Option<String>

instrument: bool

Plays notes (instrument plugins, SoundFonts, SFZ); IRs and effects do not.

category: Option<String>

One of keys, strings, guitar, bass, drums, synth, pad, brass, winds, vocal, fx.

tags: Vec<String>

origin: String

installed, sound-path, or plugin-scan.

registry_id: Option<String>

The registry entry this came from, when installed from the registry.

Implementations

impl Sound

pub fn source(&self) -> String

The explicit source string for this sound (sf2:/path, plugin:/path#id), usable anywhere an instrument name is accepted.

pub fn plugin_ref(&self) -> Option<PluginRef>

For plugin sounds, the reference to hand to crate::render_instrument.

Trait Implementations

impl Clone for Sound

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sound

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sound

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Sound

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Sound

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Sound