software.amazon.awssdk.services.kinesisvideo.model

Interface ImageGenerationConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ImageGenerationConfiguration.Builder,ImageGenerationConfiguration>, SdkBuilder<ImageGenerationConfiguration.Builder,ImageGenerationConfiguration>, SdkPojo

Enclosing class:

ImageGenerationConfiguration

public static interface ImageGenerationConfiguration.Builder
extends SdkPojo, CopyableBuilder<ImageGenerationConfiguration.Builder,ImageGenerationConfiguration>

Method Summary

Modifier and Type	Method and Description
default ImageGenerationConfiguration.Builder	destinationConfig(Consumer<ImageGenerationDestinationConfig.Builder> destinationConfig) The structure that contains the information required to deliver images to a customer.
ImageGenerationConfiguration.Builder	destinationConfig(ImageGenerationDestinationConfig destinationConfig) The structure that contains the information required to deliver images to a customer.
ImageGenerationConfiguration.Builder	format(Format format) The accepted image format.
ImageGenerationConfiguration.Builder	format(String format) The accepted image format.
ImageGenerationConfiguration.Builder	formatConfig(Map<FormatConfigKey,String> formatConfig) The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated.
ImageGenerationConfiguration.Builder	formatConfigWithStrings(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.Builder	heightPixels(Integer heightPixels) The height of the output image that is used in conjunction with the WidthPixels parameter.
ImageGenerationConfiguration.Builder	imageSelectorType(ImageSelectorType imageSelectorType) The origin of the Server or Producer timestamps to use to generate the images.
ImageGenerationConfiguration.Builder	imageSelectorType(String imageSelectorType) The origin of the Server or Producer timestamps to use to generate the images.
ImageGenerationConfiguration.Builder	samplingInterval(Integer samplingInterval) The time interval in milliseconds (ms) at which the images need to be generated from the stream.
ImageGenerationConfiguration.Builder	status(ConfigurationStatus status) Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.
ImageGenerationConfiguration.Builder	status(String status) Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.
ImageGenerationConfiguration.Builder	widthPixels(Integer widthPixels) The width of the output image that is used in conjunction with the HeightPixels parameter.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

status

ImageGenerationConfiguration.Builder status(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, ConfigurationStatus

status

ImageGenerationConfiguration.Builder status(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, ConfigurationStatus

imageSelectorType

ImageGenerationConfiguration.Builder imageSelectorType(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, ImageSelectorType

imageSelectorType

ImageGenerationConfiguration.Builder imageSelectorType(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, ImageSelectorType

destinationConfig

ImageGenerationConfiguration.Builder destinationConfig(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.

destinationConfig

default ImageGenerationConfiguration.Builder destinationConfig(Consumer<ImageGenerationDestinationConfig.Builder> destinationConfig)

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

This is a convenience method that creates an instance of the ImageGenerationDestinationConfig.Builder avoiding the need to create one manually via ImageGenerationDestinationConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationConfig(ImageGenerationDestinationConfig).

Parameters:

destinationConfig - a consumer that will call methods on ImageGenerationDestinationConfig.Builder

Returns:

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

See Also:

destinationConfig(ImageGenerationDestinationConfig)

samplingInterval

ImageGenerationConfiguration.Builder samplingInterval(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 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 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 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 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.

format

ImageGenerationConfiguration.Builder format(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, Format

format

ImageGenerationConfiguration.Builder format(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, Format

formatConfigWithStrings

ImageGenerationConfiguration.Builder formatConfigWithStrings(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.

formatConfig

ImageGenerationConfiguration.Builder formatConfig(Map<FormatConfigKey,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.

widthPixels

ImageGenerationConfiguration.Builder widthPixels(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.

heightPixels

ImageGenerationConfiguration.Builder heightPixels(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.