NielsenNonLinearWatermarkSettings (AWS Java SDK :: Services :: AWS Elemental MediaConvert 2.20.110 API)

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NielsenNonLinearWatermarkSettings.Builder,NielsenNonLinearWatermarkSettings>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class NielsenNonLinearWatermarkSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NielsenNonLinearWatermarkSettings.Builder,NielsenNonLinearWatermarkSettings>
```
Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface NielsenNonLinearWatermarkSettings.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NielsenActiveWatermarkProcessType`	`activeWatermarkProcess()` Choose the type of Nielsen watermarks that you want in your outputs.
`String`	`activeWatermarkProcessAsString()` Choose the type of Nielsen watermarks that you want in your outputs.
`String`	`adiFilename()` Optional.
`String`	`assetId()` Use the asset ID that you provide to Nielsen to uniquely identify this asset.
`String`	`assetName()` Use the asset name that you provide to Nielsen for this asset.
`static NielsenNonLinearWatermarkSettings.Builder`	`builder()`
`String`	`cbetSourceId()` Use the CSID that Nielsen provides to you.
`String`	`episodeId()` Optional.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`metadataDestination()` Specify the Amazon S3 location where you want MediaConvert to save your Nielsen non-linear metadata .zip file.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends NielsenNonLinearWatermarkSettings.Builder>`	`serializableBuilderClass()`
`Integer`	`sourceId()` Use the SID that Nielsen provides to you.
`NielsenSourceWatermarkStatusType`	`sourceWatermarkStatus()` Required.
`String`	`sourceWatermarkStatusAsString()` Required.
`String`	`ticServerUrl()` Specify the endpoint for the TIC server that you have deployed and configured in the AWS Cloud.
`NielsenNonLinearWatermarkSettings.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`NielsenUniqueTicPerAudioTrackType`	`uniqueTicPerAudioTrack()` To create assets that have the same TIC values in each audio track, keep the default value Share TICs (SAME_TICS_PER_TRACK).
`String`	`uniqueTicPerAudioTrackAsString()` To create assets that have the same TIC values in each audio track, keep the default value Share TICs (SAME_TICS_PER_TRACK).

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
  - activeWatermarkProcess
```
public final NielsenActiveWatermarkProcessType activeWatermarkProcess()
```
    Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW (NAES2_AND_NW), you must provide a value for the setting SID (sourceId). When you choose CBET (CBET), you must provide a value for the setting CSID (cbetSourceId). When you choose NAES 2, NW, and CBET (NAES2_AND_NW_AND_CBET), you must provide values for both of these settings.
    If the service returns an enum value that is not available in the current SDK version, activeWatermarkProcess will return NielsenActiveWatermarkProcessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activeWatermarkProcessAsString().
    
    Returns:
    
    Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW (NAES2_AND_NW), you must provide a value for the setting SID (sourceId). When you choose CBET (CBET), you must provide a value for the setting CSID (cbetSourceId). When you choose NAES 2, NW, and CBET (NAES2_AND_NW_AND_CBET), you must provide values for both of these settings.
    
    See Also:
    
    NielsenActiveWatermarkProcessType
  - activeWatermarkProcessAsString
```
public final String activeWatermarkProcessAsString()
```
    Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW (NAES2_AND_NW), you must provide a value for the setting SID (sourceId). When you choose CBET (CBET), you must provide a value for the setting CSID (cbetSourceId). When you choose NAES 2, NW, and CBET (NAES2_AND_NW_AND_CBET), you must provide values for both of these settings.
    If the service returns an enum value that is not available in the current SDK version, activeWatermarkProcess will return NielsenActiveWatermarkProcessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activeWatermarkProcessAsString().
    
    Returns:
    
    Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW (NAES2_AND_NW), you must provide a value for the setting SID (sourceId). When you choose CBET (CBET), you must provide a value for the setting CSID (cbetSourceId). When you choose NAES 2, NW, and CBET (NAES2_AND_NW_AND_CBET), you must provide values for both of these settings.
    
    See Also:
    
    NielsenActiveWatermarkProcessType
  - adiFilename
