class ElementState
Defined at line 3285 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio.signalprocessing/fuchsia.hardware.audio.signalprocessing/cpp/fidl/fuchsia.hardware.audio.signalprocessing/cpp/natural_types.h
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.
Public Methods
void ElementState (Storage_ storage)void ElementState ()Defined at line 3290 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio.signalprocessing/fuchsia.hardware.audio.signalprocessing/cpp/fidl/fuchsia.hardware.audio.signalprocessing/cpp/natural_types.h
void ElementState (ElementState && )Defined at line 3291 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio.signalprocessing/fuchsia.hardware.audio.signalprocessing/cpp/fidl/fuchsia.hardware.audio.signalprocessing/cpp/natural_types.h
void ElementState (const ElementState & other)ElementState & operator= (ElementState && )Defined at line 3292 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio.signalprocessing/fuchsia.hardware.audio.signalprocessing/cpp/fidl/fuchsia.hardware.audio.signalprocessing/cpp/natural_types.h
ElementState & operator= (const ElementState & other)bool operator== (const ElementState & other)bool operator!= (const ElementState & other)bool IsEmpty ()const std::optional< ::fuchsia_hardware_audio_signalprocessing::TypeSpecificElementState> & type_specific ()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.
::std::optional< ::fuchsia_hardware_audio_signalprocessing::TypeSpecificElementState> & type_specific ()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.
ElementState & type_specific (std::optional< ::fuchsia_hardware_audio_signalprocessing::TypeSpecificElementState> value)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.
const std::optional< ::std::vector<uint8_t>> & vendor_specific_data ()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).
::std::optional< ::std::vector<uint8_t>> & vendor_specific_data ()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).
ElementState & vendor_specific_data (std::optional< ::std::vector<uint8_t>> value)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).
const std::optional<bool> & started ()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.
::std::optional<bool> & started ()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.
ElementState & started (std::optional<bool> value)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.
const std::optional<bool> & bypassed ()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.
::std::optional<bool> & bypassed ()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.
ElementState & bypassed (std::optional<bool> value)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.
const std::optional<int64_t> & turn_on_delay ()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.
::std::optional<int64_t> & turn_on_delay ()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.
ElementState & turn_on_delay (std::optional<int64_t> value)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.
const std::optional<int64_t> & turn_off_delay ()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.
::std::optional<int64_t> & turn_off_delay ()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.
ElementState & turn_off_delay (std::optional<int64_t> value)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.
const std::optional<int64_t> & processing_delay ()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.
::std::optional<int64_t> & processing_delay ()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.
ElementState & processing_delay (std::optional<int64_t> value)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.
void ElementState (::fidl::internal::DefaultConstructPossiblyInvalidObjectTag )Friends
class MemberVisitorclass NaturalTableCodingTraits