Skip to main content

Encryptions

NameTypeDescription
idstringEncryption id, used for referencing encryptions
enabledbooleanEnable or disable encryption.
schemaenum                          
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
drmarray enum                          
playready
fairplay
widevine
clearkey
An array specifying the types of DRM that will be used.
rotationinteger
The encryption rotation interval. Every N file segments, a new encryption key will be generated.
default: 12
external_key_filebooleanUse the externally created key file with path from key_location. Do not store key file.
key_locationobjectThe optional key location. This will override any location defined within the parent of this task.
key_file_patternstring
This describes the key file name. Placeholders such as {source_basename} for source file name are supported.
keystringThe actual key, if pre-supplied.
ivstringThe initialization vector, if pre-supplied.
key_idstringThe Key ID. Used for MPEG-CENC only.
key_seedstringThe Key seed.
content_idstringThe Content ID. Used for MPEG-CENC only.
widevine_providerstringThe Widevine provider.
widevine_psshstringA Widevine PSSH string.
playready_urlstringThe PlayReady licensing authority URL.
playready_psshstringA PlayReady PSSH string.
playready_versionenum                          
4.0
4.1
4.2
4.3
The PlayReady version.
fairplay_uristringThe FairPlay URI for the HSL URI attribute.
clearkey_pssh_versionintegerThe PSSH box version for CENC.
cpix_keyobjectThe CPIX configuration.

Example encryptions

{
"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": "180",
"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"
}
},
"encryptions": [
{
"id": "id_playready_encryption",
"enabled": true,
"schema": "mpeg-cenc",
"drm": [
"playready"
],
"key_id": "[hex sequence]",
"key": "[hex sequence]",
"content_id": "2a",
"playready_pssh": "[base-64 encoded pssh]"
},
{
"id": "id_fairplay_encryption",
"enabled": true,
"schema": "mpeg-cenc",
"drm": [
"fairplay"
],
"key_id": "[hex sequence]",
"key": "[hex sequence]",
"content_id": "3a",
"fairplay_uri": "skd://your_fairplay_skd_uri"
}
]
}
}