Skip to content

Latest commit

 

History

History
169 lines (125 loc) · 4.61 KB

OpenCDMiPlugin.md

File metadata and controls

169 lines (125 loc) · 4.61 KB

OpenCDMi Plugin

Version: 1.0

Status: ⚫⚫⚫

OCDM plugin for Thunder framework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the OCDM plugin. It includes detailed specification of its configuration and properties provided.

Case Sensitivity

All identifiers on the interface 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

Configuration

The table below lists configuration options of the plugin.

Name Type Description
callsign string Plugin instance name (default: OCDM)
classname string Class name: OCDM
locator string Library name: libWPEFrameworkOCDM.so
autostart boolean Determines if the plugin is to be started automatically along with the framework

Properties

The following properties are provided by the OCDM plugin:

OCDM interface properties:

Property Description
drms RO Supported DRM systems
keysystems RO DRM key systems

drms property

Provides access to the supported DRM systems.

This property is read-only.

Value

Name Type Description
(property) array Supported DRM systems
(property)[#] object
(property)[#].name string Name of the DRM
(property)[#].keysystems array
(property)[#].keysystems[#] string Identifier of a key system

Example

Get Request

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "method": "OCDM.1.drms"
}

Get Response

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "result": [
        {
            "name": "PlayReady",
            "keysystems": [
                "com.microsoft.playready"
            ]
        }
    ]
}

keysystems property

Provides access to the DRM key systems.

This property is read-only.

Value

Name Type Description
(property) array DRM key systems
(property)[#] string Identifier of a key system

The drm system shall be passed as the index to the property, e.g. OCDM.1.keysystems@PlayReady.

Errors

Code Message Description
30 ERROR_BAD_REQUEST Invalid DRM name

Example

Get Request

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "method": "OCDM.1.keysystems@PlayReady"
}

Get Response

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "result": [
        "com.microsoft.playready"
    ]
}