Struct Manifest 

pub struct Manifest {

    pub id: String,
    pub name: String,
    pub version: String,
    pub description: String,
    pub api: u32,
    pub subscribe: Vec<String>,
    pub audio_formats: Vec<String>,
    pub config: Option<Value>,
    pub system_config: Option<Value>,
    pub homepage: String,
    pub repository: String,
    pub authors: Vec<String>,
    pub license: String,
    pub page: Option<Page>,
    pub contribute: Vec<Contribution>,
    pub live_settings: bool,
}

Who a plugin is and what it wants — printed by plugin --describe.

Fields

id: String

Unique, lowercase, a-z0-9- (the registry key and the install folder).

name: String

Shown in the interface.

version: String

Semver of the plugin.

description: String

api: u32

The protocol version the plugin speaks (API_VERSION).

subscribe: Vec<String>

Topics (topic) to receive. Nothing else is sent — or even built.

audio_formats: Vec<String>

Extra audio formats (format) for call.concluded. The recorder encodes each call once for every plugin that asks, when it can.

config: Option<Value>

JSON Schema of the plugin’s settings (an object), for the settings form.

system_config: Option<Value>

JSON Schema of the settings the plugin takes for each system (an object); the form repeats it under each system.

homepage: String

repository: String

authors: Vec<String>

license: String

page: Option<Page>

A page of its own in the interface, in the navigation, for settings too many for its card (rules, destinations, …). None: its card in Setup is enough.

contribute: Vec<Contribution>

Buttons it adds elsewhere in the interface, each adding an item to its settings from what it’s on (Contribution).

live_settings: bool

It takes new settings while it runs (HostMessage::Settings): changing its own settings doesn’t restart it, or anything else.

Implementations

impl Manifest

pub fn subscribes(&self, topic: &str) -> bool

pub fn wants_format(&self, format: &str) -> bool

Trait Implementations

impl Clone for Manifest

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 Manifest

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

Formats the value using the given formatter.

impl Default for Manifest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Manifest

where Manifest: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Manifest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Manifest

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 Manifest