Skip to content

Latest commit

 

History

History
292 lines (210 loc) · 6.82 KB

VolumeControlPlugin.md

File metadata and controls

292 lines (210 loc) · 6.82 KB
Raw

Volume Control Plugin

Version: 1.0

Status: ⚫⚫⚪

VolumeControl plugin for Thunder framework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the VolumeControl plugin. It includes detailed specification about its configuration, 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

The Volume Control plugin allows to manage system's audio volume.

The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [Thunder].

Configuration

The table below lists configuration options of the plugin.

Name Type Description
callsign string Plugin instance name (default: VolumeControl)
classname string Class name: VolumeControl
locator string Library name: libWPEVolumeControl.so
startmode string Determines if the plugin shall be started automatically along with the framework

Interfaces

This plugin implements the following interfaces:

  • IVolumeControl (IVolumeControl.h) (version 1.0.0) (uncompliant-extended format)

Properties

The following properties are provided by the VolumeControl plugin:

VolumeControl interface properties:

Property Description
muted Audio mute state
volume Audio volume level

muted property

Provides access to the audio mute state.

Value

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

Result

Name Type Description
result boolean

Errors

Code Message Description
ERROR_GENERAL Failed to set/retrieve muting state

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "VolumeControl.1.muted"
}

Get Response

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

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "VolumeControl.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 Description
(property) integer Volume level in percent

Result

Name Type Description
result integer

Errors

Code Message Description
ERROR_GENERAL Failed to set/retrieve audio volume

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "VolumeControl.1.volume"
}

Get Response

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

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "VolumeControl.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 plugin:

VolumeControl interface events:

Event Description
volume Signals volume change
muted Signals mute state change

volume event

Signals volume change.

Parameters

Name Type Description
params object
params.volume integer New bolume level in percent

Example

{
  "jsonrpc": "2.0",
  "method": "client.events.1.volume",
  "params": {
    "volume": 100
  }
}

muted event

Signals mute state change.

Parameters

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

Example

{
  "jsonrpc": "2.0",
  "method": "client.events.1.muted",
  "params": {
    "muted": false
  }
}