Package software.amazon.awssdk.services.medialive.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StaticImageActivateScheduleActionSettings.Builder

Method Summary

Modifier and Type	Method	Description
static StaticImageActivateScheduleActionSettings.Builder	builder()
Integer	duration()	The duration in milliseconds for the image to remain on the video.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	fadeIn()	The time in milliseconds for the image to fade in.
Integer	fadeOut()	Applies only if a duration is specified.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	height()	The height of the image when inserted into the video, in pixels.
InputLocation	image()	The location and filename of the image file to overlay on the video.
Integer	imageX()	Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels.
Integer	imageY()	Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels.
Integer	layer()	The number of the layer, 0 to 7.
Integer	opacity()	Opacity of image where 0 is transparent and 100 is fully opaque.
List<SdkField<?>>	sdkFields()
static Class<? extends StaticImageActivateScheduleActionSettings.Builder>	serializableBuilderClass()
StaticImageActivateScheduleActionSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	width()	The width of the image when inserted into the video, in pixels.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

duration

public final Integer 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

public final Integer 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

public final Integer 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

public final Integer 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

public final InputLocation 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

public final Integer 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

public final Integer 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

public final Integer 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

public final Integer 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

public final Integer 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

public StaticImageActivateScheduleActionSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StaticImageActivateScheduleActionSettings.Builder,StaticImageActivateScheduleActionSettings>

builder

public static StaticImageActivateScheduleActionSettings.Builder builder()

serializableBuilderClass

public static Class<? extends StaticImageActivateScheduleActionSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo