com.amazonaws.services.kinesisvideo.model

Class ImageGenerationConfiguration

java.lang.Object

com.amazonaws.services.kinesisvideo.model.ImageGenerationConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The structure that contains the information required for the KVS images delivery. If null, the configuration will be deleted from the stream.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImageGenerationConfiguration()

Method Summary

Modifier and Type	Method and Description
ImageGenerationConfiguration	addFormatConfigEntry(String key, String value) Add a single FormatConfig entry
ImageGenerationConfiguration	clearFormatConfigEntries() Removes all the entries added into FormatConfig.
ImageGenerationConfiguration	clone()
boolean	equals(Object obj)
ImageGenerationDestinationConfig	getDestinationConfig() The structure that contains the information required to deliver images to a customer.
String	getFormat() The accepted image format.
Map<String,String>	getFormatConfig() The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated.
Integer	getHeightPixels() The height of the output image that is used in conjunction with the WidthPixels parameter.
String	getImageSelectorType() The origin of the Server or Producer timestamps to use to generate the images.
Integer	getSamplingInterval() The time interval in milliseconds (ms) at which the images need to be generated from the stream.
String	getStatus() Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.
Integer	getWidthPixels() The width of the output image that is used in conjunction with the HeightPixels parameter.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDestinationConfig(ImageGenerationDestinationConfig destinationConfig) The structure that contains the information required to deliver images to a customer.
void	setFormat(String format) The accepted image format.
void	setFormatConfig(Map<String,String> formatConfig) The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated.
void	setHeightPixels(Integer heightPixels) The height of the output image that is used in conjunction with the WidthPixels parameter.
void	setImageSelectorType(String imageSelectorType) The origin of the Server or Producer timestamps to use to generate the images.
void	setSamplingInterval(Integer samplingInterval) The time interval in milliseconds (ms) at which the images need to be generated from the stream.
void	setStatus(String status) Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.
void	setWidthPixels(Integer widthPixels) The width of the output image that is used in conjunction with the HeightPixels parameter.
String	toString() Returns a string representation of this object.
ImageGenerationConfiguration	withDestinationConfig(ImageGenerationDestinationConfig destinationConfig) The structure that contains the information required to deliver images to a customer.
ImageGenerationConfiguration	withFormat(Format format) The accepted image format.
ImageGenerationConfiguration	withFormat(String format) The accepted image format.
ImageGenerationConfiguration	withFormatConfig(Map<String,String> formatConfig) The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated.
ImageGenerationConfiguration	withHeightPixels(Integer heightPixels) The height of the output image that is used in conjunction with the WidthPixels parameter.
ImageGenerationConfiguration	withImageSelectorType(ImageSelectorType imageSelectorType) The origin of the Server or Producer timestamps to use to generate the images.
ImageGenerationConfiguration	withImageSelectorType(String imageSelectorType) The origin of the Server or Producer timestamps to use to generate the images.
ImageGenerationConfiguration	withSamplingInterval(Integer samplingInterval) The time interval in milliseconds (ms) at which the images need to be generated from the stream.
ImageGenerationConfiguration	withStatus(ConfigurationStatus status) Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.
ImageGenerationConfiguration	withStatus(String status) Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.
ImageGenerationConfiguration	withWidthPixels(Integer widthPixels) The width of the output image that is used in conjunction with the HeightPixels parameter.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImageGenerationConfiguration

public ImageGenerationConfiguration()

Method Detail

setStatus

public void setStatus(String status)

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

Parameters:

status - Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

See Also:

ConfigurationStatus

getStatus

public String getStatus()

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

Returns:

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

See Also:

ConfigurationStatus

withStatus

public ImageGenerationConfiguration withStatus(String status)

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

Parameters:

status - Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

Returns:

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

See Also:

ConfigurationStatus

withStatus

public ImageGenerationConfiguration withStatus(ConfigurationStatus status)

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

Parameters:

status - Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

Returns:

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

See Also:

ConfigurationStatus

setImageSelectorType

public void setImageSelectorType(String imageSelectorType)

The origin of the Server or Producer timestamps to use to generate the images.

