Firebolt APIs

Firebolt APIs are defined by OpenRPC schemas.

The schemas are used to generate SDK and Documentation artifacts.

xrn:firebolt:capability:accessibility:audiodescriptions

Uses
Accessibility.audioDescriptionSettings Accessibility.onAudioDescriptionSettingsChanged AudioDescriptions.enabled AudioDescriptions.onEnabledChanged

Manages
AudioDescriptions.setEnabled

xrn:firebolt:capability:accessibility:closedcaptions

Uses

Accessibility.closedCaptions Accessibility.closedCaptionsSettings Accessibility.onClosedCaptionsSettingsChanged ClosedCaptions.enabled ClosedCaptions.fontFamily ClosedCaptions.fontSize ClosedCaptions.fontColor ClosedCaptions.fontEdge ClosedCaptions.fontEdgeColor ClosedCaptions.fontOpacity ClosedCaptions.backgroundColor ClosedCaptions.backgroundOpacity ClosedCaptions.textAlign ClosedCaptions.textAlignVertical ClosedCaptions.windowColor ClosedCaptions.windowOpacity ClosedCaptions.preferredLanguages ClosedCaptions.onEnabledChanged ClosedCaptions.onFontFamilyChanged ClosedCaptions.onFontSizeChanged ClosedCaptions.onFontColorChanged ClosedCaptions.onFontEdgeChanged ClosedCaptions.onFontEdgeColorChanged ClosedCaptions.onFontOpacityChanged ClosedCaptions.onBackgroundColorChanged ClosedCaptions.onBackgroundOpacityChanged ClosedCaptions.onTextAlignChanged ClosedCaptions.onTextAlignVerticalChanged ClosedCaptions.onWindowColorChanged ClosedCaptions.onWindowOpacityChanged ClosedCaptions.onPreferredLanguagesChanged

Manages

ClosedCaptions.setEnabled ClosedCaptions.setFontFamily ClosedCaptions.setFontSize ClosedCaptions.setFontColor ClosedCaptions.setFontEdge ClosedCaptions.setFontEdgeColor ClosedCaptions.setFontOpacity ClosedCaptions.setBackgroundColor ClosedCaptions.setBackgroundOpacity ClosedCaptions.setTextAlign ClosedCaptions.setTextAlignVertical ClosedCaptions.setWindowColor ClosedCaptions.setWindowOpacity ClosedCaptions.setPreferredLanguages

xrn:firebolt:capability:accessibility:voiceguidance

Uses
Accessibility.voiceGuidance Accessibility.voiceGuidanceSettings Accessibility.onVoiceGuidanceSettingsChanged VoiceGuidance.enabled VoiceGuidance.speed VoiceGuidance.onEnabledChanged VoiceGuidance.onSpeedChanged

Manages
VoiceGuidance.setEnabled VoiceGuidance.setSpeed

xrn:firebolt:capability:account:id

Uses
Account.id

Manages
Device.provision

xrn:firebolt:capability:account:uid

Uses
Account.uid

xrn:firebolt:capability:advertising:configuration

Uses
Advertising.config Advertising.deviceAttributes Advertising.appBundleId

Manages
Advertising.skipRestriction Advertising.onSkipRestrictionChanged Advertising.setSkipRestriction

xrn:firebolt:capability:advertising:identifier

Uses
Advertising.advertisingId

Manages
Advertising.resetIdentifier

xrn:firebolt:capability:advertising:policy

Uses
Advertising.policy Advertising.onPolicyChanged

xrn:firebolt:capability:approve:content

Uses
Profile.approveContentRating

xrn:firebolt:capability:approve:purchase

Uses
Profile.approvePurchase

xrn:firebolt:capability:capabilities:info

Uses
Capabilities.supported Capabilities.available Capabilities.permitted Capabilities.granted Capabilities.info Capabilities.onAvailable Capabilities.onUnavailable Capabilities.onGranted Capabilities.onRevoked

xrn:firebolt:capability:capabilities:request

Uses
Capabilities.request

xrn:firebolt:capability:device:distributor

Uses
Device.distributor

Manages
Device.provision

xrn:firebolt:capability:device:id

Uses
Device.id

Manages
Device.provision

xrn:firebolt:capability:device:info

Uses
Device.platform Device.type Device.version Device.hdcp Device.hdr Device.audio Device.screenResolution Device.videoResolution Device.onHdcpChanged Device.onHdrChanged Device.onAudioChanged Device.onScreenResolutionChanged Device.onVideoResolutionChanged

