fuchsia.settings

Added: 7

PROTOCOLS

Accessibility

Defined in fuchsia.settings/accessibility.fidl

Modify or watch accessibility settings that are persisted.

Supported SettingsEpitaph enums: REQUEST_NOT_SUPPORTED, INTERNAL_SERVICE_ERROR, PERSISTENT_STORAGE_ERROR

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
payload Accessibility_Set_Result

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.

If this call fails, it is considered a fatal error and the channel will be closed.

Request

<EMPTY>

Response

NameType
settings AccessibilitySettings

Audio

Defined in fuchsia.settings/audio.fidl

Settings related to audio.

Supported SettingsEpitaph enums: REQUEST_NOT_SUPPORTED, INTERNAL_SERVICE_ERROR, PERSISTENT_STORAGE_ERROR

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
payload Audio_Set_Result

Watch

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

If this call fails, it is considered a fatal error and the channel will be closed.

Request

<EMPTY>

Response

NameType
settings AudioSettings

Display

Defined in fuchsia.settings/display.fidl

Settings related to display.

Supported SettingsEpitaph enums: REQUEST_NOT_SUPPORTED, INTERNAL_SERVICE_ERROR, PERSISTENT_STORAGE_ERROR

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
payload Display_Set_Result

Watch

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

If this call fails, it is considered a fatal error and the channel will be closed.

Request

<EMPTY>

Response

NameType
settings DisplaySettings

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.

Supported SettingsEpitaph enums: REQUEST_NOT_SUPPORTED, INTERNAL_SERVICE_ERROR, PERSISTENT_STORAGE_ERROR

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
payload DoNotDisturb_Set_Result

Watch

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

If this call fails, it is considered a fatal error and the channel will be closed.

Request

<EMPTY>

Response

NameType
settings DoNotDisturbSettings

FactoryReset

Defined in fuchsia.settings/factory_reset.fidl

Settings related to factory reset.

Set

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

Request

NameType
settings FactoryResetSettings

Response

NameType
payload FactoryReset_Set_Result

Watch

Notifies of a change in information about the factory reset 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.

If this call fails, it is considered a fatal error and the channel will be closed.

Request

<EMPTY>

Response

NameType
settings FactoryResetSettings

Input

Defined in fuchsia.settings/input.fidl

Settings related to input to the device.

Supported SettingsEpitaph enums: REQUEST_NOT_SUPPORTED, INTERNAL_SERVICE_ERROR, PERSISTENT_STORAGE_ERROR

Set

Requests software input devices to set their software state. May not necessarily change the overall state of the device, depending on the hardware state. Will modify the software state of the existing device if a known device_name and device_type are passed. Otherwise it will add a new input device. Devices not included in input_states will not be modified.

Request

NameType
input_states vector<InputState>

Response

NameType
payload Input_Set_Result

Watch

Gets the current |InputSettings|. Returns immediately on first call; subsequent calls return when the value changes.

When any of the input devices' states change, this will return the full [InputSettings] object, containing the states for all the available input devices on the target device.

To find the state of a specific input device, the devices vector contained in settings can be iterated through to find a specific [DeviceType]. If there are multiple devices of the same [DeviceType], the [InputDevice]'s device_name can be examined in conjunction with the [DeviceType] to find the desired input device. Together, the device_name and [DeviceType] uniquely identify an [InputDevice].

If this call fails, it is considered a fatal error and the channel will be closed.

Request

<EMPTY>

Response

NameType
settings InputSettings

Intl

Defined in fuchsia.settings/intl.fidl

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

Supported SettingsEpitaph enums: REQUEST_NOT_SUPPORTED, INTERNAL_SERVICE_ERROR, PERSISTENT_STORAGE_ERROR, FILE_READ_ERROR

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
payload Intl_Set_Result

Watch

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

If this call fails, it is considered a fatal error and the channel will be closed.

Request

<EMPTY>

Response

NameType
settings IntlSettings

Keyboard

Defined in fuchsia.settings/keyboard.fidl

The SetUI protocol for reading and modifying the keyboard settings.

Set

