fuchsia.settings

PROTOCOLS

Accessibility

Defined in fuchsia.settings/accessibility.fidl

Modify or watch accessibility settings that are persisted.

Watch

Gets the current value of all accessibility settings. Returns immediately on first call; subsequent calls return when any of the values change.

  • settings all current values of the accessibility settings.
  • see AccessibilitySettings for their meaning.

    This call may fail if AccessibilitySettings are not accessible, possibly because of file system errors, not being supported on this product, or general service failures.

Request

NameType

Response

NameType
result Accessibility_Watch_Result

Set

Sets [AccessibilitySettings] settings. Any field not explicitly set in the table performs a no-op, and will not make any changes.

Request

NameType
settings AccessibilitySettings

Response

NameType
result Accessibility_Set_Result

Audio

Defined in fuchsia.settings/audio.fidl

Settings related to audio.

Watch

Gets the current [AudioSettings]. Returns immediately on first call; subsequent calls return when the value changes.

Request

NameType

Response

NameType
result Audio_Watch_Result

Set

Sets audio settings. Any field not explicitly set in the table performs a no-op, and will not make any changes.

Request

NameType
settings AudioSettings

Response

NameType
result Audio_Set_Result

Device

Defined in fuchsia.settings/device.fidl

Watch

Notifies of a change in information about the device.

On a given connection, the first call will return the current settings value while subsequent calls will only return the new settings value upon a value change. This follows the hanging get pattern.

Request

NameType

Response

NameType
device_settings DeviceSettings

Display

Defined in fuchsia.settings/display.fidl

Settings related to display

Watch

Gets the current [DisplaySettings]. Returns immediately on first call; subsequent calls return when the value changes.

Request

NameType

Response

NameType
result Display_Watch_Result

WatchLightSensor

Obtains the current data from the light sensor. Returns immediately on first call; subsequent calls return when the light sensor value changes by a certain amount measured in lux.

Request

NameType
delta float32

Response

NameType
result Display_WatchLightSensor_Result

Set

Sets display settings. Any field not explicitly set in the table performs a no-op, and will not make any changes.

Request

NameType
settings DisplaySettings

Response

NameType
result Display_Set_Result

DoNotDisturb

Defined in fuchsia.settings/do_not_disturb.fidl

Modify or watch do-not-disturb (DND) mode. While DND is active, distractions created by the device are reduced or eliminated. E.g. bootup is silent, incoming calls could be rejected or silent, and notifications could be paused, silent, or hidden. High-priority disruptions like alarms can be allowed.

Watch

Gets the current DoNotDisturbSettings. Returns immediately on first call; subsequent calls return when the values change.

Request

NameType

Response

NameType
settings DoNotDisturbSettings

Set

Sets DoNotDisturbSettings settings. Any field not explicitly set in the table performs a no-op, and will not make any changes.

Request

NameType
settings DoNotDisturbSettings

Response

NameType
result DoNotDisturb_Set_Result

Intl

Defined in fuchsia.settings/intl.fidl

Settings related to internationalization such as locale, time zone, and temperature units.

Watch

Gets the current [IntlSettings]. Returns immediately on first call; subsequent calls return when the value changes.

Request

NameType

Response

NameType
result Intl_Watch_Result

Set

Sets [IntlSettings] settings. Any field not explicitly set in the table performs a no-op, and will not make any changes.

Request

NameType
settings IntlSettings

Response

NameType
result Intl_Set_Result

Privacy

Defined in fuchsia.settings/privacy.fidl

Watch

Notifies of a change in privacy settings.

On a given connection, the first call will return the current settings value while subsequent calls will only return the new settings value upon a value change. This follows the hanging get pattern.

Request

NameType

Response

NameType
result Privacy_Watch_Result

Set

Sets the privacy settings.

Any field not explicitly set in settings performs a no-op, and will not make any changes.

Request

NameType
settings PrivacySettings

Response

NameType
result Privacy_Set_Result

