Struct AddonSignal 

pub struct AddonSignal {
    pub id: &'static str,
    pub name: &'static str,
    pub description: &'static str,
}

A named boolean fact an addon publishes about its target.

FR-062. Recording, streaming, in a call, muted, playing. An overlay can be conditioned on one (ADR-0011), which makes a signal a resolution input and therefore a stronger obligation than FR-047’s display state: a stale label is a cosmetic problem, a stale signal is a device doing the wrong thing.

Boolean, and FR-063 keeps it that way until a specified need exists for more. The same reasoning as the RPC being deliberately small: a value set that grows on speculation grows a conversion for every consumer, and the consumers here include third-party addons.

Fields

id: &'static str

Stable identifier, unqualified — recording, not obs.recording. The addon’s own id qualifies it, so an addon cannot claim a name in another’s space by choosing a clever string.

Stored in configurations, so a rename silently breaks someone’s overlay, exactly as AddonAction::id does.

name: &'static str

What to call it.

description: &'static str

What it means, in a sentence. Shown next to a live value, so it has to say what true means rather than what the signal is about: “Spotify is playing” beats “playback state”.

Trait Implementations

impl Clone for AddonSignal

fn clone(&self) -> AddonSignal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddonSignal

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

Formats the value using the given formatter.

impl PartialEq for AddonSignal

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for AddonSignal

impl Eq for AddonSignal

impl StructuralPartialEq for AddonSignal