Contents

previewPhotoFormat

A dictionary describing the format for delivery of preview-sized images alongside the main photo.

Declaration

var previewPhotoFormat: [String : Any]? { get set }

Mentioned in

Discussion

By default, this property is nil, specifying that the photo output should return only the main image requested. To also receive a preview-sized image, set this property to a dictionary describing the format for that image, containing the following keys and values:

The dictionary must contain the kCVPixelBufferPixelFormatTypeKey key, whose corresponding value must be one of the pixel format types listed in the availablePreviewPhotoPixelFormatTypes array.

Optionally, you can also include the kCVPixelBufferWidthKey and kCVPixelBufferHeightKey keys to specify the size of the preview image. (If you specify either width or height, you must specify both.) If the size you specify does not match the aspect ratio of the primary photo, the photo output provides a preview image whose size matches the longer of the two specified dimensions, preserving the original aspect ratio.

See Also

Enabling preview and thumbnail delivery