Setting protocol: if a field is left unset, it is not modified. To clear a field, set it to its type's "zero" value.

Request

NameType
settings KeyboardSettings

Response

NameType
payload KeyboardSet_Set_Result

Watch

The Watch protocol is the same as in the other fuchsia.settings.* protocols.

Returns immediately on first call; on subsequent calls it blocks until the settings change, and then returns following the "hanging get" pattern.

Request

<EMPTY>

Response

NameType
settings KeyboardSettings

KeyboardSet

Defined in fuchsia.settings/keyboard.fidl

The mutable API for modifying the keyboard settings.

Set

Setting protocol: if a field is left unset, it is not modified. To clear a field, set it to its type's "zero" value.

Request

NameType
settings KeyboardSettings

Response

NameType
payload KeyboardSet_Set_Result

KeyboardWatch

Defined in fuchsia.settings/keyboard.fidl

The read-only API for monitoring the changes to the keyboard settings.

Watch

The Watch protocol is the same as in the other fuchsia.settings.* protocols.

Returns immediately on first call; on subsequent calls it blocks until the settings change, and then returns following the "hanging get" pattern.

Request

<EMPTY>

Response

NameType
settings KeyboardSettings

Light

Defined in fuchsia.settings/light.fidl

SetLightGroupValues

Sets the values for the lights in the group with the given name.

If the provided value does not match the light group's type, this call will fail.

The requested changes may not take immediate effect if the light is forced to a certain state by the device's hardware. This call will still succeed, but the light's value may not change.

Request

NameType
name string[32]
state vector<LightState>

Response

NameType
payload Light_SetLightGroupValues_Result

WatchLightGroup

Fetches information on an individual light group on the device with the given name. Returns immediately on first call; subsequent calls return when the value changes.

If this call fails, it is considered a fatal error and the channel will be closed. If the failure is due to an invalid light group name, the channel will be closed with a NOT_FOUND epitaph.

Request

NameType
name string[32]

Response

NameType
group LightGroup

WatchLightGroups

Fetches information on the controllable light groups on the device. Returns immediately on first call; subsequent calls return when the value changes.

If this call fails, it is considered a fatal error and the channel will be closed.

Request

<EMPTY>

Response

NameType
groups vector<LightGroup>

NightMode

Defined in fuchsia.settings/night_mode.fidl

Modify or watch Night Mode setting. Night mode puts the device in a restricted mode which can be overrided if the user prefers. During night mode, the following settings apply as per night mode parameters:

  1. DoNotDisturb is enabled/not.
  2. System volume is set to an override maximum.
  3. LED Brightness is set to an overridable maximum.
  4. Sleep mode is enabled/not.

Supported SettingsEpitaph enums: REQUEST_NOT_SUPPORTED, INTERNAL_SERVICE_ERROR, PERSISTENT_STORAGE_ERROR

Set

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

Request

NameType
settings NightModeSettings

Response

NameType
payload NightMode_Set_Result

Watch

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

If this call fails, it is considered a fatal error and the channel will be closed.

Request

<EMPTY>

Response

NameType
settings NightModeSettings

Privacy

Defined in fuchsia.settings/privacy.fidl

Settings related to privacy.

Supported SettingsEpitaph enums: REQUEST_NOT_SUPPORTED, INTERNAL_SERVICE_ERROR, PERSISTENT_STORAGE_ERROR

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
payload Privacy_Set_Result

Watch

Notifies of a change in privacy settings.

On a given connection, the server will return immediately if this is the first call made, or if the settings value has changed since a previous call. Otherwise, the server will wait on a value change before returning the new value. This follows the hanging get pattern.

If this call fails, it is considered a fatal error and the channel will be closed.

Request

<EMPTY>

Response

NameType
settings PrivacySettings

Setup

Defined in fuchsia.settings/setup.fidl

Settings that influence the device's setup behavior.

Supported SettingsEpitaph enums: REQUEST_NOT_SUPPORTED, INTERNAL_SERVICE_ERROR, PERSISTENT_STORAGE_ERROR

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
reboot_device bool

Response

NameType
payload Setup_Set_Result

