Struct SystemEffect 

pub struct SystemEffect {
    pub id: Clsid,
    pub controllable: bool,
    pub state: SystemEffectState,
}

One system effect this APO advertises to the audio engine via IAudioSystemEffects2::GetEffectsList and (when this APO supports per-effect toggling) IAudioSystemEffects3::GetControllableSystemEffectsList.

The Windows audio engine surfaces these in the Sound Settings UI; users can see the effect by name (resolved via the per-effect ID in the audio property store) and — for effects marked controllable — toggle each independently.

The framework’s default ProcessingObject::system_effects returns an empty slice, so an APO advertises no enumerable effects unless it overrides the method. That matches the historical behaviour of a v1-only IAudioSystemEffects marker.

Fields

id: Clsid

Unique identifier for this effect within the APO. The audio engine pairs this with the friendly name in the per-endpoint AudioSystemEffects_PropertyStore to render the UI.

controllable: bool

true if the audio engine may call SetAudioSystemEffectState on this effect at runtime. false means the effect is always on and the Sound Settings UI hides the toggle.

state: SystemEffectState

Initial state of the effect, also surfaced through GetControllableSystemEffectsList.

Implementations

impl SystemEffect

pub const fn new(id: Clsid) -> Self

Construct an effect descriptor from its unique ID. Defaults to non-controllable, On state — the v1/v2 behaviour where effects are always-on markers in the discovery list.

pub const fn with_controllable(self, controllable: bool) -> Self

Builder-style: mark this effect as user-controllable.

pub const fn with_state(self, state: SystemEffectState) -> Self

Builder-style: set the initial state.

Trait Implementations

impl Clone for SystemEffect

fn clone(&self) -> SystemEffect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemEffect

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

Formats the value using the given formatter.

impl Hash for SystemEffect

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 for SystemEffect

fn eq(&self, other: &SystemEffect) -> 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 SystemEffect

impl Eq for SystemEffect

impl StructuralPartialEq for SystemEffect