```
public final String adiFilename()
```
    Optional. Use this setting when you want the service to include an ADI file in the Nielsen metadata .zip file. To provide an ADI file, store it in Amazon S3 and provide a URL to it here. The URL should be in the following format: S3://bucket/path/ADI-file. For more information about the metadata .zip file, see the setting Metadata destination (metadataDestination).
    
    Returns:
    
    Optional. Use this setting when you want the service to include an ADI file in the Nielsen metadata .zip file. To provide an ADI file, store it in Amazon S3 and provide a URL to it here. The URL should be in the following format: S3://bucket/path/ADI-file. For more information about the metadata .zip file, see the setting Metadata destination (metadataDestination).
  - assetId
```
public final String assetId()
```
    Use the asset ID that you provide to Nielsen to uniquely identify this asset. Required for all Nielsen non-linear watermarking.
    
    Returns:
    
    Use the asset ID that you provide to Nielsen to uniquely identify this asset. Required for all Nielsen non-linear watermarking.
  - assetName
```
public final String assetName()
```
    Use the asset name that you provide to Nielsen for this asset. Required for all Nielsen non-linear watermarking.
    
    Returns:
    
    Use the asset name that you provide to Nielsen for this asset. Required for all Nielsen non-linear watermarking.
  - cbetSourceId
```
public final String cbetSourceId()
```
    Use the CSID that Nielsen provides to you. This CBET source ID should be unique to your Nielsen account but common to all of your output assets that have CBET watermarking. Required when you choose a value for the setting Watermark types (ActiveWatermarkProcess) that includes CBET.
    
    Returns:
    
    Use the CSID that Nielsen provides to you. This CBET source ID should be unique to your Nielsen account but common to all of your output assets that have CBET watermarking. Required when you choose a value for the setting Watermark types (ActiveWatermarkProcess) that includes CBET.
  - episodeId
```
public final String episodeId()
```
    Optional. If this asset uses an episode ID with Nielsen, provide it here.
    
    Returns:
    
    Optional. If this asset uses an episode ID with Nielsen, provide it here.
  - metadataDestination
```
public final String metadataDestination()
```
    Specify the Amazon S3 location where you want MediaConvert to save your Nielsen non-linear metadata .zip file. This Amazon S3 bucket must be in the same Region as the one where you do your MediaConvert transcoding. If you want to include an ADI file in this .zip file, use the setting ADI file (adiFilename) to specify it. MediaConvert delivers the Nielsen metadata .zip files only to your metadata destination Amazon S3 bucket. It doesn't deliver the .zip files to Nielsen. You are responsible for delivering the metadata .zip files to Nielsen.
    
    Returns:
    
    Specify the Amazon S3 location where you want MediaConvert to save your Nielsen non-linear metadata .zip file. This Amazon S3 bucket must be in the same Region as the one where you do your MediaConvert transcoding. If you want to include an ADI file in this .zip file, use the setting ADI file (adiFilename) to specify it. MediaConvert delivers the Nielsen metadata .zip files only to your metadata destination Amazon S3 bucket. It doesn't deliver the .zip files to Nielsen. You are responsible for delivering the metadata .zip files to Nielsen.
  - sourceId
```
public final Integer sourceId()
```
    Use the SID that Nielsen provides to you. This source ID should be unique to your Nielsen account but common to all of your output assets. Required for all Nielsen non-linear watermarking. This ID should be unique to your Nielsen account but common to all of your output assets. Required for all Nielsen non-linear watermarking.
    
    Returns:
    
    Use the SID that Nielsen provides to you. This source ID should be unique to your Nielsen account but common to all of your output assets. Required for all Nielsen non-linear watermarking. This ID should be unique to your Nielsen account but common to all of your output assets. Required for all Nielsen non-linear watermarking.
  - sourceWatermarkStatus
```
public final NielsenSourceWatermarkStatusType sourceWatermarkStatus()
```
    Required. Specify whether your source content already contains Nielsen non-linear watermarks. When you set this value to Watermarked (WATERMARKED), the service fails the job. Nielsen requires that you add non-linear watermarking to only clean content that doesn't already have non-linear Nielsen watermarks.
    If the service returns an enum value that is not available in the current SDK version, sourceWatermarkStatus will return NielsenSourceWatermarkStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceWatermarkStatusAsString().
    
    Returns:
    
    Required. Specify whether your source content already contains Nielsen non-linear watermarks. When you set this value to Watermarked (WATERMARKED), the service fails the job. Nielsen requires that you add non-linear watermarking to only clean content that doesn't already have non-linear Nielsen watermarks.
    
    See Also:
    
    NielsenSourceWatermarkStatusType
  - sourceWatermarkStatusAsString