Watch

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

If this call fails, it is considered a fatal error and the channel will be closed.

Request

<EMPTY>

Response

NameType
settings SetupSettings

STRUCTS

Accessibility_Set_Response

Defined in fuchsia.settings/accessibility.fidl

<EMPTY>

Audio_Set_Response

Defined in fuchsia.settings/audio.fidl

<EMPTY>

Autorepeat

Defined in fuchsia.settings/keyboard.fidl

FieldTypeDescriptionDefault
delay zx/Duration

The duration between key actuation and autorepeat actuation.

No default
period zx/Duration

The duration between two successive autorepeat actuations (1/rate). Rate is defined as once the autorepeat kicks in, the frequency at which repeated key actuations are generated per second.

No default

Display_Set_Response

Defined in fuchsia.settings/display.fidl

<EMPTY>

DoNotDisturb_Set_Response

Defined in fuchsia.settings/do_not_disturb.fidl

<EMPTY>

FactoryReset_Set_Response

Defined in fuchsia.settings/factory_reset.fidl

<EMPTY>

Input_Set_Response

Defined in fuchsia.settings/input.fidl

<EMPTY>

Intl_Set_Response

Defined in fuchsia.settings/intl.fidl

<EMPTY>

KeyboardSet_Set_Response

Defined in fuchsia.settings/keyboard.fidl

<EMPTY>

Light_SetLightGroupValues_Response

Defined in fuchsia.settings/light.fidl

<EMPTY>

NightMode_Set_Response

Defined in fuchsia.settings/night_mode.fidl

<EMPTY>

Privacy_Set_Response

Defined in fuchsia.settings/privacy.fidl

<EMPTY>

Setup_Set_Response

Defined in fuchsia.settings/setup.fidl

<EMPTY>

ENUMS

AudioStreamSettingSource strict

Type: uint32

Defined in fuchsia.settings/audio.fidl

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

NameValueDescription
0

The volume is set by the user. When the source in AudioStreamSettings is set to this, the audio volume is set to user_volume.

1

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.

2

The system takes control of the volume. This is used when the system changes the volume, but we still want to play feedback sounds for these changes. The volume is not stored for this source.

CaptionFontFamily strict

Type: uint32

Defined in fuchsia.settings/accessibility.fidl

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

NameValueDescription
0
1
2
3
4
5
6
7

ColorBlindnessType strict

Type: uint32

Defined in fuchsia.settings/accessibility.fidl

NameValueDescription
0

No color blindness.

1

Red-green color blindness due to reduced sensitivity to red light.

2

Red-green color blindness due to reduced sensitivity to green light.

3

Blue-yellow color blindness. It is due to reduced sensitivity to blue light.

DeviceStateSource strict

Type: uint32

Defined in fuchsia.settings/input.fidl

NameValueDescription
1
2

DeviceType strict

Type: uint32

Defined in fuchsia.settings/input.fidl

NameValueDescription
1
2

EdgeStyle strict

Type: uint32

Defined in fuchsia.settings/accessibility.fidl

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

NameValueDescription
0

No border around fonts.

1

A shadow "behind" and slightly offset from each edge.

2

A bevel that mimics a 3D raised effect.

3

A bevel that mimics a 3D depressed effect.

4

A plain border around each shapes.

Error strict

Type: uint32

Defined in fuchsia.settings/settings.fidl

Common error code used across different settings.

NameValueDescription
1
2

HourCycle strict

Type: uint32

Defined in fuchsia.settings/intl.fidl

Whether if the time format should be using 12 hour or 24 hour clock. H indicates the maximum number that the hour indicator will ever show.

NameValueDescription
0
1

12-hour clock, 0:10am after midnight.

2

12-hour clock, 12:10am after midnight.

3

24-hour clock, 0:10 after midnight.

4

24-hour clock, 24:10 after midnight.

LightError strict

Type: uint32

Defined in fuchsia.settings/light.fidl

NameValueDescription
1

Call failed for unspecified reasons.

2

Call not supported, this setting may not be present on this .

3

An invalid/unknown light group name was provided.

4

