Struct ElementState

pub struct ElementState {
    pub type_specific: Option<TypeSpecificElementState>,
    pub enabled: Option<bool>,
    pub latency: Option<Latency>,
    pub vendor_specific_data: Option<Vec<u8>>,
    pub started: Option<bool>,
    pub bypassed: Option<bool>,
    pub turn_on_delay: Option<i64>,
    pub turn_off_delay: Option<i64>,
    pub processing_delay: Option<i64>,
    /* private fields */
}

The current state of an element, as returned from the driver. Note that this table contains fields that are not present in SettableElementState, since they cannot be changed by clients.

Fields

type_specific: Option<TypeSpecificElementState>

Type-specific state parameters for the processing element.

If this processing element is disabled and its type-specific state is provided, then the type-specific state is only informational (e.g. the state of a stopped element, if it were to be re-started without also providing additional superceding state information).

Required for DAI_INTERCONNECT, DYNAMICS, EQUALIZER, GAIN and VENDOR_SPECIFIC elements. Invalid if specified for elements of type AUTOMATIC_GAIN_CONTROL, AUTOMATIC_GAIN_LIMITER, CONNECTION_POINT, DELAY, MUTE, RING_BUFFER or SAMPLE_RATE_CONVERSION.

enabled: Option<bool>

Enable/disable state for the processing element.

Deprecation

Use bypassed instead.

latency: Option<Latency>

How much latency this element adds, if enabled.

Deprecation

Use processing_delay instead.

vendor_specific_data: Option<Vec<u8>>

If included, an opaque object of octets for conveying vendor-specific information from the driver to SignalProcessing clients.

Optional (permitted even if the element’s type is not VENDOR_SPECIFIC).

started: Option<bool>

The start/stop state for this processing element. If true, the hardware associated with the element is started. If false, it is stopped.

If the corresponding Element omitted can_stop or set it to false, then this field can never be false.

A stopped processing element does not provide its abstracted functionality. No audio data flows through stopped elements.

Required.

bypassed: Option<bool>

The bypass state for this processing element. If true, the hardware associated with the element is bypassed. If false or missing, the associated hardware is not bypassed.

By default, processing elements are not bypassed. If the corresponding Element omitted can_bypass or set it to false, then this field can never be set to true.

A bypassed element does not affect the flow of audio through the topology. Audio flows through a bypassed element, unchanged.

Optional.

turn_on_delay: Option<i64>

If included, the driver’s best estimate of the amount of time it takes the element’s hardware to enter a fully operational mode after started has changed from false to true. Hardware may require some duration to reach a fully operational mode after changing its power state, for example.

If turn_on_delay is not taken into account, then an audio stream’s initial frames might be lost while audio elements are powering up. If not included, turn_on_delay is unknown.

Optional. If specified, must be non-negative.

turn_off_delay: Option<i64>

If included, the driver’s best estimate of the amount of time it takes the element’s hardware to enter a fully disabled mode after started has changed from true to false. Hardware may require some duration to get into a fully stopped state after a change in power state, for example.

If turn_off_delay is not taken into account, more frames will be emitted/captured than a client might expect, while audio elements are powering down. If not included, turn_off_delay is unknown.

Optional. If specified, must be non-negative.

processing_delay: Option<i64>

If included, the driver’s best estimate of the delay added by this processing element, as it is currently configured (including bypassed state).

This value should be taken into account by timing-sensitive clients, when determining the requirements for (playback) minimum lead time and minimum capture delay.

For an element of type RING_BUFFER, this delay should not include the inherent delay added by the temporary buffering needed to copy data in and out of a ring buffer, which is contained in the RingBufferProperties field driver_transfer_bytes.

Optional. If specified, must be non-negative.

Trait Implementations

impl Clone for ElementState

fn clone(&self) -> ElementState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ElementState

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

Formats the value using the given formatter.

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

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 ElementState

fn default() -> ElementState

Returns the “default value” for a type.

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

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 ElementState

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

type Owned = ElementState

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 ElementState

type Borrowed<'a> = &'a ElementState

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 ElementState

impl StructuralPartialEq for ElementState