java.lang.Object
- software.amazon.awssdk.services.mediaconvert.model.VideoDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VideoDescription.Builder,VideoDescription>
```
@Generated("software.amazon.awssdk:codegen")
public final class VideoDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VideoDescription.Builder,VideoDescription>
```
Settings related to video encoding of your output. The specific video settings depend on the video codec that you choose.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface VideoDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AfdSignaling`	`afdSignaling()`	This setting only applies to H.264, H.265, and MPEG2 outputs.
`String`	`afdSignalingAsString()`	This setting only applies to H.264, H.265, and MPEG2 outputs.
`AntiAlias`	`antiAlias()`	The anti-alias filter is automatically applied to all outputs.
`String`	`antiAliasAsString()`	The anti-alias filter is automatically applied to all outputs.
`static VideoDescription.Builder`	`builder()`
`VideoCodecSettings`	`codecSettings()`	Video codec settings contains the group of settings related to video encoding.
`ColorMetadata`	`colorMetadata()`	Choose Insert for this setting to include color metadata in this output.
`String`	`colorMetadataAsString()`	Choose Insert for this setting to include color metadata in this output.
`Rectangle`	`crop()`	Use Cropping selection to specify the video area that the service will include in the output video frame.
`DropFrameTimecode`	`dropFrameTimecode()`	Applies only to 29.97 fps outputs.
`String`	`dropFrameTimecodeAsString()`	Applies only to 29.97 fps outputs.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Integer`	`fixedAfd()`	Applies only if you set AFD Signaling to Fixed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`height()`	Use Height to define the video resolution height, in pixels, for this output.
`Rectangle`	`position()`	Use Selection placement to define the video area in your output frame.
`RespondToAfd`	`respondToAfd()`	Use Respond to AFD to specify how the service changes the video itself in response to AFD values in the input.
`String`	`respondToAfdAsString()`	Use Respond to AFD to specify how the service changes the video itself in response to AFD values in the input.
`ScalingBehavior`	`scalingBehavior()`	Specify the video Scaling behavior when your output has a different resolution than your input.
`String`	`scalingBehaviorAsString()`	Specify the video Scaling behavior when your output has a different resolution than your input.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends VideoDescription.Builder>`	`serializableBuilderClass()`
`Integer`	`sharpness()`	Use Sharpness setting to specify the strength of anti-aliasing.
`VideoTimecodeInsertion`	`timecodeInsertion()`	Applies only to H.264, H.265, MPEG2, and ProRes outputs.
`String`	`timecodeInsertionAsString()`	Applies only to H.264, H.265, MPEG2, and ProRes outputs.
`VideoDescription.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`VideoPreprocessor`	`videoPreprocessors()`	Find additional transcoding features under Preprocessors.
`Integer`	`width()`	Use Width to define the video resolution width, in pixels, for this output.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - afdSignaling
```
public final AfdSignaling afdSignaling()
```
    This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.
    If the service returns an enum value that is not available in the current SDK version, afdSignaling will return AfdSignaling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from afdSignalingAsString().
    
    Returns:
    
    This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.
    
    See Also:
    
    AfdSignaling
  - afdSignalingAsString
```
public final String afdSignalingAsString()
```
    This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.
    If the service returns an enum value that is not available in the current SDK version, afdSignaling will return AfdSignaling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from afdSignalingAsString().
    
    Returns:
    
    This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.
    
    See Also:
    
    AfdSignaling
  - antiAlias
```
public final AntiAlias antiAlias()
```
    The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.
    If the service returns an enum value that is not available in the current SDK version, antiAlias will return AntiAlias.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from antiAliasAsString().
    
    Returns:
    
    The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.
    
    See Also:
    
    AntiAlias
  - antiAliasAsString
```
public final String antiAliasAsString()
```
    The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.
    If the service returns an enum value that is not available in the current SDK version, antiAlias will return AntiAlias.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from antiAliasAsString().
    
    Returns:
    
    The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.
    
    See Also:
    
    AntiAlias
  - codecSettings
