Interface StaticImageActivateScheduleActionSettings.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<StaticImageActivateScheduleActionSettings.Builder,
,StaticImageActivateScheduleActionSettings> SdkBuilder<StaticImageActivateScheduleActionSettings.Builder,
,StaticImageActivateScheduleActionSettings> SdkPojo
- Enclosing class:
StaticImageActivateScheduleActionSettings
public static interface StaticImageActivateScheduleActionSettings.Builder
extends SdkPojo, CopyableBuilder<StaticImageActivateScheduleActionSettings.Builder,StaticImageActivateScheduleActionSettings>
-
Method Summary
Modifier and TypeMethodDescriptionThe duration in milliseconds for the image to remain on the video.The time in milliseconds for the image to fade in.Applies only if a duration is specified.The height of the image when inserted into the video, in pixels.image
(Consumer<InputLocation.Builder> image) The location and filename of the image file to overlay on the video.image
(InputLocation image) The location and filename of the image file to overlay on the video.Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels.Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels.The number of the layer, 0 to 7.Opacity of image where 0 is transparent and 100 is fully opaque.The width of the image when inserted into the video, in pixels.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
duration
The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.- Parameters:
duration
- The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fadeIn
The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).- Parameters:
fadeIn
- The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fadeOut
Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).- Parameters:
fadeOut
- Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
height
The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.- Parameters:
height
- The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
image
The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video.- Parameters:
image
- The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
image
default StaticImageActivateScheduleActionSettings.Builder image(Consumer<InputLocation.Builder> image) The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video. This is a convenience method that creates an instance of theInputLocation.Builder
avoiding the need to create one manually viaInputLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toimage(InputLocation)
.- Parameters:
image
- a consumer that will call methods onInputLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imageX
Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.- Parameters:
imageX
- Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageY
Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.- Parameters:
imageY
- Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
layer
The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.- Parameters:
layer
- The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
opacity
Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.- Parameters:
opacity
- Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
width
The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.- Parameters:
width
- The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-