watermarking

Property Manager name: Watermarking
Behavior version: The v2023-01-05 rule format supports the watermarking behavior v1.1.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

Adds watermarking for each valid user's content. Content segments are delivered from different sources using a pattern unique to each user, based on a watermarking token included in each request. If your content is pirated or redistributed, you can forensically analyze the segments to extract the pattern, and identify the user who leaked the content.

Option	Type	Description	Requires
`enable`	boolean	Enables the watermarking behavior.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`signature_verification_enable`	boolean	When enabled, you can verify the signature in your watermarking token.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enable","op":"eq","value":true}}
`verification_key_id1`	string	Specifies a unique identifier for the first public key.	`signature_verification_enable` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"signatureVerificationEnable","op":"eq","value":true}}
`verification_public_key1`	string	Specifies the first public key in its entirety.	`signature_verification_enable` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"signatureVerificationEnable","op":"eq","value":true}}
`verification_key_id2`	string	Specifies a unique identifier for the optional second public key.	`signature_verification_enable` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"signatureVerificationEnable","op":"eq","value":true}}
`verification_public_key2`	string	Specifies the optional second public key in its entirety. Specify a second key to enable rotation.	`signature_verification_enable` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"signatureVerificationEnable","op":"eq","value":true}}
`pattern_decryption_enable`	boolean	If patterns in your watermarking tokens have been encrypted, enabling this allows you to provide values to decrypt them.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enable","op":"eq","value":true}}
`decryption_password_id1`	string	Specifies a label that corresponds to the primary password.	`pattern_decryption_enable` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"patternDecryptionEnable","op":"eq","value":true}}
`decryption_password1`	string	Provides the primary password used to encrypt patterns in your watermarking tokens.	`pattern_decryption_enable` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"patternDecryptionEnable","op":"eq","value":true}}
`decryption_password_id2`	string	Specifies a label for the secondary password, used in rotation scenarios to identify which password to use for decryption.	`pattern_decryption_enable` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"patternDecryptionEnable","op":"eq","value":true}}
`decryption_password2`	string	Provides the secondary password you can use to rotate passwords.	`pattern_decryption_enable` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"patternDecryptionEnable","op":"eq","value":true}}
`use_original_as_a`	boolean	When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. With the standard filename-prefix AB naming preprocessing method, the watermarking vendor creates two variants of the original segment content and labels them as an `A` and `B` segment in the filename. If you selected the unlabeled A variant preprocessing method, enabling this option tells your configuration to use the original filename segment content as your `A` variant.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enable","op":"eq","value":true}}
`ab_variant_location`	enum	When you work with your watermarking vendor, you can apply several preprocessing methods to your content. See the AMD help for more information. Use this option to specify the location of the `A` and `B` variant segments.		{"displayType":"enum","options":["FILENAME_PREFIX","PARENT_DIRECTORY_PREFIX"],"tag":"select"} {"if":{"attribute":"enable","op":"eq","value":true}}
	`FILENAME_PREFIX`	Set for the standard, filename-prefix AB naming preprocessing method, where the variant letter is included in the filename.
	`PARENT_DIRECTORY_PREFIX`	Set for the directory-prefix AB naming preprocessing method, where variants are located in a subdirectory named after the variants, such as `/B/segment1.ts`.