FairPlay Claims

The claims in this section apply only to FairPlay objects.

Security Policy

Security policies within the token are assigned unique IDs by a UUID. The claims must be within a "fairplay" object.

Example FairPlay Security Policy

"security_policy":{
"1f6c0d04-b740-4597-89ff-ab411ef61115":{
"fairplay":{
"hdcp_type":1
}
}
}

"hdcp_type" claim

Optional. The "hdcp_type" claim is a child of the FairPlay policy claim. It is an integer object, that indicates the required HDCP output enforcement.
Valid values:

• 0 - HDCP Level 0 – Stream may be transmitted by HDCP repeater to all HDCP devices.
• 1 - HDCP Level 1 (HDCP version 2.2 or later) - Stream may not be sent to HDCP 1.x-compliant or HDCP 2.0 devices.

Playback Policy

Playback policies are applied across the entire asset. The claims must be within a "fairplay" object.
**Example FairPlay Playback Policy

"policy": {
"fairplay": {
"lease": true,
"lease_duration": 3600
}
}

"key_duration" claim

Optional. The "key_duration " claim is a child of the FairPlay policy claim. It is an integer object that indicates how long the content key is valid for.

"lease" claim

Optional. The "lease" claim is a child of the FairPlay policy claim. It is a boolean value that indicates if the license is valid for lease use. It can only be combined with the rental claim.

"lease_duration" claim

Optional. The "lease_duration" claim is a child of the FairPlay policy claim. It is an integer value that indicates how long playback will be allowed for. Playback stops upon the expiration of the license. It requires the lease claim to be present and set to true. Playback stops if the lease period expires during playback. It can only be combined with the rental claim.
Units: Seconds

"persistence" claim

Optional. The "persistence" claim is a child of the FairPlay policy claim. It is a boolean value that indicates if the license is valid for offline usage. It can be combined only with the rental claim.

"persistence_duration" claim

Optional. The "persistence_duration" claim is a child of the FairPlay policy claim. It is an integer value that indicates how long the license can be held persistently. It can only be combined with the rental claim.
Units: Seconds

"rental" claim

Optional. The "rental" claim is a child of the FairPlay policy claim. It is a boolean object that indicates if the license is valid for rental use.

"rental_duration" claim

Optional. The rental_duration claim is a child of the FairPlay policy claim. It is an integer that indicates the duration of an asset's rental period. Playback continues if the rental expires during playback.
Units: Seconds