Skip to content

HDRProperties API

Version: 1.0.0

Status: ⚫⚪⚪

HDRProperties interface for Thunder framework.

(Defined with IHDRProperties in IDisplayInfo.h)

Table of Contents

Introduction

Scope

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

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

HDRProperties 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 HDRProperties interface:

HDRProperties interface properties:

Property R/W Description
tvcapabilities read-only HDR formats supported by TV
stbcapabilities read-only HDR formats supported by STB
hdrsetting read-only HDR format in use

tvcapabilities property

Provides access to the HDR formats supported by TV.

This property is read-only.

Value

Name Type M/O Description
(property) array mandatory HDR formats supported by TV
(property)[#] string mandatory ... (must be one of the following: Hdr10, Hdr10plus, HdrDolbyvision, HdrHlg, HdrOff, HdrTechnicolor)

Example

Get Request

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

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    "Hdr10"
  ]
}

stbcapabilities property

Provides access to the HDR formats supported by STB.

This property is read-only.

Value

Name Type M/O Description
(property) array mandatory HDR formats supported by STB
(property)[#] string mandatory ... (must be one of the following: Hdr10, Hdr10plus, HdrDolbyvision, HdrHlg, HdrOff, HdrTechnicolor)

Example

Get Request

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

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    "Hdr10"
  ]
}

hdrsetting property

Provides access to the HDR format in use.

This property is read-only.

Value

Name Type M/O Description
(property) string mandatory HDR format (must be one of the following: Hdr10, Hdr10plus, HdrDolbyvision, HdrHlg, HdrOff, HdrTechnicolor)

Example

Get Request

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

Get Response

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