```
public final String sourceWatermarkStatusAsString()
```
    Required. Specify whether your source content already contains Nielsen non-linear watermarks. When you set this value to Watermarked (WATERMARKED), the service fails the job. Nielsen requires that you add non-linear watermarking to only clean content that doesn't already have non-linear Nielsen watermarks.
    If the service returns an enum value that is not available in the current SDK version, sourceWatermarkStatus will return NielsenSourceWatermarkStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceWatermarkStatusAsString().
    
    Returns:
    
    Required. Specify whether your source content already contains Nielsen non-linear watermarks. When you set this value to Watermarked (WATERMARKED), the service fails the job. Nielsen requires that you add non-linear watermarking to only clean content that doesn't already have non-linear Nielsen watermarks.
    
    See Also:
    
    NielsenSourceWatermarkStatusType
  - ticServerUrl
```
public final String ticServerUrl()
```
    Specify the endpoint for the TIC server that you have deployed and configured in the AWS Cloud. Required for all Nielsen non-linear watermarking. MediaConvert can't connect directly to a TIC server. Instead, you must use API Gateway to provide a RESTful interface between MediaConvert and a TIC server that you deploy in your AWS account. For more information on deploying a TIC server in your AWS account and the required API Gateway, contact Nielsen support.
    
    Returns:
    
    Specify the endpoint for the TIC server that you have deployed and configured in the AWS Cloud. Required for all Nielsen non-linear watermarking. MediaConvert can't connect directly to a TIC server. Instead, you must use API Gateway to provide a RESTful interface between MediaConvert and a TIC server that you deploy in your AWS account. For more information on deploying a TIC server in your AWS account and the required API Gateway, contact Nielsen support.
  - uniqueTicPerAudioTrack
```
public final NielsenUniqueTicPerAudioTrackType uniqueTicPerAudioTrack()
```
    To create assets that have the same TIC values in each audio track, keep the default value Share TICs (SAME_TICS_PER_TRACK). To create assets that have unique TIC values for each audio track, choose Use unique TICs (RESERVE_UNIQUE_TICS_PER_TRACK).
    If the service returns an enum value that is not available in the current SDK version, uniqueTicPerAudioTrack will return NielsenUniqueTicPerAudioTrackType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from uniqueTicPerAudioTrackAsString().
    
    Returns:
    
    To create assets that have the same TIC values in each audio track, keep the default value Share TICs (SAME_TICS_PER_TRACK). To create assets that have unique TIC values for each audio track, choose Use unique TICs (RESERVE_UNIQUE_TICS_PER_TRACK).
    
    See Also:
    
    NielsenUniqueTicPerAudioTrackType
  - uniqueTicPerAudioTrackAsString
```
public final String uniqueTicPerAudioTrackAsString()
```
    To create assets that have the same TIC values in each audio track, keep the default value Share TICs (SAME_TICS_PER_TRACK). To create assets that have unique TIC values for each audio track, choose Use unique TICs (RESERVE_UNIQUE_TICS_PER_TRACK).
    If the service returns an enum value that is not available in the current SDK version, uniqueTicPerAudioTrack will return NielsenUniqueTicPerAudioTrackType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from uniqueTicPerAudioTrackAsString().
    
    Returns:
    
    To create assets that have the same TIC values in each audio track, keep the default value Share TICs (SAME_TICS_PER_TRACK). To create assets that have unique TIC values for each audio track, choose Use unique TICs (RESERVE_UNIQUE_TICS_PER_TRACK).
    
    See Also:
    
    NielsenUniqueTicPerAudioTrackType
  - toBuilder
```
public NielsenNonLinearWatermarkSettings.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<NielsenNonLinearWatermarkSettings.Builder,NielsenNonLinearWatermarkSettings>
  - builder
```
public static NielsenNonLinearWatermarkSettings.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends NielsenNonLinearWatermarkSettings.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 NielsenNonLinearWatermarkSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

activeWatermarkProcess

activeWatermarkProcessAsString

adiFilename

assetId

assetName

cbetSourceId

episodeId

metadataDestination

sourceId

sourceWatermarkStatus

sourceWatermarkStatusAsString

ticServerUrl

uniqueTicPerAudioTrack

uniqueTicPerAudioTrackAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields