Class: Aws::KinesisVideoArchivedMedia::Types::GetImagesInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kinesisvideoarchivedmedia/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_timestamp ⇒ Time

The end timestamp for the range of images to be generated. If the time range between ‘StartTimestamp` and `EndTimestamp` is more than 300 seconds above `StartTimestamp`, you will receive an `IllegalArgumentException`.

Returns:

  • (Time) 


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 816

class GetImagesInput < Struct.new(
  :stream_name,
  :stream_arn,
  :image_selector_type,
  :start_timestamp,
  :end_timestamp,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

The format that will be used to encode the image.

Returns:

  • (String) 


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 816

class GetImagesInput < Struct.new(
  :stream_name,
  :stream_arn,
  :image_selector_type,
  :start_timestamp,
  :end_timestamp,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#format_config ⇒ Hash<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>) 


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 816

class GetImagesInput < Struct.new(
  :stream_name,
  :stream_arn,
  :image_selector_type,
  :start_timestamp,
  :end_timestamp,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#height_pixels ⇒ Integer

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) 


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 816

class GetImagesInput < Struct.new(
  :stream_name,
  :stream_arn,
  :image_selector_type,
  :start_timestamp,
  :end_timestamp,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#image_selector_type ⇒ String

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

Returns:

  • (String) 


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 816

class GetImagesInput < Struct.new(
  :stream_name,
  :stream_arn,
  :image_selector_type,
  :start_timestamp,
  :end_timestamp,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of images to be returned by the API.

<note markdown=“1”> The default limit is 25 images per API response. Providing a ‘MaxResults` greater than this value will result in a page size of

  1. Any additional results will be paginated.

</note>

Returns:

  • (Integer) 


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 816

class GetImagesInput < Struct.new(
  :stream_name,
  :stream_arn,
  :image_selector_type,
  :start_timestamp,
  :end_timestamp,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A token that specifies where to start paginating the next set of Images. This is the ‘GetImages:NextToken` from a previously truncated response.

Returns:

  • (String) 


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 816

class GetImagesInput < Struct.new(
  :stream_name,
  :stream_arn,
  :image_selector_type,
  :start_timestamp,
  :end_timestamp,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#sampling_interval ⇒ Integer

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 (5 images per second). If the timestamp range is less than the sampling interval, the image from the ‘startTimestamp` will be returned if available.

Returns:

  • (Integer) 


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 816

class GetImagesInput < Struct.new(
  :stream_name,
  :stream_arn,
  :image_selector_type,
  :start_timestamp,
  :end_timestamp,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_timestamp ⇒ Time

The starting point from which the images should be generated. This ‘StartTimestamp` must be within an inclusive range of timestamps for an image to be returned.

Returns:

  • (Time) 


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 816

class GetImagesInput < Struct.new(
  :stream_name,
  :stream_arn,
  :image_selector_type,
  :start_timestamp,
  :end_timestamp,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ String

The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the ‘StreamName` or the `StreamARN`.

Returns:

  • (String) 


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 816

class GetImagesInput < Struct.new(
  :stream_name,
  :stream_arn,
  :image_selector_type,
  :start_timestamp,
  :end_timestamp,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#stream_name ⇒ String

The name of the stream from which to retrieve the images. You must specify either the ‘StreamName` or the `StreamARN`.

Returns:

  • (String) 


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 816

class GetImagesInput < Struct.new(
  :stream_name,
  :stream_arn,
  :image_selector_type,
  :start_timestamp,
  :end_timestamp,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#width_pixels ⇒ Integer

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 or if only the `HeightPixels` is provided, a `ValidationException` will be thrown. If neither parameter is provided, the original image size from the stream will be returned.

Returns:

  • (Integer) 


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 816

class GetImagesInput < Struct.new(
  :stream_name,
  :stream_arn,
  :image_selector_type,
  :start_timestamp,
  :end_timestamp,
  :sampling_interval,
  :format,
  :format_config,
  :width_pixels,
  :height_pixels,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end