Skip to content

docs: Add license duration and persistence configurations to DRM API #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PReshma-tp wants to merge 5 commits into
base: main
Choose a base branch
from
Open

docs: Add license duration and persistence configurations to DRM API #92

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1a400f0
expose download and license expiry configurations
PReshma-tp Feb 27, 2026
b2edb11
remove license_duration field
PReshma-tp Feb 27, 2026
903545d
remove formatting inconsistencies
PReshma-tp Feb 27, 2026
21ad872
add rental duration in payload
PReshma-tp Feb 27, 2026
acce9ce
update line formatting
PReshma-tp Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions docs/server-api/drm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,14 @@ POST: https://app.tpstreams.com/api/v1/<organization_id>/assets/<asset_id>/drm_l

**Request Body**

| Name | Type | Description | Required |
| ---------------- | ------ | --------------------------------------------------------------------------------------------------------------------- | -------- |
| `player_payload` | string | For **Widevine**, this is the key message. For **FairPlay**, this is the Server Playback Context (SPC) message. This **must be encoded in base64** to be sent within the JSON body. | Yes |
| `widevine` | object | Additional configurations for Widevine. See the Widevine table below. | No |
| Name | Type | Description | Required |
| -------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `player_payload` | string | For **Widevine**, this is the key message. For **FairPlay**, this is the SPC message. This **must be encoded in base64**. | Yes |
| `rental_duration_seconds` | integer | Total validity period (in seconds) of a stored license on the device. Used only for persistent (offline) licenses. Defines how long the license remains usable before it expires. | No |
| `license_duration_seconds` | integer | (Widevine only) Duration (in seconds) for which playback is allowed. This defines the active viewing window once playback begins. | No |
| `lease_duration_seconds` | integer | (FairPlay only) Duration (in seconds) for which playback is allowed. This defines the active viewing window once playback begins. | No |
| `is_persistent` | boolean | Set to true to allow the license to be stored on the device for offline playback. | No |
| `widevine` | object | Additional configurations for Widevine. See the Widevine table below. | No |

**Widevine Configuration Fields**

Expand Down Expand Up @@ -67,12 +71,6 @@ POST: https://app.tpstreams.com/api/v1/<organization_id>/assets/<asset_id>/drm_l
| | - HDCP_V2_3 |
| | - HDCP_NO_DIGITAL_OUTPUT |
+---------------------------------------------------+------------------------------------------------------+
| license_duration | The total duration (in seconds) that the DRM |
| | license is valid. Once this time expires, the |
| | player must request a new license to continue |
| | playback. Set to 0 for unlimited duration |
| | (not recommended for rental content). |
+---------------------------------------------------+------------------------------------------------------+

**Sample Payloads**

Expand All @@ -82,6 +80,9 @@ POST: https://app.tpstreams.com/api/v1/<organization_id>/assets/<asset_id>/drm_l
```json
{
"player_payload": "<base64_encoded_key_message>",
"license_duration_seconds": 3600,
"rental_duration_seconds": 7200,
"is_persistent": false,
"widevine": {
"content_key_specs": [
{
Expand Down Expand Up @@ -109,8 +110,7 @@ POST: https://app.tpstreams.com/api/v1/<organization_id>/assets/<asset_id>/drm_l
"security_level": 1,
"required_output_protection": { "hdcp": "HDCP_V1" }
}
],
"license_duration": 3600
]
}
}
```
Expand All @@ -122,7 +122,10 @@ POST: https://app.tpstreams.com/api/v1/<organization_id>/assets/<asset_id>/drm_l

```json
{
"player_payload": "<base64_encoded_spc_data>"
"player_payload": "<base64_encoded_spc_data>",
"lease_duration_seconds": 3600,
"rental_duration_seconds": 7200,
"is_persistent": true
}
```

Expand Down