class Aws::MediaConvert::Types::KantarWatermarkSettings

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 docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.

@note When making an API call, you may pass KantarWatermarkSettings

data as a hash:

    {
      channel_name: "__stringMin1Max20",
      content_reference: "__stringMin1Max50PatternAZAZ09",
      credentials_secret_name: "__stringMin1Max512PatternAZAZ09",
      file_offset: 1.0,
      kantar_license_id: 1,
      kantar_server_url: "__stringPatternHttpsKantarmediaCom",
      log_destination: "__stringPatternS3",
      metadata_3: "__stringMin1Max50",
      metadata_4: "__stringMin1Max50",
      metadata_5: "__stringMin1Max50",
      metadata_6: "__stringMin1Max50",
      metadata_7: "__stringMin1Max50",
      metadata_8: "__stringMin1Max50",
    }

@!attribute [rw] channel_name

Provide an audio channel name from your Kantar audio license.
@return [String]

@!attribute [rw] content_reference

Specify a unique identifier for Kantar to use for this piece of
content.
@return [String]

@!attribute [rw] credentials_secret_name

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.
@return [String]

@!attribute [rw] file_offset

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.
@return [Float]

@!attribute [rw] kantar_license_id

Provide your Kantar license ID number. You should get this number
from Kantar.
@return [Integer]

@!attribute [rw] kantar_server_url

Provide the HTTPS endpoint to the Kantar server. You should get this
endpoint from Kantar.
@return [String]

@!attribute [rw] log_destination

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
@return [String]

@!attribute [rw] metadata_3

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.
@return [String]

@!attribute [rw] metadata_4

Additional metadata that MediaConvert sends to Kantar. Maximum
length is 50 characters.
@return [String]

@!attribute [rw] metadata_5

Additional metadata that MediaConvert sends to Kantar. Maximum
length is 50 characters.
@return [String]

@!attribute [rw] metadata_6

Additional metadata that MediaConvert sends to Kantar. Maximum
length is 50 characters.
@return [String]

@!attribute [rw] metadata_7

Additional metadata that MediaConvert sends to Kantar. Maximum
length is 50 characters.
@return [String]

@!attribute [rw] metadata_8

Additional metadata that MediaConvert sends to Kantar. Maximum
length is 50 characters.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/mediaconvert-2017-08-29/KantarWatermarkSettings AWS API Documentation

Constants

SENSITIVE