Package software.amazon.awssdk.services.mediaconvert.model

Class NielsenNonLinearWatermarkSettings

    • 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, 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 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, 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:
        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, 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 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, 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:
        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.
        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

        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 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

        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 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

        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, 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, 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, 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, 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.

      • uniqueTicPerAudioTrackAsString

        public final String 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 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. To create assets that have unique TIC values for each audio track, choose Use unique TICs.
        See Also:
        NielsenUniqueTicPerAudioTrackType

      • hashCode

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

      • equals

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

      • 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)