Encryption
Name | Type | Description |
---|---|---|
id | string | Encryption id, used for referencing encryptions |
enabled | boolean | Enable or disable encryption. |
schema | enum aes-128-cbc sample-aes mpeg-cenc mpeg-cbc1 mpeg-cens mpeg-cbcs none | The chosen encryption schema. Encryption keys will be generated by Hybrik. default: aes-128-cbc |
drm | array enum playready fairplay widevine clearkey | 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.0 4.1 4.2 4.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. |
Example encryption
{
"uid": "transcode_task",
"kind": "transcode",
"payload": {
"location": {
"storage_provider": "s3",
"path": "s3://my_bucket/my_folder"
},
"targets": [
{
"file_pattern": "{source_basename}_output.{default_extension}",
"existing_files": "replace",
"container": {
"kind": "mp4",
"encryption": {
"enabled": true,
"schema": "mpeg-cenc",
"drm": [
"playready"
],
"key_id": "[32 char hex sequence]",
"key": "[32 char hex sequence]",
"playready_pssh": "[base-64 encoded pssh]...=="
}
},
"video": {
"codec": "h264",
"bitrate_mode": "vbr",
"bitrate_kb": 1000,
"max_bitrate_kb": 1200,
"profile": "main",
"level": "4.0",
"height": 720
},
"audio": [
{
"codec": "aac",
"channels": 2,
"sample_rate": 48000,
"sample_size": 16,
"bitrate_kb": 128
}
]
}
]
}
}