Struct EqualizerBandState

pub struct EqualizerBandState {
    pub id: Option<u64>,
    pub type_: Option<EqualizerBandType>,
    pub frequency: Option<u32>,
    pub q: Option<f32>,
    pub gain_db: Option<f32>,
    pub enabled: Option<bool>,
    /* private fields */
}

State for a single band within a Element with type equal to EQUALIZER.

Fields

id: Option<u64>

Unique ID for the band. Must match one of the ids specified in Equalizer bands.

Required.

type_: Option<EqualizerBandType>

Type of band.

Required. If this is a call to SetElementState, then the corresponding SUPPORTS_TYPE_... EqualizerSupportedControls bit for type must be set in Element.supported_controls.

frequency: Option<u32>

Center frequency for the band.

Required. If this is a call to SetElementState and represents a change in this band’s frequency, then CAN_CONTROL_FREQUENCY must be set in Element.supported_controls.

q: Option<f32>

Quality factor, usually denoted as “Q”. Indicates how narrow the frequency transition is. Higher Q values imply narrower notches/peaks and steeper cuts/shelves. Must be positive.

Optional. If used in SetElementState and represents a change in this band’s q, then CAN_CONTROL_Q must be set in Element.supported_controls. Must be finite.

gain_db: Option<f32>

Gain in dB.

Required, for EqualizerBandType of PEAK, LOW_SHELF and HIGH_SHELF. Must be finite. Disallowed, for EqualizerBandType of NOTCH, LOW_CUT and HIGH_CUT.

enabled: Option<bool>

Enable/disable the band. If disabled, audio still flows through the equalizer but this band has no effect.

If absent in the return value from WatchElementState, the band is enabled. If omitted in a SetElementState call, the band’s enable/disable state is unchanged.

Bypassing the entire enclosing processing element (by setting ElementState.bypassed to true) does not change this field’s value, although for an equalizer band to be functional, its enclosing equalizer processing element must be both started and not bypassed.

Optional.

Trait Implementations

impl Clone for EqualizerBandState

fn clone(&self) -> EqualizerBandState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EqualizerBandState

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<EqualizerBandState, D> for EqualizerBandState

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for EqualizerBandState

fn default() -> EqualizerBandState

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<EqualizerBandState, D> for &EqualizerBandState

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for EqualizerBandState

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

type Owned = EqualizerBandState

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for EqualizerBandState

type Borrowed<'a> = &'a EqualizerBandState

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for EqualizerBandState

impl StructuralPartialEq for EqualizerBandState