SecondScreen Module

Version 0.8.0

Methods for communicating with second screen devices

Firebolt APIs are maintained in the rdkcentral/firebolt-core-sdk GitHub repository.

You can see this API in the secondscreen.json OpenRPC JSON-Schema document.

• Overview

• OpenRPC

• Usage

• Methods

  • device
  • friendlyName
  • listen
  • once
  • protocols

• Events

  • Additional Events

• Schemas

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

import { SecondScreen } from '@firebolt-js/sdk'

Get the broadcasted id for the device

function device(type?: string): Promise<string>

Parameters:

Promise resolution:

Examples

Default Example

JavaScript:

import { SecondScreen } from '@firebolt-js/sdk'

SecondScreen.device(null)
    .then(deviceId => {
        console.log(deviceId)
    })

Value of deviceId:

"device-id"

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "secondscreen.device",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "device-id"
}

Get the broadcasted friendly name for the device

To get the value, call the method with no parameters:

function friendlyName(): Promise<string>

Promise resolution:

Examples

Default Example

JavaScript:

import { SecondScreen } from '@firebolt-js/sdk'

SecondScreen.friendlyName()
    .then(friendlyName => {
        console.log(friendlyName)
    })

Value of friendlyName:

"Living Room"

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "secondscreen.friendlyName",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "Living Room"
}

To subscribe to notifications when the value changes, pass a function as the only parameter:

function friendlyName(subscriber: (friendlyName: string) => void): Promise<boolean>

Parameters:

Promise resolution:

Callback parameters:

Examples

Default Example

JavaScript:

import { SecondScreen } from '@firebolt-js/sdk'

SecondScreen.friendlyName(friendlyName => {
  // property value was changed
  console.log(friendlyName)
}).then(listenerId => {
  // you can clear this listener w/ SecondScreen.clear(listenerId)
})

value of friendlyName:

"Living Room"

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "secondscreen.onFriendlyNameChanged",
  "params": {
    "listen": true
  }
}

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

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "Living Room"
}

Listen for events from this module.

To listen to a specific event pass the event name as the first parameter:

SecondScreen.listen(event: string, (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:

SecondScreen.listen((event: string, data: any) => void): Promise<number>

Parameters:

Callback parameters:

Promise resolution:

See Listening for events for more information and examples.

Listen for only one occurance of an event from this module. The callback will be cleared after one event.

To listen to a specific event pass the event name as the first parameter:

SecondScreen.once(event: string, (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:

SecondScreen.once((event: string, data: any) => void): Promise<number>

Parameters:

Callback parameters:

Promise resolution:

See Listening for events for more information and examples.

Get the supported second screen discovery protocols

function protocols(): Promise<BooleanMap>

Promise resolution:

Examples

Default Example

JavaScript:

import { SecondScreen } from '@firebolt-js/sdk'

SecondScreen.protocols()
    .then(protocols => {
        console.log(protocols)
    })

Value of protocols:

{
  "dial1.7": true
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "secondscreen.protocols",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "dial1.7": true
  }
}

Listen to the closeRequest event

See also: listen(), once(), clear().

Event value:

Examples

Default Example:

JavaScript:

import { SecondScreen } from '@firebolt-js/sdk'

SecondScreen.listen('closeRequest', closeRequestEvent => {
  console.log(closeRequestEvent)
})

Value of closeRequestEvent

{
  "type": "dial",
  "version": "1.7"
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "secondscreen.onCloseRequest",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "type": "dial",
    "version": "1.7"
  }
}

Listen to the launchRequest event

See also: listen(), once(), clear().

Event value:

Examples

Default Example:

JavaScript:

import { SecondScreen } from '@firebolt-js/sdk'

SecondScreen.listen('launchRequest', launchRequestEvent => {
  console.log(launchRequestEvent)
})

Value of launchRequestEvent

{
  "type": "dial",
  "version": "1.7",
  "data": "{\"code\":\"AQDPQZiQcb3KQ7gY7yy5tHTMbbkGHR9Zjp-KL53H3eKBZIeAt7O9UKYPu6B21l2UZVmIqkFXDXBmXvK4g2e3EgZtjMNmKPsTltgnRl95DImtOXjSpWtTjSaOkW4w1kZKUTwLKdwVWTzBVH8ERHorvLU6vCGOVHxXt65LNwdl5HKRweShVC1V9QsyvRnQS61ov0UclmrH_xZML2Bt-Q-rZFjey5MjwupIb4x4f53XUJMhjHpDHoIUKrjpdPDQvK2a\",\"friendlyName\":\"Operator_TX061AEI\",\"UDN\":\"608fef11-2800-482a-962b-23a6690c93c1\"}"
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "secondscreen.onLaunchRequest",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "type": "dial",
    "version": "1.7",
    "data": "{\"code\":\"AQDPQZiQcb3KQ7gY7yy5tHTMbbkGHR9Zjp-KL53H3eKBZIeAt7O9UKYPu6B21l2UZVmIqkFXDXBmXvK4g2e3EgZtjMNmKPsTltgnRl95DImtOXjSpWtTjSaOkW4w1kZKUTwLKdwVWTzBVH8ERHorvLU6vCGOVHxXt65LNwdl5HKRweShVC1V9QsyvRnQS61ov0UclmrH_xZML2Bt-Q-rZFjey5MjwupIb4x4f53XUJMhjHpDHoIUKrjpdPDQvK2a\",\"friendlyName\":\"Operator_TX061AEI\",\"UDN\":\"608fef11-2800-482a-962b-23a6690c93c1\"}"
  }
}

The following events are documented as part of a related set of method APIs.

For more information, follow the links under the “Documentation” column.