Class NielsenNonLinearWatermarkSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<NielsenNonLinearWatermarkSettings.Builder,
NielsenNonLinearWatermarkSettings>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionChoose the type of Nielsen watermarks that you want in your outputs.final String
Choose the type of Nielsen watermarks that you want in your outputs.final String
Optional.final String
assetId()
Use the asset ID that you provide to Nielsen to uniquely identify this asset.final String
Use the asset name that you provide to Nielsen for this asset.builder()
final String
Use the CSID that Nielsen provides to you.final String
Optional.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
Specify the Amazon S3 location where you want MediaConvert to save your Nielsen non-linear metadata .zip file.static Class
<? extends NielsenNonLinearWatermarkSettings.Builder> final Integer
sourceId()
Use the SID that Nielsen provides to you.Required.final String
Required.final String
Specify the endpoint for the TIC server that you have deployed and configured in the AWS Cloud.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.To create assets that have the same TIC values in each audio track, keep the default value Share TICs.final String
To create assets that have the same TIC values in each audio track, keep the default value Share TICs.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
activeWatermarkProcess
Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW, you must provide a value for the setting SID. When you choose CBET, you must provide a value for the setting CSID. When you choose NAES 2, 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 returnNielsenActiveWatermarkProcessType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactiveWatermarkProcessAsString()
.- Returns:
- Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW, you must provide a value for the setting SID. When you choose CBET, you must provide a value for the setting CSID. When you choose NAES 2, NW, and CBET, you must provide values for both of these settings.
- See Also:
-
activeWatermarkProcessAsString
Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW, you must provide a value for the setting SID. When you choose CBET, you must provide a value for the setting CSID. When you choose NAES 2, 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 returnNielsenActiveWatermarkProcessType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactiveWatermarkProcessAsString()
.- Returns:
- Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW, you must provide a value for the setting SID. When you choose CBET, you must provide a value for the setting CSID. When you choose NAES 2, NW, and CBET, you must provide values for both of these settings.
- See Also:
-
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.- 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.
-
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
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
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 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 that includes CBET.
-
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
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 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 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
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
Required. Specify whether your source content already contains Nielsen non-linear watermarks. When you set this value to 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 returnNielsenSourceWatermarkStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceWatermarkStatusAsString()
.- Returns:
- Required. Specify whether your source content already contains Nielsen non-linear watermarks. When you set this value to 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:
-
sourceWatermarkStatusAsString
Required. Specify whether your source content already contains Nielsen non-linear watermarks. When you set this value to 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 returnNielsenSourceWatermarkStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceWatermarkStatusAsString()
.- Returns:
- Required. Specify whether your source content already contains Nielsen non-linear watermarks. When you set this value to 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:
-
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
To create assets that have the same TIC values in each audio track, keep the default value Share TICs. To create assets that have unique TIC values for each audio track, choose Use unique TICs.If the service returns an enum value that is not available in the current SDK version,
uniqueTicPerAudioTrack
will returnNielsenUniqueTicPerAudioTrackType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuniqueTicPerAudioTrackAsString()
.- Returns:
- To create assets that have the same TIC values in each audio track, keep the default value Share TICs. To create assets that have unique TIC values for each audio track, choose Use unique TICs.
- See Also:
-
uniqueTicPerAudioTrackAsString
To create assets that have the same TIC values in each audio track, keep the default value Share TICs. To create assets that have unique TIC values for each audio track, choose Use unique TICs.If the service returns an enum value that is not available in the current SDK version,
uniqueTicPerAudioTrack
will returnNielsenUniqueTicPerAudioTrackType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuniqueTicPerAudioTrackAsString()
.- Returns:
- To create assets that have the same TIC values in each audio track, keep the default value Share TICs. To create assets that have unique TIC values for each audio track, choose Use unique TICs.
- See Also:
-
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 interfaceToCopyableBuilder<NielsenNonLinearWatermarkSettings.Builder,
NielsenNonLinearWatermarkSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-