Encryption
| Name | Type | Description |
|---|---|---|
| id | string | Encryption id, used for referencing encryptions |
| enabled | boolean | Enable or disable encryption. |
| schema | enum aes-128-cbcsample-aesmpeg-cencmpeg-cbc1mpeg-censmpeg-cbcsnone | The chosen encryption schema. Encryption keys will be generated by Hybrik. default: aes-128-cbc |
| drm | array enum playreadyfairplaywidevineclearkey | An array specifying the types of DRM that will be used. |
| rotation | integer | The encryption rotation interval. Every N file segments, a new encryption key will be generated. default: 12 |
| external_key_file | boolean | Use the externally created key file with path from key_location. Do not store key file. |
| key_location | object | The optional key location. This will override any location defined within the parent of this task. |
| key_file_pattern | string | This describes the key file name. Placeholders such as {source_basename} for source file name are supported. |
| key | string | The actual key, if pre-supplied. |
| iv | string | The initialization vector, if pre-supplied. |
| key_id | string | The Key ID. Used for MPEG-CENC only. |
| key_seed | string | The Key seed. |
| content_id | string | The Content ID. Used for MPEG-CENC only. |
| widevine_provider | string | The Widevine provider. |
| widevine_pssh | string | A Widevine PSSH string. |
| playready_url | string | The PlayReady licensing authority URL. |
| playready_pssh | string | A PlayReady PSSH string. |
| playready_version | enum 4.04.14.24.3 | The PlayReady version. |
| fairplay_uri | string | The FairPlay URI for the HSL URI attribute. |
| clearkey_pssh_version | integer | The PSSH box version for CENC. |
| cpix_key | object | The CPIX configuration. |
Example encryption
{
"uid": "package_hls",
"kind": "package",
"payload": {
"kind": "hls",
"location": {
"storage_provider": "s3",
"path": "s3://my_bucket/my_output_folder/hls_manifests",
"attributes": [
{
"name": "ContentType",
"value": "application/x-mpegURL"
}
]
},
"file_pattern": "master_manifest.m3u8",
"segmentation_mode": "segmented_ts",
"segment_duration_sec": "6",
"force_original_media": false,
"media_location": {
"storage_provider": "s3",
"path": "s3://my_bucket/my_output_folder/hls_media",
"attributes": [
{
"name": "ContentType",
"value": "video/MP2T"
}
]
},
"media_file_pattern": "{source_basename}.ts",
"hls": {
"media_playlist_location": {
"storage_provider": "s3",
"path": "s3://my_bucket/my_output_folder/hls_manifests"
}
},
"encryption": {
"enabled": true,
"schema": "mpeg-cenc",
"drm": [
"playready"
],
"key_id": "[32 char hex sequence]",
"key": "[32 char hex sequence]",
"content_id": "2a",
"playready_pssh": "[base-64 encoded pssh]...=="
}
}
}