AWSKinesisVideoArchivedMediaGetImagesInput

Objective-C

@interface AWSKinesisVideoArchivedMediaGetImagesInput

Swift

class AWSKinesisVideoArchivedMediaGetImagesInput

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable endTimestamp;

    Swift

    var endTimestamp: Date? { get set }

  • The format that will be used to encode the image.

    Declaration

    Objective-C

    @property (nonatomic) AWSKinesisVideoArchivedMediaFormat format;

    Swift

    var format: AWSKinesisVideoArchivedMediaFormat { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable formatConfig;

    Swift

    var formatConfig: [String : String]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable heightPixels;

    Swift

    var heightPixels: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSKinesisVideoArchivedMediaImageSelectorType imageSelectorType;

    Swift

    var imageSelectorType: AWSKinesisVideoArchivedMediaImageSelectorType { get set }

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

    The default limit is 25 images per API response. Providing a MaxResults greater than this value will result in a page size of 25. Any additional results will be paginated.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable maxResults;

    Swift

    var maxResults: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable nextToken;

    Swift

    var nextToken: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable samplingInterval;

    Swift

    var samplingInterval: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable startTimestamp;

    Swift

    var startTimestamp: Date? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable streamARN;

    Swift

    var streamARN: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable streamName;

    Swift

    var streamName: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable widthPixels;

    Swift

    var widthPixels: NSNumber? { get set }