Class: Aws::KinesisVideoArchivedMedia::Types::Image

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

Overview

A structure that contains the ‘Timestamp`, `Error`, and `ImageContent`.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#error ⇒ String

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

  • There is no media that exists for the specified ‘Timestamp`.

^ ^

  • The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

^

Returns:

  • (String) 


1054
1055
1056
1057
1058
1059
1060
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 1054

class Image < Struct.new(
  :time_stamp,
  :error,
  :image_content)
  SENSITIVE = []
  include Aws::Structure
end

#image_content ⇒ String

An attribute of the ‘Image` object that is Base64 encoded.

Returns:

  • (String) 


1054
1055
1056
1057
1058
1059
1060
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 1054

class Image < Struct.new(
  :time_stamp,
  :error,
  :image_content)
  SENSITIVE = []
  include Aws::Structure
end

#time_stamp ⇒ Time

An attribute of the ‘Image` object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

Returns:

  • (Time) 


1054
1055
1056
1057
1058
1059
1060
 
# File 'lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 1054

class Image < Struct.new(
  :time_stamp,
  :error,
  :image_content)
  SENSITIVE = []
  include Aws::Structure
end