Interface VideoDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<VideoDescription.Builder,VideoDescription>, SdkBuilder<VideoDescription.Builder,VideoDescription>, SdkPojo
Enclosing class:
VideoDescription
@Mutable @NotThreadSafe public static interface VideoDescription.Builder extends SdkPojo, CopyableBuilder<VideoDescription.Builder,VideoDescription>

  • Method Details

    • afdSignaling

      VideoDescription.Builder afdSignaling(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • afdSignaling

      VideoDescription.Builder afdSignaling(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • antiAlias

      VideoDescription.Builder antiAlias(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

      VideoDescription.Builder antiAlias(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:

    • chromaPositionMode

      VideoDescription.Builder chromaPositionMode(String chromaPositionMode)
      Specify the chroma sample positioning metadata for your H.264 or H.265 output. To have MediaConvert automatically determine chroma positioning: We recommend that you keep the default value, Auto. To specify center positioning: Choose Force center. To specify top left positioning: Choose Force top left.
      Parameters:
      chromaPositionMode - Specify the chroma sample positioning metadata for your H.264 or H.265 output. To have MediaConvert automatically determine chroma positioning: We recommend that you keep the default value, Auto. To specify center positioning: Choose Force center. To specify top left positioning: Choose Force top left.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • chromaPositionMode

      VideoDescription.Builder chromaPositionMode(ChromaPositionMode chromaPositionMode)
      Specify the chroma sample positioning metadata for your H.264 or H.265 output. To have MediaConvert automatically determine chroma positioning: We recommend that you keep the default value, Auto. To specify center positioning: Choose Force center. To specify top left positioning: Choose Force top left.
      Parameters:
      chromaPositionMode - Specify the chroma sample positioning metadata for your H.264 or H.265 output. To have MediaConvert automatically determine chroma positioning: We recommend that you keep the default value, Auto. To specify center positioning: Choose Force center. To specify top left positioning: Choose Force top left.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • codecSettings

      VideoDescription.Builder codecSettings(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 * GIF, GifSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * UNCOMPRESSED, UncompressedSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings
      Parameters:
      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 * GIF, GifSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * UNCOMPRESSED, UncompressedSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codecSettings

      default VideoDescription.Builder codecSettings(Consumer<VideoCodecSettings.Builder> 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 * GIF, GifSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * UNCOMPRESSED, UncompressedSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings This is a convenience method that creates an instance of the VideoCodecSettings.Builder avoiding the need to create one manually via VideoCodecSettings.builder().

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

      Parameters:
      codecSettings - a consumer that will call methods on VideoCodecSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • colorMetadata

      VideoDescription.Builder colorMetadata(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • colorMetadata

      VideoDescription.Builder colorMetadata(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • crop

      VideoDescription.Builder crop(Rectangle crop)
      Use Cropping selection to specify the video area that the service will include in the output video frame.
      Parameters:
      crop - Use Cropping selection 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.

    • crop

      default VideoDescription.Builder crop(Consumer<Rectangle.Builder> crop)
      Use Cropping selection to specify the video area that the service will include in the output video frame. This is a convenience method that creates an instance of the Rectangle.Builder avoiding the need to create one manually via Rectangle.builder().

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

      Parameters:
      crop - a consumer that will call methods on Rectangle.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dropFrameTimecode

      VideoDescription.Builder dropFrameTimecode(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 or Timecode track 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 or Timecode track is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dropFrameTimecode

      VideoDescription.Builder dropFrameTimecode(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 or Timecode track 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 or Timecode track is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fixedAfd

      VideoDescription.Builder fixedAfd(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • height

      VideoDescription.Builder height(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • position

      VideoDescription.Builder position(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • position

      default VideoDescription.Builder position(Consumer<Rectangle.Builder> 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. This is a convenience method that creates an instance of the Rectangle.Builder avoiding the need to create one manually via Rectangle.builder().

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

      Parameters:
      position - a consumer that will call methods on Rectangle.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • respondToAfd

      VideoDescription.Builder respondToAfd(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • respondToAfd

      VideoDescription.Builder respondToAfd(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scalingBehavior

      VideoDescription.Builder scalingBehavior(String 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
      Parameters:
      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
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scalingBehavior

      VideoDescription.Builder scalingBehavior(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
      Parameters:
      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
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sharpness

      VideoDescription.Builder sharpness(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • timecodeInsertion

      VideoDescription.Builder timecodeInsertion(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 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.
      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 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timecodeInsertion

      VideoDescription.Builder timecodeInsertion(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.
      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 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timecodeTrack

      VideoDescription.Builder timecodeTrack(String timecodeTrack)
      To include a timecode track in your MP4 output: Choose Enabled. MediaConvert writes the timecode track in the Null Media Header box (NMHD), without any timecode text formatting information. You can also specify dropframe or non-dropframe timecode under the Drop Frame Timecode setting. To not include a timecode track: Keep the default value, Disabled.
      Parameters:
      timecodeTrack - To include a timecode track in your MP4 output: Choose Enabled. MediaConvert writes the timecode track in the Null Media Header box (NMHD), without any timecode text formatting information. You can also specify dropframe or non-dropframe timecode under the Drop Frame Timecode setting. To not include a timecode track: Keep the default value, Disabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timecodeTrack

      VideoDescription.Builder timecodeTrack(TimecodeTrack timecodeTrack)
      To include a timecode track in your MP4 output: Choose Enabled. MediaConvert writes the timecode track in the Null Media Header box (NMHD), without any timecode text formatting information. You can also specify dropframe or non-dropframe timecode under the Drop Frame Timecode setting. To not include a timecode track: Keep the default value, Disabled.
      Parameters:
      timecodeTrack - To include a timecode track in your MP4 output: Choose Enabled. MediaConvert writes the timecode track in the Null Media Header box (NMHD), without any timecode text formatting information. You can also specify dropframe or non-dropframe timecode under the Drop Frame Timecode setting. To not include a timecode track: Keep the default value, Disabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • videoPreprocessors

      VideoDescription.Builder videoPreprocessors(VideoPreprocessor videoPreprocessors)
      Find additional transcoding features under Preprocessors. Enable the features at each output individually. These features are disabled by default.
      Parameters:
      videoPreprocessors - Find additional transcoding features under Preprocessors. 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.

    • videoPreprocessors

      default VideoDescription.Builder videoPreprocessors(Consumer<VideoPreprocessor.Builder> videoPreprocessors)
      Find additional transcoding features under Preprocessors. Enable the features at each output individually. These features are disabled by default. This is a convenience method that creates an instance of the VideoPreprocessor.Builder avoiding the need to create one manually via VideoPreprocessor.builder().

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

      Parameters:
      videoPreprocessors - a consumer that will call methods on VideoPreprocessor.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • width

      VideoDescription.Builder width(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.