ClosedCaptions Module

Version ClosedCaptions 1.2.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<Color>

Promise resolution:

Color

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let color = await ClosedCaptions.backgroundColor()
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'

let color = await ClosedCaptions.backgroundColor()
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'

let color = await ClosedCaptions.backgroundColor()
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: Color): Promise<void>

Parameters:

Param Type Required Description
value Color true  

Promise resolution:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.backgroundColor('#000000')
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'

let result = await ClosedCaptions.backgroundColor('#ffffff')
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'

let result = await ClosedCaptions.backgroundColor(null)
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) => Color): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await backgroundColor((value) => {
  console.log(value)
})
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'

let listenerId = await backgroundColor((value) => {
  console.log(value)
})
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'

let listenerId = await backgroundColor((value) => {
  console.log(value)
})
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<Opacity>

Promise resolution:

Opacity

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let opacity = await ClosedCaptions.backgroundOpacity()
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'

let opacity = await ClosedCaptions.backgroundOpacity()
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'

let opacity = await ClosedCaptions.backgroundOpacity()
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: Opacity): Promise<void>

Parameters:

Param Type Required Description
value Opacity true  

Promise resolution:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.backgroundOpacity(99)
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'

let result = await ClosedCaptions.backgroundOpacity(100)
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'

let result = await ClosedCaptions.backgroundOpacity(null)
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) => Opacity): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await backgroundOpacity((value) => {
  console.log(value)
})
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'

let listenerId = await backgroundOpacity((value) => {
  console.log(value)
})
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'

let listenerId = await backgroundOpacity((value) => {
  console.log(value)
})
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:

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let enabled = await ClosedCaptions.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'

let enabled = await ClosedCaptions.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:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.enabled(true)
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'

let result = await ClosedCaptions.enabled(false)
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'

let listenerId = await enabled((value) => {
  console.log(value)
})
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'

let listenerId = await enabled((value) => {
  console.log(value)
})
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<Color>

Promise resolution:

Color

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let color = await ClosedCaptions.fontColor()
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'

let color = await ClosedCaptions.fontColor()
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'

let color = await ClosedCaptions.fontColor()
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: Color): Promise<void>

Parameters:

Param Type Required Description
value Color true  

Promise resolution:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.fontColor('#ffffff')
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'

let result = await ClosedCaptions.fontColor('#000000')
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'

let result = await ClosedCaptions.fontColor(null)
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) => Color): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await fontColor((value) => {
  console.log(value)
})
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'

let listenerId = await fontColor((value) => {
  console.log(value)
})
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'

let listenerId = await fontColor((value) => {
  console.log(value)
})
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<FontEdge>

Promise resolution:

FontEdge

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let edge = await ClosedCaptions.fontEdge()
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'

let edge = await ClosedCaptions.fontEdge()
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'

let edge = await ClosedCaptions.fontEdge()
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: FontEdge): Promise<void>

Parameters:

Param Type Required Description
value FontEdge true  

Promise resolution:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.fontEdge('none')
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'

let result = await ClosedCaptions.fontEdge('uniform')
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'

let result = await ClosedCaptions.fontEdge(null)
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) => FontEdge): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await fontEdge((value) => {
  console.log(value)
})
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'

let listenerId = await fontEdge((value) => {
  console.log(value)
})
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'

let listenerId = await fontEdge((value) => {
  console.log(value)
})
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<Color>

Promise resolution:

Color

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let color = await ClosedCaptions.fontEdgeColor()
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'

let color = await ClosedCaptions.fontEdgeColor()
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'

let color = await ClosedCaptions.fontEdgeColor()
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: Color): Promise<void>

Parameters:

Param Type Required Description
value Color true  

Promise resolution:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.fontEdgeColor('#000000')
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'

let result = await ClosedCaptions.fontEdgeColor('#ffffff')
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'

let result = await ClosedCaptions.fontEdgeColor(null)
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) => Color): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await fontEdgeColor((value) => {
  console.log(value)
})
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'

let listenerId = await fontEdgeColor((value) => {
  console.log(value)
})
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'

let listenerId = await fontEdgeColor((value) => {
  console.log(value)
})
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<FontFamily>

Promise resolution:

FontFamily

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let family = await ClosedCaptions.fontFamily()
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'

let family = await ClosedCaptions.fontFamily()
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'

let family = await ClosedCaptions.fontFamily()
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: FontFamily): Promise<void>

Parameters:

Param Type Required Description
value FontFamily true  

Promise resolution:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.fontFamily('monospaced_sanserif')
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'

let result = await ClosedCaptions.fontFamily('cursive')
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'

let result = await ClosedCaptions.fontFamily(null)
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) => FontFamily): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await fontFamily((value) => {
  console.log(value)
})
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'

let listenerId = await fontFamily((value) => {
  console.log(value)
})
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'

let listenerId = await fontFamily((value) => {
  console.log(value)
})
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<Opacity>

Promise resolution:

Opacity

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let opacity = await ClosedCaptions.fontOpacity()
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'

let opacity = await ClosedCaptions.fontOpacity()
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'

let opacity = await ClosedCaptions.fontOpacity()
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: Opacity): Promise<void>

Parameters:

Param Type Required Description
value Opacity true  

Promise resolution:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.fontOpacity(99)
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'

let result = await ClosedCaptions.fontOpacity(100)
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'

let result = await ClosedCaptions.fontOpacity(null)
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) => Opacity): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await fontOpacity((value) => {
  console.log(value)
})
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'

let listenerId = await fontOpacity((value) => {
  console.log(value)
})
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'

let listenerId = await fontOpacity((value) => {
  console.log(value)
})
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<FontSize>

Promise resolution:

FontSize

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let size = await ClosedCaptions.fontSize()
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'

let size = await ClosedCaptions.fontSize()
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'

let size = await ClosedCaptions.fontSize()
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: FontSize): Promise<void>

Parameters:

Param Type Required Description
value FontSize true  

Promise resolution:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.fontSize(1)
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'

let result = await ClosedCaptions.fontSize(1)
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'

let result = await ClosedCaptions.fontSize(null)
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) => FontSize): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await fontSize((value) => {
  console.log(value)
})
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'

let listenerId = await fontSize((value) => {
  console.log(value)
})
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'

let listenerId = await fontSize((value) => {
  console.log(value)
})
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<ISO639_2Language[]>

Promise resolution:

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default Example

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let languages = await ClosedCaptions.preferredLanguages()
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'

let languages = await ClosedCaptions.preferredLanguages()
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: ISO639_2Language[]): Promise<void>

Parameters:

Param Type Required Description
value ISO639_2Language[] true the preferred closed captions languages
pattern: ^[a-z]{3}$

Promise resolution:

Examples

Default Example

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.preferredLanguages(['spa', 'eng'])
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'

let result = await ClosedCaptions.preferredLanguages(['eng', 'spa'])
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) => ISO639_2Language[],
): Promise<number>

Promise resolution:

number

Examples

Default Example

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await preferredLanguages((value) => {
  console.log(value)
})
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'

let listenerId = await preferredLanguages((value) => {
  console.log(value)
})
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<HorizontalAlignment>

Promise resolution:

HorizontalAlignment

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let alignment = await ClosedCaptions.textAlign()
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'

let alignment = await ClosedCaptions.textAlign()
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'

let alignment = await ClosedCaptions.textAlign()
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: HorizontalAlignment): Promise<void>

Parameters:

Param Type Required Description
value HorizontalAlignment true  

Promise resolution:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.textAlign('center')
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'

let result = await ClosedCaptions.textAlign('left')
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'

let result = await ClosedCaptions.textAlign(null)
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) => HorizontalAlignment): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await textAlign((value) => {
  console.log(value)
})
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'

let listenerId = await textAlign((value) => {
  console.log(value)
})
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'

let listenerId = await textAlign((value) => {
  console.log(value)
})
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<VerticalAlignment>

Promise resolution:

VerticalAlignment

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let alignment = await ClosedCaptions.textAlignVertical()
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'

let alignment = await ClosedCaptions.textAlignVertical()
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'

let alignment = await ClosedCaptions.textAlignVertical()
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: VerticalAlignment): Promise<void>

Parameters:

Param Type Required Description
value VerticalAlignment true  

Promise resolution:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.textAlignVertical('middle')
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'

let result = await ClosedCaptions.textAlignVertical('top')
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'

let result = await ClosedCaptions.textAlignVertical(null)
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) => VerticalAlignment,
): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await textAlignVertical((value) => {
  console.log(value)
})
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'

let listenerId = await textAlignVertical((value) => {
  console.log(value)
})
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'

let listenerId = await textAlignVertical((value) => {
  console.log(value)
})
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<Color>

Promise resolution:

Color

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let color = await ClosedCaptions.windowColor()
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'

let color = await ClosedCaptions.windowColor()
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'

let color = await ClosedCaptions.windowColor()
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: Color): Promise<void>

Parameters:

Param Type Required Description
value Color true  

Promise resolution:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.windowColor('#000000')
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'

let result = await ClosedCaptions.windowColor('white')
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'

let result = await ClosedCaptions.windowColor(null)
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) => Color): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await windowColor((value) => {
  console.log(value)
})
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'

let listenerId = await windowColor((value) => {
  console.log(value)
})
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'

let listenerId = await windowColor((value) => {
  console.log(value)
})
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<Opacity>

Promise resolution:

Opacity

Capabilities:

Role Capability
uses xrn:firebolt:capability:accessibility:closedcaptions

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let opacity = await ClosedCaptions.windowOpacity()
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'

let opacity = await ClosedCaptions.windowOpacity()
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'

let opacity = await ClosedCaptions.windowOpacity()
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: Opacity): Promise<void>

Parameters:

Param Type Required Description
value Opacity true  

Promise resolution:

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let result = await ClosedCaptions.windowOpacity(99)
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'

let result = await ClosedCaptions.windowOpacity(100)
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'

let result = await ClosedCaptions.windowOpacity(null)
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) => Opacity): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { ClosedCaptions } from '@firebolt-js/manage-sdk'

let listenerId = await windowOpacity((value) => {
  console.log(value)
})
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'

let listenerId = await windowOpacity((value) => {
  console.log(value)
})
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'

let listenerId = await windowOpacity((value) => {
  console.log(value)
})
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

Types