```
public final VideoCodecSettings codecSettings()
```
    Video codec settings contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec. For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * UNCOMPRESSED, UncompressedSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings
    
    Returns:
    
    Video codec settings contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec. For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * UNCOMPRESSED, UncompressedSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings
  - colorMetadata
```
public final ColorMetadata colorMetadata()
```
    Choose Insert for this setting to include color metadata in this output. Choose Ignore to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
    If the service returns an enum value that is not available in the current SDK version, colorMetadata will return ColorMetadata.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from colorMetadataAsString().
    
    Returns:
    
    Choose Insert for this setting to include color metadata in this output. Choose Ignore to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
    
    See Also:
    
    ColorMetadata
  - colorMetadataAsString
```
public final String colorMetadataAsString()
```
    Choose Insert for this setting to include color metadata in this output. Choose Ignore to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
    If the service returns an enum value that is not available in the current SDK version, colorMetadata will return ColorMetadata.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from colorMetadataAsString().
    
    Returns:
    
    Choose Insert for this setting to include color metadata in this output. Choose Ignore to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
    
    See Also:
    
    ColorMetadata
  - crop
```
public final Rectangle crop()
```
    Use Cropping selection to specify the video area that the service will include in the output video frame.
    
    Returns:
    
    Use Cropping selection to specify the video area that the service will include in the output video frame.
  - dropFrameTimecode
```
public final DropFrameTimecode dropFrameTimecode()
```
    Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion is enabled.
    If the service returns an enum value that is not available in the current SDK version, dropFrameTimecode will return DropFrameTimecode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dropFrameTimecodeAsString().
    
    Returns:
    
    Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion is enabled.
    
    See Also:
    
    DropFrameTimecode
  - dropFrameTimecodeAsString
```
public final String dropFrameTimecodeAsString()
```
    Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion is enabled.
    If the service returns an enum value that is not available in the current SDK version, dropFrameTimecode will return DropFrameTimecode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dropFrameTimecodeAsString().
    
    Returns:
    
    Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion is enabled.
    
    See Also:
    
    DropFrameTimecode
  - fixedAfd
```
public final Integer fixedAfd()
```
    Applies only if you set AFD Signaling to Fixed. Use Fixed to specify a four-bit AFD value which the service will write on all frames of this video output.
    
    Returns:
    
    Applies only if you set AFD Signaling to Fixed. Use Fixed to specify a four-bit AFD value which the service will write on all frames of this video output.
  - height
```
public final Integer height()
```
    Use Height to define the video resolution height, in pixels, for this output. To use the same resolution as your input: Leave both Width and Height blank. To evenly scale from your input resolution: Leave Height blank and enter a value for Width. For example, if your input is 1920x1080 and you set Width to 1280, your output will be 1280x720.
    
    Returns:
    
    Use Height to define the video resolution height, in pixels, for this output. To use the same resolution as your input: Leave both Width and Height blank. To evenly scale from your input resolution: Leave Height blank and enter a value for Width. For example, if your input is 1920x1080 and you set Width to 1280, your output will be 1280x720.
  - position
```
public final Rectangle position()
```
    Use Selection placement to define the video area in your output frame. The area outside of the rectangle that you specify here is black.
    
    Returns:
    
    Use Selection placement to define the video area in your output frame. The area outside of the rectangle that you specify here is black.
  - respondToAfd
```
public final RespondToAfd respondToAfd()
```
    Use Respond to AFD to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to NONE. A preferred implementation of this workflow is to set RespondToAfd to and set AfdSignaling to AUTO. * Choose None to remove all input AFD values from this output.
    If the service returns an enum value that is not available in the current SDK version, respondToAfd will return RespondToAfd.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from respondToAfdAsString().
    
    Returns:
    
    Use Respond to AFD to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to NONE. A preferred implementation of this workflow is to set RespondToAfd to and set AfdSignaling to AUTO. * Choose None to remove all input AFD values from this output.
    
    See Also:
    
    RespondToAfd
  - respondToAfdAsString
