DisplayProperties API

Version: 1.0.0

Status:

DisplayProperties interface for Thunder framework.

(Defined with IDisplayProperties in IDisplayInfo.h)

Table of Contents

• Introduction
• Description
• Properties

Introduction

Scope

This document describes purpose and functionality of the DisplayProperties 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

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

DisplayProperties interface properties:

Property	R/W	Description
colorspace	read-only	Provides access to the display's Colour space (chroma subsampling format)
framerate	read-only	Provides access to Frame Rate
colourdepth	read-only	Provides access to display's colour Depth
colorimetry	read-only	Provides access to display's colorimetry
quantizationrange	read-only	Provides access to display's Qauntization Range
eotf	read-only	Provides access to display's Electro optical transfer function

colorspace ^property

Provides access to the provides access to the display's Colour space (chroma subsampling format).

This property is read-only.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Colour space (must be one of the following: FormatOther, FormatRgb444, FormatUnknown, FormatYcbcr420, FormatYcbcr422, FormatYcbcr444)

Example

Get Request

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

Get Response

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

framerate ^property

Provides access to the provides access to Frame Rate.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Frame rate (must be one of the following: Framerate11988, Framerate120, Framerate144, Framerate23976, Framerate24, Framerate25, Framerate2997, Framerate30, Framerate47952, Framerate48, Framerate50, Framerate5994, Framerate60, FramerateUnknown)

Example

Get Request

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

Get Response

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

colourdepth ^property

Provides access to the provides access to display's colour Depth.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Colour depth (must be one of the following: Colordepth10Bit, Colordepth12Bit, Colordepth8Bit, ColordepthUnknown)

Example

Get Request

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

Get Response

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

colorimetry ^property

Provides access to the provides access to display's colorimetry.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	array	mandatory	Display colorimetry
(property)[#]	string	mandatory	... (must be one of the following: ColorimetryBt2020rgbYcbcr, ColorimetryBt2020yccbcbrc, ColorimetryBt709, ColorimetryOprgb, ColorimetryOpycc601, ColorimetryOther, ColorimetrySmpte170m, ColorimetrySycc601, ColorimetryUnknown, ColorimetryXvycc601, ColorimetryXvycc709)

Example

Get Request

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

Get Response

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

quantizationrange ^property

Provides access to the provides access to display's Qauntization Range.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Quantization range (must be one of the following: QuantizationrangeFull, QuantizationrangeLimited, QuantizationrangeUnknown)

Example

Get Request

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

Get Response

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

eotf ^property

Provides access to the provides access to display's Electro optical transfer function.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Display's EOTF (must be one of the following: EotfBt1886, EotfBt2100, EotfOther, EotfSmpteSt2084, EotfUnknown)

Example

Get Request

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

Get Response

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