Interface VideoOverlay.Builder

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

  • Method Details

    • crop

      VideoOverlay.Builder crop(VideoOverlayCrop crop)
      Specify a rectangle of content to crop and use from your video overlay's input video. When you do, MediaConvert uses the cropped dimensions that you specify under X offset, Y offset, Width, and Height.
      Parameters:
      crop - Specify a rectangle of content to crop and use from your video overlay's input video. When you do, MediaConvert uses the cropped dimensions that you specify under X offset, Y offset, Width, and Height.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • crop

      default VideoOverlay.Builder crop(Consumer<VideoOverlayCrop.Builder> crop)
      Specify a rectangle of content to crop and use from your video overlay's input video. When you do, MediaConvert uses the cropped dimensions that you specify under X offset, Y offset, Width, and Height. This is a convenience method that creates an instance of the VideoOverlayCrop.Builder avoiding the need to create one manually via VideoOverlayCrop.builder().

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

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

    • endTimecode

      VideoOverlay.Builder endTimecode(String endTimecode)
      Enter the end timecode in the base input video for this overlay. Your overlay will be active through this frame. To display your video overlay for the duration of the base input video: Leave blank. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS isthe second, and FF is the frame number. When entering this value, take into account your choice for the base input video's timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your overlay to end ten minutes into the video, enter 01:10:00:00.
      Parameters:
      endTimecode - Enter the end timecode in the base input video for this overlay. Your overlay will be active through this frame. To display your video overlay for the duration of the base input video: Leave blank. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS isthe second, and FF is the frame number. When entering this value, take into account your choice for the base input video's timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your overlay to end ten minutes into the video, enter 01:10:00:00.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialPosition

      VideoOverlay.Builder initialPosition(VideoOverlayPosition initialPosition)
      Specify the Initial position of your video overlay. To specify the Initial position of your video overlay, including distance from the left or top edge of the base input video's frame, or size: Enter a value for X position, Y position, Width, or Height. To use the full frame of the base input video: Leave blank.
      Parameters:
      initialPosition - Specify the Initial position of your video overlay. To specify the Initial position of your video overlay, including distance from the left or top edge of the base input video's frame, or size: Enter a value for X position, Y position, Width, or Height. To use the full frame of the base input video: Leave blank.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialPosition

      default VideoOverlay.Builder initialPosition(Consumer<VideoOverlayPosition.Builder> initialPosition)
      Specify the Initial position of your video overlay. To specify the Initial position of your video overlay, including distance from the left or top edge of the base input video's frame, or size: Enter a value for X position, Y position, Width, or Height. To use the full frame of the base input video: Leave blank. This is a convenience method that creates an instance of the VideoOverlayPosition.Builder avoiding the need to create one manually via VideoOverlayPosition.builder().

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

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

    • input

      VideoOverlay.Builder input(VideoOverlayInput input)
      Input settings for Video overlay. You can include one or more video overlays in sequence at different times that you specify.
      Parameters:
      input - Input settings for Video overlay. You can include one or more video overlays in sequence at different times that you specify.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • input

      default VideoOverlay.Builder input(Consumer<VideoOverlayInput.Builder> input)
      Input settings for Video overlay. You can include one or more video overlays in sequence at different times that you specify. This is a convenience method that creates an instance of the VideoOverlayInput.Builder avoiding the need to create one manually via VideoOverlayInput.builder().

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

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

    • playback

      VideoOverlay.Builder playback(String playback)
      Specify whether your video overlay repeats or plays only once. To repeat your video overlay on a loop: Keep the default value, Repeat. Your overlay will repeat for the duration of the base input video. To playback your video overlay only once: Choose Once. With either option, you can end playback at a time that you specify by entering a value for End timecode.
      Parameters:
      playback - Specify whether your video overlay repeats or plays only once. To repeat your video overlay on a loop: Keep the default value, Repeat. Your overlay will repeat for the duration of the base input video. To playback your video overlay only once: Choose Once. With either option, you can end playback at a time that you specify by entering a value for End timecode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • playback

      VideoOverlay.Builder playback(VideoOverlayPlayBackMode playback)
      Specify whether your video overlay repeats or plays only once. To repeat your video overlay on a loop: Keep the default value, Repeat. Your overlay will repeat for the duration of the base input video. To playback your video overlay only once: Choose Once. With either option, you can end playback at a time that you specify by entering a value for End timecode.
      Parameters:
      playback - Specify whether your video overlay repeats or plays only once. To repeat your video overlay on a loop: Keep the default value, Repeat. Your overlay will repeat for the duration of the base input video. To playback your video overlay only once: Choose Once. With either option, you can end playback at a time that you specify by entering a value for End timecode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startTimecode

      VideoOverlay.Builder startTimecode(String startTimecode)
      Enter the start timecode in the base input video for this overlay. Your overlay will be active starting with this frame. To display your video overlay starting at the beginning of the base input video: Leave blank. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When entering this value, take into account your choice for the base input video's timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your overlay to begin five minutes into the video, enter 01:05:00:00.
      Parameters:
      startTimecode - Enter the start timecode in the base input video for this overlay. Your overlay will be active starting with this frame. To display your video overlay starting at the beginning of the base input video: Leave blank. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When entering this value, take into account your choice for the base input video's timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your overlay to begin five minutes into the video, enter 01:05:00:00.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transitions

      VideoOverlay.Builder transitions(Collection<VideoOverlayTransition> transitions)
      Specify one or more transitions for your video overlay. Use Transitions to reposition or resize your overlay over time. To use the same position and size for the duration of your video overlay: Leave blank. To specify a Transition: Enter a value for Start timecode, End Timecode, X Position, Y Position, Width, or Height.
      Parameters:
      transitions - Specify one or more transitions for your video overlay. Use Transitions to reposition or resize your overlay over time. To use the same position and size for the duration of your video overlay: Leave blank. To specify a Transition: Enter a value for Start timecode, End Timecode, X Position, Y Position, Width, or Height.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transitions

      VideoOverlay.Builder transitions(VideoOverlayTransition... transitions)
      Specify one or more transitions for your video overlay. Use Transitions to reposition or resize your overlay over time. To use the same position and size for the duration of your video overlay: Leave blank. To specify a Transition: Enter a value for Start timecode, End Timecode, X Position, Y Position, Width, or Height.
      Parameters:
      transitions - Specify one or more transitions for your video overlay. Use Transitions to reposition or resize your overlay over time. To use the same position and size for the duration of your video overlay: Leave blank. To specify a Transition: Enter a value for Start timecode, End Timecode, X Position, Y Position, Width, or Height.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transitions

      VideoOverlay.Builder transitions(Consumer<VideoOverlayTransition.Builder>... transitions)
      Specify one or more transitions for your video overlay. Use Transitions to reposition or resize your overlay over time. To use the same position and size for the duration of your video overlay: Leave blank. To specify a Transition: Enter a value for Start timecode, End Timecode, X Position, Y Position, Width, or Height. This is a convenience method that creates an instance of the VideoOverlayTransition.Builder avoiding the need to create one manually via VideoOverlayTransition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to transitions(List<VideoOverlayTransition>).

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