AWSKinesisVideoImageGenerationConfiguration

Objective-C

@interface AWSKinesisVideoImageGenerationConfiguration

Swift

class AWSKinesisVideoImageGenerationConfiguration

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

Required parameters: [Status, ImageSelectorType, DestinationConfig, SamplingInterval, Format]

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSKinesisVideoImageGenerationDestinationConfig *_Nullable destinationConfig;

    Swift

    var destinationConfig: AWSKinesisVideoImageGenerationDestinationConfig? { get set }

  • The accepted image format.

    Declaration

    Objective-C

    @property (nonatomic) AWSKinesisVideoFormat format;

    Swift

    var format: AWSKinesisVideoFormat { 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) AWSKinesisVideoImageSelectorType imageSelectorType;

    Swift

    var imageSelectorType: AWSKinesisVideoImageSelectorType { 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. 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 }

  • Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

    Declaration

    Objective-C

    @property (nonatomic) AWSKinesisVideoConfigurationStatus status;

    Swift

    var status: AWSKinesisVideoConfigurationStatus { 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, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

    Declaration

    Objective-C

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

    Swift

    var widthPixels: NSNumber? { get set }