Skip to content

PlayerProperties API

Version: 1.0.0

Status: ⚫⚪⚪

PlayerProperties interface for Thunder framework.

(Defined with IPlayerProperties in IPlayerInfo.h)

Table of Contents

Introduction

Scope

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

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

PlayerProperties interface properties:

Property R/W Description
audiocodecs read-only Query Audio Codecs List
videocodecs read-only Query Video Codecs List
resolution read-only Current Video playback resolution
isaudioequivalenceenabled read-only Checks Loudness Equivalence in platform

audiocodecs property

Provides access to the query Audio Codecs List.

This property is read-only.

Value

Name Type M/O Description
(property) array mandatory Query Audio Codecs List
(property)[#] string mandatory ... (must be one of the following: AudioAac, AudioAc3, AudioAc3Plus, AudioDts, AudioMpeg1, AudioMpeg2, AudioMpeg3, AudioMpeg4, AudioOpus, AudioUndefined, AudioVorbisOgg, AudioWav)

Example

Get Request

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

Get Response

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

videocodecs property

Provides access to the query Video Codecs List.

This property is read-only.

Value

Name Type M/O Description
(property) array mandatory Query Video Codecs List
(property)[#] string mandatory ... (must be one of the following: VideoH263, VideoH264, VideoH265, VideoH26510, VideoMpeg, VideoMpeg2, VideoMpeg4, VideoUndefined, VideoVp10, VideoVp8, VideoVp9)

Example

Get Request

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

Get Response

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

resolution property

Provides access to the current Video playback resolution.

This property is read-only.

Value

Name Type M/O Description
(property) string mandatory Current Video playback resolution (must be one of the following: Resolution1080i, Resolution1080i24, Resolution1080i25, Resolution1080i30, Resolution1080i50, Resolution1080p, Resolution1080p24, Resolution1080p25, Resolution1080p30, Resolution1080p50, Resolution2160p, Resolution2160p24, Resolution2160p25, Resolution2160p30, Resolution2160p50, Resolution2160p60, Resolution480i, Resolution480i24, Resolution480i25, Resolution480i30, Resolution480i50, Resolution480p, Resolution480p24, Resolution480p25, Resolution480p30, Resolution480p50, Resolution576i, Resolution576i24, Resolution576i25, Resolution576i30, Resolution576i50, Resolution576p, Resolution576p24, Resolution576p25, Resolution576p30, Resolution576p50, Resolution720p, Resolution720p24, Resolution720p25, Resolution720p30, Resolution720p50, ResolutionUnknown)

Example

Get Request

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

Get Response

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

isaudioequivalenceenabled property

Provides access to the checks Loudness Equivalence in platform.

This property is read-only.

Value

Name Type M/O Description
(property) boolean mandatory Checks Loudness Equivalence in platform

Example

Get Request

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

Get Response

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