Class: Aws::KinesisVideo::Types::ImageGenerationConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb

Overview

Note:

When making an API call, you may pass ImageGenerationConfiguration data as a hash:

{
  status: "ENABLED", # required, accepts ENABLED, DISABLED
  image_selector_type: "SERVER_TIMESTAMP", # required, accepts SERVER_TIMESTAMP, PRODUCER_TIMESTAMP
  destination_config: { # required
    uri: "DestinationUri", # required
    destination_region: "DestinationRegion", # required
  },
  sampling_interval: 1, # required
  format: "JPEG", # required, accepts JPEG, PNG
  format_config: {
    "JPEGQuality" => "FormatConfigValue",
  },
  width_pixels: 1,
  height_pixels: 1,
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destination_configTypes::ImageGenerationDestinationConfig

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



731
732
733
734
735
736
737
738
739
740
741
742
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 731

class ImageGenerationConfiguration < Struct.new(
  :status,
  :image_selector_type,
  :destination_config,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels)
  SENSITIVE = []
  include Aws::Structure
end

#formatString

The accepted image format.

Returns:

  • (String)


731
732
733
734
735
736
737
738
739
740
741
742
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 731

class ImageGenerationConfiguration < Struct.new(
  :status,
  :image_selector_type,
  :destination_config,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels)
  SENSITIVE = []
  include Aws::Structure
end

#format_configHash<String,String>

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:

  • (Hash<String,String>)


731
732
733
734
735
736
737
738
739
740
741
742
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 731

class ImageGenerationConfiguration < Struct.new(
  :status,
  :image_selector_type,
  :destination_config,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels)
  SENSITIVE = []
  include Aws::Structure
end

#height_pixelsInteger

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:

  • (Integer)


731
732
733
734
735
736
737
738
739
740
741
742
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 731

class ImageGenerationConfiguration < Struct.new(
  :status,
  :image_selector_type,
  :destination_config,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels)
  SENSITIVE = []
  include Aws::Structure
end

#image_selector_typeString

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

Returns:

  • (String)


731
732
733
734
735
736
737
738
739
740
741
742
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 731

class ImageGenerationConfiguration < Struct.new(
  :status,
  :image_selector_type,
  :destination_config,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels)
  SENSITIVE = []
  include Aws::Structure
end

#sampling_intervalInteger

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:

  • (Integer)


731
732
733
734
735
736
737
738
739
740
741
742
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 731

class ImageGenerationConfiguration < Struct.new(
  :status,
  :image_selector_type,
  :destination_config,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

Returns:

  • (String)


731
732
733
734
735
736
737
738
739
740
741
742
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 731

class ImageGenerationConfiguration < Struct.new(
  :status,
  :image_selector_type,
  :destination_config,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels)
  SENSITIVE = []
  include Aws::Structure
end

#width_pixelsInteger

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:

  • (Integer)


731
732
733
734
735
736
737
738
739
740
741
742
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 731

class ImageGenerationConfiguration < Struct.new(
  :status,
  :image_selector_type,
  :destination_config,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels)
  SENSITIVE = []
  include Aws::Structure
end