@firebolt-js/manage-sdk

{ "openrpc": "1.2.4", "info": { "title": "Firebolt Manage SDK", "version": "1.5.0", "x-module-descriptions": { "Account": "A module for querying about the device account.", "AcknowledgeChallenge": "A module for registering as a provider for a user grant in which the user confirms access to a capability", "Advertising": "A module for platform provided advertising settings and functionality.", "AudioDescriptions": "A module for managing audio-description Settings.", "ClosedCaptions": "A module for managing closed-captions Settings.", "Device": "A module for querying about the device and it's capabilities.", "Discovery": "Your App likely wants to integrate with the Platform's discovery capabilities. For example to add a \"Watch Next\" tile that links to your app from the platform's home screen.\n\nGetting access to this information requires to connect to lower level APIs made available by the platform. Since implementations differ between operators and platforms, the Firebolt SDK offers a Discovery module, that exposes a generic, agnostic interface to the developer.\n\nUnder the hood, an underlaying transport layer will then take care of calling the right APIs for the actual platform implementation that your App is running on.\n\nThe Discovery plugin is used to _send_ information to the Platform.\n\n### Localization\nApps should provide all user-facing strings in the device's language, as specified by the Firebolt `Localization.language` property.\n\nApps should provide prices in the same currency presented in the app. If multiple currencies are supported in the app, the app should provide prices in the user's current default currency.", "HDMIInput": "Methods for managing HDMI inputs on an HDMI sink device.", "Keyboard": "Methods for prompting users to enter text with task-oriented UX", "Localization": "Methods for accessessing location and language preferences", "Metrics": "Methods for sending metrics", "PinChallenge": "A module for registering as a provider for a user grant in which the user is prompted for a pin for access to a capability", "Privacy": "A module for managing device settings.", "SecureStorage": "A module for storing and retrieving secure data owned by the app", "UserGrants": "A module for managing grants given by the user", "VoiceGuidance": "A module for managing voice guidance settings.", "Wifi": "A module for providing support for Wifi." }, "x-interface-names": { "xrn:firebolt:capability:lifecycle:state": "StateProvider" } }, "methods": [ { "name": "Localization.locality", "tags": [ { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:locality" ] }, { "name": "property" } ], "summary": "Get the locality/city the device is located in", "params": [], "result": { "name": "locality", "summary": "the device city", "schema": { "$ref": "#/x-schemas/Localization/Locality" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "Default Result", "value": "Philadelphia" } }, { "name": "Default example #2", "params": [], "result": { "name": "Default Result", "value": "Rockville" } } ] }, { "name": "Localization.postalCode", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:postal-code" ] } ], "summary": "Get the postal code the device is located in", "params": [], "result": { "name": "postalCode", "summary": "the device postal code", "schema": { "type": "string" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "Default Result", "value": "19103" } }, { "name": "Default example #2", "params": [], "result": { "name": "Default Result", "value": "20850" } } ] }, { "name": "Localization.countryCode", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:country-code" ] } ], "summary": "Get the ISO 3166-1 alpha-2 code for the country device is located in", "params": [], "result": { "name": "code", "summary": "the device country code", "schema": { "$ref": "#/x-schemas/Localization/CountryCode" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "Default Result", "value": "US" } }, { "name": "Default example #2", "params": [], "result": { "name": "Default Result", "value": "UK" } } ] }, { "name": "Localization.language", "summary": "Get the ISO 639 1/2 code for the preferred language", "params": [], "tags": [ { "name": "deprecated", "x-since": "0.17.0", "x-alternative": "Localization.locale" }, { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:language" ] } ], "result": { "name": "lang", "summary": "the device language", "schema": { "$ref": "#/x-schemas/Localization/Language" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "Default Result", "value": "en" } }, { "name": "Default example #2", "params": [], "result": { "name": "Default Result", "value": "es" } } ] }, { "name": "Localization.preferredAudioLanguages", "summary": "A prioritized list of ISO 639 1/2 codes for the preferred audio languages on this device.", "params": [], "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:language" ] } ], "result": { "name": "languages", "summary": "the preferred audio languages", "schema": { "type": "array", "items": { "$ref": "#/x-schemas/Localization/ISO639_2Language" } } }, "examples": [ { "name": "Default Example", "params": [], "result": { "name": "Default Result", "value": [ "spa", "eng" ] } }, { "name": "Default Example #2", "params": [], "result": { "name": "Default Result", "value": [ "eng", "spa" ] } } ] }, { "name": "Localization.locale", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:locale" ] } ], "summary": "Get the *full* BCP 47 code, including script, region, variant, etc., for the preferred langauage/locale", "params": [], "result": { "name": "locale", "summary": "the device locale", "schema": { "$ref": "#/x-schemas/Localization/Locale" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "Default Result", "value": "en-US" } }, { "name": "Default example #2", "params": [], "result": { "name": "Default Result", "value": "es-US" } } ] }, { "name": "Localization.additionalInfo", "tags": [ { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:additional-info" ] } ], "summary": "Get any platform-specific localization information", "params": [], "result": { "name": "info", "summary": "the additional info", "schema": { "type": "object", "additionalProperties": { "type": [ "number", "string", "boolean" ], "maxLength": 1024 }, "maxProperties": 32 } }, "examples": [ { "name": "Default Example", "params": [], "result": { "name": "info", "value": {} } } ] }, { "name": "Localization.addAdditionalInfo", "tags": [ { "name": "capabilities", "x-manages": [ "xrn:firebolt:capability:localization:additional-info" ] } ], "summary": "Add any platform-specific localization information in key/value pair", "params": [ { "name": "key", "summary": "Key to add additionalInfo", "schema": { "type": "string" }, "required": true }, { "name": "value", "summary": "Value to be set for additionalInfo. Value can be a number, string or boolean", "schema": { "type": [ "number", "string", "boolean" ] }, "required": true } ], "result": { "name": "result", "schema": { "const": null } }, "examples": [ { "name": "Add an additionalInfo for localization", "params": [ { "name": "key", "value": "defaultKey" }, { "name": "value", "value": "defaultValue=" } ], "result": { "name": "defaultResult", "value": null } } ] }, { "name": "Localization.removeAdditionalInfo", "tags": [ { "name": "capabilities", "x-manages": [ "xrn:firebolt:capability:localization:additional-info" ] } ], "summary": "Remove any platform-specific localization information from map", "params": [ { "name": "key", "summary": "Key to remove additionalInfo", "schema": { "type": "string" }, "required": true } ], "result": { "name": "result", "schema": { "const": null } }, "examples": [ { "name": "Remove an additionalInfo for localization", "params": [ { "name": "key", "value": "defaultKey" } ], "result": { "name": "defaultResult", "value": null } } ] }, { "name": "Localization.timeZone", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:time-zone" ] } ], "summary": "Set the IANA timezone for the device", "params": [], "result": { "name": "result", "schema": { "$ref": "#/x-schemas/Localization/TimeZone" } }, "examples": [ { "name": "Default Example", "params": [], "result": { "name": "Default Result", "value": "America/New_York" } }, { "name": "Additional Example", "params": [], "result": { "name": "Default Result", "value": "America/Los_Angeles" } } ] }, { "name": "Localization.onLocalityChanged", "tags": [ { "name": "subscriber", "x-subscriber-for": "Localization.locality" }, { "name": "event", "x-alternative": "locality" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:locality" ] } ], "summary": "Get the locality/city the device is located in", "params": [ { "name": "listen", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "locality", "summary": "the device city", "schema": { "anyOf": [ { "$ref": "#/x-schemas/Types/ListenResponse" }, { "$ref": "#/x-schemas/Localization/Locality" } ] } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": "Philadelphia" } }, { "name": "Default example #2", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": "Rockville" } } ] }, { "name": "Localization.onPostalCodeChanged", "tags": [ { "name": "subscriber", "x-subscriber-for": "Localization.postalCode" }, { "name": "event", "x-alternative": "postalCode" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:postal-code" ] } ], "summary": "Get the postal code the device is located in", "params": [ { "name": "listen", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "postalCode", "summary": "the device postal code", "schema": { "anyOf": [ { "$ref": "#/x-schemas/Types/ListenResponse" }, { "type": "string" } ] } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": "19103" } }, { "name": "Default example #2", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": "20850" } } ] }, { "name": "Localization.onCountryCodeChanged", "tags": [ { "name": "subscriber", "x-subscriber-for": "Localization.countryCode" }, { "name": "event", "x-alternative": "countryCode" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:country-code" ] } ], "summary": "Get the ISO 3166-1 alpha-2 code for the country device is located in", "params": [ { "name": "listen", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "code", "summary": "the device country code", "schema": { "anyOf": [ { "$ref": "#/x-schemas/Types/ListenResponse" }, { "$ref": "#/x-schemas/Localization/CountryCode" } ] } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": "US" } }, { "name": "Default example #2", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": "UK" } } ] }, { "name": "Localization.onLanguageChanged", "summary": "Get the ISO 639 1/2 code for the preferred language", "params": [ { "name": "listen", "required": true, "schema": { "type": "boolean" } } ], "tags": [ { "name": "subscriber", "x-subscriber-for": "Localization.language" }, { "name": "event", "x-alternative": "language" }, { "name": "deprecated", "x-since": "0.17.0", "x-alternative": "Localization.locale" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:language" ] } ], "result": { "name": "lang", "summary": "the device language", "schema": { "anyOf": [ { "$ref": "#/x-schemas/Types/ListenResponse" }, { "$ref": "#/x-schemas/Localization/Language" } ] } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": "en" } }, { "name": "Default example #2", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": "es" } } ] }, { "name": "Localization.onPreferredAudioLanguagesChanged", "summary": "A prioritized list of ISO 639 1/2 codes for the preferred audio languages on this device.", "params": [ { "name": "listen", "required": true, "schema": { "type": "boolean" } } ], "tags": [ { "name": "subscriber", "x-subscriber-for": "Localization.preferredAudioLanguages" }, { "name": "event", "x-alternative": "preferredAudioLanguages" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:language" ] } ], "result": { "name": "languages", "summary": "the preferred audio languages", "schema": { "anyOf": [ { "$ref": "#/x-schemas/Types/ListenResponse" }, { "type": "array", "items": { "$ref": "#/x-schemas/Localization/ISO639_2Language" } } ] } }, "examples": [ { "name": "Default Example", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": [ "spa", "eng" ] } }, { "name": "Default Example #2", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": [ "eng", "spa" ] } } ] }, { "name": "Localization.onLocaleChanged", "tags": [ { "name": "subscriber", "x-subscriber-for": "Localization.locale" }, { "name": "event", "x-alternative": "locale" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:locale" ] } ], "summary": "Get the *full* BCP 47 code, including script, region, variant, etc., for the preferred langauage/locale", "params": [ { "name": "listen", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "locale", "summary": "the device locale", "schema": { "anyOf": [ { "$ref": "#/x-schemas/Types/ListenResponse" }, { "$ref": "#/x-schemas/Localization/Locale" } ] } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": "en-US" } }, { "name": "Default example #2", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": "es-US" } } ] }, { "name": "Localization.onTimeZoneChanged", "tags": [ { "name": "subscriber", "x-subscriber-for": "Localization.timeZone" }, { "name": "event", "x-alternative": "timeZone" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:localization:time-zone" ] } ], "summary": "Set the IANA timezone for the device", "params": [ { "name": "listen", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "anyOf": [ { "$ref": "#/x-schemas/Types/ListenResponse" }, { "$ref": "#/x-schemas/Localization/TimeZone" } ] } }, "examples": [ { "name": "Default Example", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": "America/New_York" } }, { "name": "Additional Example", "params": [ { "name": "listen", "value": true } ], "result": { "name": "Default Result", "value": "America/Los_Angeles" } } ] }, { "name": "Localization.setLocality", "tags": [ { "name": "setter", "x-setter-for": "locality" }, { "name": "capabilities", "x-manages": [ "xrn:firebolt:capability:localization:locality" ] } ], "summary": "Get the locality/city the device is located in", "params": [ { "name": "value", "summary": "the device city", "schema": { "$ref": "#/x-schemas/Localization/Locality" }, "required": true } ], "result": { "name": "result", "schema": { "type": "null" } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "value", "value": "Philadelphia" } ], "result": { "name": "Default Result", "value": null } }, { "name": "Default example #2", "params": [ { "name": "value", "value": "Rockville" } ], "result": { "name": "Default Result", "value": null } } ] }, { "name": "Localization.setPostalCode", "tags": [ { "name": "setter", "x-setter-for": "postalCode" }, { "name": "capabilities", "x-manages": [ "xrn:firebolt:capability:localization:postal-code" ] } ], "summary": "Get the postal code the device is located in", "params": [ { "name": "value", "summary": "the device postal code", "schema": { "type": "string" }, "required": true } ], "result": { "name": "result", "schema": { "type": "null" } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "value", "value": "19103" } ], "result": { "name": "Default Result", "value": null } }, { "name": "Default example #2", "params": [ { "name": "value", "value": "20850" } ], "result": { "name": "Default Result", "value": null } } ] }, { "name": "Localization.setCountryCode", "tags": [ { "name": "setter", "x-setter-for": "countryCode" }, { "name": "capabilities", "x-manages": [ "xrn:firebolt:capability:localization:country-code" ] } ], "summary": "Get the ISO 3166-1 alpha-2 code for the country device is located in", "params": [ { "name": "value", "summary": "the device country code", "schema": { "$ref": "#/x-schemas/Localization/CountryCode" }, "required": true } ], "result": { "name": "result", "schema": { "type": "null" } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "value", "value": "US" } ], "result": { "name": "Default Result", "value": null } }, { "name": "Default example #2", "params": [ { "name": "value", "value": "UK" } ], "result": { "name": "Default Result", "value": null } } ] }, { "name": "Localization.setLanguage", "summary": "Get the ISO 639 1/2 code for the preferred language", "params": [ { "name": "value", "summary": "the device language", "schema": { "$ref": "#/x-schemas/Localization/Language" }, "required": true } ], "tags": [ { "name": "setter", "x-setter-for": "language" }, { "name": "deprecated", "x-since": "0.17.0", "x-alternative": "Localization.locale" }, { "name": "capabilities", "x-manages": [ "xrn:firebolt:capability:localization:language" ] } ], "result": { "name": "result", "schema": { "type": "null" } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "value", "value": "en" } ], "result": { "name": "Default Result", "value": null } }, { "name": "Default example #2", "params": [ { "name": "value", "value": "es" } ], "result": { "name": "Default Result", "value": null } } ] }, { "name": "Localization.setPreferredAudioLanguages", "summary": "A prioritized list of ISO 639 1/2 codes for the preferred audio languages on this device.", "params": [ { "name": "value", "summary": "the preferred audio languages", "schema": { "type": "array", "items": { "$ref": "#/x-schemas/Localization/ISO639_2Language" } }, "required": true } ], "tags": [ { "name": "setter", "x-setter-for": "preferredAudioLanguages" }, { "name": "capabilities", "x-manages": [ "xrn:firebolt:capability:localization:language" ] } ], "result": { "name": "result", "schema": { "type": "null" } }, "examples": [ { "name": "Default Example", "params": [ { "name": "value", "value": [ "spa", "eng" ] } ], "result": { "name": "Default Result", "value": null } }, { "name": "Default Example #2", "params": [ { "name": "value", "value": [ "eng", "spa" ] } ], "result": { "name": "Default Result", "value": null } } ] }, { "name": "Localization.setLocale", "tags": [ { "name": "setter", "x-setter-for": "locale" }, { "name": "capabilities", "x-manages": [ "xrn:firebolt:capability:localization:locale" ] } ], "summary": "Get the *full* BCP 47 code, including script, region, variant, etc., for the preferred langauage/locale", "params": [ { "name": "value", "summary": "the device locale", "schema": { "$ref": "#/x-schemas/Localization/Locale" }, "required": true } ], "result": { "name": "result", "schema": { "type": "null" } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "value", "value": "en-US" } ], "result": { "name": "Default Result", "value": null } }, { "name": "Default example #2", "params": [ { "name": "value", "value": "es-US" } ], "result": { "name": "Default Result", "value": null } } ] }, { "name": "Localization.setTimeZone", "tags": [ { "name": "setter", "x-setter-for": "timeZone" }, { "name": "capabilities", "x-manages": [ "xrn:firebolt:capability:localization:time-zone" ] } ], "summary": "Set the IANA timezone for the device", "params": [ { "name": "value", "schema": { "$ref": "#/x-schemas/Localization/TimeZone" }, "required": true } ], "result": { "name": "result", "schema": { "type": "null" } }, "examples": [ { "name": "Default Example", "params": [ { "name": "value", "value": "America/New_York" } ], "result": { "name": "Default Result", "value": null } }, { "name": "Additional Example", "params": [ { "name": "value", "value": "America/Los_Angeles" } ], "result": { "name": "Default Result", "value": null } } ] }, { "name": "Metrics.event", "tags": [ { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:metrics:distributor" ] } ], "summary": "Inform the platform of 1st party distributor metrics.", "params": [ { "name": "schema", "summary": "The schema URI of the metric type", "schema": { "type": "string", "format": "uri" }, "required": true }, { "name": "data", "summary": "A JSON payload conforming the the provided schema", "schema": { "$ref": "#/components/schemas/EventObject" }, "required": true } ], "result": { "name": "results", "schema": { "type": "null" } }, "examples": [ { "name": "Send foo event", "params": [ { "name": "schema", "value": "http://meta.rdkcentral.com/some/schema" }, { "name": "data", "value": { "foo": "foo" } } ], "result": { "name": "result", "value": null } } ] }, { "name": "Wifi.scan", "summary": "Scan available wifi networks in the location.", "tags": [ { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:protocol:wifi" ] } ], "params": [ { "name": "timeout", "schema": { "$ref": "#/x-schemas/Types/Timeout" } } ], "result": { "name": "list", "summary": "Contains a list of wifi networks available near the device.", "schema": { "$ref": "#/components/schemas/AccessPointList" } }, "examples": [ { "name": "Successful Wifi List", "params": [ { "name": "timeout", "value": 30 } ], "result": { "name": "successfulWifiResultExample", "value": { "list": [ { "ssid": "DND", "security": "wpa2Psk", "signalStrength": -70, "frequency": 2.4 }, { "ssid": "Fortnite", "security": "WPA2_ENTERPRISE_AES", "signalStrength": -70, "frequency": 5 }, { "ssid": "Guardian", "security": "none", "signalStrength": -70, "frequency": 2.4 } ] } } } ] }, { "name": "Wifi.connect", "summary": "Connect the device to the specified SSID.", "tags": [ { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:protocol:wifi" ] } ], "params": [ { "name": "ssid", "schema": { "type": "string" }, "description": "Name of Wifi SSID to connect for the device." }, { "name": "passphrase", "schema": { "type": "string" }, "description": "Password or Passphrase for the wifi." }, { "name": "security", "schema": { "$ref": "#/components/schemas/WifiSecurityMode" } } ], "result": { "name": "connectedWifi", "summary": "Successful Response after connecting to the Wifi.", "schema": { "$ref": "#/components/schemas/AccessPoint" } }, "examples": [ { "name": "Connect to a wpa2Psk Wifi with password", "params": [ { "name": "ssid", "value": "DND" }, { "name": "passphrase", "value": "gargoyle" }, { "name": "security", "value": "wpa2Psk" } ], "result": { "name": "successfulWifiConnection", "value": { "ssid": "DND", "security": "wpa2Psk", "signalStrength": -70, "frequency": 2.4 } } }, { "name": "Connect to a WPA2 PSK Wifi with password", "params": [ { "name": "ssid", "value": "Guardian WIFI" }, { "name": "passphrase", "value": "" }, { "name": "security", "value": "none" } ], "result": { "name": "successfulWifiConnection", "value": { "ssid": "Guardian WIFI", "security": "none", "signalStrength": -70, "frequency": 2.4 } } } ] }, { "name": "Wifi.disconnect", "summary": "Disconnect the device if connected via WIFI.", "tags": [ { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:protocol:wifi" ] } ], "params": [], "result": { "name": "result", "schema": { "const": null } }, "examples": [ { "name": "Disconnect", "params": [], "result": { "name": "defaultResult", "value": null } } ] }, { "name": "Wifi.wps", "summary": "Connect to WPS", "tags": [ { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:protocol:wifi" ] } ], "params": [ { "name": "security", "schema": { "$ref": "#/components/schemas/WPSSecurityPin" } } ], "result": { "name": "connectedWifi", "summary": "Successful Response after connecting to the Wifi.", "schema": { "$ref": "#/components/schemas/AccessPoint" } }, "examples": [ { "name": "Connect to a WPS Wifi router", "params": [ { "name": "security", "value": "pushButton" } ], "result": { "name": "successfulWifiConnection", "value": { "ssid": "DND", "security": "wpa2Psk", "signalStrength": -70, "frequency": 2.4 } } } ] }, { "name": "ClosedCaptions.enabled", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "Whether or not closed-captions are enabled.", "params": [], "result": { "name": "enabled", "schema": { "type": "boolean" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "enabled", "value": true } }, { "name": "Default example #2", "params": [], "result": { "name": "enabled", "value": false } } ] }, { "name": "ClosedCaptions.fontFamily", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred font family for displaying closed-captions.", "params": [], "result": { "name": "family", "schema": { "$ref": "#/x-schemas/Accessibility/FontFamily" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "family", "value": "monospaced_sanserif" } }, { "name": "Default example #2", "params": [], "result": { "name": "family", "value": "cursive" } }, { "name": "Default example #3", "params": [], "result": { "name": "family", "value": null } } ] }, { "name": "ClosedCaptions.fontSize", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred font size for displaying closed-captions.", "params": [], "result": { "name": "size", "schema": { "$ref": "#/x-schemas/Accessibility/FontSize" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "size", "value": 1 } }, { "name": "Default example #2", "params": [], "result": { "name": "size", "value": 1 } }, { "name": "Default example #3", "params": [], "result": { "name": "size", "value": null } } ] }, { "name": "ClosedCaptions.fontColor", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred font color for displaying closed-captions.", "params": [], "result": { "name": "color", "schema": { "$ref": "#/x-schemas/Accessibility/Color" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "color", "value": "#ffffff" } }, { "name": "Default example #2", "params": [], "result": { "name": "color", "value": "#000000" } }, { "name": "Default example #3", "params": [], "result": { "name": "color", "value": null } } ] }, { "name": "ClosedCaptions.fontEdge", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred font edge style for displaying closed-captions.", "params": [], "result": { "name": "edge", "schema": { "$ref": "#/x-schemas/Accessibility/FontEdge" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "edge", "value": "none" } }, { "name": "Default example #2", "params": [], "result": { "name": "edge", "value": "uniform" } }, { "name": "Default example #3", "params": [], "result": { "name": "edge", "value": null } } ] }, { "name": "ClosedCaptions.fontEdgeColor", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred font edge color for displaying closed-captions.", "params": [], "result": { "name": "color", "schema": { "$ref": "#/x-schemas/Accessibility/Color" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "color", "value": "#000000" } }, { "name": "Default example #2", "params": [], "result": { "name": "color", "value": "#ffffff" } }, { "name": "Default example #3", "params": [], "result": { "name": "color", "value": null } } ] }, { "name": "ClosedCaptions.fontOpacity", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred opacity for displaying closed-captions characters.", "params": [], "result": { "name": "opacity", "schema": { "$ref": "#/x-schemas/Accessibility/Opacity" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "opacity", "value": 99 } }, { "name": "Default example #2", "params": [], "result": { "name": "opacity", "value": 100 } }, { "name": "Default example #3", "params": [], "result": { "name": "opacity", "value": null } } ] }, { "name": "ClosedCaptions.backgroundColor", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred background color for displaying closed-captions, .", "params": [], "result": { "name": "color", "schema": { "$ref": "#/x-schemas/Accessibility/Color" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "color", "value": "#000000" } }, { "name": "Default example #2", "params": [], "result": { "name": "color", "value": "#ffffff" } }, { "name": "Default example #3", "params": [], "result": { "name": "color", "value": null } } ] }, { "name": "ClosedCaptions.backgroundOpacity", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred opacity for displaying closed-captions backgrounds.", "params": [], "result": { "name": "opacity", "schema": { "$ref": "#/x-schemas/Accessibility/Opacity" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "opacity", "value": 99 } }, { "name": "Default example #2", "params": [], "result": { "name": "opacity", "value": 100 } }, { "name": "Default example #3", "params": [], "result": { "name": "opacity", "value": null } } ] }, { "name": "ClosedCaptions.textAlign", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred horizontal alignment for displaying closed-captions characters.", "params": [], "result": { "name": "alignment", "schema": { "$ref": "#/x-schemas/Accessibility/HorizontalAlignment" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "alignment", "value": "center" } }, { "name": "Default example #2", "params": [], "result": { "name": "alignment", "value": "left" } }, { "name": "Default example #3", "params": [], "result": { "name": "alignment", "value": null } } ] }, { "name": "ClosedCaptions.textAlignVertical", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred horizontal alignment for displaying closed-captions characters.", "params": [], "result": { "name": "alignment", "schema": { "$ref": "#/x-schemas/Accessibility/VerticalAlignment" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "alignment", "value": "middle" } }, { "name": "Default example #2", "params": [], "result": { "name": "alignment", "value": "top" } }, { "name": "Default example #3", "params": [], "result": { "name": "alignment", "value": null } } ] }, { "name": "ClosedCaptions.windowColor", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred window color for displaying closed-captions, .", "params": [], "result": { "name": "color", "schema": { "$ref": "#/x-schemas/Accessibility/Color" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "color", "value": "#000000" } }, { "name": "Default example #2", "params": [], "result": { "name": "color", "value": "white" } }, { "name": "Default example #3", "params": [], "result": { "name": "color", "value": null } } ] }, { "name": "ClosedCaptions.windowOpacity", "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred window opacity for displaying closed-captions backgrounds.", "params": [], "result": { "name": "opacity", "schema": { "$ref": "#/x-schemas/Accessibility/Opacity" } }, "examples": [ { "name": "Default example #1", "params": [], "result": { "name": "opacity", "value": 99 } }, { "name": "Default example #2", "params": [], "result": { "name": "opacity", "value": 100 } }, { "name": "Default example #3", "params": [], "result": { "name": "opacity", "value": null } } ] }, { "name": "ClosedCaptions.preferredLanguages", "summary": "A prioritized list of ISO 639-2/B codes for the preferred closed captions languages on this device.", "params": [], "tags": [ { "name": "property" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "result": { "name": "languages", "summary": "the preferred closed captions languages", "schema": { "type": "array", "items": { "$ref": "#/x-schemas/Localization/ISO639_2Language" } } }, "examples": [ { "name": "Default Example", "params": [], "result": { "name": "Default Result", "value": [ "spa", "eng" ] } }, { "name": "Default Example #2", "params": [], "result": { "name": "Default Result", "value": [ "eng", "spa" ] } } ] }, { "name": "ClosedCaptions.onEnabledChanged", "tags": [ { "name": "subscriber", "x-subscriber-for": "ClosedCaptions.enabled" }, { "name": "event", "x-alternative": "enabled" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "Whether or not closed-captions are enabled.", "params": [ { "name": "listen", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "enabled", "schema": { "anyOf": [ { "$ref": "#/x-schemas/Types/ListenResponse" }, { "type": "boolean" } ] } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "listen", "value": true } ], "result": { "name": "enabled", "value": true } }, { "name": "Default example #2", "params": [ { "name": "listen", "value": true } ], "result": { "name": "enabled", "value": false } } ] }, { "name": "ClosedCaptions.onFontFamilyChanged", "tags": [ { "name": "subscriber", "x-subscriber-for": "ClosedCaptions.fontFamily" }, { "name": "event", "x-alternative": "fontFamily" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred font family for displaying closed-captions.", "params": [ { "name": "listen", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "family", "schema": { "anyOf": [ { "$ref": "#/x-schemas/Types/ListenResponse" }, { "$ref": "#/x-schemas/Accessibility/FontFamily" } ] } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "listen", "value": true } ], "result": { "name": "family", "value": "monospaced_sanserif" } }, { "name": "Default example #2", "params": [ { "name": "listen", "value": true } ], "result": { "name": "family", "value": "cursive" } }, { "name": "Default example #3", "params": [ { "name": "listen", "value": true } ], "result": { "name": "family", "value": null } } ] }, { "name": "ClosedCaptions.onFontSizeChanged", "tags": [ { "name": "subscriber", "x-subscriber-for": "ClosedCaptions.fontSize" }, { "name": "event", "x-alternative": "fontSize" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred font size for displaying closed-captions.", "params": [ { "name": "listen", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "size", "schema": { "anyOf": [ { "$ref": "#/x-schemas/Types/ListenResponse" }, { "$ref": "#/x-schemas/Accessibility/FontSize" } ] } }, "examples": [ { "name": "Default example #1", "params": [ { "name": "listen", "value": true } ], "result": { "name": "size", "value": 1 } }, { "name": "Default example #2", "params": [ { "name": "listen", "value": true } ], "result": { "name": "size", "value": 1 } }, { "name": "Default example #3", "params": [ { "name": "listen", "value": true } ], "result": { "name": "size", "value": null } } ] }, { "name": "ClosedCaptions.onFontColorChanged", "tags": [ { "name": "subscriber", "x-subscriber-for": "ClosedCaptions.fontColor" }, { "name": "event", "x-alternative": "fontColor" }, { "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:accessibility:closedcaptions" ] } ], "summary": "The preferred font color for displaying closed-captions.", "params": [ { "name": "listen", "required": true, "schema": { "type": "boolean"