Project: /_project.yaml Book: /_book.yaml

fuchsia.settings

PROTOCOLS

Accessibility {:#Accessibility}

Defined in fuchsia.settings/accessibility.fidl

Modify or watch accessibility settings that are persisted.

Watch {:#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

Response

Set {:#Set}

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

Request

Response

Audio {:#Audio}

Defined in fuchsia.settings/audio.fidl

Settings related to audio.

Watch {:#Watch}

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

Request

Response

Set {:#Set}

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

Request

Response

Device {:#Device}

Defined in fuchsia.settings/device.fidl

Watch {:#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

Response

Display {:#Display}

Defined in fuchsia.settings/display.fidl

Settings related to display

Watch {:#Watch}

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

Request

Response

WatchLightSensor {:#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

Response

Set {:#Set}

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

Request

Response

DoNotDisturb {:#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 {:#Watch}

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

Request

Response

Set {:#Set}

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

Request

Response

Intl {:#Intl}

Defined in fuchsia.settings/intl.fidl

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

Watch {:#Watch}

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

Request

Response

Set {:#Set}

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

Request

Response

Privacy {:#Privacy}

Defined in fuchsia.settings/privacy.fidl

Watch {:#Watch}

Notifies of a change in privacy settings.

Request

Response

Set {:#Set}

Sets the privacy settings.

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

Request

Response

Setup {:#Setup}

Defined in fuchsia.settings/setup.fidl

Settings that influence the device's setup behavior.

Watch {:#Watch}

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

Request

Response

Set {:#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

Response

System {:#System}

Defined in fuchsia.settings/system.fidl

Settings related to the general system.

Watch {:#Watch}

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

Request

Response

Set {:#Set}

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

Request

Response

Accessibility {:#Accessibility}

Defined in fuchsia.settings/accessibility.fidl

Modify or watch accessibility settings that are persisted.

Watch {:#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

Response

Set {:#Set}

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

Request

Response

Audio {:#Audio}

Defined in fuchsia.settings/audio.fidl

Settings related to audio.

Watch {:#Watch}

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

Request

Response

Set {:#Set}

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

Request

Response

Device {:#Device}

Defined in fuchsia.settings/device.fidl

Watch {:#Watch}

Notifies of a change in information about the device.

Request

Response

Display {:#Display}

Defined in fuchsia.settings/display.fidl

Settings related to display

Watch {:#Watch}

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

Request

Response

WatchLightSensor {:#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

Response

Set {:#Set}

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

Request

Response

DoNotDisturb {:#DoNotDisturb}

Defined in fuchsia.settings/do_not_disturb.fidl

Watch {:#Watch}

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

Request

Response

Set {:#Set}

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

Request

Response

Intl {:#Intl}

Defined in fuchsia.settings/intl.fidl

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

Watch {:#Watch}

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

Request

Response

Set {:#Set}

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

Request

Response

Privacy {:#Privacy}

Defined in fuchsia.settings/privacy.fidl

Watch {:#Watch}

Notifies of a change in privacy settings.

Request

Response

Set {:#Set}

Sets the privacy settings.

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

Request

Response

Setup {:#Setup}

Defined in fuchsia.settings/setup.fidl

Settings that influence the device's setup behavior.

Watch {:#Watch}

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

Request

Response

Set {:#Set}

Request

Response

System {:#System}

Defined in fuchsia.settings/system.fidl

Settings related to the general system.

Watch {:#Watch}

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

Request

Response

Set {:#Set}

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

Request

Response

STRUCTS

Accessibility_Watch_Response {:#Accessibility_Watch_Response}

generated

Accessibility_Set_Response {:#Accessibility_Set_Response}

generated

Audio_Watch_Response {:#Audio_Watch_Response}

generated

Audio_Set_Response {:#Audio_Set_Response}

generated

Display_Watch_Response {:#Display_Watch_Response}

generated

Display_WatchLightSensor_Response {:#Display_WatchLightSensor_Response}

generated

Display_Set_Response {:#Display_Set_Response}

generated

DoNotDisturb_Set_Response {:#DoNotDisturb_Set_Response}

generated

Intl_Watch_Response {:#Intl_Watch_Response}

generated

Intl_Set_Response {:#Intl_Set_Response}

generated

Privacy_Watch_Response {:#Privacy_Watch_Response}

generated

Privacy_Set_Response {:#Privacy_Set_Response}

generated

Setup_Set_Response {:#Setup_Set_Response}

generated

System_Watch_Response {:#System_Watch_Response}

generated

System_Set_Response {:#System_Set_Response}

generated

Accessibility_Watch_Response {:#Accessibility_Watch_Response}

generated

Accessibility_Set_Response {:#Accessibility_Set_Response}

generated

Audio_Watch_Response {:#Audio_Watch_Response}

generated

Audio_Set_Response {:#Audio_Set_Response}

generated

Display_Watch_Response {:#Display_Watch_Response}

generated

Display_WatchLightSensor_Response {:#Display_WatchLightSensor_Response}

generated

Display_Set_Response {:#Display_Set_Response}

generated

DoNotDisturb_Set_Response {:#DoNotDisturb_Set_Response}

generated

Intl_Watch_Response {:#Intl_Watch_Response}

generated

Intl_Set_Response {:#Intl_Set_Response}

generated

Privacy_Watch_Response {:#Privacy_Watch_Response}

generated

Privacy_Set_Response {:#Privacy_Set_Response}

generated

Setup_Set_Response {:#Setup_Set_Response}

generated

System_Watch_Response {:#System_Watch_Response}

generated

System_Set_Response {:#System_Set_Response}

generated

ENUMS

ColorBlindnessType {:#ColorBlindnessType}

Type: uint32

Defined in fuchsia.settings/accessibility.fidl

CaptionFontFamily {:#CaptionFontFamily}

Type: uint32

Defined in fuchsia.settings/accessibility.fidl

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

EdgeStyle {:#EdgeStyle}

Type: uint32

Defined in fuchsia.settings/accessibility.fidl

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

AudioStreamSettingSource {:#AudioStreamSettingSource}

Type: uint32

Defined in fuchsia.settings/audio.fidl

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

Error {:#Error}

Type: uint32

Defined in fuchsia.settings/settings.fidl

Common error code used across different settings.

LoginOverride {:#LoginOverride}

Type: uint32

Defined in fuchsia.settings/system.fidl

What preferred login behavior has been set.

ColorBlindnessType {:#ColorBlindnessType}

Type: uint32

Defined in fuchsia.settings/accessibility.fidl

CaptionFontFamily {:#CaptionFontFamily}

Type: uint32

Defined in fuchsia.settings/accessibility.fidl

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

EdgeStyle {:#EdgeStyle}

Type: uint32

Defined in fuchsia.settings/accessibility.fidl

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

AudioStreamSettingSource {:#AudioStreamSettingSource}

Type: uint32

Defined in fuchsia.settings/audio.fidl

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

Error {:#Error}

Type: uint32

Defined in fuchsia.settings/settings.fidl

Common error code used across different settings.

LoginOverride {:#LoginOverride}

Type: uint32

Defined in fuchsia.settings/system.fidl

What preferred login behavior has been set.

TABLES

AccessibilitySettings {:#AccessibilitySettings}

Defined in fuchsia.settings/accessibility.fidl

Supported accessibility settings.

CaptionsSettings {:#CaptionsSettings}

Defined in fuchsia.settings/accessibility.fidl

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

CaptionFontStyle {:#CaptionFontStyle}

Defined in fuchsia.settings/accessibility.fidl

Font, size, and color of closed captions text.

Information about the device.

DisplaySettings {:#DisplaySettings}

Defined in fuchsia.settings/display.fidl

LightSensorData {:#LightSensorData}

Defined in fuchsia.settings/display.fidl

DoNotDisturbSettings {:#DoNotDisturbSettings}

Defined in fuchsia.settings/do_not_disturb.fidl

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

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.

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 {:#IntlSettings}

Defined in fuchsia.settings/intl.fidl

Collection of internationalization-related settings.

PrivacySettings {:#PrivacySettings}

Defined in fuchsia.settings/privacy.fidl

SetupSettings {:#SetupSettings}

Defined in fuchsia.settings/setup.fidl

SystemSettings {:#SystemSettings}

Defined in fuchsia.settings/system.fidl

Settings related to the general system.

AccessibilitySettings {:#AccessibilitySettings}

Defined in fuchsia.settings/accessibility.fidl

Supported accessibility settings.

CaptionsSettings {:#CaptionsSettings}

Defined in fuchsia.settings/accessibility.fidl

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

CaptionFontStyle {:#CaptionFontStyle}

Defined in fuchsia.settings/accessibility.fidl

Font, size, and color of closed captions text.

Volume {:#Volume}

Defined in fuchsia.settings/audio.fidl

AudioStreamSettings {:#AudioStreamSettings}

Defined in fuchsia.settings/audio.fidl

AudioSettings {:#AudioSettings}

Defined in fuchsia.settings/audio.fidl

AudioInput {:#AudioInput}

Defined in fuchsia.settings/audio.fidl

DeviceSettings {:#DeviceSettings}

Defined in fuchsia.settings/device.fidl

Information about the device.

DisplaySettings {:#DisplaySettings}

Defined in fuchsia.settings/display.fidl

LightSensorData {:#LightSensorData}

Defined in fuchsia.settings/display.fidl

DoNotDisturbSettings {:#DoNotDisturbSettings}

Defined in fuchsia.settings/do_not_disturb.fidl

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

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.

IntlSettings {:#IntlSettings}

Defined in fuchsia.settings/intl.fidl

Collection of internationalization-related settings.

PrivacySettings {:#PrivacySettings}

Defined in fuchsia.settings/privacy.fidl

SetupSettings {:#SetupSettings}

Defined in fuchsia.settings/setup.fidl

SystemSettings {:#SystemSettings}

Defined in fuchsia.settings/system.fidl

Settings related to the general system.

UNIONS

Accessibility_Watch_Result {:#Accessibility_Watch_Result}

generated

Accessibility_Set_Result {:#Accessibility_Set_Result}

generated

Audio_Watch_Result {:#Audio_Watch_Result}

generated

Audio_Set_Result {:#Audio_Set_Result}

generated

Display_Watch_Result {:#Display_Watch_Result}

generated

Display_WatchLightSensor_Result {:#Display_WatchLightSensor_Result}

generated

Display_Set_Result {:#Display_Set_Result}

generated

DoNotDisturb_Set_Result {:#DoNotDisturb_Set_Result}

generated

Intl_Watch_Result {:#Intl_Watch_Result}

generated

Intl_Set_Result {:#Intl_Set_Result}

generated

Privacy_Watch_Result {:#Privacy_Watch_Result}

generated

Privacy_Set_Result {:#Privacy_Set_Result}

generated

Setup_Set_Result {:#Setup_Set_Result}

generated

System_Watch_Result {:#System_Watch_Result}

generated

System_Set_Result {:#System_Set_Result}

generated

Accessibility_Watch_Result {:#Accessibility_Watch_Result}

generated

Accessibility_Set_Result {:#Accessibility_Set_Result}

generated

Audio_Watch_Result {:#Audio_Watch_Result}

generated

Audio_Set_Result {:#Audio_Set_Result}

generated

Display_Watch_Result {:#Display_Watch_Result}

generated

Display_WatchLightSensor_Result {:#Display_WatchLightSensor_Result}

generated

Display_Set_Result {:#Display_Set_Result}

generated

DoNotDisturb_Set_Result {:#DoNotDisturb_Set_Result}

generated

Intl_Watch_Result {:#Intl_Watch_Result}

generated

Intl_Set_Result {:#Intl_Set_Result}

generated

Privacy_Watch_Result {:#Privacy_Watch_Result}

generated

Privacy_Set_Result {:#Privacy_Set_Result}

generated

Setup_Set_Result {:#Setup_Set_Result}

generated

System_Watch_Result {:#System_Watch_Result}

generated

System_Set_Result {:#System_Set_Result}

generated

BITS

ConfigurationInterfaces {:#ConfigurationInterfaces}

Type: uint32

ConfigurationInterfaces {:#ConfigurationInterfaces}

Type: uint32