You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticTranscoder::Types::JobWatermark

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

Overview

Note:

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

{
  preset_watermark_id: "PresetWatermarkId",
  input_key: "WatermarkKey",
  encryption: {
    mode: "EncryptionMode",
    key: "Base64EncodedString",
    key_md_5: "Base64EncodedString",
    initialization_vector: "ZeroTo255String",
  },
}

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

Instance Attribute Summary collapse

Instance Attribute Details

#encryptionTypes::Encryption

The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.

Returns:



2904
2905
2906
2907
2908
2909
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2904

class JobWatermark < Struct.new(
  :preset_watermark_id,
  :input_key,
  :encryption)
  include Aws::Structure
end

#input_keyString

The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

Returns:

  • (String)


2904
2905
2906
2907
2908
2909
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2904

class JobWatermark < Struct.new(
  :preset_watermark_id,
  :input_key,
  :encryption)
  include Aws::Structure
end

#preset_watermark_idString

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.

Returns:

  • (String)


2904
2905
2906
2907
2908
2909
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2904

class JobWatermark < Struct.new(
  :preset_watermark_id,
  :input_key,
  :encryption)
  include Aws::Structure
end