Struct DynamicsBandState

pub struct DynamicsBandState {

    pub id: Option<u64>,
    pub min_frequency: Option<u32>,
    pub max_frequency: Option<u32>,
    pub threshold_db: Option<f32>,
    pub threshold_type: Option<ThresholdType>,
    pub ratio: Option<f32>,
    pub knee_width_db: Option<f32>,
    pub attack: Option<i64>,
    pub release: Option<i64>,
    pub output_gain_db: Option<f32>,
    pub input_gain_db: Option<f32>,
    pub level_type: Option<LevelType>,
    pub lookahead: Option<i64>,
    pub linked_channels: Option<bool>,
    /* private fields */
}

State for a single band within an Element with type equal to DYNAMICS. Servers may include control band fields even if the values are not able to be changed by the client (i.e. the bits are not set in supported_controls).

Fields

id: Option<u64>

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

min_frequency: Option<u32>

Minimum frequency for the band in Hz. This field could be 0, for instance for single band dynamics processing to specify (together with max_frequency) that the band is full range.

max_frequency: Option<u32>

Maximum frequency for the band in Hz. This field could be the Nyquist frequency, for instance for single band dynamics processing to specify (together with min_frequency) that the band is full range.

Required.

threshold_db: Option<f32>

The value beyond which the dynamics main processing starts (subject to the knee_width_db), in input dB. Some signal processing like input_gain and output_gain are not affected by this value.

Required.

threshold_type: Option<ThresholdType>

Dynamics processing is applied ABOVE or BELOW the threshold.

Required for a server. A client must not include this field in a SetElementState if DynamicsSupportedControls.THRESHOLD_TYPE is not set in supported_controls.

ratio: Option<f32>

The input-to-output dB ratio above or below (see threshold_type) the knee region.

Required.

knee_width_db: Option<f32>

The width of the knee region, in input dB. If present, cannot be negative. If not included, the width of the knee region is unspecified. A value of zero is a “hard” knee; larger values lead to “softer” knees. This knee is centered on threshold_db.

Optional. A client must not include this field in a SetElementState if DynamicsSupportedControls.KNEE_WIDTH is not set in supported_controls.

attack: Option<i64>

Attack time. If not included, the attack time is unspecified.

Optional. A client must not include this field in a SetElementState if DynamicsSupportedControls.ATTACK is not set in supported_controls.

release: Option<i64>

Release time. If not included, the release time is unspecified.

Optional. A client must not include this field in a SetElementState if DynamicsSupportedControls.RELEASE is not set in supported_controls.

output_gain_db: Option<f32>

Output (a.k.a. make up or post) gain value in dB. If not included, the output gain is unspecified.

Optional. A client must not include this field in a SetElementState if DynamicsSupportedControls.OUTPUT_GAIN is not set in supported_controls.

input_gain_db: Option<f32>

input (a.k.a. pre) gain value in dB. If not included, the input gain is unspecified.

Optional. A client must not include this field in a SetElementState if DynamicsSupportedControls.INPUT_GAIN is not set in supported_controls.

level_type: Option<LevelType>

Level type (peak or RMS). If not included, the level type is unspecified.

Optional. A client must not include this field in a SetElementState if DynamicsSupportedControls.LEVEL_TYPE is not set in supported_controls.

lookahead: Option<i64>

Look-ahead time. If not included, the look-ahead time is unspecified.

Optional. A client must not include this field in a SetElementState if DynamicsSupportedControls.LOOKAHEAD is not set in supported_controls.

linked_channels: Option<bool>

Linked channels (a.k.a. Stereo linked for 2-channel systems). If not included, the linked channels option is unspecified. If true, the dynamics response is applied to all channels. If false, each channel has its own dynamics response.

Optional. A client must not include this field in a SetElementState if DynamicsSupportedControls.LINKED_CHANNELS is not set in supported_controls.

Trait Implementations

impl Clone for DynamicsBandState

fn clone(&self) -> DynamicsBandState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicsBandState

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

Formats the value using the given formatter.

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

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 DynamicsBandState

fn default() -> DynamicsBandState

Returns the “default value” for a type.

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

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 DynamicsBandState

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

type Owned = DynamicsBandState

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 DynamicsBandState

type Borrowed<'a> = &'a DynamicsBandState

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 DynamicsBandState

impl StructuralPartialEq for DynamicsBandState