AudioDescriptions Module

Version AudioDescriptions 1.2.0

Table of Contents

• Table of Contents
• Usage
• Overview
• Methods
  • enabled
  • listen
  • once
• Events
  • enabledChanged
• Types

Usage

To use the AudioDescriptions module, you can import it into your project from the Firebolt SDK:

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

Overview

A module for managing audio-description Settings.

Methods

enabled

Whether or not audio-descriptions are enabled.

To get the value of enabled call the method like this:

function enabled(): Promise<boolean>

Promise resolution:

Capabilities:

Examples

Default example #1

JavaScript:

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

let enabled = await AudioDescriptions.enabled()
console.log(enabled)

Value of enabled:

true

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

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

Default example #2

JavaScript:

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

let enabled = await AudioDescriptions.enabled()
console.log(enabled)

Value of enabled:

true

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "AudioDescriptions.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:

Examples

Default example #1

JavaScript:

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

let result = await AudioDescriptions.enabled(true)
console.log(result)

Value of result:

null

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

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

Default example #2

JavaScript:

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

let result = await AudioDescriptions.enabled(false)
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "AudioDescriptions.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 { AudioDescriptions } from '@firebolt-js/manage-sdk'

let listenerId = await enabled((value) => {
  console.log(value)
})
console.log(listenerId)

Value of enabled:

true

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

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

Default example #2

JavaScript:

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

let listenerId = await enabled((value) => {
  console.log(value)
})
console.log(listenerId)

Value of enabled:

true

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

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

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.

Events

enabledChanged

See: enabled

Types