Struct Equalizer

pub struct Equalizer {
    pub bands: Option<Vec<EqualizerBand>>,
    pub supported_controls: Option<EqualizerSupportedControls>,
    pub can_disable_bands: Option<bool>,
    pub min_frequency: Option<u32>,
    pub max_frequency: Option<u32>,
    pub max_q: Option<f32>,
    pub min_gain_db: Option<f32>,
    pub max_gain_db: Option<f32>,
    /* private fields */
}

Parameters for a Element with type equal to EQUALIZER.

Fields

bands: Option<Vec<EqualizerBand>>

Equalizers in this protocol are built by a number of bands, each specifying a number of parameters here and EqualizerElementState that can be changed with SetElementState. The number of elements of the bands vector determines the number of bands supported by this processing element.

Required.

supported_controls: Option<EqualizerSupportedControls>

The controls supported by this equalizer.

Optional.

can_disable_bands: Option<bool>

If included and true, individual bands can be disabled via SetElementState. If not included or false, the bands are always enabled. For a band to be functional its enclosing equalizer processing element has to be enabled.

Optional.

min_frequency: Option<u32>

Minimum frequency for the bands in Hz.

Required.

max_frequency: Option<u32>

Maximum frequency for the bands in Hz.

Required.

max_q: Option<f32>

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

Optional.

min_gain_db: Option<f32>

Minimum gain in dB.

Optional, but required if supported_controls is present and includes SUPPORTS_TYPE_PEAK, SUPPORTS_TYPE_LOW_SHELF or SUPPORTS_TYPE_HIGH_SHELF.

max_gain_db: Option<f32>

Maximum gain in dB.

Optional, but required if supported_controls is present and includes SUPPORTS_TYPE_PEAK, SUPPORTS_TYPE_LOW_SHELF or SUPPORTS_TYPE_HIGH_SHELF.

Trait Implementations

impl Clone for Equalizer

fn clone(&self) -> Equalizer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Equalizer

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

Formats the value using the given formatter.

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

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 Equalizer

fn default() -> Equalizer

Returns the “default value” for a type.

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

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 Equalizer

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

type Owned = Equalizer

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 Equalizer

type Borrowed<'a> = &'a Equalizer

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 Equalizer

impl StructuralPartialEq for Equalizer