Struct SettableElementState

pub struct SettableElementState {
    pub type_specific: Option<SettableTypeSpecificElementState>,
    pub vendor_specific_data: Option<Vec<u8>>,
    pub started: Option<bool>,
    pub bypassed: Option<bool>,
    /* private fields */
}

Processing element state that can be set by clients.

Fields

type_specific: Option<SettableTypeSpecificElementState>

Type-specific element-state parameters that can be set by clients.

If an element is disabled, changes in this field (and all others in SettableElementState) are purely informational and take no effect until the element is enabled.

If not set, then the element’s previous type_specific state is preserved.

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

vendor_specific_data: Option<Vec<u8>>

If included, an opaque object of octets for conveying vendor-specific information from a client to the audio driver. This can be used with any element type, not just VENDOR_SPECIFIC elements.

Optional.

started: Option<bool>

Whether to start or stop this processing element. A stopped processing element does not provide its abstracted functionality. Specifically, no audio data flows through a stopped element.

If the corresponding Element returned can_stop equals to false, then this field must not be set to false – SetElementState will return ZX_ERR_INVALID_ARGS in that case. If not set, then the element’s previous started state will be unchanged.

Optional.

bypassed: Option<bool>

Whether to bypass this processing element. A bypassed element does not affect the flow of audio through the topology. Specifically, audio flows through a bypassed element, without change.

If the corresponding Element omits can_bypass or sets it to false, then this field must not be set to true. If this occurs, SetElementState will fail and return error ZX_ERR_INVALID_ARGS. If not set, then the element’s previous bypassed state will be unchanged.

Optional.

Trait Implementations

impl Clone for SettableElementState

fn clone(&self) -> SettableElementState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SettableElementState

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

Formats the value using the given formatter.

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

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 SettableElementState

fn default() -> SettableElementState

Returns the “default value” for a type.

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

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 SettableElementState

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

type Owned = SettableElementState

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 SettableElementState

type Borrowed<'a> = &'a SettableElementState

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 SettableElementState

impl StructuralPartialEq for SettableElementState