class StreamProperties

Defined at line 10606 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

Public Members

static const fidl_type_t * FidlType

Public Methods

bool IsEmpty ()

Returns whether no field is set.

StreamProperties & set_unique_id (::std::array<uint8_t, 16> _value)

StreamProperties & set_is_input (bool _value)

StreamProperties & set_can_mute (bool _value)

StreamProperties & set_can_agc (bool _value)

StreamProperties & set_min_gain_db (float _value)

StreamProperties & set_max_gain_db (float _value)

StreamProperties & set_gain_step_db (float _value)

StreamProperties & set_plug_detect_capabilities (::fuchsia::hardware::audio::PlugDetectCapabilities _value)

StreamProperties & set_manufacturer (::std::string _value)

StreamProperties & set_product (::std::string _value)

StreamProperties & set_clock_domain (uint32_t _value)

void StreamProperties ()

void StreamProperties (StreamProperties && other)

void ~StreamProperties ()

StreamProperties & operator= (StreamProperties && other)

::std::unique_ptr<StreamProperties> New ()

void Encode (::fidl::Encoder * _encoder, size_t _offset, std::optional< ::fidl::HandleInformation> maybe_handle_info)

void Decode (::fidl::Decoder * _decoder, StreamProperties * _value, size_t _offset)

zx_status_t Clone (StreamProperties * _result)

const ::std::array<uint8_t, 16> & unique_id ()

A unique identifier. If not included, there is no unique id for this StreamConfig.

See `unique_id.fidl` for considerations about specific pre-defined values and ranges.

Optional.

Defined at line 10616 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool has_unique_id ()

Defined at line 10620 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

::std::array<uint8_t, 16> * mutable_unique_id ()

A unique identifier. If not included, there is no unique id for this StreamConfig.

See `unique_id.fidl` for considerations about specific pre-defined values and ranges.

Optional.

Defined at line 10628 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

void clear_unique_id ()

Defined at line 10636 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

const bool & is_input ()

Driver type is input (true) or output (false)

Required.

Defined at line 10647 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool has_is_input ()

Defined at line 10651 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool * mutable_is_input ()

Driver type is input (true) or output (false)

Required.

Defined at line 10658 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

void clear_is_input ()

Defined at line 10666 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

const bool & can_mute ()

Gain mute capability. If not included, the StreamConfig can't mute.

Optional.

Defined at line 10677 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool has_can_mute ()

Defined at line 10681 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool * mutable_can_mute ()

Gain mute capability. If not included, the StreamConfig can't mute.

Optional.

Defined at line 10688 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

void clear_can_mute ()

Defined at line 10696 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

const bool & can_agc ()

Automatic Gain Control (AGC) capability. If not included, the StreamConfig can't AGC.

Optional.

Defined at line 10707 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool has_can_agc ()

Defined at line 10711 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool * mutable_can_agc ()

Automatic Gain Control (AGC) capability. If not included, the StreamConfig can't AGC.

Optional.

Defined at line 10718 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

void clear_can_agc ()

Defined at line 10726 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

const float & min_gain_db ()

Minimum gain in decibels.

Required.

Defined at line 10737 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool has_min_gain_db ()

Defined at line 10741 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

float * mutable_min_gain_db ()

Minimum gain in decibels.

Required.

Defined at line 10748 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

void clear_min_gain_db ()

Defined at line 10756 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

const float & max_gain_db ()

Maximum gain in decibels.

Required.

Defined at line 10767 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool has_max_gain_db ()

Defined at line 10771 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

float * mutable_max_gain_db ()

Maximum gain in decibels.

Required.

Defined at line 10778 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

void clear_max_gain_db ()

Defined at line 10786 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

const float & gain_step_db ()

Gain step in decibels, this value must not be negative, but may be zero to convey an

effectively continuous range of values. Must not exceed `max_gain_db` - `min_gain_db`.

Required.

Defined at line 10798 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool has_gain_step_db ()

Defined at line 10802 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

float * mutable_gain_step_db ()

Gain step in decibels, this value must not be negative, but may be zero to convey an

effectively continuous range of values. Must not exceed `max_gain_db` - `min_gain_db`.

Required.

Defined at line 10810 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

void clear_gain_step_db ()

Defined at line 10818 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

const ::fuchsia::hardware::audio::PlugDetectCapabilities & plug_detect_capabilities ()

Plug Detect Capabilities.

Required.

Defined at line 10829 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool has_plug_detect_capabilities ()

Defined at line 10833 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

::fuchsia::hardware::audio::PlugDetectCapabilities * mutable_plug_detect_capabilities ()

Plug Detect Capabilities.

Required.

Defined at line 10840 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

void clear_plug_detect_capabilities ()

Defined at line 10848 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

const ::std::string & manufacturer ()

UI string for the manufacturer name. If not included, the manufacturer is unspecified.

If included, this string must be non-empty.

Optional.

Defined at line 10860 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool has_manufacturer ()

Defined at line 10864 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

::std::string * mutable_manufacturer ()

UI string for the manufacturer name. If not included, the manufacturer is unspecified.

If included, this string must be non-empty.

Optional.

Defined at line 10872 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

void clear_manufacturer ()

Defined at line 10880 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

const ::std::string & product ()

UI string for the product name. If not included, the product name is unspecified.

If included, this string must be non-empty.

Optional.

Defined at line 10892 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool has_product ()

Defined at line 10896 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

::std::string * mutable_product ()

UI string for the product name. If not included, the product name is unspecified.

If included, this string must be non-empty.

Optional.

Defined at line 10904 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

void clear_product ()

Defined at line 10912 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

const uint32_t & clock_domain ()

An identifier for the clock domain in which this hardware operates. If

two hardware devices have the same clock domain, their clock rates are

identical and perfectly synchronized. Although these two clocks have the

same rate, the clock positions may be offset from each other by an

arbitrary (but fixed) amount. The clock_domain typically comes from a

system wide entity, such as a platform bus or global clock tree.

There are two special values:

* `CLOCK_DOMAIN_MONOTONIC` means the hardware is operating at the same

rate as the system montonic clock.

* `CLOCK_DOMAIN_EXTERNAL` means the hardware is operating at an unknown

rate and is not synchronized with any known clock, not even with

other clocks in domain `CLOCK_DOMAIN_EXTERNAL`.

If the domain is not `CLOCK_DOMAIN_MONOTONIC`, client must use position

notification updates to recover the hardware's clock.

Required.

Defined at line 10940 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

bool has_clock_domain ()

Defined at line 10944 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

uint32_t * mutable_clock_domain ()

An identifier for the clock domain in which this hardware operates. If

two hardware devices have the same clock domain, their clock rates are

identical and perfectly synchronized. Although these two clocks have the

same rate, the clock positions may be offset from each other by an

arbitrary (but fixed) amount. The clock_domain typically comes from a

system wide entity, such as a platform bus or global clock tree.

There are two special values:

* `CLOCK_DOMAIN_MONOTONIC` means the hardware is operating at the same

rate as the system montonic clock.

* `CLOCK_DOMAIN_EXTERNAL` means the hardware is operating at an unknown

rate and is not synchronized with any known clock, not even with

other clocks in domain `CLOCK_DOMAIN_EXTERNAL`.

If the domain is not `CLOCK_DOMAIN_MONOTONIC`, client must use position

notification updates to recover the hardware's clock.

Required.

Defined at line 10968 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h

void clear_clock_domain ()

Defined at line 10976 of file fidling/gen/sdk/fidl/fuchsia.hardware.audio/fuchsia.hardware.audio/hlcpp/fuchsia/hardware/audio/cpp/fidl.h