StreamingPolicyProperties

object
catalogmap from strings to anyOptional
The custom catalog configuration.
Show value schemaHide value schema
[any key]any
commonEncryptionCbcsobjectCommonEncryptionCbcsOptional
CommonEncryptionCbcs
Show 5 propertiesHide 5 properties
clearKeyEncryptionConfigurationobjectClearKeyEncryptionConfigurationOptional
Clear key configuration
Show 1 propertyHide 1 property
customKeysAcquisitionUrlTemplatestringOptional
The custom license acquisition URL template for a Clear Key license delivery service.
clearTrackslist of objectsStreamingPolicyTrackSelectionOptional
This represents which tracks should not be encrypted.
Show 1 propertyHide 1 property
trackSelectionslist of objectsStreamingPolicyTrackPropertyConditionOptional
track selections is used to specify a set or a subset of track for selection by the streaming policy.
Show 3 propertiesHide 3 properties
operationenumRequired
Track property operation. Only equality is supported.
Allowed values:UnknownEqual
propertyenumRequired
Track property type
Allowed values:UnknownFourCC
valuestringOptional
Track property value
contentKeysobjectStreamingPolicyContentKeysOptional
Content keys used by the streaming policy.
Show 2 propertiesHide 2 properties
defaultKeyobjectDefaultKeyOptional
Default content key used by the encryption.
Show 2 propertiesHide 2 properties
labelstringOptional
Labels are a potential matching field for selecting a content key via a streaming locator.
policyNamestringOptional
Policy used by the key.
keyToTrackMappingslist of objectsStreamingPolicyContentKeyOptional
List of content keys used by the key. Used to assign different keys to different tracks. For instance, using widevine L3 for SD and L1 for HD.
Show 3 propertiesHide 3 properties
labelstringOptional
Labels are a potential matching field for selecting a content key via a streaming locator.
policyNamestringOptional
Policy used by the key.
trackslist of objectsStreamingPolicyTrackSelectionOptional
This represents which tracks should be encrypted.
Show 1 propertyHide 1 property
trackSelectionslist of objectsStreamingPolicyTrackPropertyConditionOptional
track selections is used to specify a set or a subset of track for selection by the streaming policy.
Show 3 propertiesHide 3 properties
operationenumRequired
Track property operation. Only equality is supported.
Allowed values:UnknownEqual
propertyenumRequired
Track property type
Allowed values:UnknownFourCC
valuestringOptional
Track property value
drmobjectCbcsDrmConfigurationOptional
DRM configuration
Show 3 propertiesHide 3 properties
fairPlayobjectStreamingPolicyFairPlayConfigurationOptional
FairPlay configuration
Show 2 propertiesHide 2 properties
allowPersistentLicensebooleanRequired
Allow persistent license
customLicenseAcquisitionUrlTemplatestringOptional
The custom license acquisition URL template for a FairPlay license delivery service.
playReadyobjectStreamingPolicyPlayReadyConfigurationOptional
PlayReady configuration
Show 2 propertiesHide 2 properties
customLicenseAcquisitionUrlTemplatestringOptional
The custom license acquisition URL template for a PlayReady license delivery service.
playReadyCustomAttributesstringOptional
The custom attributes for PlayReady.
widevineobjectStreamingPolicyWidevineConfigurationOptional
Widevine configuration
Show 1 propertyHide 1 property
customLicenseAcquisitionUrlTemplatestringOptional
The custom license acquisition URL template for a Widevine license delivery service.
enabledProtocolsobjectEnabledProtocolsOptional
Enabled protocols. This is the set of protocols (dash, download, and hls) that will be delivered with common encryption.
Show 4 propertiesHide 4 properties
dashbooleanRequired
Enable Dash protocol
downloadbooleanRequired
Enable download protocol
hlsbooleanRequired
Enable HLS protocol
smoothStreamingbooleanRequired
Smooth streaming is not supported and the value of this field is ignored.
commonEncryptionCencobjectCommonEncryptionCencOptional
CommonEncryptionCenc
Show 5 propertiesHide 5 properties
clearKeyEncryptionConfigurationobjectClearKeyEncryptionConfigurationOptional
Clear key configuration
Show 1 propertyHide 1 property
customKeysAcquisitionUrlTemplatestringOptional
The custom license acquisition URL template for a Clear Key license delivery service.
clearTrackslist of objectsStreamingPolicyTrackSelectionOptional
This represents which tracks should not be encrypted.
Show 1 propertyHide 1 property
trackSelectionslist of objectsStreamingPolicyTrackPropertyConditionOptional
track selections is used to specify a set or a subset of track for selection by the streaming policy.
Show 3 propertiesHide 3 properties
operationenumRequired
Track property operation. Only equality is supported.
Allowed values:UnknownEqual
propertyenumRequired
Track property type
Allowed values:UnknownFourCC
valuestringOptional
Track property value
contentKeysobjectStreamingPolicyContentKeysOptional
Content keys used by the streaming policy.
Show 2 propertiesHide 2 properties
defaultKeyobjectDefaultKeyOptional
Default content key used by the encryption.
Show 2 propertiesHide 2 properties
labelstringOptional
Labels are a potential matching field for selecting a content key via a streaming locator.
policyNamestringOptional
Policy used by the key.
keyToTrackMappingslist of objectsStreamingPolicyContentKeyOptional
List of content keys used by the key. Used to assign different keys to different tracks. For instance, using widevine L3 for SD and L1 for HD.
Show 3 propertiesHide 3 properties
labelstringOptional
Labels are a potential matching field for selecting a content key via a streaming locator.
policyNamestringOptional
Policy used by the key.
trackslist of objectsStreamingPolicyTrackSelectionOptional
This represents which tracks should be encrypted.
Show 1 propertyHide 1 property
trackSelectionslist of objectsStreamingPolicyTrackPropertyConditionOptional
track selections is used to specify a set or a subset of track for selection by the streaming policy.
Show 3 propertiesHide 3 properties
operationenumRequired
Track property operation. Only equality is supported.
Allowed values:UnknownEqual
propertyenumRequired
Track property type
Allowed values:UnknownFourCC
valuestringOptional
Track property value
drmobjectCencDrmConfigurationOptional
DRM configuration
Show 2 propertiesHide 2 properties
playReadyobjectStreamingPolicyPlayReadyConfigurationOptional
PlayReady configuration
Show 2 propertiesHide 2 properties
customLicenseAcquisitionUrlTemplatestringOptional
The custom license acquisition URL template for a PlayReady license delivery service.
playReadyCustomAttributesstringOptional
The custom attributes for PlayReady.
widevineobjectStreamingPolicyWidevineConfigurationOptional
Widevine configuration
Show 1 propertyHide 1 property
customLicenseAcquisitionUrlTemplatestringOptional
The custom license acquisition URL template for a Widevine license delivery service.
enabledProtocolsobjectEnabledProtocolsOptional
Enabled protocols. This is the set of protocols (dash, download, and hls) that will be delivered with common encryption.
Show 4 propertiesHide 4 properties
dashbooleanRequired
Enable Dash protocol
downloadbooleanRequired
Enable download protocol
hlsbooleanRequired
Enable HLS protocol
smoothStreamingbooleanRequired
Smooth streaming is not supported and the value of this field is ignored.
defaultContentKeyPolicyNamestringOptional<=260 characters
The default content key policy name used by current streaming policy.
envelopeEncryptionobjectEnvelopeEncryptionOptional
EnvelopeEncryption
Show 4 propertiesHide 4 properties
clearTrackslist of objectsStreamingPolicyTrackSelectionOptional
Clear tracks. This is the set of tracks that will be delivered without envelope encryption.
Show 1 propertyHide 1 property
trackSelectionslist of objectsStreamingPolicyTrackPropertyConditionOptional
track selections is used to specify a set or a subset of track for selection by the streaming policy.
Show 3 propertiesHide 3 properties
operationenumRequired
Track property operation. Only equality is supported.
Allowed values:UnknownEqual
propertyenumRequired
Track property type
Allowed values:UnknownFourCC
valuestringOptional
Track property value
contentKeysobjectStreamingPolicyContentKeysOptional
Content keys used by the streaming policy.
Show 2 propertiesHide 2 properties
defaultKeyobjectDefaultKeyOptional
Default content key used by the encryption.
Show 2 propertiesHide 2 properties
labelstringOptional
Labels are a potential matching field for selecting a content key via a streaming locator.
policyNamestringOptional
Policy used by the key.
keyToTrackMappingslist of objectsStreamingPolicyContentKeyOptional
List of content keys used by the key. Used to assign different keys to different tracks. For instance, using widevine L3 for SD and L1 for HD.
Show 3 propertiesHide 3 properties
labelstringOptional
Labels are a potential matching field for selecting a content key via a streaming locator.
policyNamestringOptional
Policy used by the key.
trackslist of objectsStreamingPolicyTrackSelectionOptional
This represents which tracks should be encrypted.
Show 1 propertyHide 1 property
trackSelectionslist of objectsStreamingPolicyTrackPropertyConditionOptional
track selections is used to specify a set or a subset of track for selection by the streaming policy.
Show 3 propertiesHide 3 properties
operationenumRequired
Track property operation. Only equality is supported.
Allowed values:UnknownEqual
propertyenumRequired
Track property type
Allowed values:UnknownFourCC
valuestringOptional
Track property value
customKeyAcquisitionUrlTemplatestringOptional1-1024 characters
Optional template for the customer service to use for key acquisition. Not needed if using the built-in key delivery service.
enabledProtocolsobjectEnabledProtocolsOptional
Enabled protocols. This is the set of protocols (dash, download, and hls) that will be delivered with envelope encryption.
Show 4 propertiesHide 4 properties
dashbooleanRequired
Enable Dash protocol
downloadbooleanRequired
Enable download protocol
hlsbooleanRequired
Enable HLS protocol
smoothStreamingbooleanRequired
Smooth streaming is not supported and the value of this field is ignored.
noEncryptionobjectNoEncryptionOptional
NoEncryption
Show 1 propertyHide 1 property
enabledProtocolsobjectEnabledProtocolsOptional
Enabled protocols. This is the set of protocols (dash, download, and hls) that will be delivered without encryption.
Show 4 propertiesHide 4 properties
dashbooleanRequired
Enable Dash protocol
downloadbooleanRequired
Enable download protocol
hlsbooleanRequired
Enable HLS protocol
smoothStreamingbooleanRequired
Smooth streaming is not supported and the value of this field is ignored.