Setup

Defined in fuchsia.settings/setup.fidl

Settings that influence the device's setup behavior.

Watch

Gets the current [SetupSettings]. Returns immediately on first call; subsequent calls return when the value changes.

Request

NameType

Response

NameType
settings SetupSettings

Set

Changes the settings specified in [SetupSettings]. Any field not set in the table will not perform any system operation. An error will be returned if the provided settings is an invalid change (for example, if it is empty).

Request

NameType
settings SetupSettings

Response

NameType
result Setup_Set_Result

System

Defined in fuchsia.settings/system.fidl

Settings related to the general system.

Watch

Gets the current [SystemSettings]. Returns immediately on first call; subsequent calls return when the value changes.

Request

NameType

Response

NameType
result System_Watch_Result

Set

Changes the settings specified in [SystemSettings]. Any field not set in the table will not perform any system operation.

Request

NameType
settings SystemSettings

Response

NameType
result System_Set_Result

STRUCTS

Accessibility_Watch_Response

generated

NameTypeDescriptionDefault
settings AccessibilitySettings No default

Accessibility_Set_Response

generated

NameTypeDescriptionDefault

Audio_Watch_Response

generated

NameTypeDescriptionDefault
settings AudioSettings No default

Audio_Set_Response

generated

NameTypeDescriptionDefault

Display_Watch_Response

generated

NameTypeDescriptionDefault
settings DisplaySettings No default

Display_WatchLightSensor_Response

generated

NameTypeDescriptionDefault
light_sensor_data LightSensorData No default

Display_Set_Response

generated

NameTypeDescriptionDefault

DoNotDisturb_Set_Response

generated

NameTypeDescriptionDefault

Intl_Watch_Response

generated

NameTypeDescriptionDefault
settings IntlSettings No default

Intl_Set_Response

generated

NameTypeDescriptionDefault

Privacy_Watch_Response

generated

NameTypeDescriptionDefault
settings PrivacySettings No default

Privacy_Set_Response

generated

NameTypeDescriptionDefault

Setup_Set_Response

generated

NameTypeDescriptionDefault

System_Watch_Response

generated

NameTypeDescriptionDefault
settings SystemSettings No default

System_Set_Response

generated

NameTypeDescriptionDefault

ENUMS

ColorBlindnessType

Type: uint32

Defined in fuchsia.settings/accessibility.fidl

NameValueDescription
NONE 0 No color blindness.
PROTANOMALY 1 Red-green color blindness due to reduced sensitivity to red light.
DEUTERANOMALY 2 Red-green color blindness due to reduced sensitivity to green light.
TRITANOMALY 3 Blue-yellow color blindness. It is due to reduced sensitivity to blue light.

CaptionFontFamily

Type: uint32

Defined in fuchsia.settings/accessibility.fidl

Font family groups for closed captions, specified by 47 CFR §79.102(k).

NameValueDescription
UNKNOWN 0
MONOSPACED_SERIF 1
PROPORTIONAL_SERIF 2
MONOSPACED_SANS_SERIF 3
PROPORTIONAL_SANS_SERIF 4
CASUAL 5
CURSIVE 6
SMALL_CAPITALS 7

EdgeStyle

Type: uint32

Defined in fuchsia.settings/accessibility.fidl

Edge style for fonts as specified in 47 CFR §79.103(c)(7)

NameValueDescription
NONE 0 No border around fonts.
DROP_SHADOW 1 A shadow "behind" and slightly offset from each edge.
RAISED 2 A bevel that mimics a 3D raised effect.
DEPRESSED 3 A bevel that mimics a 3D depressed effect.
OUTLINE 4 A plain border around each shapes.

AudioStreamSettingSource

Type: uint32

Defined in fuchsia.settings/audio.fidl

The source of the volume settings. The volume is set according to the source.