An invalid LightValue was provided that did not match the light group's LightType or did not match the requirements for the value type.

LightType strict

Type: uint32

Defined in fuchsia.settings/light.fidl

Enum describing the possible types of values for controlling a light.

NameValueDescription
1

This type of light supports setting brightness to a uint8_t value.

2

This type of light supports setting an RGB value.

3

Light can only be turned on or off.

LowLightMode strict

Type: uint32

Defined in fuchsia.settings/display.fidl

NameValueDescription
0

Device should not be in low-light mode.

1

Device should not be in low-light mode and should transition out of it immediately.

2

Device should be in low-light mode.

SettingsEpitaph strict

Type: uint32

Defined in fuchsia.settings/settings.fidl

Common epitaph messages used across different settings.

NameValueDescription
1
2
3
4

ThemeType strict

Type: uint32

Defined in fuchsia.settings/display.fidl

NameValueDescription
0

When ThemeType is set to DEFAULT it is up to the specific product to determine what that actually means.

1
2

TABLES

AccessibilitySettings

Defined in fuchsia.settings/accessibility.fidl

Supported accessibility settings.

OrdinalFieldTypeDescription
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.

screen_reader bool

Read aloud elements of the screen selected by the user.

color_inversion bool

Invert colors on the screen.

enable_magnification bool

Interpret triple-tap on the touchscreen as a command to zoom in.

color_correction ColorBlindnessType

What type of color-blindness, if any, to correct for.

captions_settings CaptionsSettings

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

AudioSettings

Defined in fuchsia.settings/audio.fidl

OrdinalFieldTypeDescription
streams vector<AudioStreamSettings>[5]

Contains the volume setting for all audio stream settings. There should only be one AudioStreamSettings for each fuchsia.media.AudioRenderUsage.

AudioStreamSettings

Defined in fuchsia.settings/audio.fidl

OrdinalFieldTypeDescription
stream fuchsia.media/AudioRenderUsage

The audio stream which the settings are applying to.

source AudioStreamSettingSource

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

user_volume Volume

User level volume setting. If the source is USER, then the volume is set to user_volume.

CaptionFontStyle

Defined in fuchsia.settings/accessibility.fidl

Font, size, and color of closed captions text.

OrdinalFieldTypeDescription
family CaptionFontFamily
color fuchsia.ui.types/ColorRgba

47 CFR §79.103(c)(2) requires at least 3-bit RGB for user override of closed-captions color.

Each color channel should be a finite number otherwise will cause SetAccessibilityInfo to fail with INVALID_VALUE.

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). Size should be a finite number.

char_edge_style EdgeStyle

CaptionsSettings

Defined in fuchsia.settings/accessibility.fidl

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

OrdinalFieldTypeDescription
for_media bool

Closed captions enabled for media sources of audio.

for_tts bool

Closed captions enabled for Text-To-Speech sources of audio.

font_style CaptionFontStyle

Font style and color used for the closed captions text.

window_color fuchsia.ui.types/ColorRgba

Border color used around the closed captions window.

Each color channel should be a finite number otherwise will cause SetAccessibilityInfo to fail with INVALID_VALUE.

background_color fuchsia.ui.types/ColorRgba

Background color of the closed captions window.

Each color channel should be a finite number otherwise will cause SetAccessibilityInfo to fail with INVALID_VALUE.

DeviceState

Defined in fuchsia.settings/input.fidl

Holds the state for an |InputDevice|.

OrdinalFieldTypeDescription
toggle_flags ToggleStateFlags

Controls the on/off state of the input device.

DisplaySettings

Defined in fuchsia.settings/display.fidl

DisplaySettings are used to determine the output state of the display. The display can be toggled between two modes, auto-brightness on and auto-brightness off.

Adjusted_auto_brightness is used to set a specific brightness level for the current lighting conditions. Auto-brightness will continue to make the screen darker and brighter as the surrounding light changes.

Brightness_value is used in manual mode to set a specific brightness level for the screen. This level will be maintained while in manual mode.

OrdinalFieldTypeDescription
auto_brightness bool

Auto brightness enabled.

brightness_value float32

