ClosedCaptions
- Print
ClosedCaptions
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
title: ClosedCaptions
version: 1.0.0
layout: default
sdk: manage
# ClosedCaptions Module
Version ClosedCaptions 1.0.0
Table of Contents
Usage
To use the ClosedCaptions module, you can import it into your project from the Firebolt SDK:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
Overview
A module for managing closed-captions Settings.
Methods
backgroundColor
The preferred background color for displaying closed-captions, .
To get the value of backgroundColor call the method like this:
function backgroundColor(): Promise<string>
Promise resolution:
type Color = string
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.backgroundColor()
.then(color => {
console.log(color)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.backgroundColor",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#000000"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.backgroundColor()
.then(color => {
console.log(color)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.backgroundColor",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#ffffff"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.backgroundColor()
.then(color => {
console.log(color)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.backgroundColor",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To set the value of backgroundColor call the method like this:
function backgroundColor(value: string): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | string | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.backgroundColor("#000000")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setBackgroundColor",
"params": {
"value": "#000000"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.backgroundColor("#ffffff")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setBackgroundColor",
"params": {
"value": "#ffffff"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.backgroundColor(null)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setBackgroundColor",
"params": {
"value": null
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function backgroundColor(callback: (value) => string): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
backgroundColor(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onBackgroundColorChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#000000"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
backgroundColor(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onBackgroundColorChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#ffffff"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
backgroundColor(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onBackgroundColorChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
backgroundOpacity
The preferred opacity for displaying closed-captions backgrounds.
To get the value of backgroundOpacity call the method like this:
function backgroundOpacity(): Promise<number>
Promise resolution:
type Opacity = number
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.backgroundOpacity()
.then(opacity => {
console.log(opacity)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.backgroundOpacity",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 99
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.backgroundOpacity()
.then(opacity => {
console.log(opacity)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.backgroundOpacity",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 100
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.backgroundOpacity()
.then(opacity => {
console.log(opacity)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.backgroundOpacity",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To set the value of backgroundOpacity call the method like this:
function backgroundOpacity(value: number): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | number | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.backgroundOpacity(99)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setBackgroundOpacity",
"params": {
"value": 99
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.backgroundOpacity(100)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setBackgroundOpacity",
"params": {
"value": 100
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.backgroundOpacity(null)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setBackgroundOpacity",
"params": {
"value": null
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function backgroundOpacity(callback: (value) => number): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
backgroundOpacity(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onBackgroundOpacityChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 99
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
backgroundOpacity(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onBackgroundOpacityChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 100
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
backgroundOpacity(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onBackgroundOpacityChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
enabled
Whether or not closed-captions are enabled.
To get the value of enabled call the method like this:
function enabled(): Promise<boolean>
Promise resolution:
boolean
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.enabled()
.then(enabled => {
console.log(enabled)
})
Value of enabled:
true
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.enabled",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": true
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.enabled()
.then(enabled => {
console.log(enabled)
})
Value of enabled:
true
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.enabled",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": false
}
To set the value of enabled call the method like this:
function enabled(value: boolean): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | boolean | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.enabled(true)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setEnabled",
"params": {
"value": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.enabled(false)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setEnabled",
"params": {
"value": false
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function enabled(callback: (value) => boolean): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
enabled(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of enabled:
true
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onEnabledChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": true
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
enabled(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of enabled:
true
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onEnabledChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": false
}
fontColor
The preferred font color for displaying closed-captions.
To get the value of fontColor call the method like this:
function fontColor(): Promise<string>
Promise resolution:
type Color = string
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontColor()
.then(color => {
console.log(color)
})
Value of color:
"#ffffff"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontColor",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#ffffff"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontColor()
.then(color => {
console.log(color)
})
Value of color:
"#ffffff"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontColor",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#000000"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontColor()
.then(color => {
console.log(color)
})
Value of color:
"#ffffff"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontColor",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To set the value of fontColor call the method like this:
function fontColor(value: string): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | string | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontColor("#ffffff")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontColor",
"params": {
"value": "#ffffff"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontColor("#000000")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontColor",
"params": {
"value": "#000000"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontColor(null)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontColor",
"params": {
"value": null
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function fontColor(callback: (value) => string): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontColor(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of color:
"#ffffff"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontColorChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#ffffff"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontColor(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of color:
"#ffffff"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontColorChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#000000"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontColor(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of color:
"#ffffff"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontColorChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
fontEdge
The preferred font edge style for displaying closed-captions.
To get the value of fontEdge call the method like this:
function fontEdge(): Promise<string>
Promise resolution:
type FontEdge = string
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontEdge()
.then(edge => {
console.log(edge)
})
Value of edge:
"none"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontEdge",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "none"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontEdge()
.then(edge => {
console.log(edge)
})
Value of edge:
"none"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontEdge",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "uniform"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontEdge()
.then(edge => {
console.log(edge)
})
Value of edge:
"none"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontEdge",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To set the value of fontEdge call the method like this:
function fontEdge(value: string): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | string | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontEdge("none")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontEdge",
"params": {
"value": "none"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontEdge("uniform")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontEdge",
"params": {
"value": "uniform"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontEdge(null)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontEdge",
"params": {
"value": null
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function fontEdge(callback: (value) => string): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontEdge(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of edge:
"none"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontEdgeChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "none"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontEdge(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of edge:
"none"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontEdgeChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "uniform"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontEdge(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of edge:
"none"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontEdgeChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
fontEdgeColor
The preferred font edge color for displaying closed-captions.
To get the value of fontEdgeColor call the method like this:
function fontEdgeColor(): Promise<string>
Promise resolution:
type Color = string
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontEdgeColor()
.then(color => {
console.log(color)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontEdgeColor",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#000000"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontEdgeColor()
.then(color => {
console.log(color)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontEdgeColor",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#ffffff"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontEdgeColor()
.then(color => {
console.log(color)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontEdgeColor",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To set the value of fontEdgeColor call the method like this:
function fontEdgeColor(value: string): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | string | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontEdgeColor("#000000")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontEdgeColor",
"params": {
"value": "#000000"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontEdgeColor("#ffffff")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontEdgeColor",
"params": {
"value": "#ffffff"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontEdgeColor(null)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontEdgeColor",
"params": {
"value": null
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function fontEdgeColor(callback: (value) => string): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontEdgeColor(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontEdgeColorChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#000000"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontEdgeColor(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontEdgeColorChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#ffffff"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontEdgeColor(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontEdgeColorChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
fontFamily
The preferred font family for displaying closed-captions.
To get the value of fontFamily call the method like this:
function fontFamily(): Promise<string>
Promise resolution:
type FontFamily = string
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontFamily()
.then(family => {
console.log(family)
})
Value of family:
"monospaced_sanserif"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontFamily",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "monospaced_sanserif"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontFamily()
.then(family => {
console.log(family)
})
Value of family:
"monospaced_sanserif"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontFamily",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "cursive"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontFamily()
.then(family => {
console.log(family)
})
Value of family:
"monospaced_sanserif"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontFamily",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To set the value of fontFamily call the method like this:
function fontFamily(value: string): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | string | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontFamily("monospaced_sanserif")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontFamily",
"params": {
"value": "monospaced_sanserif"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontFamily("cursive")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontFamily",
"params": {
"value": "cursive"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontFamily(null)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontFamily",
"params": {
"value": null
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function fontFamily(callback: (value) => string): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontFamily(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of family:
"monospaced_sanserif"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontFamilyChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "monospaced_sanserif"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontFamily(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of family:
"monospaced_sanserif"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontFamilyChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "cursive"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontFamily(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of family:
"monospaced_sanserif"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontFamilyChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
fontOpacity
The preferred opacity for displaying closed-captions characters.
To get the value of fontOpacity call the method like this:
function fontOpacity(): Promise<number>
Promise resolution:
type Opacity = number
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontOpacity()
.then(opacity => {
console.log(opacity)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontOpacity",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 99
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontOpacity()
.then(opacity => {
console.log(opacity)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontOpacity",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 100
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontOpacity()
.then(opacity => {
console.log(opacity)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontOpacity",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To set the value of fontOpacity call the method like this:
function fontOpacity(value: number): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | number | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontOpacity(99)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontOpacity",
"params": {
"value": 99
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontOpacity(100)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontOpacity",
"params": {
"value": 100
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontOpacity(null)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontOpacity",
"params": {
"value": null
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function fontOpacity(callback: (value) => number): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontOpacity(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontOpacityChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 99
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontOpacity(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontOpacityChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 100
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontOpacity(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontOpacityChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
fontSize
The preferred font size for displaying closed-captions.
To get the value of fontSize call the method like this:
function fontSize(): Promise<number>
Promise resolution:
type FontSize = number
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontSize()
.then(size => {
console.log(size)
})
Value of size:
1
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontSize",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 1
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontSize()
.then(size => {
console.log(size)
})
Value of size:
1
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontSize",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 1
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontSize()
.then(size => {
console.log(size)
})
Value of size:
1
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.fontSize",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To set the value of fontSize call the method like this:
function fontSize(value: number): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | number | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontSize(1)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontSize",
"params": {
"value": 1
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontSize(1)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontSize",
"params": {
"value": 1
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.fontSize(null)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setFontSize",
"params": {
"value": null
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function fontSize(callback: (value) => number): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontSize(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of size:
1
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontSizeChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 1
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontSize(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of size:
1
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontSizeChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 1
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
fontSize(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of size:
1
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onFontSizeChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
listen
To listen to a specific event pass the event name as the first parameter:
listen(event: string, callback: (data: any) => void): Promise<number>
Parameters:
| Param | Type | Required | Summary |
|---|---|---|---|
event | string | Yes | The event to listen for, see Events. |
| callback | function | Yes | A function that will be invoked when the event occurs. |
Promise resolution:
| Type | Description |
|---|---|
number | Listener ID to clear the callback method and stop receiving the event, e.g. ClosedCaptions.clear(id) |
Callback parameters:
| Param | Type | Required | Summary |
|---|---|---|---|
data | any | Yes | The event data, which depends on which event is firing, see Events. |
To listen to all events from this module pass only a callback, without specifying an event name:
listen(callback: (event: string, data: any) => void): Promise<number>
Parameters:
| Param | Type | Required | Summary |
|---|---|---|---|
| callback | function | Yes | A function that will be invoked when the event occurs. The event data depends on which event is firing, see Events. |
Callback parameters:
| Param | Type | Required | Summary |
|---|---|---|---|
event | string | Yes | The event that has occured listen for, see Events. |
data | any | Yes | The event data, which depends on which event is firing, see Events. |
Promise resolution:
| Type | Description |
|---|---|
number | Listener ID to clear the callback method and stop receiving the event, e.g. ClosedCaptions.clear(id) |
See Listening for events for more information and examples.
once
To listen to a single instance of a specific event pass the event name as the first parameter:
once(event: string, callback: (data: any) => void): Promise<number>
The once method will only pass the next instance of this event, and then dicard the listener you provided.
Parameters:
| Param | Type | Required | Summary |
|---|---|---|---|
event | string | Yes | The event to listen for, see Events. |
| callback | function | Yes | A function that will be invoked when the event occurs. |
Promise resolution:
| Type | Description |
|---|---|
number | Listener ID to clear the callback method and stop receiving the event, e.g. ClosedCaptions.clear(id) |
Callback parameters:
| Param | Type | Required | Summary |
|---|---|---|---|
data | any | Yes | The event data, which depends on which event is firing, see Events. |
To listen to the next instance only of any events from this module pass only a callback, without specifying an event name:
once(callback: (event: string, data: any) => void): Promise<number>
Parameters:
| Param | Type | Required | Summary |
|---|---|---|---|
| callback | function | Yes | A function that will be invoked when the event occurs. The event data depends on which event is firing, see Events. |
Callback parameters:
| Param | Type | Required | Summary |
|---|---|---|---|
event | string | Yes | The event that has occured listen for, see Events. |
data | any | Yes | The event data, which depends on which event is firing, see Events. |
Promise resolution:
| Type | Description |
|---|---|
number | Listener ID to clear the callback method and stop receiving the event, e.g. ClosedCaptions.clear(id) |
See Listening for events for more information and examples.
preferredLanguages
A prioritized list of ISO 639-2/B codes for the preferred closed captions languages on this device.
To get the value of preferredLanguages call the method like this:
function preferredLanguages(): Promise<string[]>
Promise resolution:
string[]
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default Example
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.preferredLanguages()
.then(languages => {
console.log(languages)
})
Value of languages:
[
"spa",
"eng"
]
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.preferredLanguages",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": [
"spa",
"eng"
]
}
Default Example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.preferredLanguages()
.then(languages => {
console.log(languages)
})
Value of languages:
[
"spa",
"eng"
]
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.preferredLanguages",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": [
"eng",
"spa"
]
}
To set the value of preferredLanguages call the method like this:
function preferredLanguages(value: string[]): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | string[] | true | the preferred closed captions languages pattern: ^[a-z]{3}$ |
Promise resolution:
null
Examples
Default Example
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.preferredLanguages(["spa","eng"])
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setPreferredLanguages",
"params": {
"value": [
"spa",
"eng"
]
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default Example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.preferredLanguages(["eng","spa"])
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setPreferredLanguages",
"params": {
"value": [
"eng",
"spa"
]
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function preferredLanguages(callback: (value) => string[]): Promise<number>
Promise resolution:
number
Examples
Default Example
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
preferredLanguages(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of languages:
[
"spa",
"eng"
]
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onPreferredLanguagesChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": [
"spa",
"eng"
]
}
Default Example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
preferredLanguages(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of languages:
[
"spa",
"eng"
]
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onPreferredLanguagesChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": [
"eng",
"spa"
]
}
textAlign
The preferred horizontal alignment for displaying closed-captions characters.
To get the value of textAlign call the method like this:
function textAlign(): Promise<string>
Promise resolution:
type HorizontalAlignment = string
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.textAlign()
.then(alignment => {
console.log(alignment)
})
Value of alignment:
"center"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.textAlign",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "center"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.textAlign()
.then(alignment => {
console.log(alignment)
})
Value of alignment:
"center"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.textAlign",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "left"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.textAlign()
.then(alignment => {
console.log(alignment)
})
Value of alignment:
"center"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.textAlign",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To set the value of textAlign call the method like this:
function textAlign(value: string): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | string | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.textAlign("center")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setTextAlign",
"params": {
"value": "center"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.textAlign("left")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setTextAlign",
"params": {
"value": "left"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.textAlign(null)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setTextAlign",
"params": {
"value": null
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function textAlign(callback: (value) => string): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
textAlign(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of alignment:
"center"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onTextAlignChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "center"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
textAlign(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of alignment:
"center"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onTextAlignChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "left"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
textAlign(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of alignment:
"center"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onTextAlignChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
textAlignVertical
The preferred horizontal alignment for displaying closed-captions characters.
To get the value of textAlignVertical call the method like this:
function textAlignVertical(): Promise<string>
Promise resolution:
type VerticalAlignment = string
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.textAlignVertical()
.then(alignment => {
console.log(alignment)
})
Value of alignment:
"middle"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.textAlignVertical",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "middle"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.textAlignVertical()
.then(alignment => {
console.log(alignment)
})
Value of alignment:
"middle"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.textAlignVertical",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "top"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.textAlignVertical()
.then(alignment => {
console.log(alignment)
})
Value of alignment:
"middle"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.textAlignVertical",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To set the value of textAlignVertical call the method like this:
function textAlignVertical(value: string): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | string | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.textAlignVertical("middle")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setTextAlignVertical",
"params": {
"value": "middle"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.textAlignVertical("top")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setTextAlignVertical",
"params": {
"value": "top"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.textAlignVertical(null)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setTextAlignVertical",
"params": {
"value": null
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function textAlignVertical(callback: (value) => string): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
textAlignVertical(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of alignment:
"middle"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onTextAlignVerticalChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "middle"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
textAlignVertical(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of alignment:
"middle"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onTextAlignVerticalChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "top"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
textAlignVertical(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of alignment:
"middle"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onTextAlignVerticalChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
windowColor
The preferred window color for displaying closed-captions, .
To get the value of windowColor call the method like this:
function windowColor(): Promise<string>
Promise resolution:
type Color = string
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.windowColor()
.then(color => {
console.log(color)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.windowColor",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#000000"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.windowColor()
.then(color => {
console.log(color)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.windowColor",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "white"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.windowColor()
.then(color => {
console.log(color)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.windowColor",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To set the value of windowColor call the method like this:
function windowColor(value: string): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | string | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.windowColor("#000000")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setWindowColor",
"params": {
"value": "#000000"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.windowColor("white")
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setWindowColor",
"params": {
"value": "white"
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.windowColor(null)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setWindowColor",
"params": {
"value": null
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function windowColor(callback: (value) => string): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
windowColor(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onWindowColorChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "#000000"
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
windowColor(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onWindowColorChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "white"
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
windowColor(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of color:
"#000000"
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onWindowColorChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
windowOpacity
The preferred window opacity for displaying closed-captions backgrounds.
To get the value of windowOpacity call the method like this:
function windowOpacity(): Promise<number>
Promise resolution:
type Opacity = number
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.windowOpacity()
.then(opacity => {
console.log(opacity)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.windowOpacity",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 99
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.windowOpacity()
.then(opacity => {
console.log(opacity)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.windowOpacity",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 100
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.windowOpacity()
.then(opacity => {
console.log(opacity)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.windowOpacity",
"params": {}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To set the value of windowOpacity call the method like this:
function windowOpacity(value: number): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
value | number | true |
Promise resolution:
null
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.windowOpacity(99)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setWindowOpacity",
"params": {
"value": 99
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.windowOpacity(100)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setWindowOpacity",
"params": {
"value": 100
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
ClosedCaptions.windowOpacity(null)
.then(result => {
console.log(result)
})
Value of result:
null
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.setWindowOpacity",
"params": {
"value": null
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
To subscribe to notifications when the value changes, call the method like this:
function windowOpacity(callback: (value) => number): Promise<number>
Promise resolution:
number
Examples
Default example #1
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
windowOpacity(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onWindowOpacityChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 99
}
Default example #2
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
windowOpacity(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onWindowOpacityChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": 100
}
Default example #3
JavaScript:
import { ClosedCaptions } from '@firebolt-js/manage-sdk'
windowOpacity(value => {
console.log(value)
}).then(listenerId => {
console.log(listenerId)
})
Value of opacity:
99
JSON-RPC:
Request:{
"jsonrpc": "2.0",
"id": 1,
"method": "ClosedCaptions.onWindowOpacityChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": null
}
Events
backgroundColorChanged
See: backgroundColor
backgroundOpacityChanged
See: backgroundOpacity
enabledChanged
See: enabled
fontColorChanged
See: fontColor
fontEdgeChanged
See: fontEdge
fontEdgeColorChanged
See: fontEdgeColor
fontFamilyChanged
See: fontFamily
fontOpacityChanged
See: fontOpacity
fontSizeChanged
See: fontSize
preferredLanguagesChanged
See: preferredLanguages
textAlignChanged
See: textAlign
textAlignVerticalChanged
See: textAlignVertical
windowColorChanged
See: windowColor
windowOpacityChanged
See: windowOpacity
Was this article helpful?