class SettableElementState
Defined at line 3792 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio.signalprocessing/fuchsia.hardware.audio.signalprocessing/cpp/fidl/fuchsia.hardware.audio.signalprocessing/cpp/natural_types.h
Processing element state that can be set by clients.
Public Methods
void SettableElementState (Storage_ storage)void SettableElementState ()Defined at line 3797 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 SettableElementState (SettableElementState && )Defined at line 3798 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 SettableElementState (const SettableElementState & other)SettableElementState & operator= (SettableElementState && )Defined at line 3799 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio.signalprocessing/fuchsia.hardware.audio.signalprocessing/cpp/fidl/fuchsia.hardware.audio.signalprocessing/cpp/natural_types.h
SettableElementState & operator= (const SettableElementState & other)bool operator== (const SettableElementState & other)bool operator!= (const SettableElementState & other)bool IsEmpty ()const std::optional< ::fuchsia_hardware_audio_signalprocessing::SettableTypeSpecificElementState> & type_specific ()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.
::std::optional< ::fuchsia_hardware_audio_signalprocessing::SettableTypeSpecificElementState> & type_specific ()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.
SettableElementState & type_specific (std::optional< ::fuchsia_hardware_audio_signalprocessing::SettableTypeSpecificElementState> value)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.
const std::optional< ::std::vector<uint8_t>> & vendor_specific_data ()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.
::std::optional< ::std::vector<uint8_t>> & vendor_specific_data ()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.
SettableElementState & vendor_specific_data (std::optional< ::std::vector<uint8_t>> value)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.
const std::optional<bool> & started ()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.
::std::optional<bool> & started ()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.
SettableElementState & started (std::optional<bool> value)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.
const std::optional<bool> & bypassed ()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.
::std::optional<bool> & bypassed ()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.
SettableElementState & bypassed (std::optional<bool> value)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.
void SettableElementState (::fidl::internal::DefaultConstructPossiblyInvalidObjectTag )Friends
class MemberVisitorclass NaturalTableCodingTraits