Class StaticImageActivateScheduleActionSettings
java.lang.Object
software.amazon.awssdk.services.medialive.model.StaticImageActivateScheduleActionSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StaticImageActivateScheduleActionSettings.Builder,
StaticImageActivateScheduleActionSettings>
@Generated("software.amazon.awssdk:codegen")
public final class StaticImageActivateScheduleActionSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StaticImageActivateScheduleActionSettings.Builder,StaticImageActivateScheduleActionSettings>
Settings for the action to activate a static image.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Integer
duration()
The duration in milliseconds for the image to remain on the video.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
fadeIn()
The time in milliseconds for the image to fade in.final Integer
fadeOut()
Applies only if a duration is specified.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
height()
The height of the image when inserted into the video, in pixels.final InputLocation
image()
The location and filename of the image file to overlay on the video.final Integer
imageX()
Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels.final Integer
imageY()
Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels.final Integer
layer()
The number of the layer, 0 to 7.final Integer
opacity()
Opacity of image where 0 is transparent and 100 is fully opaque.static Class
<? extends StaticImageActivateScheduleActionSettings.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
width()
The width of the image when inserted into the video, in pixels.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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.- Returns:
- 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.
-
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:
- 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).
-
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:
- 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).
-
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:
- 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.
-
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:
- 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.
-
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:
- 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.
-
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:
- 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.
-
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:
- 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.
-
opacity
Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.- Returns:
- Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StaticImageActivateScheduleActionSettings.Builder,
StaticImageActivateScheduleActionSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends StaticImageActivateScheduleActionSettings.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-