Skip to content

OpenCDM API

Version: 1.0.0

Status: ⚫⚪⚪

OpenCDM interface for Thunder framework.

(Defined with IOpenCDM in IOCDM.h)

Table of Contents

Introduction

Scope

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

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

OpenCDM interface properties:

Property R/W Description
systems read-only Supported DRM systems
designators read-only Designators of a specified DRM system

systems property

Provides access to the supported DRM systems.

This property is read-only.

Value

Name Type M/O Description
(property) array mandatory Supported DRM systems
(property)[#] string mandatory ...

Example

Get Request

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

Get Response

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

designators property

Provides access to the designators of a specified DRM system.

This property is read-only.

The keysystem parameter shall be passed as the index to the property, i.e. designators@<keysystem>.

Index

Name Type M/O Description
keysystem string mandatory ...

Value

Name Type M/O Description
(property) array mandatory Designators of a specified DRM system
(property)[#] string mandatory ...

Errors

Message Description
ERROR_UNKNOWN_KEY Invalid DRM name

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.designators@xyz"
}

Get Response

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