xrn:firebolt:capability:device:make

Uses
Device.make

xrn:firebolt:capability:device:model

Uses
Device.model

xrn:firebolt:capability:device:name

Uses
Device.name Device.onDeviceNameChanged Device.onNameChanged

Manages
Device.setName

xrn:firebolt:capability:device:sku

Uses
Device.sku

xrn:firebolt:capability:device:uid

Uses
Device.uid

xrn:firebolt:capability:discovery:content-access

Uses
Discovery.entitlements Discovery.contentAccess Discovery.clearContentAccess

xrn:firebolt:capability:discovery:entity-info

Provides
Discovery.entityInfo Discovery.onPullEntityInfo

xrn:firebolt:capability:discovery:interest

Uses
Content.requestUserInterest Content.onUserInterest

Provides
Discovery.userInterest Discovery.onRequestUserInterest Discovery.userInterestResponse Discovery.userInterestError

xrn:firebolt:capability:discovery:navigate-to

Uses
Discovery.onNavigateTo

xrn:firebolt:capability:discovery:policy

Uses
Discovery.policy Discovery.onPolicyChanged

xrn:firebolt:capability:discovery:purchased-content

Provides
Discovery.purchasedContent Discovery.onPullPurchasedContent

xrn:firebolt:capability:discovery:sign-in-status

Uses
Discovery.signIn Discovery.signOut

Manages
Discovery.onSignIn Discovery.onSignOut

xrn:firebolt:capability:discovery:watch-next

Uses
Discovery.watchNext

xrn:firebolt:capability:discovery:watched

Uses
Discovery.watched

xrn:firebolt:capability:grants:state

Uses
UserGrants.app UserGrants.device UserGrants.capability

Manages
UserGrants.grant UserGrants.deny UserGrants.clear UserGrants.request

xrn:firebolt:capability:input:keyboard

Uses
Keyboard.email Keyboard.password Keyboard.standard

Provides
Keyboard.onRequestStandard Keyboard.onRequestPassword Keyboard.onRequestEmail Keyboard.standardFocus Keyboard.passwordFocus Keyboard.emailFocus Keyboard.standardResponse Keyboard.standardError Keyboard.passwordResponse Keyboard.passwordError Keyboard.emailResponse Keyboard.emailError

xrn:firebolt:capability:inputs:hdmi

Uses
HDMIInput.ports HDMIInput.port HDMIInput.onConnectionChanged HDMIInput.onSignalChanged HDMIInput.lowLatencyMode HDMIInput.onAutoLowLatencyModeSignalChanged HDMIInput.autoLowLatencyModeCapable HDMIInput.edidVersion HDMIInput.onLowLatencyModeChanged HDMIInput.onAutoLowLatencyModeCapableChanged HDMIInput.onEdidVersionChanged

Manages
HDMIInput.open HDMIInput.close HDMIInput.setLowLatencyMode HDMIInput.setAutoLowLatencyModeCapable HDMIInput.setEdidVersion

xrn:firebolt:capability:lifecycle:initialize

Uses
Internal.initialize

xrn:firebolt:capability:lifecycle:launch

Uses
Discovery.launch

xrn:firebolt:capability:lifecycle:ready

Uses
Lifecycle.ready

xrn:firebolt:capability:lifecycle:state

Uses
Lifecycle.close Lifecycle.finished Lifecycle.state Lifecycle.onInactive Lifecycle.onForeground Lifecycle.onBackground Lifecycle.onSuspended Lifecycle.onUnloading Parameters.initialization

xrn:firebolt:capability:localization:additional-info

Uses
Localization.additionalInfo

Manages
Localization.addAdditionalInfo Localization.removeAdditionalInfo

xrn:firebolt:capability:localization:country-code

Uses
Localization.countryCode Localization.onCountryCodeChanged

Manages
Localization.setCountryCode

xrn:firebolt:capability:localization:language

Uses
Localization.language Localization.preferredAudioLanguages Localization.onLanguageChanged Localization.onPreferredAudioLanguagesChanged

Manages
Localization.setLanguage Localization.setPreferredAudioLanguages

xrn:firebolt:capability:localization:locale

Uses
Localization.locale Localization.onLocaleChanged

Manages
Localization.setLocale

xrn:firebolt:capability:localization:locality

Uses
Localization.locality Localization.onLocalityChanged

Manages
Localization.setLocality

xrn:firebolt:capability:localization:location

Uses
Localization.latlon

