com.amazonaws.services.medialive.model

Class StaticImageOutputActivateScheduleActionSettings

java.lang.Object

com.amazonaws.services.medialive.model.StaticImageOutputActivateScheduleActionSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StaticImageOutputActivateScheduleActionSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

Settings for the action to activate a static image.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
StaticImageOutputActivateScheduleActionSettings()

Method Summary

Modifier and Type	Method and Description
StaticImageOutputActivateScheduleActionSettings	clone()
boolean	equals(Object obj)
Integer	getDuration() The duration in milliseconds for the image to remain on the video.
Integer	getFadeIn() The time in milliseconds for the image to fade in.
Integer	getFadeOut() Applies only if a duration is specified.
Integer	getHeight() The height of the image when inserted into the video, in pixels.
InputLocation	getImage() The location and filename of the image file to overlay on the video.
Integer	getImageX() Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels.
Integer	getImageY() Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels.
Integer	getLayer() The number of the layer, 0 to 7.
Integer	getOpacity() Opacity of image where 0 is transparent and 100 is fully opaque.
List<String>	getOutputNames() The name(s) of the output(s) the activation should apply to.
Integer	getWidth() The width of the image when inserted into the video, in pixels.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDuration(Integer duration) The duration in milliseconds for the image to remain on the video.
void	setFadeIn(Integer fadeIn) The time in milliseconds for the image to fade in.
void	setFadeOut(Integer fadeOut) Applies only if a duration is specified.
void	setHeight(Integer height) The height of the image when inserted into the video, in pixels.
void	setImage(InputLocation image) The location and filename of the image file to overlay on the video.
void	setImageX(Integer imageX) Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels.
void	setImageY(Integer imageY) Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels.
void	setLayer(Integer layer) The number of the layer, 0 to 7.
void	setOpacity(Integer opacity) Opacity of image where 0 is transparent and 100 is fully opaque.
void	setOutputNames(Collection<String> outputNames) The name(s) of the output(s) the activation should apply to.
void	setWidth(Integer width) The width of the image when inserted into the video, in pixels.
String	toString() Returns a string representation of this object.
StaticImageOutputActivateScheduleActionSettings	withDuration(Integer duration) The duration in milliseconds for the image to remain on the video.
StaticImageOutputActivateScheduleActionSettings	withFadeIn(Integer fadeIn) The time in milliseconds for the image to fade in.
StaticImageOutputActivateScheduleActionSettings	withFadeOut(Integer fadeOut) Applies only if a duration is specified.
StaticImageOutputActivateScheduleActionSettings	withHeight(Integer height) The height of the image when inserted into the video, in pixels.
StaticImageOutputActivateScheduleActionSettings	withImage(InputLocation image) The location and filename of the image file to overlay on the video.
StaticImageOutputActivateScheduleActionSettings	withImageX(Integer imageX) Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels.
StaticImageOutputActivateScheduleActionSettings	withImageY(Integer imageY) Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels.
StaticImageOutputActivateScheduleActionSettings	withLayer(Integer layer) The number of the layer, 0 to 7.
StaticImageOutputActivateScheduleActionSettings	withOpacity(Integer opacity) Opacity of image where 0 is transparent and 100 is fully opaque.
StaticImageOutputActivateScheduleActionSettings	withOutputNames(Collection<String> outputNames) The name(s) of the output(s) the activation should apply to.
StaticImageOutputActivateScheduleActionSettings	withOutputNames(String... outputNames) The name(s) of the output(s) the activation should apply to.
StaticImageOutputActivateScheduleActionSettings	withWidth(Integer width) The width of the image when inserted into the video, in pixels.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StaticImageOutputActivateScheduleActionSettings

public StaticImageOutputActivateScheduleActionSettings()

Method Detail

setDuration

public void setDuration(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.

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.

getDuration

public Integer getDuration()

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.

withDuration

public StaticImageOutputActivateScheduleActionSettings withDuration(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.

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.

setFadeIn

public void setFadeIn(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).

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).

getFadeIn

public Integer getFadeIn()

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).

withFadeIn

public StaticImageOutputActivateScheduleActionSettings withFadeIn(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).

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.

setFadeOut

public void setFadeOut(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).

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).

getFadeOut

public Integer getFadeOut()

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).

withFadeOut

public StaticImageOutputActivateScheduleActionSettings withFadeOut(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).

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.

setHeight

public void setHeight(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.

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.

getHeight

public Integer getHeight()

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.

withHeight

public StaticImageOutputActivateScheduleActionSettings withHeight(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.

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.

setImage

public void setImage(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.

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.

getImage

public InputLocation getImage()

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.

withImage

public StaticImageOutputActivateScheduleActionSettings withImage(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.

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.

setImageX

public void setImageX(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.

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.

getImageX

public Integer getImageX()

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.

withImageX

public StaticImageOutputActivateScheduleActionSettings withImageX(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.

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.

setImageY

public void setImageY(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.

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.

getImageY

public Integer getImageY()

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.

withImageY

public StaticImageOutputActivateScheduleActionSettings withImageY(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.

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.

setLayer

public void setLayer(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.

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.

getLayer

public Integer getLayer()

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.

withLayer

public StaticImageOutputActivateScheduleActionSettings withLayer(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.

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.

setOpacity

public void setOpacity(Integer 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.

getOpacity

public Integer getOpacity()

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.

withOpacity

public StaticImageOutputActivateScheduleActionSettings withOpacity(Integer 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.

getOutputNames

public List<String> getOutputNames()

The name(s) of the output(s) the activation should apply to.

Returns:

The name(s) of the output(s) the activation should apply to.

setOutputNames

public void setOutputNames(Collection<String> outputNames)

The name(s) of the output(s) the activation should apply to.

Parameters:

outputNames - The name(s) of the output(s) the activation should apply to.

withOutputNames

public StaticImageOutputActivateScheduleActionSettings withOutputNames(String... outputNames)

The name(s) of the output(s) the activation should apply to.

NOTE: This method appends the values to the existing list (if any). Use setOutputNames(java.util.Collection) or withOutputNames(java.util.Collection) if you want to override the existing values.

Parameters:

outputNames - The name(s) of the output(s) the activation should apply to.

Returns:

Returns a reference to this object so that method calls can be chained together.

withOutputNames

public StaticImageOutputActivateScheduleActionSettings withOutputNames(Collection<String> outputNames)

The name(s) of the output(s) the activation should apply to.

Parameters:

outputNames - The name(s) of the output(s) the activation should apply to.

Returns:

Returns a reference to this object so that method calls can be chained together.

setWidth

public void setWidth(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.

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.

getWidth

public Integer getWidth()

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.

withWidth

public StaticImageOutputActivateScheduleActionSettings withWidth(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.

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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StaticImageOutputActivateScheduleActionSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.