Class VideoParameters
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VideoParameters.Builder,
VideoParameters>
The VideoParameters
structure.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
final String
bitRate()
The bit rate of the video stream in the output file, in kilobits/second.static VideoParameters.Builder
builder()
final String
codec()
The video codec for the output file.Profile (H.264/VP8/VP9 Only)final String
The value that Elastic Transcoder adds to the metadata in the output file.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
fixedGOP()
Applicable only when the value of Video:Codec is one ofH.264
,MPEG2
, orVP8
.final String
The frames per second for the video stream in the output file.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CodecOptions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Watermarks property.final String
Applicable only when the value of Video:Codec is one ofH.264
,MPEG2
, orVP8
.final String
If you specifyauto
forFrameRate
, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video.final String
The maximum height of the output video in pixels.final String
maxWidth()
The maximum width of the output video in pixels.final String
When you setPaddingPolicy
toPad
, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified forMaxWidth
andMaxHeight
.final String
static Class
<? extends VideoParameters.Builder> final String
Specify one of the following values to control scaling of the output video:Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<PresetWatermark> Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
codec
The video codec for the output file. Valid values include
gif
,H.264
,mpeg2
,vp8
, andvp9
. You can only specifyvp8
andvp9
when the container type iswebm
,gif
when the container type isgif
, andmpeg2
when the container type ismpg
.- Returns:
- The video codec for the output file. Valid values include
gif
,H.264
,mpeg2
,vp8
, andvp9
. You can only specifyvp8
andvp9
when the container type iswebm
,gif
when the container type isgif
, andmpeg2
when the container type ismpg
.
-
hasCodecOptions
public final boolean hasCodecOptions()For responses, this returns true if the service returned a value for the CodecOptions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
codecOptions
Profile (H.264/VP8/VP9 Only)
The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:
-
baseline
: The profile most commonly used for videoconferencing and for mobile applications. -
main
: The profile used for standard-definition digital TV broadcasts. -
high
: The profile used for high-definition digital TV broadcasts and for Blu-ray discs.
Level (H.264 Only)
The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:
1
,1b
,1.1
,1.2
,1.3
,2
,2.1
,2.2
,3
,3.1
,3.2
,4
,4.1
MaxReferenceFrames (H.264 Only)
Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:
Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16)
where Width in pixels and Height in pixels represent either MaxWidth and MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends on the value of the
Level
object. See the list below. (A macroblock is a block of pixels measuring 16x16.)-
1 - 396
-
1b - 396
-
1.1 - 900
-
1.2 - 2376
-
1.3 - 2376
-
2 - 2376
-
2.1 - 4752
-
2.2 - 8100
-
3 - 8100
-
3.1 - 18000
-
3.2 - 20480
-
4 - 32768
-
4.1 - 32768
MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 only)
The maximum number of bits per second in a video buffer; the size of the buffer is specified by
BufferSize
. Specify a value between 16 and 62,500. You can reduce the bandwidth required to stream a video by reducing the maximum bit rate, but this also reduces the quality of the video.BufferSize (Optional, H.264/MPEG2/VP8/VP9 only)
The maximum number of bits in any x seconds of the output video. This window is commonly 10 seconds, the standard segment duration when you're using FMP4 or MPEG-TS for the container type of the output video. Specify an integer greater than 0. If you specify
MaxBitRate
and omitBufferSize
, Elastic Transcoder setsBufferSize
to 10 times the value ofMaxBitRate
.InterlacedMode (Optional, H.264/MPEG2 Only)
The interlace mode for the output video.
Interlaced video is used to double the perceived frame rate for a video by interlacing two fields (one field on every other line, the other field on the other lines) so that the human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required for transmitting a video, but can result in blurred images and flickering.
Valid values include
Progressive
(no interlacing, top to bottom),TopFirst
(top field first),BottomFirst
(bottom field first), andAuto
.If
InterlaceMode
is not specified, Elastic Transcoder usesProgressive
for the output. IfAuto
is specified, Elastic Transcoder interlaces the output.ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)
The color space conversion Elastic Transcoder applies to the output video. Color spaces are the algorithms used by the computer to store information about how to render color.
Bt.601
is the standard for standard definition video, whileBt.709
is the standard for high definition video.Valid values include
None
,Bt709toBt601
,Bt601toBt709
, andAuto
.If you chose
Auto
forColorSpaceConversionMode
and your output is interlaced, your frame rate is one of23.97
,24
,25
,29.97
,50
, or60
, yourSegmentDuration
is null, and you are using one of the resolution changes from the list below, Elastic Transcoder applies the following color space conversions:-
Standard to HD, 720x480 to 1920x1080 - Elastic Transcoder applies
Bt601ToBt709
-
Standard to HD, 720x576 to 1920x1080 - Elastic Transcoder applies
Bt601ToBt709
-
HD to Standard, 1920x1080 to 720x480 - Elastic Transcoder applies
Bt709ToBt601
-
HD to Standard, 1920x1080 to 720x576 - Elastic Transcoder applies
Bt709ToBt601
Elastic Transcoder may change the behavior of the
ColorspaceConversionMode
Auto
mode in the future. All outputs in a playlist must use the sameColorSpaceConversionMode
.If you do not specify a
ColorSpaceConversionMode
, Elastic Transcoder does not change the color space of a file. If you are unsure whatColorSpaceConversionMode
was applied to your output file, you can check theAppliedColorSpaceConversion
parameter included in your job response. If your job does not have anAppliedColorSpaceConversion
in its response, noColorSpaceConversionMode
was applied.ChromaSubsampling
The sampling pattern for the chroma (color) channels of the output video. Valid values include
yuv420p
andyuv422p
.yuv420p
samples the chroma information of every other horizontal and every other vertical line,yuv422p
samples the color information of every horizontal line and every other vertical line.LoopCount (Gif Only)
The number of times you want the output gif to loop. Valid values include
Infinite
and integers between0
and100
, inclusive.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCodecOptions()
method.- Returns:
- Profile (H.264/VP8/VP9 Only)
The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:
-
baseline
: The profile most commonly used for videoconferencing and for mobile applications. -
main
: The profile used for standard-definition digital TV broadcasts. -
high
: The profile used for high-definition digital TV broadcasts and for Blu-ray discs.
Level (H.264 Only)
The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:
1
,1b
,1.1
,1.2
,1.3
,2
,2.1
,2.2
,3
,3.1
,3.2
,4
,4.1
MaxReferenceFrames (H.264 Only)
Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:
Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16)
where Width in pixels and Height in pixels represent either MaxWidth and MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends on the value of the
Level
object. See the list below. (A macroblock is a block of pixels measuring 16x16.)-
1 - 396
-
1b - 396
-
1.1 - 900
-
1.2 - 2376
-
1.3 - 2376
-
2 - 2376
-
2.1 - 4752
-
2.2 - 8100
-
3 - 8100
-
3.1 - 18000
-
3.2 - 20480
-
4 - 32768
-
4.1 - 32768
MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 only)
The maximum number of bits per second in a video buffer; the size of the buffer is specified by
BufferSize
. Specify a value between 16 and 62,500. You can reduce the bandwidth required to stream a video by reducing the maximum bit rate, but this also reduces the quality of the video.BufferSize (Optional, H.264/MPEG2/VP8/VP9 only)
The maximum number of bits in any x seconds of the output video. This window is commonly 10 seconds, the standard segment duration when you're using FMP4 or MPEG-TS for the container type of the output video. Specify an integer greater than 0. If you specify
MaxBitRate
and omitBufferSize
, Elastic Transcoder setsBufferSize
to 10 times the value ofMaxBitRate
.InterlacedMode (Optional, H.264/MPEG2 Only)
The interlace mode for the output video.
Interlaced video is used to double the perceived frame rate for a video by interlacing two fields (one field on every other line, the other field on the other lines) so that the human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required for transmitting a video, but can result in blurred images and flickering.
Valid values include
Progressive
(no interlacing, top to bottom),TopFirst
(top field first),BottomFirst
(bottom field first), andAuto
.If
InterlaceMode
is not specified, Elastic Transcoder usesProgressive
for the output. IfAuto
is specified, Elastic Transcoder interlaces the output.ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)
The color space conversion Elastic Transcoder applies to the output video. Color spaces are the algorithms used by the computer to store information about how to render color.
Bt.601
is the standard for standard definition video, whileBt.709
is the standard for high definition video.Valid values include
None
,Bt709toBt601
,Bt601toBt709
, andAuto
.If you chose
Auto
forColorSpaceConversionMode
and your output is interlaced, your frame rate is one of23.97
,24
,25
,29.97
,50
, or60
, yourSegmentDuration
is null, and you are using one of the resolution changes from the list below, Elastic Transcoder applies the following color space conversions:-
Standard to HD, 720x480 to 1920x1080 - Elastic Transcoder applies
Bt601ToBt709
-
Standard to HD, 720x576 to 1920x1080 - Elastic Transcoder applies
Bt601ToBt709
-
HD to Standard, 1920x1080 to 720x480 - Elastic Transcoder applies
Bt709ToBt601
-
HD to Standard, 1920x1080 to 720x576 - Elastic Transcoder applies
Bt709ToBt601
Elastic Transcoder may change the behavior of the
ColorspaceConversionMode
Auto
mode in the future. All outputs in a playlist must use the sameColorSpaceConversionMode
.If you do not specify a
ColorSpaceConversionMode
, Elastic Transcoder does not change the color space of a file. If you are unsure whatColorSpaceConversionMode
was applied to your output file, you can check theAppliedColorSpaceConversion
parameter included in your job response. If your job does not have anAppliedColorSpaceConversion
in its response, noColorSpaceConversionMode
was applied.ChromaSubsampling
The sampling pattern for the chroma (color) channels of the output video. Valid values include
yuv420p
andyuv422p
.yuv420p
samples the chroma information of every other horizontal and every other vertical line,yuv422p
samples the color information of every horizontal line and every other vertical line.LoopCount (Gif Only)
The number of times you want the output gif to loop. Valid values include
Infinite
and integers between0
and100
, inclusive. -
-
-
keyframesMaxDist
Applicable only when the value of Video:Codec is one of
H.264
,MPEG2
, orVP8
.The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.
For
Smooth
outputs, theFrameRate
must have a constant ratio to theKeyframesMaxDist
. This allowsSmooth
playlists to switch between different quality levels while the file is being played.For example, an input file can have a
FrameRate
of 30 with aKeyframesMaxDist
of 90. The output file then needs to have a ratio of 1:3. Valid outputs would haveFrameRate
of 30, 25, and 10, andKeyframesMaxDist
of 90, 75, and 30, respectively.Alternately, this can be achieved by setting
FrameRate
to auto and having the same values forMaxFrameRate
andKeyframesMaxDist
.- Returns:
- Applicable only when the value of Video:Codec is one of
H.264
,MPEG2
, orVP8
.The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.
For
Smooth
outputs, theFrameRate
must have a constant ratio to theKeyframesMaxDist
. This allowsSmooth
playlists to switch between different quality levels while the file is being played.For example, an input file can have a
FrameRate
of 30 with aKeyframesMaxDist
of 90. The output file then needs to have a ratio of 1:3. Valid outputs would haveFrameRate
of 30, 25, and 10, andKeyframesMaxDist
of 90, 75, and 30, respectively.Alternately, this can be achieved by setting
FrameRate
to auto and having the same values forMaxFrameRate
andKeyframesMaxDist
.
-
fixedGOP
Applicable only when the value of Video:Codec is one of
H.264
,MPEG2
, orVP8
.Whether to use a fixed value for
FixedGOP
. Valid values aretrue
andfalse
:-
true
: Elastic Transcoder uses the value ofKeyframesMaxDist
for the distance between key frames (the number of frames in a group of pictures, or GOP). -
false
: The distance between key frames can vary.
FixedGOP
must be set totrue
forfmp4
containers.- Returns:
- Applicable only when the value of Video:Codec is one of
H.264
,MPEG2
, orVP8
.Whether to use a fixed value for
FixedGOP
. Valid values aretrue
andfalse
:-
true
: Elastic Transcoder uses the value ofKeyframesMaxDist
for the distance between key frames (the number of frames in a group of pictures, or GOP). -
false
: The distance between key frames can vary.
FixedGOP
must be set totrue
forfmp4
containers. -
-
-
bitRate
The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of
Level
andProfile
. If you specifyauto
, Elastic Transcoder uses the detected bit rate of the input source. If you specify a value other thanauto
, we recommend that you specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile:Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)
-
1 - 64 : 80
-
1b - 128 : 160
-
1.1 - 192 : 240
-
1.2 - 384 : 480
-
1.3 - 768 : 960
-
2 - 2000 : 2500
-
3 - 10000 : 12500
-
3.1 - 14000 : 17500
-
3.2 - 20000 : 25000
-
4 - 20000 : 25000
-
4.1 - 50000 : 62500
- Returns:
- The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the
values of
Level
andProfile
. If you specifyauto
, Elastic Transcoder uses the detected bit rate of the input source. If you specify a value other thanauto
, we recommend that you specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile:Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)
-
1 - 64 : 80
-
1b - 128 : 160
-
1.1 - 192 : 240
-
1.2 - 384 : 480
-
1.3 - 768 : 960
-
2 - 2000 : 2500
-
3 - 10000 : 12500
-
3.1 - 14000 : 17500
-
3.2 - 20000 : 25000
-
4 - 20000 : 25000
-
4.1 - 50000 : 62500
-
-
-
frameRate
The frames per second for the video stream in the output file. Valid values include:
auto
,10
,15
,23.97
,24
,25
,29.97
,30
,60
If you specify
auto
, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation:Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)
where:
-
width in pixels and height in pixels represent the Resolution of the output video.
-
maximum recommended decoding speed in Luma samples/second is less than or equal to the maximum value listed in the following table, based on the value that you specified for Level.
The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):
-
1 - 380160
-
1b - 380160
-
1.1 - 76800
-
1.2 - 1536000
-
1.3 - 3041280
-
2 - 3041280
-
2.1 - 5068800
-
2.2 - 5184000
-
3 - 10368000
-
3.1 - 27648000
-
3.2 - 55296000
-
4 - 62914560
-
4.1 - 62914560
- Returns:
- The frames per second for the video stream in the output file. Valid values include:
auto
,10
,15
,23.97
,24
,25
,29.97
,30
,60
If you specify
auto
, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation:Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)
where:
-
width in pixels and height in pixels represent the Resolution of the output video.
-
maximum recommended decoding speed in Luma samples/second is less than or equal to the maximum value listed in the following table, based on the value that you specified for Level.
The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):
-
1 - 380160
-
1b - 380160
-
1.1 - 76800
-
1.2 - 1536000
-
1.3 - 3041280
-
2 - 3041280
-
2.1 - 5068800
-
2.2 - 5184000
-
3 - 10368000
-
3.1 - 27648000
-
3.2 - 55296000
-
4 - 62914560
-
4.1 - 62914560
-
-
-
maxFrameRate
If you specify
auto
forFrameRate
, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video. Specify the maximum frame rate that you want Elastic Transcoder to use when the frame rate of the input video is greater than the desired maximum frame rate of the output video. Valid values include:10
,15
,23.97
,24
,25
,29.97
,30
,60
.- Returns:
- If you specify
auto
forFrameRate
, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video. Specify the maximum frame rate that you want Elastic Transcoder to use when the frame rate of the input video is greater than the desired maximum frame rate of the output video. Valid values include:10
,15
,23.97
,24
,25
,29.97
,30
,60
.
-
resolution
To better control resolution and aspect ratio of output videos, we recommend that you use the values
MaxWidth
,MaxHeight
,SizingPolicy
,PaddingPolicy
, andDisplayAspectRatio
instead ofResolution
andAspectRatio
. The two groups of settings are mutually exclusive. Do not use them together.The width and height of the video in the output file, in pixels. Valid values are
auto
and width x height:-
auto
: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules. -
width x height
: The width and height of the output video in pixels.
Note the following about specifying the width and height:
-
The width must be an even integer between 128 and 4096, inclusive.
-
The height must be an even integer between 96 and 3072, inclusive.
-
If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the output file to the lower resolution.
-
If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales the output to the higher resolution.
-
We recommend that you specify a resolution for which the product of width and height is less than or equal to the applicable value in the following list (List - Max width x height value):
-
1 - 25344
-
1b - 25344
-
1.1 - 101376
-
1.2 - 101376
-
1.3 - 101376
-
2 - 101376
-
2.1 - 202752
-
2.2 - 404720
-
3 - 404720
-
3.1 - 921600
-
3.2 - 1310720
-
4 - 2097152
-
4.1 - 2097152
-
- Returns:
To better control resolution and aspect ratio of output videos, we recommend that you use the values
MaxWidth
,MaxHeight
,SizingPolicy
,PaddingPolicy
, andDisplayAspectRatio
instead ofResolution
andAspectRatio
. The two groups of settings are mutually exclusive. Do not use them together.The width and height of the video in the output file, in pixels. Valid values are
auto
and width x height:-
auto
: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules. -
width x height
: The width and height of the output video in pixels.
Note the following about specifying the width and height:
-
The width must be an even integer between 128 and 4096, inclusive.
-
The height must be an even integer between 96 and 3072, inclusive.
-
If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the output file to the lower resolution.
-
If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales the output to the higher resolution.
-
We recommend that you specify a resolution for which the product of width and height is less than or equal to the applicable value in the following list (List - Max width x height value):
-
1 - 25344
-
1b - 25344
-
1.1 - 101376
-
1.2 - 101376
-
1.3 - 101376
-
2 - 101376
-
2.1 - 202752
-
2.2 - 404720
-
3 - 404720
-
3.1 - 921600
-
3.2 - 1310720
-
4 - 2097152
-
4.1 - 2097152
-
-
-
-
aspectRatio
To better control resolution and aspect ratio of output videos, we recommend that you use the values
MaxWidth
,MaxHeight
,SizingPolicy
,PaddingPolicy
, andDisplayAspectRatio
instead ofResolution
andAspectRatio
. The two groups of settings are mutually exclusive. Do not use them together.The display aspect ratio of the video in the output file. Valid values include:
auto
,1:1
,4:3
,3:2
,16:9
If you specify
auto
, Elastic Transcoder tries to preserve the aspect ratio of the input file.If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.
- Returns:
To better control resolution and aspect ratio of output videos, we recommend that you use the values
MaxWidth
,MaxHeight
,SizingPolicy
,PaddingPolicy
, andDisplayAspectRatio
instead ofResolution
andAspectRatio
. The two groups of settings are mutually exclusive. Do not use them together.The display aspect ratio of the video in the output file. Valid values include:
auto
,1:1
,4:3
,3:2
,16:9
If you specify
auto
, Elastic Transcoder tries to preserve the aspect ratio of the input file.If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.
-
maxWidth
The maximum width of the output video in pixels. If you specify
auto
, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096.- Returns:
- The maximum width of the output video in pixels. If you specify
auto
, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096.
-
maxHeight
The maximum height of the output video in pixels. If you specify
auto
, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072.- Returns:
- The maximum height of the output video in pixels. If you specify
auto
, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072.
-
displayAspectRatio
The value that Elastic Transcoder adds to the metadata in the output file.
- Returns:
- The value that Elastic Transcoder adds to the metadata in the output file.
-
sizingPolicy
Specify one of the following values to control scaling of the output video:
-
Fit
: Elastic Transcoder scales the output video so it matches the value that you specified in eitherMaxWidth
orMaxHeight
without exceeding the other value. -
Fill
: Elastic Transcoder scales the output video so it matches the value that you specified in eitherMaxWidth
orMaxHeight
and matches or exceeds the other value. Elastic Transcoder centers the output video and then crops it in the dimension (if any) that exceeds the maximum value. -
Stretch
: Elastic Transcoder stretches the output video to match the values that you specified forMaxWidth
andMaxHeight
. If the relative proportions of the input video and the output video are different, the output video will be distorted. -
Keep
: Elastic Transcoder does not scale the output video. If either dimension of the input video exceeds the values that you specified forMaxWidth
andMaxHeight
, Elastic Transcoder crops the output video. -
ShrinkToFit
: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without exceeding either value. If you specify this option, Elastic Transcoder does not scale the video up. -
ShrinkToFill
: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without dropping below either value. If you specify this option, Elastic Transcoder does not scale the video up.
- Returns:
- Specify one of the following values to control scaling of the output video:
-
Fit
: Elastic Transcoder scales the output video so it matches the value that you specified in eitherMaxWidth
orMaxHeight
without exceeding the other value. -
Fill
: Elastic Transcoder scales the output video so it matches the value that you specified in eitherMaxWidth
orMaxHeight
and matches or exceeds the other value. Elastic Transcoder centers the output video and then crops it in the dimension (if any) that exceeds the maximum value. -
Stretch
: Elastic Transcoder stretches the output video to match the values that you specified forMaxWidth
andMaxHeight
. If the relative proportions of the input video and the output video are different, the output video will be distorted. -
Keep
: Elastic Transcoder does not scale the output video. If either dimension of the input video exceeds the values that you specified forMaxWidth
andMaxHeight
, Elastic Transcoder crops the output video. -
ShrinkToFit
: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without exceeding either value. If you specify this option, Elastic Transcoder does not scale the video up. -
ShrinkToFill
: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without dropping below either value. If you specify this option, Elastic Transcoder does not scale the video up.
-
-
-
paddingPolicy
When you set
PaddingPolicy
toPad
, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified forMaxWidth
andMaxHeight
.- Returns:
- When you set
PaddingPolicy
toPad
, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified forMaxWidth
andMaxHeight
.
-
hasWatermarks
public final boolean hasWatermarks()For responses, this returns true if the service returned a value for the Watermarks property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
watermarks
Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.
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.
When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasWatermarks()
method.- Returns:
- Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over
videos that are transcoded using this preset. You can specify settings for up to four watermarks.
Watermarks appear in the specified size and location, and with the specified opacity for the duration of
the transcoded video.
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.
When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<VideoParameters.Builder,
VideoParameters> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-