Skip to content

VolumeControl API

Version: 1.0.0

Status: ⚫⚪⚪

VolumeControl interface for Thunder framework.

(Defined with IVolumeControl in IVolumeControl.h)

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the VolumeControl interface (version 1.0.0). It includes detailed specification about its properties provided and notifications sent.

Case Sensitivity

All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.

Acronyms, Abbreviations and Terms

The table below provides and overview of acronyms used in this document and their definitions.

Acronym Description
API Application Programming Interface
HTTP Hypertext Transfer Protocol
JSON JavaScript Object Notation; a data interchange format
JSON-RPC A remote procedure call protocol encoded in JSON

The table below provides and overview of terms and abbreviations used in this document and their definitions.

Term Description
callsign The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique.

References

Ref ID Description
HTTP HTTP specification
JSON-RPC JSON-RPC 2.0 specification
JSON JSON specification
Thunder Thunder API Reference

Description

VolumeControl JSON-RPC interface.

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.

Properties

The following properties are provided by the VolumeControl interface:

VolumeControl interface properties:

Property R/W Description
muted read/write Audio mute state
volume read/write Audio volume level

muted property

Provides access to the audio mute state.

Value

Name Type M/O Description
(property) boolean mandatory Mute state (true: muted, false: un-muted)
Name Type M/O Description
(property) boolean mandatory Mute state (true: muted, false: un-muted)

Errors

Message Description
ERROR_GENERAL Failed to set/retrieve muting state

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.muted"
}

Get Response

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

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.muted",
  "params": false
}

Set Response

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

volume property

Provides access to the audio volume level.

Value

Name Type M/O Description
(property) integer mandatory Volume level in percent
Name Type M/O Description
(property) integer mandatory Volume level in percent

Errors

Message Description
ERROR_GENERAL Failed to set/retrieve audio volume

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.volume"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": 0
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.volume",
  "params": 100
}

Set Response

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

Notifications

Notifications are autonomous events triggered by the internals of the implementation and broadcasted via JSON-RPC to all registered observers. Refer to [Thunder] for information on how to register for a notification.

The following events are provided by the VolumeControl interface:

VolumeControl interface events:

Notification Description
volume Signals volume change
muted Signals mute state change

volume notification

Signals volume change.

Notification Parameters

Name Type M/O Description
params object mandatory ...
params.volume integer mandatory New bolume level in percent

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.register",
  "params": {
    "event": "volume",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.volume",
  "params": {
    "volume": 100
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.volume.

muted notification

Signals mute state change.

Notification Parameters

Name Type M/O Description
params object mandatory ...
params.muted boolean mandatory New mute state (true: muted, false: un-muted)

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.register",
  "params": {
    "event": "muted",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.muted",
  "params": {
    "muted": false
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.muted.