NameValueDescription
DEFAULT 0 The volume is default.
USER 1 The volume is set by the user. When the |source| in AudioStreamSettings is set to this, the audio volume is set to |user_volume|.
SYSTEM 2 The system takes control of the volume. This is used when the system constantly calculates and changes the volume. The volume is not stored for this source.

Error

Type: uint32

Defined in fuchsia.settings/settings.fidl

Common error code used across different settings.

NameValueDescription
FAILED 1
UNSUPPORTED 2

LoginOverride

Type: uint32

Defined in fuchsia.settings/system.fidl

What preferred login behavior has been set.

NameValueDescription
NONE 1 No override has been set.
AUTOLOGIN_GUEST 2 Do not require an account and login always as guest.
AUTH_PROVIDER 3 Requires a provisioned account through auth provider.

TABLES

AccessibilitySettings

Defined in fuchsia.settings/accessibility.fidl

Supported accessibility settings.

OrdinalNameTypeDescription
1 audio_description bool For videos, use an alternative audio track (akin to changing languages) that explains what is happening visually while there is no dialogue.
2 screen_reader bool Read aloud elements of the screen selected by the user.
3 color_inversion bool Invert colors on the screen.
4 enable_magnification bool Interpret triple-tap on the touchscreen as a command to zoom in.
5 color_correction ColorBlindnessType What type of color-blindness, if any, to correct for.
6 captions_settings CaptionsSettings What kind of sources get closed captions, and how they look.

CaptionsSettings

Defined in fuchsia.settings/accessibility.fidl

What kind of sources get closed captions, and how they look.

OrdinalNameTypeDescription
1 for_media bool Closed captions enabled for media sources of audio.
2 for_tts bool Closed captions enabled for Text-To-Speech sources of audio.
3 font_style CaptionFontStyle Font style and color used for the closed captions text.
4 window_color fuchsia.ui.types/ColorRgba Border color used around the closed captions window.
5 background_color fuchsia.ui.types/ColorRgba Background color of the closed captions window.

CaptionFontStyle

Defined in fuchsia.settings/accessibility.fidl

Font, size, and color of closed captions text.

OrdinalNameTypeDescription
1 family CaptionFontFamily
2 color fuchsia.ui.types/ColorRgba 47 CFR §79.103(c)(2) requires at least 3-bit RGB for user override of closed-captions color.
3 relative_size float32 Size of closed captions text relative to the default captions size. A range of [0.5, 2] is guaranteed to be supported (as 47 CFR §79.103(c)(4) establishes).
4 char_edge_style EdgeStyle

Volume

Defined in fuchsia.settings/audio.fidl

OrdinalNameTypeDescription
1 level float32 The volume level ranged [0.0, 1.0]. The level maps to a dbfs value from a volume curve in the setting service.
2 muted bool True if the volume should be muted. If this is true, then the volume is silent, regardless of |level|.

AudioStreamSettings

Defined in fuchsia.settings/audio.fidl

OrdinalNameTypeDescription
1 stream fuchsia.media/AudioRenderUsage The audio stream which the settings are applying to.
2 source AudioStreamSettingSource The volume of |stream| is set according to the volume settings from |source|.
3 user_volume Volume User level volume setting. If the |source| is USER, then the volume is set to |user_volume|.

AudioSettings

Defined in fuchsia.settings/audio.fidl

OrdinalNameTypeDescription
1 streams vector<AudioStreamSettings>[5] Contains the volume setting for all audio stream settings. There should only be one AudioStreamSettings for each fuchsia.media.AudioRenderUsage.
2 input AudioInput Settings related to the audio input.

AudioInput

Defined in fuchsia.settings/audio.fidl

OrdinalNameTypeDescription
1 muted bool Whether the audio input is muted. Takes into consideration the hardware state.

DeviceSettings

Defined in fuchsia.settings/device.fidl

Information about the device.

OrdinalNameTypeDescription
1 build_tag string[50] The identifier representing the specific build that the device is currently running. Read-only field, cannot be set by client.

DisplaySettings

Defined in fuchsia.settings/display.fidl

OrdinalNameTypeDescription
1 auto_brightness bool
2 brightness_value float32

LightSensorData

Defined in fuchsia.settings/display.fidl

OrdinalNameTypeDescription
1 illuminance_lux float32 Brightness from the light sensor measured in lux

DoNotDisturbSettings

Defined in fuchsia.settings/do_not_disturb.fidl

Settings related to do-not-disturb (DND) mode.

OrdinalNameTypeDescription
1 user_initiated_do_not_disturb bool If true, the device is in do-not-disturb (DND) mode. Change this value if you're directly responding to a user-initiated event. Note that the device could still be in DND mode even if this is set to `false`, as night_mode_initiated_do_not_disturb might be `true`. To actually disable DND mode, set both fields to `false`. To know whether DND is enabled, you need to do a boolean OR of both fields.
2 night_mode_initiated_do_not_disturb bool If true, the device is in do-not-disturb (DND) mode. Change this value if you're trying to enable or disable DND based on a nightly schedule. Note that the device could still be in DND mode even if this is set to `false`, as user_initiated_do_not_disturb might be `true`. Do not set that field to `false` unless you're directly responding to a user-initiated event. To know whether DND is enabled, you need to do a boolean OR of both fields.

IntlSettings

Defined in fuchsia.settings/intl.fidl

Collection of internationalization-related settings.

OrdinalNameTypeDescription
1 locales vector<fuchsia.intl/LocaleId>[10] An ordered list of preferred locales.
2 temperature_unit fuchsia.intl/TemperatureUnit The preferred temperature unit.
3 time_zone_id fuchsia.intl/TimeZoneId The currently set time zone.

PrivacySettings

Defined in fuchsia.settings/privacy.fidl

OrdinalNameTypeDescription
1 user_data_sharing_consent bool Reflects the user consent to have their user data shared with the product owner, e.g., for metrics collection and crash reporting.

SetupSettings

Defined in fuchsia.settings/setup.fidl

OrdinalNameTypeDescription
1 enabled_configuration_interfaces ConfigurationInterfaces Specifies the network interfaces that the device can be configured over during setup.

SystemSettings

Defined in fuchsia.settings/system.fidl

Settings related to the general system.

OrdinalNameTypeDescription
1 mode LoginOverride If set, indicates a login behavior specified at runtime.

UNIONS

Accessibility_Watch_Result

generated

NameTypeDescription
response Accessibility_Watch_Response
err Error

Accessibility_Set_Result

generated

NameTypeDescription
response Accessibility_Set_Response
err Error

Audio_Watch_Result

generated

NameTypeDescription
response Audio_Watch_Response
err Error

Audio_Set_Result

generated

NameTypeDescription
response Audio_Set_Response
err Error

Display_Watch_Result

generated

NameTypeDescription
response Display_Watch_Response
err Error

Display_WatchLightSensor_Result

generated

NameTypeDescription
response Display_WatchLightSensor_Response
err Error

Display_Set_Result

generated

NameTypeDescription
response Display_Set_Response
err Error

DoNotDisturb_Set_Result

generated

NameTypeDescription
response DoNotDisturb_Set_Response
err Error

Intl_Watch_Result

generated

NameTypeDescription
response Intl_Watch_Response
err Error

Intl_Set_Result

generated

NameTypeDescription
response Intl_Set_Response
err Error

Privacy_Watch_Result

generated

NameTypeDescription
response Privacy_Watch_Response
err Error

Privacy_Set_Result

generated

NameTypeDescription
response Privacy_Set_Response
err Error

Setup_Set_Result

generated

NameTypeDescription
response Setup_Set_Response
err Error

System_Watch_Result

generated

NameTypeDescription
response System_Watch_Response
err Error

System_Set_Result

generated

NameTypeDescription
response System_Set_Response
err Error

BITS

ConfigurationInterfaces

Type: uint32

NameValueDescription
ETHERNET 1
WIFI 2