Package software.amazon.awssdk.services.elastictranscoder.model

Interface Artwork.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Artwork.Builder,Artwork>, SdkBuilder<Artwork.Builder,Artwork>, SdkPojo

Enclosing class:

Artwork

public static interface Artwork.Builder
extends SdkPojo, CopyableBuilder<Artwork.Builder,Artwork>

Method Summary

Modifier and Type	Method	Description
Artwork.Builder	albumArtFormat(String albumArtFormat)	The format of album art, if any.
default Artwork.Builder	encryption(Consumer<Encryption.Builder> encryption)	The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
Artwork.Builder	encryption(Encryption encryption)	The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
Artwork.Builder	inputKey(String inputKey)	The name of the file to be used as album art.
Artwork.Builder	maxHeight(String maxHeight)	The maximum height of the output album art in pixels.
Artwork.Builder	maxWidth(String maxWidth)	The maximum width of the output album art in pixels.
Artwork.Builder	paddingPolicy(String paddingPolicy)	When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified for MaxWidth and MaxHeight.
Artwork.Builder	sizingPolicy(String sizingPolicy)	Specify one of the following values to control scaling of the output album art:

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

inputKey

Artwork.Builder inputKey(String inputKey)

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the InputBucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, cooking/pie.jpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

Parameters:

inputKey - The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the InputBucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, cooking/pie.jpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxWidth

Artwork.Builder maxWidth(String maxWidth)

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.

Parameters:

maxWidth - The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxHeight

Artwork.Builder maxHeight(String maxHeight)

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.

Parameters:

maxHeight - The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.

Returns:

Returns a reference to this object so that method calls can be chained together.

sizingPolicy

Artwork.Builder sizingPolicy(String sizingPolicy)

Specify one of the following values to control scaling of the output album art:

• Fit: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.

• Fill: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value.

• Stretch: Elastic Transcoder stretches the output art to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input art and the output art are different, the output art will be distorted.

• Keep: Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output art.

• ShrinkToFit: Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up.

• ShrinkToFill Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.

Parameters:

sizingPolicy - Specify one of the following values to control scaling of the output album art:

• Fit: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.

• Fill: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value.

• Stretch: Elastic Transcoder stretches the output art to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input art and the output art are different, the output art will be distorted.

• Keep: Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output art.

• ShrinkToFit: Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up.

• ShrinkToFill Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.

Returns:

Returns a reference to this object so that method calls can be chained together.

paddingPolicy

Artwork.Builder paddingPolicy(String paddingPolicy)

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified for MaxWidth and MaxHeight.

Parameters:

paddingPolicy - When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified for MaxWidth and MaxHeight.

Returns:

Returns a reference to this object so that method calls can be chained together.

albumArtFormat

Artwork.Builder albumArtFormat(String albumArtFormat)

The format of album art, if any. Valid formats are .jpg and .png.

Parameters:

albumArtFormat - The format of album art, if any. Valid formats are .jpg and .png.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryption

Artwork.Builder encryption(Encryption encryption)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

encryption

default Artwork.Builder encryption(Consumer<Encryption.Builder> encryption)

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

This is a convenience method that creates an instance of the Encryption.Builder avoiding the need to create one manually via Encryption.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryption(Encryption).

Parameters:

encryption - a consumer that will call methods on Encryption.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

encryption(Encryption)