Class KantarWatermarkSettings

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.KantarWatermarkSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<KantarWatermarkSettings.Builder,KantarWatermarkSettings>
@Generated("software.amazon.awssdk:codegen") public final class KantarWatermarkSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KantarWatermarkSettings.Builder,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 https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.
See Also:

  • Method Details

    • channelName

      public final String channelName()
      Provide an audio channel name from your Kantar audio license.
      Returns:
      Provide an audio channel name from your Kantar audio license.

    • contentReference

      public final String contentReference()
      Specify a unique identifier for Kantar to use for this piece of content.
      Returns:
      Specify a unique identifier for Kantar to use for this piece of content.

    • credentialsSecretName

      public final String credentialsSecretName()
      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.
      Returns:
      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

      public final Double fileOffset()
      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.
      Returns:
      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

      public final Integer kantarLicenseId()
      Provide your Kantar license ID number. You should get this number from Kantar.
      Returns:
      Provide your Kantar license ID number. You should get this number from Kantar.

    • kantarServerUrl

      public final String kantarServerUrl()
      Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.
      Returns:
      Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.

    • logDestination

      public final String logDestination()
      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
      Returns:
      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

      public final String metadata3()
      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.
      Returns:
      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

      public final String metadata4()
      Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
      Returns:
      Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

    • metadata5

      public final String metadata5()
      Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
      Returns:
      Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

    • metadata6

      public final String metadata6()
      Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
      Returns:
      Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

    • metadata7

      public final String metadata7()
      Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
      Returns:
      Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

    • metadata8

      public final String metadata8()
      Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
      Returns:
      Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

    • toBuilder

      public KantarWatermarkSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<KantarWatermarkSettings.Builder,KantarWatermarkSettings>
      Returns:
      a builder for type T

    • builder

      public static KantarWatermarkSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends KantarWatermarkSettings.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.