Class: Aws::MediaConvert::Types::KantarWatermarkSettings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

Note:

When making an API call, you may pass KantarWatermarkSettings data as a hash:

{
  channel_name: "__stringMin1Max20",
  content_reference: "__stringMin1Max50PatternAZAZ09",
  credentials_secret_name: "__stringMin1Max512PatternAZAZ09",
  file_offset: 1.0,
  kantar_license_id: 1,
  kantar_server_url: "__stringPatternHttpsKantarmediaCom",
  log_destination: "__stringPatternS3",
  metadata_3: "__stringMin1Max50",
  metadata_4: "__stringMin1Max50",
  metadata_5: "__stringMin1Max50",
  metadata_6: "__stringMin1Max50",
  metadata_7: "__stringMin1Max50",
  metadata_8: "__stringMin1Max50",
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_nameString

Provide an audio channel name from your Kantar audio license.

Returns:

  • (String)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end

#content_referenceString

Specify a unique identifier for Kantar to use for this piece of content.

Returns:

  • (String)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end

#credentials_secret_nameString

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:

  • (String)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end

#file_offsetFloat

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:

  • (Float)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end

#kantar_license_idInteger

Provide your Kantar license ID number. You should get this number from Kantar.

Returns:

  • (Integer)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end

#kantar_server_urlString

Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.

Returns:

  • (String)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end

#log_destinationString

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:

  • (String)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_3String

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:

  • (String)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_4String

Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

Returns:

  • (String)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_5String

Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

Returns:

  • (String)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_6String

Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

Returns:

  • (String)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_7String

Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

Returns:

  • (String)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_8String

Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.

Returns:

  • (String)


16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 16352

class KantarWatermarkSettings < Struct.new(
  :channel_name,
  :content_reference,
  :credentials_secret_name,
  :file_offset,
  :kantar_license_id,
  :kantar_server_url,
  :log_destination,
  :metadata_3,
  :metadata_4,
  :metadata_5,
  :metadata_6,
  :metadata_7,
  :metadata_8)
  SENSITIVE = []
  include Aws::Structure
end