class Aws::MediaConvert::Types::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]

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

data as a hash:

    {
      active_watermark_process: "NAES2_AND_NW", # accepts NAES2_AND_NW, CBET, NAES2_AND_NW_AND_CBET
      adi_filename: "__stringPatternS3",
      asset_id: "__stringMin1Max20",
      asset_name: "__stringMin1Max50",
      cbet_source_id: "__stringPattern0xAFaF0908190908",
      episode_id: "__stringMin1Max20",
      metadata_destination: "__stringPatternS3",
      source_id: 1,
      source_watermark_status: "CLEAN", # accepts CLEAN, WATERMARKED
      tic_server_url: "__stringPatternHttps",
      unique_tic_per_audio_track: "RESERVE_UNIQUE_TICS_PER_TRACK", # accepts RESERVE_UNIQUE_TICS_PER_TRACK, SAME_TICS_PER_TRACK
    }

@!attribute [rw] active_watermark_process

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

@!attribute [rw] adi_filename

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

@!attribute [rw] asset_id

Use the asset ID that you provide to Nielsen to uniquely identify
this asset. Required for all Nielsen non-linear watermarking.
@return [String]

@!attribute [rw] asset_name

Use the asset name that you provide to Nielsen for this asset.
Required for all Nielsen non-linear watermarking.
@return [String]

@!attribute [rw] cbet_source_id

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

@!attribute [rw] episode_id

Optional. If this asset uses an episode ID with Nielsen, provide it
here.
@return [String]

@!attribute [rw] metadata_destination

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

@!attribute [rw] source_id

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

@!attribute [rw] source_watermark_status

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

@!attribute [rw] tic_server_url

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

@!attribute [rw] unique_tic_per_audio_track

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

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

Constants

SENSITIVE