Skip to content

Image

Source code in docs_src/capo_kinesis_video_archived_media/types/image.py 
13
14
15
16
17
18
19
20
21
22
23
class Image(TypedDict, closed=True):
    time_stamp: NotRequired[
        "capo_kinesis_video_archived_media.types.timestamp.Timestamp"
    ]
    """<p>An attribute of the <code>Image</code> 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.</p>"""
    error: NotRequired["capo_kinesis_video_archived_media.types.image_error.ImageError"]
    """<p>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: </p> <ul> <li> <p>There is no media that exists for the specified <code>Timestamp</code>.</p> </li> </ul> <ul> <li> <p>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.</p> </li> </ul>"""
    image_content: NotRequired[
        "capo_kinesis_video_archived_media.types.image_content.ImageContent"
    ]
    """<p>An attribute of the <code>Image</code> object that is Base64 encoded.</p>"""

error instance-attribute 

error: NotRequired[ImageError]

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.

image_content instance-attribute 

image_content: NotRequired[ImageContent]

An attribute of the Image object that is Base64 encoded.

time_stamp instance-attribute 

time_stamp: NotRequired[Timestamp]

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.