```
public final String respondToAfdAsString()
```
    Use Respond to AFD to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to NONE. A preferred implementation of this workflow is to set RespondToAfd to and set AfdSignaling to AUTO. * Choose None to remove all input AFD values from this output.
    If the service returns an enum value that is not available in the current SDK version, respondToAfd will return RespondToAfd.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from respondToAfdAsString().
    
    Returns:
    
    Use Respond to AFD to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to NONE. A preferred implementation of this workflow is to set RespondToAfd to and set AfdSignaling to AUTO. * Choose None to remove all input AFD values from this output.
    
    See Also:
    
    RespondToAfd
  - scalingBehavior
```
public final ScalingBehavior scalingBehavior()
```
    Specify the video Scaling behavior when your output has a different resolution than your input. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/video-scaling.html
    If the service returns an enum value that is not available in the current SDK version, scalingBehavior will return ScalingBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingBehaviorAsString().
    
    Returns:
    
    Specify the video Scaling behavior when your output has a different resolution than your input. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/video-scaling.html
    
    See Also:
    
    ScalingBehavior
  - scalingBehaviorAsString
```
public final String scalingBehaviorAsString()
```
    Specify the video Scaling behavior when your output has a different resolution than your input. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/video-scaling.html
    If the service returns an enum value that is not available in the current SDK version, scalingBehavior will return ScalingBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingBehaviorAsString().
    
    Returns:
    
    Specify the video Scaling behavior when your output has a different resolution than your input. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/video-scaling.html
    
    See Also:
    
    ScalingBehavior
  - sharpness
```
public final Integer sharpness()
```
    Use Sharpness setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.
    
    Returns:
    
    Use Sharpness setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.
  - timecodeInsertion
```
public final VideoTimecodeInsertion timecodeInsertion()
```
    Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration. In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration does.
    If the service returns an enum value that is not available in the current SDK version, timecodeInsertion will return VideoTimecodeInsertion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timecodeInsertionAsString().
    
    Returns:
    
    Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration. In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration does.
    
    See Also:
    
    VideoTimecodeInsertion
  - timecodeInsertionAsString
```
public final String timecodeInsertionAsString()
```
    Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration. In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration does.
    If the service returns an enum value that is not available in the current SDK version, timecodeInsertion will return VideoTimecodeInsertion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timecodeInsertionAsString().
    
    Returns:
    
    Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration. In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration does.
    
    See Also:
    
    VideoTimecodeInsertion
  - videoPreprocessors
```
public final VideoPreprocessor videoPreprocessors()
```
    Find additional transcoding features under Preprocessors. Enable the features at each output individually. These features are disabled by default.
    
    Returns:
    
    Find additional transcoding features under Preprocessors. Enable the features at each output individually. These features are disabled by default.
  - width
```
public final Integer width()
```
    Use Width to define the video resolution width, in pixels, for this output. To use the same resolution as your input: Leave both Width and Height blank. To evenly scale from your input resolution: Leave Width blank and enter a value for Height. For example, if your input is 1920x1080 and you set Height to 720, your output will be 1280x720.
    
    Returns:
    
    Use Width to define the video resolution width, in pixels, for this output. To use the same resolution as your input: Leave both Width and Height blank. To evenly scale from your input resolution: Leave Width blank and enter a value for Height. For example, if your input is 1920x1080 and you set Height to 720, your output will be 1280x720.
  - toBuilder
```
public VideoDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<VideoDescription.Builder,VideoDescription>
  - builder
```
public static VideoDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends VideoDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class VideoDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

afdSignaling

afdSignalingAsString

antiAlias

antiAliasAsString

codecSettings

colorMetadata

colorMetadataAsString

crop

dropFrameTimecode

dropFrameTimecodeAsString

fixedAfd

height

position

respondToAfd

respondToAfdAsString

scalingBehavior

scalingBehaviorAsString

sharpness

timecodeInsertion

timecodeInsertionAsString

videoPreprocessors

width

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField