amazonka-elastictranscoder-2.0: Amazon Elastic Transcoder SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ElasticTranscoder.Types.JobWatermark

Description

 
Synopsis

Documentation

data JobWatermark Source #

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.

See: newJobWatermark smart constructor.

Constructors

JobWatermark' 

Fields

  • encryption :: Maybe Encryption

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

  • inputKey :: Maybe Text

    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.

  • presetWatermarkId :: Maybe Text

    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.

Instances

Instances details
FromJSON JobWatermark Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.JobWatermark

ToJSON JobWatermark Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.JobWatermark

Generic JobWatermark Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.JobWatermark

Associated Types

type Rep JobWatermark :: Type -> Type #

Read JobWatermark Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.JobWatermark

Show JobWatermark Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.JobWatermark

NFData JobWatermark Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.JobWatermark

Methods

rnf :: JobWatermark -> () #

Eq JobWatermark Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.JobWatermark

Hashable JobWatermark Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.JobWatermark

type Rep JobWatermark Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.JobWatermark

type Rep JobWatermark = D1 ('MetaData "JobWatermark" "Amazonka.ElasticTranscoder.Types.JobWatermark" "amazonka-elastictranscoder-2.0-CmXzguD33FBGrVHrZxYHry" 'False) (C1 ('MetaCons "JobWatermark'" 'PrefixI 'True) (S1 ('MetaSel ('Just "encryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Encryption)) :*: (S1 ('MetaSel ('Just "inputKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "presetWatermarkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newJobWatermark :: JobWatermark Source #

Create a value of JobWatermark with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encryption:JobWatermark', jobWatermark_encryption - The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.

$sel:inputKey:JobWatermark', jobWatermark_inputKey - 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.

$sel:presetWatermarkId:JobWatermark', jobWatermark_presetWatermarkId - 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.

jobWatermark_encryption :: Lens' JobWatermark (Maybe Encryption) Source #

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

jobWatermark_inputKey :: Lens' JobWatermark (Maybe Text) Source #

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.

jobWatermark_presetWatermarkId :: Lens' JobWatermark (Maybe Text) Source #

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.