Parameters:

imageSelectorType - The origin of the Server or Producer timestamps to use to generate the images.

See Also:

ImageSelectorType

getImageSelectorType

public String getImageSelectorType()

The origin of the Server or Producer timestamps to use to generate the images.

Returns:

The origin of the Server or Producer timestamps to use to generate the images.

See Also:

ImageSelectorType

withImageSelectorType

public ImageGenerationConfiguration withImageSelectorType(String imageSelectorType)

The origin of the Server or Producer timestamps to use to generate the images.

Parameters:

imageSelectorType - The origin of the Server or Producer timestamps to use to generate the images.

Returns:

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

See Also:

ImageSelectorType

withImageSelectorType

public ImageGenerationConfiguration withImageSelectorType(ImageSelectorType imageSelectorType)

The origin of the Server or Producer timestamps to use to generate the images.

Parameters:

imageSelectorType - The origin of the Server or Producer timestamps to use to generate the images.

Returns:

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

See Also:

ImageSelectorType

setDestinationConfig

public void setDestinationConfig(ImageGenerationDestinationConfig destinationConfig)

The structure that contains the information required to deliver images to a customer.

Parameters:

destinationConfig - The structure that contains the information required to deliver images to a customer.

getDestinationConfig

public ImageGenerationDestinationConfig getDestinationConfig()

The structure that contains the information required to deliver images to a customer.

Returns:

The structure that contains the information required to deliver images to a customer.

withDestinationConfig

public ImageGenerationConfiguration withDestinationConfig(ImageGenerationDestinationConfig destinationConfig)

The structure that contains the information required to deliver images to a customer.

Parameters:

destinationConfig - The structure that contains the information required to deliver images to a customer.

Returns:

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

setSamplingInterval

public void setSamplingInterval(Integer samplingInterval)

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

Parameters:

samplingInterval - The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

getSamplingInterval

public Integer getSamplingInterval()

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

Returns:

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

withSamplingInterval

public ImageGenerationConfiguration withSamplingInterval(Integer samplingInterval)

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

Parameters:

samplingInterval - The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

Returns:

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

setFormat

public void setFormat(String format)

The accepted image format.

Parameters:

format - The accepted image format.

See Also:

Format

getFormat

public String getFormat()

The accepted image format.

Returns:

The accepted image format.

See Also:

Format

withFormat

public ImageGenerationConfiguration withFormat(String format)

The accepted image format.

Parameters:

format - The accepted image format.

Returns:

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

See Also:

Format

withFormat

public ImageGenerationConfiguration withFormat(Format format)

The accepted image format.

Parameters:

format - The accepted image format.

Returns:

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

See Also:

Format

getFormatConfig

public Map<String,String> getFormatConfig()

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

Returns:

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

setFormatConfig

public void setFormatConfig(Map<String,String> formatConfig)

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

Parameters:

formatConfig - The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

withFormatConfig

public ImageGenerationConfiguration withFormatConfig(Map<String,String> formatConfig)

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

Parameters:

formatConfig - The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

Returns:

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

addFormatConfigEntry

public ImageGenerationConfiguration addFormatConfigEntry(String key,
                                                         String value)

Add a single FormatConfig entry

See Also:

withFormatConfig(java.util.Map<java.lang.String, java.lang.String>)

clearFormatConfigEntries

public ImageGenerationConfiguration clearFormatConfigEntries()

Removes all the entries added into FormatConfig.

Returns:

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

setWidthPixels

public void setWidthPixels(Integer widthPixels)

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

Parameters:

widthPixels - The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

getWidthPixels

public Integer getWidthPixels()

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

Returns:

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

withWidthPixels

public ImageGenerationConfiguration withWidthPixels(Integer widthPixels)

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

Parameters:

widthPixels - The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

Returns:

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

setHeightPixels

public void setHeightPixels(Integer heightPixels)

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

Parameters:

heightPixels - The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

getHeightPixels

public Integer getHeightPixels()

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

Returns:

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

withHeightPixels

public ImageGenerationConfiguration withHeightPixels(Integer heightPixels)

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

Parameters:

heightPixels - The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

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