Starboard Module Reference: accessibility.h
Stay organized with collections
Save and categorize content based on your preferences.
Provides access to the system options and settings related to accessibility.
Enums
SbAccessibilityCaptionCharacterEdgeStyle
Enum for possible closed captioning character edge styles.
Values
kSbAccessibilityCaptionCharacterEdgeStyleNonekSbAccessibilityCaptionCharacterEdgeStyleRaisedkSbAccessibilityCaptionCharacterEdgeStyleDepressedkSbAccessibilityCaptionCharacterEdgeStyleUniformkSbAccessibilityCaptionCharacterEdgeStyleDropShadow
SbAccessibilityCaptionColor
Enum for possible closed captioning colors.
Values
kSbAccessibilityCaptionColorBluekSbAccessibilityCaptionColorBlackkSbAccessibilityCaptionColorCyankSbAccessibilityCaptionColorGreenkSbAccessibilityCaptionColorMagentakSbAccessibilityCaptionColorRedkSbAccessibilityCaptionColorWhitekSbAccessibilityCaptionColorYellow
SbAccessibilityCaptionFontFamily
Enum for possible closed captioning font families
Values
kSbAccessibilityCaptionFontFamilyCasualkSbAccessibilityCaptionFontFamilyCursivekSbAccessibilityCaptionFontFamilyMonospaceSansSerifkSbAccessibilityCaptionFontFamilyMonospaceSerifkSbAccessibilityCaptionFontFamilyProportionalSansSerifkSbAccessibilityCaptionFontFamilyProportionalSerifkSbAccessibilityCaptionFontFamilySmallCapitals
SbAccessibilityCaptionFontSizePercentage
Enum for possible closed captioning font size percentages.
Values
kSbAccessibilityCaptionFontSizePercentage25kSbAccessibilityCaptionFontSizePercentage50kSbAccessibilityCaptionFontSizePercentage75kSbAccessibilityCaptionFontSizePercentage100kSbAccessibilityCaptionFontSizePercentage125kSbAccessibilityCaptionFontSizePercentage150kSbAccessibilityCaptionFontSizePercentage175kSbAccessibilityCaptionFontSizePercentage200kSbAccessibilityCaptionFontSizePercentage225kSbAccessibilityCaptionFontSizePercentage250kSbAccessibilityCaptionFontSizePercentage275kSbAccessibilityCaptionFontSizePercentage300
SbAccessibilityCaptionOpacityPercentage
Enum for possible closed captioning opacity percentages.
Values
kSbAccessibilityCaptionOpacityPercentage0kSbAccessibilityCaptionOpacityPercentage25kSbAccessibilityCaptionOpacityPercentage50kSbAccessibilityCaptionOpacityPercentage75kSbAccessibilityCaptionOpacityPercentage100
SbAccessibilityCaptionState
Enum for possible states of closed captioning properties.
Values
kSbAccessibilityCaptionStateUnsupported
The property is not supported by the system. The application should provide
a way to set this property, otherwise it will not be changeable. For any
given closed captioning property, if its corresponding state property has a
value of kSbAccessibilityCaptionStateUnsupported, then its own value is
undefined. For example, if
SbAccessibilityCaptionColor::background_color_state has a value of
kSbAccessibilityCaptionStateUnsupported, then the value of
SbAccessibilityCaptionColor::background_color is undefined.
kSbAccessibilityCaptionStateUnset
The property is supported by the system, but the user has not set it. The
application should provide a default setting for the property to handle this
case.
kSbAccessibilityCaptionStateSet
The user has set this property as a system default, meaning that it should
take priority over app defaults. If
SbAccessibilityCaptionSettings.supportsOverride contains true, this value
should be interpreted as explicitly saying "do not override." If it contains
false, it is up to the application to interpret any additional meaning of
this value.
kSbAccessibilityCaptionStateOverride
This property should take priority over everything but application-level
overrides, including video caption data. If
SbAccessibilityCaptionSettings.supportsOverride contains false, then no
fields of SbAccessibilityCaptionSettings will ever contain this value.
Structs
SbAccessibilityCaptionSettings
A group of settings related to system-level closed captioning settings, for
platforms that expose closed captioning settings.
Members
SbAccessibilityCaptionColor background_colorSbAccessibilityCaptionState background_color_stateSbAccessibilityCaptionOpacityPercentage background_opacitySbAccessibilityCaptionState background_opacity_stateSbAccessibilityCaptionCharacterEdgeStyle character_edge_styleSbAccessibilityCaptionState character_edge_style_stateSbAccessibilityCaptionColor font_colorSbAccessibilityCaptionState font_color_stateSbAccessibilityCaptionFontFamily font_familySbAccessibilityCaptionState font_family_stateSbAccessibilityCaptionOpacityPercentage font_opacitySbAccessibilityCaptionState font_opacity_stateSbAccessibilityCaptionFontSizePercentage font_sizeSbAccessibilityCaptionState font_size_stateSbAccessibilityCaptionColor window_colorSbAccessibilityCaptionState window_color_stateSbAccessibilityCaptionOpacityPercentage window_opacitySbAccessibilityCaptionState window_opacity_statebool is_enabled
The is_enabled attribute determines if the user has chosen to enable
closed captions on their system.
bool supports_is_enabled
Some platforms support enabling or disabling captions, some support reading
whether they are enabled from the system settings, and others support
neither. As a result, there are separate checks for getting and setting the
value that is contained in the is_enabled attribute. Modifying the
attribute via SbAccessibilitySetCaptionsEnabled will change the setting
system-wide. Attempting to read is_enabled when the value of
supports_is_enabled is false will always return false. Attempting to set
is_enabled via SbAccessibilitySetCaptionsEnabled when the value of
supports_set_enabled is false will fail silently.
bool supports_set_enabled
bool supports_override
Some platforms may specify that when setting a property, it should override
data from video streams and application settings (unless the application has
its own overrides). Depending on whether this attribute contains true or
false, the values of SbAccessibilityCaptionState should be interpreted
differently.
SbAccessibilityDisplaySettings
Members
bool has_high_contrast_text_setting
Whether this platform has a system setting for high contrast text or not.
bool is_high_contrast_text_enabled
Whether the high contrast text setting is enabled or not.
SbAccessibilityTextToSpeechSettings
A group of settings related to text-to-speech functionality, for platforms that
expose system settings for text-to-speech.
Members
bool has_text_to_speech_setting
Whether this platform has a system setting for text-to-speech or not.
bool is_text_to_speech_enabled
Whether the text-to-speech setting is enabled or not. This setting is only
valid if has_text_to_speech_setting is set to true.
Functions
SbAccessibilityGetCaptionSettings
Get the platform's settings for system-level closed captions. This function
returns false if caption_settings is NULL or if it is not zero-initialized.
caption_settings: A pointer to a zero-initialized
SbAccessibilityTextToSpeechSettings struct.
Declaration
bool SbAccessibilityGetCaptionSettings(SbAccessibilityCaptionSettings *caption_settings)
SbAccessibilityGetDisplaySettings
Get the platform settings related to high contrast text. This function returns
false if out_settings is NULL or if it is not zero-initialized.
out_settings: A pointer to a zero-initialized SbAccessibilityDisplaySettings*
struct.
Declaration
bool SbAccessibilityGetDisplaySettings(SbAccessibilityDisplaySettings *out_settings)
SbAccessibilityGetTextToSpeechSettings
Get the platform settings related to the text-to-speech accessibility feature.
This function returns false if out_settings is NULL or if it is not zero-
initialized.
out_settings: A pointer to a zero-initialized
SbAccessibilityTextToSpeechSettings struct.
Declaration
bool SbAccessibilityGetTextToSpeechSettings(SbAccessibilityTextToSpeechSettings *out_settings)
SbAccessibilitySetCaptionsEnabled
Modifies whether closed captions are enabled at a system level. This function
returns false if this feature is not supported by the platform, or if changing
the setting is unsuccessful. This function will modify the setting system-wide.
enabled: A boolean indicating whether captions should be turned on (true) or
off (false).
Declaration
bool SbAccessibilitySetCaptionsEnabled(bool enabled)
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[[["\u003cp\u003eThis page details the system options and settings related to accessibility, including closed captioning, high contrast text, and text-to-speech.\u003c/p\u003e\n"],["\u003cp\u003eClosed captioning settings encompass various enums for customization, such as \u003ccode\u003eSbAccessibilityCaptionCharacterEdgeStyle\u003c/code\u003e, \u003ccode\u003eSbAccessibilityCaptionColor\u003c/code\u003e, \u003ccode\u003eSbAccessibilityCaptionFontFamily\u003c/code\u003e, \u003ccode\u003eSbAccessibilityCaptionFontSizePercentage\u003c/code\u003e, and \u003ccode\u003eSbAccessibilityCaptionOpacityPercentage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSbAccessibilityCaptionState\u003c/code\u003e enum defines the support level of a closed captioning property, which can be unsupported, unset, set, or override.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eSbAccessibilityCaptionSettings\u003c/code\u003e struct consolidates all system-level closed captioning configurations, including font and background color, opacity, and edge styles.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSbAccessibilityGetCaptionSettings\u003c/code\u003e, \u003ccode\u003eSbAccessibilityGetDisplaySettings\u003c/code\u003e, \u003ccode\u003eSbAccessibilityGetTextToSpeechSettings\u003c/code\u003e, and \u003ccode\u003eSbAccessibilitySetCaptionsEnabled\u003c/code\u003e functions allow for retrieving and setting the system-level accessibility preferences.\u003c/p\u003e\n"]]],["This content details accessibility settings, specifically for closed captions, display, and text-to-speech. It defines enums for caption styles (edge style, color, font, size, opacity) and their states (unsupported, unset, set, override). The `SbAccessibilityCaptionSettings` struct controls various caption properties, including enabling/disabling and override support. `SbAccessibilityDisplaySettings` and `SbAccessibilityTextToSpeechSettings` detail high-contrast text and text-to-speech settings respectively. Functions `SbAccessibilityGetCaptionSettings`, `SbAccessibilityGetDisplaySettings`, `SbAccessibilityGetTextToSpeechSettings`, and `SbAccessibilitySetCaptionsEnabled` are used to get and modify these settings.\n"],null,["Provides access to the system options and settings related to accessibility.\n\nEnums\n\nSbAccessibilityCaptionCharacterEdgeStyle\n\nEnum for possible closed captioning character edge styles.\n\nValues\n\n- `kSbAccessibilityCaptionCharacterEdgeStyleNone`\n- `kSbAccessibilityCaptionCharacterEdgeStyleRaised`\n- `kSbAccessibilityCaptionCharacterEdgeStyleDepressed`\n- `kSbAccessibilityCaptionCharacterEdgeStyleUniform`\n- `kSbAccessibilityCaptionCharacterEdgeStyleDropShadow`\n\nSbAccessibilityCaptionColor\n\nEnum for possible closed captioning colors.\n\nValues\n\n- `kSbAccessibilityCaptionColorBlue`\n- `kSbAccessibilityCaptionColorBlack`\n- `kSbAccessibilityCaptionColorCyan`\n- `kSbAccessibilityCaptionColorGreen`\n- `kSbAccessibilityCaptionColorMagenta`\n- `kSbAccessibilityCaptionColorRed`\n- `kSbAccessibilityCaptionColorWhite`\n- `kSbAccessibilityCaptionColorYellow`\n\nSbAccessibilityCaptionFontFamily\n\nEnum for possible closed captioning font families\n\nValues\n\n- `kSbAccessibilityCaptionFontFamilyCasual`\n- `kSbAccessibilityCaptionFontFamilyCursive`\n- `kSbAccessibilityCaptionFontFamilyMonospaceSansSerif`\n- `kSbAccessibilityCaptionFontFamilyMonospaceSerif`\n- `kSbAccessibilityCaptionFontFamilyProportionalSansSerif`\n- `kSbAccessibilityCaptionFontFamilyProportionalSerif`\n- `kSbAccessibilityCaptionFontFamilySmallCapitals`\n\nSbAccessibilityCaptionFontSizePercentage\n\nEnum for possible closed captioning font size percentages.\n\nValues\n\n- `kSbAccessibilityCaptionFontSizePercentage25`\n- `kSbAccessibilityCaptionFontSizePercentage50`\n- `kSbAccessibilityCaptionFontSizePercentage75`\n- `kSbAccessibilityCaptionFontSizePercentage100`\n- `kSbAccessibilityCaptionFontSizePercentage125`\n- `kSbAccessibilityCaptionFontSizePercentage150`\n- `kSbAccessibilityCaptionFontSizePercentage175`\n- `kSbAccessibilityCaptionFontSizePercentage200`\n- `kSbAccessibilityCaptionFontSizePercentage225`\n- `kSbAccessibilityCaptionFontSizePercentage250`\n- `kSbAccessibilityCaptionFontSizePercentage275`\n- `kSbAccessibilityCaptionFontSizePercentage300`\n\nSbAccessibilityCaptionOpacityPercentage\n\nEnum for possible closed captioning opacity percentages.\n\nValues\n\n- `kSbAccessibilityCaptionOpacityPercentage0`\n- `kSbAccessibilityCaptionOpacityPercentage25`\n- `kSbAccessibilityCaptionOpacityPercentage50`\n- `kSbAccessibilityCaptionOpacityPercentage75`\n- `kSbAccessibilityCaptionOpacityPercentage100`\n\nSbAccessibilityCaptionState\n\nEnum for possible states of closed captioning properties.\n\nValues\n\n- `kSbAccessibilityCaptionStateUnsupported`\n\n The property is not supported by the system. The application should provide\n a way to set this property, otherwise it will not be changeable. For any\n given closed captioning property, if its corresponding state property has a\n value of `kSbAccessibilityCaptionStateUnsupported`, then its own value is\n undefined. For example, if\n `SbAccessibilityCaptionColor::background_color_state` has a value of\n `kSbAccessibilityCaptionStateUnsupported`, then the value of\n `SbAccessibilityCaptionColor::background_color` is undefined.\n- `kSbAccessibilityCaptionStateUnset`\n\n The property is supported by the system, but the user has not set it. The\n application should provide a default setting for the property to handle this\n case.\n- `kSbAccessibilityCaptionStateSet`\n\n The user has set this property as a system default, meaning that it should\n take priority over app defaults. If\n SbAccessibilityCaptionSettings.supportsOverride contains true, this value\n should be interpreted as explicitly saying \"do not override.\" If it contains\n false, it is up to the application to interpret any additional meaning of\n this value.\n- `kSbAccessibilityCaptionStateOverride`\n\n This property should take priority over everything but application-level\n overrides, including video caption data. If\n SbAccessibilityCaptionSettings.supportsOverride contains false, then no\n fields of SbAccessibilityCaptionSettings will ever contain this value.\n\nStructs\n\nSbAccessibilityCaptionSettings\n\nA group of settings related to system-level closed captioning settings, for\nplatforms that expose closed captioning settings.\n\nMembers\n\n- `SbAccessibilityCaptionColor background_color`\n- `SbAccessibilityCaptionState background_color_state`\n- `SbAccessibilityCaptionOpacityPercentage background_opacity`\n- `SbAccessibilityCaptionState background_opacity_state`\n- `SbAccessibilityCaptionCharacterEdgeStyle character_edge_style`\n- `SbAccessibilityCaptionState character_edge_style_state`\n- `SbAccessibilityCaptionColor font_color`\n- `SbAccessibilityCaptionState font_color_state`\n- `SbAccessibilityCaptionFontFamily font_family`\n- `SbAccessibilityCaptionState font_family_state`\n- `SbAccessibilityCaptionOpacityPercentage font_opacity`\n- `SbAccessibilityCaptionState font_opacity_state`\n- `SbAccessibilityCaptionFontSizePercentage font_size`\n- `SbAccessibilityCaptionState font_size_state`\n- `SbAccessibilityCaptionColor window_color`\n- `SbAccessibilityCaptionState window_color_state`\n- `SbAccessibilityCaptionOpacityPercentage window_opacity`\n- `SbAccessibilityCaptionState window_opacity_state`\n- `bool is_enabled`\n\n The `is_enabled` attribute determines if the user has chosen to enable\n closed captions on their system.\n- `bool supports_is_enabled`\n\n Some platforms support enabling or disabling captions, some support reading\n whether they are enabled from the system settings, and others support\n neither. As a result, there are separate checks for getting and setting the\n value that is contained in the `is_enabled` attribute. Modifying the\n attribute via `SbAccessibilitySetCaptionsEnabled` will change the setting\n system-wide. Attempting to read `is_enabled` when the value of\n `supports_is_enabled` is false will always return false. Attempting to set\n `is_enabled` via `SbAccessibilitySetCaptionsEnabled` when the value of\n `supports_set_enabled` is false will fail silently.\n- `bool supports_set_enabled`\n\n- `bool supports_override`\n\n Some platforms may specify that when setting a property, it should override\n data from video streams and application settings (unless the application has\n its own overrides). Depending on whether this attribute contains true or\n false, the values of `SbAccessibilityCaptionState` should be interpreted\n differently.\n\nSbAccessibilityDisplaySettings\n\nMembers\n\n- `bool has_high_contrast_text_setting`\n\n Whether this platform has a system setting for high contrast text or not.\n- `bool is_high_contrast_text_enabled`\n\n Whether the high contrast text setting is enabled or not.\n\nSbAccessibilityTextToSpeechSettings\n\nA group of settings related to text-to-speech functionality, for platforms that\nexpose system settings for text-to-speech.\n\nMembers\n\n- `bool has_text_to_speech_setting`\n\n Whether this platform has a system setting for text-to-speech or not.\n- `bool is_text_to_speech_enabled`\n\n Whether the text-to-speech setting is enabled or not. This setting is only\n valid if `has_text_to_speech_setting` is set to true.\n\nFunctions\n\nSbAccessibilityGetCaptionSettings\n\nGet the platform's settings for system-level closed captions. This function\nreturns false if `caption_settings` is NULL or if it is not zero-initialized.\n\n`caption_settings`: A pointer to a zero-initialized\nSbAccessibilityTextToSpeechSettings struct.\n\nDeclaration \n\n bool SbAccessibilityGetCaptionSettings(SbAccessibilityCaptionSettings *caption_settings)\n\nSbAccessibilityGetDisplaySettings\n\nGet the platform settings related to high contrast text. This function returns\nfalse if `out_settings` is NULL or if it is not zero-initialized.\n\n`out_settings`: A pointer to a zero-initialized SbAccessibilityDisplaySettings\\*\nstruct.\n\nDeclaration \n\n bool SbAccessibilityGetDisplaySettings(SbAccessibilityDisplaySettings *out_settings)\n\nSbAccessibilityGetTextToSpeechSettings\n\nGet the platform settings related to the text-to-speech accessibility feature.\nThis function returns false if `out_settings` is NULL or if it is not zero-\ninitialized.\n\n`out_settings`: A pointer to a zero-initialized\nSbAccessibilityTextToSpeechSettings struct.\n\nDeclaration \n\n bool SbAccessibilityGetTextToSpeechSettings(SbAccessibilityTextToSpeechSettings *out_settings)\n\nSbAccessibilitySetCaptionsEnabled\n\nModifies whether closed captions are enabled at a system level. This function\nreturns false if this feature is not supported by the platform, or if changing\nthe setting is unsuccessful. This function will modify the setting system-wide.\n\n`enabled`: A boolean indicating whether captions should be turned on (true) or\noff (false).\n\nDeclaration \n\n bool SbAccessibilitySetCaptionsEnabled(bool enabled)"]]