Manually set brightness value [0.0 - 1.0]. Not a number, infinity or negative infinity will cause SetDisplayInfo to fail with INVALID_VALUE.

RESERVED
low_light_mode LowLightMode

The low light mode state of the device.

screen_enabled bool

Whether the screen is enabled.

theme Theme

Theme to be used for the device's user interface.

adjusted_auto_brightness float32

Brightness value to adjust auto-brightness to [0.0 - 1.0].

DoNotDisturbSettings

Defined in fuchsia.settings/do_not_disturb.fidl

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

OrdinalFieldTypeDescription
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.

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.

FactoryResetSettings

Defined in fuchsia.settings/factory_reset.fidl

Information about the factory reset settings.

OrdinalFieldTypeDescription
is_local_reset_allowed bool

When set to true, a user is able to physically perform a factory reset. When false, that functionality is disabled.

InputDevice

Defined in fuchsia.settings/input.fidl

Contains the information for an input device. The device is uniquely identified by the combination of device_name and device_type.

OrdinalFieldTypeDescription
device_name string

Uniquely identifies a device within a device type.

device_type DeviceType

The type of input device (e.g. camera, microphone).

source_states vector<SourceState>

The state for each individual [DeviceStateSource].

mutable_toggle_state ToggleStateFlags

The software toggle states which are allowed to be changed for a device.

state DeviceState

The overall state of the device, considering the combination of the source states.

InputSettings

Defined in fuchsia.settings/input.fidl

Settings related to device input. New format for InputDeviceSettings.

InputSettings contains a list of input devices, e.g. Microphone and Camera devices. There may be multiple devices of each type. If so, they will be differentiated by the device_name. If there is only one device of a certain [DeviceType], then the name defaults to the same as the device type, e.g. DeviceType::Microphone -> "microphone".

OrdinalFieldTypeDescription
devices vector<InputDevice>

InputState

Defined in fuchsia.settings/input.fidl

A subset of |DeviceState|'s properties that clients may pass to change the software state of an InputDevice.

OrdinalFieldTypeDescription
name string
device_type DeviceType
state DeviceState

IntlSettings

Defined in fuchsia.settings/intl.fidl

Collection of internationalization-related settings.

OrdinalFieldTypeDescription
locales vector<fuchsia.intl/LocaleId>[10]

An ordered list of preferred locales.

temperature_unit fuchsia.intl/TemperatureUnit

The preferred temperature unit.

time_zone_id fuchsia.intl/TimeZoneId

The currently set time zone.

hour_cycle HourCycle

The preferred hour cycle.

KeyboardSettings

Defined in fuchsia.settings/keyboard.fidl

The various keyboard settings.

OrdinalFieldTypeDescription
keymap fuchsia.input/KeymapId
autorepeat Autorepeat

LightGroup

Defined in fuchsia.settings/light.fidl

Information about a controllable light group. A group may have one or more lights.

OrdinalFieldTypeDescription
name string[32]

Identifier for this light group, clients should pass this back into the service to set the group's light values.

enabled bool

True if the light group is enabled and changes will be visible to the user. False if the light group is forced off by hardware. If the light group is disabled, its value can still be set, but the change may not be visible until the light group is back on.

type LightType

Defines the acceptable value type for controlling this light group.

lights vector<LightState>

States of the lights in this group.

LightState

Defined in fuchsia.settings/light.fidl

State of a given light.

OrdinalFieldTypeDescription
value LightValue

NightModeSettings

Defined in fuchsia.settings/night_mode.fidl

Settings related to Night mode.

OrdinalFieldTypeDescription
night_mode_enabled bool

If true, the device/user have opted in for NightMode routine.

PrivacySettings

Defined in fuchsia.settings/privacy.fidl

OrdinalFieldTypeDescription

SetupSettings

Defined in fuchsia.settings/setup.fidl

OrdinalFieldTypeDescription
enabled_configuration_interfaces ConfigurationInterfaces

Specifies the network interfaces that the device can be configured over during setup.

SourceState

Defined in fuchsia.settings/input.fidl

Describes what the |source|'s |state| is.

