Mediaconvert Api Kantar Watermark Settings Structure
Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.
Type: objectProperties: 13
BroadcastingMedia ProcessingMedia
KantarWatermarkSettings is a JSON Structure definition published by Amazon MediaConvert, describing 13 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mediaconvert/refs/heads/main/json-structure/mediaconvert-api-kantar-watermark-settings-structure.json",
"name": "KantarWatermarkSettings",
"type": "object",
"description": "Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.",
"properties": {
"ChannelName": {
"allOf": [
{
"$ref": "#/components/schemas/__stringMin1Max20"
},
{
"xml": {
"name": "channelName"
},
"description": "Provide an audio channel name from your Kantar audio license."
}
]
},
"ContentReference": {
"allOf": [
{
"$ref": "#/components/schemas/__stringMin1Max50PatternAZAZ09"
},
{
"xml": {
"name": "contentReference"
},
"description": "Specify a unique identifier for Kantar to use for this piece of content."
}
]
},
"CredentialsSecretName": {
"allOf": [
{
"$ref": "#/components/schemas/__stringMin1Max512PatternAZAZ09"
},
{
"xml": {
"name": "credentialsSecretName"
},
"description": "Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored. Note that your MediaConvert service role must provide access to this secret. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets-manager-secret.html. For instructions on creating a secret, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, in the AWS Secrets Manager User Guide."
}
]
},
"FileOffset": {
"allOf": [
{
"$ref": "#/components/schemas/__doubleMin0"
},
{
"xml": {
"name": "fileOffset"
},
"description": "Optional. Specify an offset, in whole seconds, from the start of your output and the beginning of the watermarking. When you don't specify an offset, Kantar defaults to zero."
}
]
},
"KantarLicenseId": {
"allOf": [
{
"$ref": "#/components/schemas/__integerMin0Max2147483647"
},
{
"xml": {
"name": "kantarLicenseId"
},
"description": "Provide your Kantar license ID number. You should get this number from Kantar."
}
]
},
"KantarServerUrl": {
"allOf": [
{
"$ref": "#/components/schemas/__stringPatternHttpsKantarmediaCom"
},
{
"xml": {
"name": "kantarServerUrl"
},
"description": "Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar."
}
]
},
"LogDestination": {
"allOf": [
{
"$ref": "#/components/schemas/__stringPatternS3"
},
{
"xml": {
"name": "logDestination"
},
"description": "Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html"
}
]
},
"Metadata3": {
"allOf": [
{
"$ref": "#/components/schemas/__stringMin1Max50"
},
{
"xml": {
"name": "metadata3"
},
"description": "You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking. Kantar suggests that you be very cautious when using this Kantar feature, and that you use it only on channels that are managed specifically for use with this feature by your Audience Measurement Operator. For more information about this feature, contact Kantar technical support."
}
]
},
"Metadata4": {
"allOf": [
{
"$ref": "#/components/schemas/__stringMin1Max50"
},
{
"xml": {
"name": "metadata4"
},
"description": "Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters."
}
]
},
"Metadata5": {
"allOf": [
{
"$ref": "#/components/schemas/__stringMin1Max50"
},
{
"xml": {
"name": "metadata5"
},
"description": "Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters."
}
]
},
"Metadata6": {
"allOf": [
{
"$ref": "#/components/schemas/__stringMin1Max50"
},
{
"xml": {
"name": "metadata6"
},
"description": "Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters."
}
]
},
"Metadata7": {
"allOf": [
{
"$ref": "#/components/schemas/__stringMin1Max50"
},
{
"xml": {
"name": "metadata7"
},
"description": "Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters."
}
]
},
"Metadata8": {
"allOf": [
{
"$ref": "#/components/schemas/__stringMin1Max50"
},
{
"xml": {
"name": "metadata8"
},
"description": "Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters."
}
]
}
}
}