xrn:firebolt:capability:localization:postal-code

Uses
Localization.postalCode Localization.onPostalCodeChanged

Manages
Localization.setPostalCode

xrn:firebolt:capability:localization:time-zone

Uses
Localization.timeZone Localization.onTimeZoneChanged

Manages
Localization.setTimeZone

xrn:firebolt:capability:metrics:distributor

Uses
Metrics.event

xrn:firebolt:capability:metrics:general

Uses
Metrics.ready Metrics.signIn Metrics.signOut Metrics.startContent Metrics.stopContent Metrics.page Metrics.action Metrics.error Metrics.appInfo

xrn:firebolt:capability:metrics:media

Uses
Metrics.mediaLoadStart Metrics.mediaPlay Metrics.mediaPlaying Metrics.mediaPause Metrics.mediaWaiting Metrics.mediaProgress Metrics.mediaSeeking Metrics.mediaSeeked Metrics.mediaRateChange Metrics.mediaRenditionChange Metrics.mediaEnded

xrn:firebolt:capability:network:status

Uses
Device.network Device.onNetworkChanged

xrn:firebolt:capability:privacy:settings

Uses

Privacy.allowResumePoints Privacy.allowUnentitledResumePoints Privacy.allowWatchHistory Privacy.allowProductAnalytics Privacy.allowPersonalization Privacy.allowUnentitledPersonalization Privacy.allowRemoteDiagnostics Privacy.allowPrimaryContentAdTargeting Privacy.allowPrimaryBrowseAdTargeting Privacy.allowAppContentAdTargeting Privacy.allowACRCollection Privacy.allowCameraAnalytics Privacy.settings Privacy.onAllowResumePointsChanged Privacy.onAllowUnentitledResumePointsChanged Privacy.onAllowWatchHistoryChanged Privacy.onAllowProductAnalyticsChanged Privacy.onAllowPersonalizationChanged Privacy.onAllowUnentitledPersonalizationChanged Privacy.onAllowRemoteDiagnosticsChanged Privacy.onAllowPrimaryContentAdTargetingChanged Privacy.onAllowPrimaryBrowseAdTargetingChanged Privacy.onAllowAppContentAdTargetingChanged Privacy.onAllowACRCollectionChanged Privacy.onAllowCameraAnalyticsChanged

Manages

Privacy.setAllowResumePoints Privacy.setAllowUnentitledResumePoints Privacy.setAllowWatchHistory Privacy.setAllowProductAnalytics Privacy.setAllowPersonalization Privacy.setAllowUnentitledPersonalization Privacy.setAllowRemoteDiagnostics Privacy.setAllowPrimaryContentAdTargeting Privacy.setAllowPrimaryBrowseAdTargeting Privacy.setAllowAppContentAdTargeting Privacy.setAllowACRCollection Privacy.setAllowCameraAnalytics

xrn:firebolt:capability:profile:flags

Uses
Profile.flags

xrn:firebolt:capability:protocol:dial

Uses
SecondScreen.device SecondScreen.friendlyName SecondScreen.onLaunchRequest SecondScreen.onCloseRequest SecondScreen.onFriendlyNameChanged

xrn:firebolt:capability:protocol:wifi

Uses
Wifi.scan Wifi.connect Wifi.disconnect Wifi.wps

xrn:firebolt:capability:rpc:discover

Uses
rpc.discover

xrn:firebolt:capability:secondscreen:protocol

Uses
SecondScreen.protocols

xrn:firebolt:capability:storage:secure

Uses
SecureStorage.get SecureStorage.set SecureStorage.remove SecureStorage.clear

Manages
SecureStorage.setForApp SecureStorage.removeForApp SecureStorage.clearForApp

xrn:firebolt:capability:token:account

Manages
Account.session

xrn:firebolt:capability:token:device

Uses
Authentication.device

xrn:firebolt:capability:token:platform

Uses
Authentication.token

xrn:firebolt:capability:token:root

Uses
Authentication.root

xrn:firebolt:capability:token:session

Uses
Authentication.session

xrn:firebolt:capability:usergrant:acknowledgechallenge

Provides
AcknowledgeChallenge.onRequestChallenge AcknowledgeChallenge.challengeFocus AcknowledgeChallenge.challengeResponse AcknowledgeChallenge.challengeError

xrn:firebolt:capability:usergrant:pinchallenge

Provides
PinChallenge.onRequestChallenge PinChallenge.challengeFocus PinChallenge.challengeResponse PinChallenge.challengeError