VideoDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mediaconvert.model.VideoDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VideoDescription
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Settings related to video encoding of your output. The specific video settings depend on the video codec that you choose. When you work directly in your JSON job specification, include one instance of Video description (VideoDescription) per output.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

VideoDescription()

Constructors
Constructor and Description
`VideoDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VideoDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAfdSignaling()` This setting only applies to H.264, H.265, and MPEG2 outputs.
`String`	`getAntiAlias()` The anti-alias filter is automatically applied to all outputs.
`VideoCodecSettings`	`getCodecSettings()` Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding.
`String`	`getColorMetadata()` Choose Insert (INSERT) for this setting to include color metadata in this output.
`Rectangle`	`getCrop()` Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.
`String`	`getDropFrameTimecode()` Applies only to 29.97 fps outputs.
`Integer`	`getFixedAfd()` Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED).
`Integer`	`getHeight()` Use the Height (Height) setting to define the video resolution height for this output.
`Rectangle`	`getPosition()` Use Selection placement (position) to define the video area in your output frame.
`String`	`getRespondToAfd()` Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input.
`String`	`getScalingBehavior()` Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio.
`Integer`	`getSharpness()` Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing.
`String`	`getTimecodeInsertion()` Applies only to H.264, H.265, MPEG2, and ProRes outputs.
`VideoPreprocessor`	`getVideoPreprocessors()` Find additional transcoding features under Preprocessors (VideoPreprocessors).
`Integer`	`getWidth()` Use Width (Width) to define the video resolution width, in pixels, for this output.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAfdSignaling(String afdSignaling)` This setting only applies to H.264, H.265, and MPEG2 outputs.
`void`	`setAntiAlias(String antiAlias)` The anti-alias filter is automatically applied to all outputs.
`void`	`setCodecSettings(VideoCodecSettings codecSettings)` Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding.
`void`	`setColorMetadata(String colorMetadata)` Choose Insert (INSERT) for this setting to include color metadata in this output.
`void`	`setCrop(Rectangle crop)` Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.
`void`	`setDropFrameTimecode(String dropFrameTimecode)` Applies only to 29.97 fps outputs.
`void`	`setFixedAfd(Integer fixedAfd)` Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED).
`void`	`setHeight(Integer height)` Use the Height (Height) setting to define the video resolution height for this output.
`void`	`setPosition(Rectangle position)` Use Selection placement (position) to define the video area in your output frame.
`void`	`setRespondToAfd(String respondToAfd)` Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input.
`void`	`setScalingBehavior(String scalingBehavior)` Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio.
`void`	`setSharpness(Integer sharpness)` Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing.
`void`	`setTimecodeInsertion(String timecodeInsertion)` Applies only to H.264, H.265, MPEG2, and ProRes outputs.
`void`	`setVideoPreprocessors(VideoPreprocessor videoPreprocessors)` Find additional transcoding features under Preprocessors (VideoPreprocessors).
`void`	`setWidth(Integer width)` Use Width (Width) to define the video resolution width, in pixels, for this output.
`String`	`toString()` Returns a string representation of this object.
`VideoDescription`	`withAfdSignaling(AfdSignaling afdSignaling)` This setting only applies to H.264, H.265, and MPEG2 outputs.
`VideoDescription`	`withAfdSignaling(String afdSignaling)` This setting only applies to H.264, H.265, and MPEG2 outputs.
`VideoDescription`	`withAntiAlias(AntiAlias antiAlias)` The anti-alias filter is automatically applied to all outputs.
`VideoDescription`	`withAntiAlias(String antiAlias)` The anti-alias filter is automatically applied to all outputs.
`VideoDescription`	`withCodecSettings(VideoCodecSettings codecSettings)` Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding.
`VideoDescription`	`withColorMetadata(ColorMetadata colorMetadata)` Choose Insert (INSERT) for this setting to include color metadata in this output.
`VideoDescription`	`withColorMetadata(String colorMetadata)` Choose Insert (INSERT) for this setting to include color metadata in this output.
`VideoDescription`	`withCrop(Rectangle crop)` Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.
`VideoDescription`	`withDropFrameTimecode(DropFrameTimecode dropFrameTimecode)` Applies only to 29.97 fps outputs.
`VideoDescription`	`withDropFrameTimecode(String dropFrameTimecode)` Applies only to 29.97 fps outputs.
`VideoDescription`	`withFixedAfd(Integer fixedAfd)` Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED).
`VideoDescription`	`withHeight(Integer height)` Use the Height (Height) setting to define the video resolution height for this output.
`VideoDescription`	`withPosition(Rectangle position)` Use Selection placement (position) to define the video area in your output frame.
`VideoDescription`	`withRespondToAfd(RespondToAfd respondToAfd)` Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input.
`VideoDescription`	`withRespondToAfd(String respondToAfd)` Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input.
`VideoDescription`	`withScalingBehavior(ScalingBehavior scalingBehavior)` Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio.
`VideoDescription`	`withScalingBehavior(String scalingBehavior)` Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio.
`VideoDescription`	`withSharpness(Integer sharpness)` Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing.
`VideoDescription`	`withTimecodeInsertion(String timecodeInsertion)` Applies only to H.264, H.265, MPEG2, and ProRes outputs.
`VideoDescription`	`withTimecodeInsertion(VideoTimecodeInsertion timecodeInsertion)` Applies only to H.264, H.265, MPEG2, and ProRes outputs.
`VideoDescription`	`withVideoPreprocessors(VideoPreprocessor videoPreprocessors)` Find additional transcoding features under Preprocessors (VideoPreprocessors).
`VideoDescription`	`withWidth(Integer width)` Use Width (Width) to define the video resolution width, in pixels, for this output.

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

- Constructor Detail
  - VideoDescription
```
public VideoDescription()
```
- Method Detail
  - setAfdSignaling
```
public void setAfdSignaling(String afdSignaling)
```
    This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) 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.
    
    Parameters:
    
    afdSignaling - This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) 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
  - getAfdSignaling
```
public String getAfdSignaling()
```
    This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) 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.
    
    Returns:
    
    This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) 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
  - withAfdSignaling
```
public VideoDescription withAfdSignaling(String afdSignaling)
```
    This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) 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.
    
    Parameters:
    
    afdSignaling - This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AfdSignaling
  - withAfdSignaling
```
public VideoDescription withAfdSignaling(AfdSignaling afdSignaling)
```
    This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) 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.
    
    Parameters:
    
    afdSignaling - This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AfdSignaling
  - setAntiAlias
```
public void setAntiAlias(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    AntiAlias
  - getAntiAlias
```
public String getAntiAlias()
```
    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.
    
    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
  - withAntiAlias
```
public VideoDescription withAntiAlias(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AntiAlias
  - withAntiAlias
```
public VideoDescription withAntiAlias(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AntiAlias
  - setCodecSettings
```
public void setCodecSettings(VideoCodecSettings codecSettings)
```
    Video codec settings, (CodecSettings) under (VideoDescription), 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 (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 * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings
    
    Parameters:
    
    codecSettings - Video codec settings, (CodecSettings) under (VideoDescription), 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 (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 * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings
  - getCodecSettings
```
public VideoCodecSettings getCodecSettings()
```
    Video codec settings, (CodecSettings) under (VideoDescription), 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 (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 * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings
    
    Returns:
    
    Video codec settings, (CodecSettings) under (VideoDescription), 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 (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 * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings
  - withCodecSettings
```
public VideoDescription withCodecSettings(VideoCodecSettings codecSettings)
```
    Video codec settings, (CodecSettings) under (VideoDescription), 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 (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 * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings
    
    Parameters:
    
    codecSettings - Video codec settings, (CodecSettings) under (VideoDescription), 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 (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 * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setColorMetadata
```
public void setColorMetadata(String colorMetadata)
```
    Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
    
    Parameters:
    
    colorMetadata - Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (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
  - getColorMetadata
```
public String getColorMetadata()
```
    Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
    
    Returns:
    
    Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (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
  - withColorMetadata
```
public VideoDescription withColorMetadata(String colorMetadata)
```
    Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
    
    Parameters:
    
    colorMetadata - Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ColorMetadata
  - withColorMetadata
```
public VideoDescription withColorMetadata(ColorMetadata colorMetadata)
```
    Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
    
    Parameters:
    
    colorMetadata - Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ColorMetadata
  - setCrop
```
public void setCrop(Rectangle crop)
```
    Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.
    
    Parameters:
    
    crop - Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.
  - getCrop
```
public Rectangle getCrop()
```
    Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.
    
    Returns:
    
    Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.
  - withCrop
```
public VideoDescription withCrop(Rectangle crop)
```
    Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.
    
    Parameters:
    
    crop - Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDropFrameTimecode
```
public void setDropFrameTimecode(String 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 (TimecodeInsertion) is enabled.
    
    Parameters:
    
    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 (TimecodeInsertion) is enabled.
    
    See Also:
    
    DropFrameTimecode
  - getDropFrameTimecode
```
public String getDropFrameTimecode()
```
    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 (TimecodeInsertion) is enabled.
    
    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 (TimecodeInsertion) is enabled.
    
    See Also:
    
    DropFrameTimecode
  - withDropFrameTimecode
```
public VideoDescription withDropFrameTimecode(String 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 (TimecodeInsertion) is enabled.
    
    Parameters:
    
    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 (TimecodeInsertion) is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DropFrameTimecode
  - withDropFrameTimecode
```
public VideoDescription withDropFrameTimecode(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 (TimecodeInsertion) is enabled.
    
    Parameters:
    
    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 (TimecodeInsertion) is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DropFrameTimecode
  - setFixedAfd
```
public void setFixedAfd(Integer fixedAfd)
```
    Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.
    
    Parameters:
    
    fixedAfd - Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.
  - getFixedAfd
```
public Integer getFixedAfd()
```
    Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) 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(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.
  - withFixedAfd
```
public VideoDescription withFixedAfd(Integer fixedAfd)
```
    Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.
    
    Parameters:
    
    fixedAfd - Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHeight
```
public void setHeight(Integer height)
```
    Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.
    
    Parameters:
    
    height - Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.
  - getHeight
```
public Integer getHeight()
```
    Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.
    
    Returns:
    
    Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.
  - withHeight
```
public VideoDescription withHeight(Integer height)
```
    Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.
    
    Parameters:
    
    height - Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPosition
```
public void setPosition(Rectangle position)
```
    Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.
    
    Parameters:
    
    position - Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.
  - getPosition
```
public Rectangle getPosition()
```
    Use Selection placement (position) 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 (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.
  - withPosition
```
public VideoDescription withPosition(Rectangle position)
```
    Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.
    
    Parameters:
    
    position - Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRespondToAfd
```
public void setRespondToAfd(String respondToAfd)
```
    Use Respond to AFD (RespondToAfd) 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 (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.
    
    Parameters:
    
    respondToAfd - Use Respond to AFD (RespondToAfd) 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 (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.
    
    See Also:
    
    RespondToAfd
  - getRespondToAfd
```
public String getRespondToAfd()
```
    Use Respond to AFD (RespondToAfd) 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 (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.
    
    Returns:
    
    Use Respond to AFD (RespondToAfd) 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 (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.
    
    See Also:
    
    RespondToAfd
  - withRespondToAfd
```
public VideoDescription withRespondToAfd(String respondToAfd)
```
    Use Respond to AFD (RespondToAfd) 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 (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.
    
    Parameters:
    
    respondToAfd - Use Respond to AFD (RespondToAfd) 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 (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RespondToAfd
  - withRespondToAfd
```
public VideoDescription withRespondToAfd(RespondToAfd respondToAfd)
```
    Use Respond to AFD (RespondToAfd) 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 (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.
    
    Parameters:
    
    respondToAfd - Use Respond to AFD (RespondToAfd) 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 (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RespondToAfd
  - setScalingBehavior
```
public void setScalingBehavior(String scalingBehavior)
```
    Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.
    
    Parameters:
    
    scalingBehavior - Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.
    
    See Also:
    
    ScalingBehavior
  - getScalingBehavior
```
public String getScalingBehavior()
```
    Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.
    
    Returns:
    
    Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.
    
    See Also:
    
    ScalingBehavior
  - withScalingBehavior
```
public VideoDescription withScalingBehavior(String scalingBehavior)
```
    Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.
    
    Parameters:
    
    scalingBehavior - Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ScalingBehavior
  - withScalingBehavior
```
public VideoDescription withScalingBehavior(ScalingBehavior scalingBehavior)
```
    Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.
    
    Parameters:
    
    scalingBehavior - Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ScalingBehavior
  - setSharpness
```
public void setSharpness(Integer sharpness)
```
    Use Sharpness (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.
    
    Parameters:
    
    sharpness - Use Sharpness (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.
  - getSharpness
```
public Integer getSharpness()
```
    Use Sharpness (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 (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.
  - withSharpness
```
public VideoDescription withSharpness(Integer sharpness)
```
    Use Sharpness (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.
    
    Parameters:
    
    sharpness - Use Sharpness (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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimecodeInsertion
```
public void setTimecodeInsertion(String 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 (VideoTimecodeInsertion) 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 (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.
    
    Parameters:
    
    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 (VideoTimecodeInsertion) 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 (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.
    
    See Also:
    
    VideoTimecodeInsertion
  - getTimecodeInsertion
```
public String getTimecodeInsertion()
```
    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 (VideoTimecodeInsertion) 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 (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.
    
    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 (VideoTimecodeInsertion) 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 (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.
    
    See Also:
    
    VideoTimecodeInsertion
  - withTimecodeInsertion
```
public VideoDescription withTimecodeInsertion(String 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 (VideoTimecodeInsertion) 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 (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.
    
    Parameters:
    
    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 (VideoTimecodeInsertion) 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 (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VideoTimecodeInsertion
  - withTimecodeInsertion
```
public VideoDescription withTimecodeInsertion(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 (VideoTimecodeInsertion) 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 (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.
    
    Parameters:
    
    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 (VideoTimecodeInsertion) 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 (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VideoTimecodeInsertion
  - setVideoPreprocessors
```
public void setVideoPreprocessors(VideoPreprocessor videoPreprocessors)
```
    Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.
    
    Parameters:
    
    videoPreprocessors - Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.
  - getVideoPreprocessors
```
public VideoPreprocessor getVideoPreprocessors()
```
    Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.
    
    Returns:
    
    Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.
  - withVideoPreprocessors
```
public VideoDescription withVideoPreprocessors(VideoPreprocessor videoPreprocessors)
```
    Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.
    
    Parameters:
    
    videoPreprocessors - Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWidth
```
public void setWidth(Integer width)
```
    Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.
    
    Parameters:
    
    width - Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.
  - getWidth
```
public Integer getWidth()
```
    Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.
    
    Returns:
    
    Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.
  - withWidth
```
public VideoDescription withWidth(Integer width)
```
    Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.
    
    Parameters:
    
    width - Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public VideoDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class VideoDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VideoDescription

Method Detail

setAfdSignaling

getAfdSignaling

withAfdSignaling

withAfdSignaling

setAntiAlias

getAntiAlias

withAntiAlias

withAntiAlias

setCodecSettings

getCodecSettings

withCodecSettings

setColorMetadata

getColorMetadata

withColorMetadata

withColorMetadata

setCrop

getCrop

withCrop

setDropFrameTimecode

getDropFrameTimecode

withDropFrameTimecode

withDropFrameTimecode

setFixedAfd

getFixedAfd

withFixedAfd

setHeight

getHeight

withHeight

setPosition

getPosition

withPosition

setRespondToAfd

getRespondToAfd

withRespondToAfd

withRespondToAfd

setScalingBehavior

getScalingBehavior

withScalingBehavior

withScalingBehavior

setSharpness

getSharpness

withSharpness

setTimecodeInsertion

getTimecodeInsertion

withTimecodeInsertion

withTimecodeInsertion

setVideoPreprocessors

getVideoPreprocessors

withVideoPreprocessors

setWidth

getWidth

withWidth

toString

equals

hashCode

clone

marshall