title: ClosedCaptions

version: 0.15.0
layout: default
sdk: manage

# ClosedCaptions Module

Version ClosedCaptions 0.15.0

Table of Contents

• Table of Contents
• Usage
• Overview
• Methods
  • backgroundColor
  • backgroundOpacity
  • enabled
  • fontColor
  • fontEdge
  • fontEdgeColor
  • fontFamily
  • fontOpacity
  • fontSize
  • listen
  • once
  • textAlign
  • textAlignVertical
• Events
  • backgroundColorChanged
  • backgroundOpacityChanged
  • enabledChanged
  • fontColorChanged
  • fontEdgeChanged
  • fontEdgeColorChanged
  • fontFamilyChanged
  • fontOpacityChanged
  • fontSizeChanged
  • textAlignChanged
  • textAlignVerticalChanged

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:

Examples

Default example #1

JavaScript:

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

ClosedCaptions.backgroundColor()
    .then(color => {
        console.log(color)
    })

Value of color:

"#000000"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.backgroundColor",
	"params": {}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.backgroundColor",
	"params": {}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.backgroundColor",
	"params": {}
}

{
	"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:

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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setBackgroundColor",
	"params": {
		"value": "#000000"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setBackgroundColor",
	"params": {
		"value": "#ffffff"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setBackgroundColor",
	"params": {
		"value": null
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onBackgroundColorChanged",
	"params": {
		"listen": true
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onBackgroundColorChanged",
	"params": {
		"listen": true
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onBackgroundColorChanged",
	"params": {
		"listen": true
	}
}

{
	"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:

Examples

Default example #1

JavaScript:

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

ClosedCaptions.backgroundOpacity()
    .then(opacity => {
        console.log(opacity)
    })

Value of opacity:

99

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.backgroundOpacity",
	"params": {}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.backgroundOpacity",
	"params": {}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.backgroundOpacity",
	"params": {}
}

{
	"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:

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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setBackgroundOpacity",
	"params": {
		"value": 99
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setBackgroundOpacity",
	"params": {
		"value": 100
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setBackgroundOpacity",
	"params": {
		"value": null
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onBackgroundOpacityChanged",
	"params": {
		"listen": true
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onBackgroundOpacityChanged",
	"params": {
		"listen": true
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onBackgroundOpacityChanged",
	"params": {
		"listen": true
	}
}

{
	"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:

Examples

Default example #1

JavaScript:

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

ClosedCaptions.enabled()
    .then(enabled => {
        console.log(enabled)
    })

Value of enabled:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.enabled",
	"params": {}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.enabled",
	"params": {}
}

{
	"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:

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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setEnabled",
	"params": {
		"value": true
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setEnabled",
	"params": {
		"value": false
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onEnabledChanged",
	"params": {
		"listen": true
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onEnabledChanged",
	"params": {
		"listen": true
	}
}

{
	"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:

Examples

Default example #1

JavaScript:

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

ClosedCaptions.fontColor()
    .then(color => {
        console.log(color)
    })

Value of color:

"#ffffff"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontColor",
	"params": {}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontColor",
	"params": {}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontColor",
	"params": {}
}

{
	"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:

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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontColor",
	"params": {
		"value": "#ffffff"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontColor",
	"params": {
		"value": "#000000"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontColor",
	"params": {
		"value": null
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontColorChanged",
	"params": {
		"listen": true
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontColorChanged",
	"params": {
		"listen": true
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontColorChanged",
	"params": {
		"listen": true
	}
}

{
	"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:

Examples

Default example #1

JavaScript:

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

ClosedCaptions.fontEdge()
    .then(edge => {
        console.log(edge)
    })

Value of edge:

"none"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontEdge",
	"params": {}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontEdge",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "solid"
}

Default example #3

JavaScript:

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

ClosedCaptions.fontEdge()
    .then(edge => {
        console.log(edge)
    })

Value of edge:

"none"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontEdge",
	"params": {}
}

{
	"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:

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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontEdge",
	"params": {
		"value": "none"
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

ClosedCaptions.fontEdge("solid")
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontEdge",
	"params": {
		"value": "solid"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontEdge",
	"params": {
		"value": null
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontEdgeChanged",
	"params": {
		"listen": true
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontEdgeChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "solid"
}

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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontEdgeChanged",
	"params": {
		"listen": true
	}
}

{
	"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:

Examples

Default example #1

JavaScript:

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

ClosedCaptions.fontEdgeColor()
    .then(color => {
        console.log(color)
    })

Value of color:

"#000000"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontEdgeColor",
	"params": {}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontEdgeColor",
	"params": {}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontEdgeColor",
	"params": {}
}

{
	"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:

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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontEdgeColor",
	"params": {
		"value": "#000000"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontEdgeColor",
	"params": {
		"value": "#ffffff"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontEdgeColor",
	"params": {
		"value": null
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontEdgeColorChanged",
	"params": {
		"listen": true
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontEdgeColorChanged",
	"params": {
		"listen": true
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontEdgeColorChanged",
	"params": {
		"listen": true
	}
}

{
	"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:

Examples

Default example #1

JavaScript:

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

ClosedCaptions.fontFamily()
    .then(family => {
        console.log(family)
    })

Value of family:

"monospace"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontFamily",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "monospace"
}

Default example #2

JavaScript:

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

ClosedCaptions.fontFamily()
    .then(family => {
        console.log(family)
    })

Value of family:

"monospace"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontFamily",
	"params": {}
}

{
	"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:

"monospace"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontFamily",
	"params": {}
}

{
	"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:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

ClosedCaptions.fontFamily("monospace")
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontFamily",
	"params": {
		"value": "monospace"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontFamily",
	"params": {
		"value": "cursive"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontFamily",
	"params": {
		"value": null
	}
}

{
	"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:

"monospace"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontFamilyChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "monospace"
}

Default example #2

JavaScript:

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

fontFamily(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of family:

"monospace"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontFamilyChanged",
	"params": {
		"listen": true
	}
}

{
	"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:

"monospace"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontFamilyChanged",
	"params": {
		"listen": true
	}
}

{
	"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:

Examples

Default example #1

JavaScript:

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

ClosedCaptions.fontOpacity()
    .then(opacity => {
        console.log(opacity)
    })

Value of opacity:

99

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontOpacity",
	"params": {}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontOpacity",
	"params": {}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontOpacity",
	"params": {}
}

{
	"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:

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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontOpacity",
	"params": {
		"value": 99
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontOpacity",
	"params": {
		"value": 100
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontOpacity",
	"params": {
		"value": null
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontOpacityChanged",
	"params": {
		"listen": true
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontOpacityChanged",
	"params": {
		"listen": true
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontOpacityChanged",
	"params": {
		"listen": true
	}
}

{
	"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:

Examples

Default example #1

JavaScript:

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

ClosedCaptions.fontSize()
    .then(size => {
        console.log(size)
    })

Value of size:

1

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontSize",
	"params": {}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontSize",
	"params": {}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.fontSize",
	"params": {}
}

{
	"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:

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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontSize",
	"params": {
		"value": 1
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontSize",
	"params": {
		"value": 1
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setFontSize",
	"params": {
		"value": null
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontSizeChanged",
	"params": {
		"listen": true
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontSizeChanged",
	"params": {
		"listen": true
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onFontSizeChanged",
	"params": {
		"listen": true
	}
}

{
	"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:

Promise resolution:

Callback parameters:

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:

Callback parameters:

Promise resolution:

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:

Promise resolution:

Callback parameters:

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:

Callback parameters:

Promise resolution:

See Listening for events for more information and examples.

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:

Examples

Default example #1

JavaScript:

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

ClosedCaptions.textAlign()
    .then(alignment => {
        console.log(alignment)
    })

Value of alignment:

"center"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.textAlign",
	"params": {}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.textAlign",
	"params": {}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.textAlign",
	"params": {}
}

{
	"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:

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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setTextAlign",
	"params": {
		"value": "center"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setTextAlign",
	"params": {
		"value": "left"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setTextAlign",
	"params": {
		"value": null
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onTextAlignChanged",
	"params": {
		"listen": true
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onTextAlignChanged",
	"params": {
		"listen": true
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onTextAlignChanged",
	"params": {
		"listen": true
	}
}

{
	"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:

Examples

Default example #1

JavaScript:

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

ClosedCaptions.textAlignVertical()
    .then(alignment => {
        console.log(alignment)
    })

Value of alignment:

"middle"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.textAlignVertical",
	"params": {}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.textAlignVertical",
	"params": {}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.textAlignVertical",
	"params": {}
}

{
	"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:

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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setTextAlignVertical",
	"params": {
		"value": "middle"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setTextAlignVertical",
	"params": {
		"value": "top"
	}
}

{
	"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

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.setTextAlignVertical",
	"params": {
		"value": null
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onTextAlignVerticalChanged",
	"params": {
		"listen": true
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onTextAlignVerticalChanged",
	"params": {
		"listen": true
	}
}

{
	"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"

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "ClosedCaptions.onTextAlignVerticalChanged",
	"params": {
		"listen": true
	}
}

{
	"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

textAlignChanged

See: textAlign

textAlignVerticalChanged

See: textAlignVertical