OrdinalFieldTypeDescription
source DeviceStateSource
state DeviceState

Theme

Defined in fuchsia.settings/display.fidl

OrdinalFieldTypeDescription
theme_type ThemeType
theme_mode ThemeMode

Volume

Defined in fuchsia.settings/audio.fidl

OrdinalFieldTypeDescription
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. Not a number (NaN), infinity or negative infinity will cause SetVolume to fail with INVALID_VALUE.

muted bool

True if the volume should be muted. If this is true, then the volume is silent, regardless of level.

UNIONS

Accessibility_Set_Result strict

Defined in fuchsia.settings/accessibility.fidl

OrdinalVariantTypeDescription
response Accessibility_Set_Response
err Error

Audio_Set_Result strict

Defined in fuchsia.settings/audio.fidl

OrdinalVariantTypeDescription
response Audio_Set_Response
err Error

Display_Set_Result strict

Defined in fuchsia.settings/display.fidl

OrdinalVariantTypeDescription
response Display_Set_Response
err Error

DoNotDisturb_Set_Result strict

Defined in fuchsia.settings/do_not_disturb.fidl

OrdinalVariantTypeDescription
response DoNotDisturb_Set_Response
err Error

FactoryReset_Set_Result strict

Defined in fuchsia.settings/factory_reset.fidl

OrdinalVariantTypeDescription
response FactoryReset_Set_Response
err Error

Input_Set_Result strict

Defined in fuchsia.settings/input.fidl

OrdinalVariantTypeDescription
response Input_Set_Response
err Error

Intl_Set_Result strict

Defined in fuchsia.settings/intl.fidl

OrdinalVariantTypeDescription
response Intl_Set_Response
err Error

KeyboardSet_Set_Result strict

Defined in fuchsia.settings/keyboard.fidl

OrdinalVariantTypeDescription
response KeyboardSet_Set_Response
err Error

LightValue strict

Defined in fuchsia.settings/light.fidl

Value of a light. Only one of the three values in the union will be present, depending on the light's LightType.

OrdinalVariantTypeDescription
on bool

Lights with LightType.SIMPLE will have this value.

brightness float64

Lights with LightType.BRIGHTNESS will have this value, a floating point value 0.0 to 1.0 inclusive, where 0.0 means the light is off. Not a number (NaN), infinity or negative infinity will cause SetLightGroup to fail with INVALID_VALUE.

color fuchsia.ui.types/ColorRgb

Lights with LightType.RGB will have this value.

Each color channel should be a value between 0.0 and 1.0 inclusive. Values outside this range will cause SetLightGroup to fail with INVALID_VALUE.

Light_SetLightGroupValues_Result strict

Defined in fuchsia.settings/light.fidl

OrdinalVariantTypeDescription
response Light_SetLightGroupValues_Response
err LightError

NightMode_Set_Result strict

Defined in fuchsia.settings/night_mode.fidl

OrdinalVariantTypeDescription
response NightMode_Set_Response
err Error

Privacy_Set_Result strict

Defined in fuchsia.settings/privacy.fidl

OrdinalVariantTypeDescription
response Privacy_Set_Response
err Error

Setup_Set_Result strict

Defined in fuchsia.settings/setup.fidl

OrdinalVariantTypeDescription
response Setup_Set_Response
err Error

BITS

ConfigurationInterfaces strict

Type: uint32

Defined in fuchsia.settings/setup.fidl

NameValueDescription
1
2

ThemeMode strict

Type: uint32

Defined in fuchsia.settings/display.fidl

NameValueDescription
1

Product can choose a theme based on ambient cues.

ToggleStateFlags strict

Type: uint64

Defined in fuchsia.settings/input.fidl

A series of flags determining the state of an input device mute toggle.

NameValueDescription
1

The input device exists and is neither muted nor disabled.

2

The input device is being used.

4

The input device could be available if it was enabled, but it is muted.

8

The input device is permanently disabled, e.g. by policy.

16

The state cannot be determined.

CONSTANTS

NameValueTypeDescription
MAX_LIGHT_NAME_LENGTH 32 uint8