KantarWatermarkSettings (AWS Java SDK :: Services :: AWS Elemental MediaConvert 2.20.113 API)

java.lang.Object
- software.amazon.awssdk.services.mediaconvert.model.KantarWatermarkSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KantarWatermarkSettings.Builder,KantarWatermarkSettings>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface KantarWatermarkSettings.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`KantarWatermarkSettings.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static KantarWatermarkSettings.Builder`	`builder()`
`String`	`channelName()` Provide an audio channel name from your Kantar audio license.
`String`	`contentReference()` Specify a unique identifier for Kantar to use for this piece of content.
`String`	`credentialsSecretName()` Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Double`	`fileOffset()` Optional.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`kantarLicenseId()` Provide your Kantar license ID number.
`String`	`kantarServerUrl()` Provide the HTTPS endpoint to the Kantar server.
`String`	`logDestination()` Optional.
`String`	`metadata3()` You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking.
`String`	`metadata4()` Additional metadata that MediaConvert sends to Kantar.
`String`	`metadata5()` Additional metadata that MediaConvert sends to Kantar.
`String`	`metadata6()` Additional metadata that MediaConvert sends to Kantar.
`String`	`metadata7()` Additional metadata that MediaConvert sends to Kantar.
`String`	`metadata8()` Additional metadata that MediaConvert sends to Kantar.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends KantarWatermarkSettings.Builder>`	`serializableBuilderClass()`
`KantarWatermarkSettings.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<KantarWatermarkSettings.Builder,KantarWatermarkSettings>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class KantarWatermarkSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

channelName

contentReference

credentialsSecretName

fileOffset

kantarLicenseId

kantarServerUrl

logDestination

metadata3

metadata4

metadata5

metadata6

metadata7

metadata8

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields