Instance Property

embeddedThumbnailPhotoFormat

A dictionary describing the format for delivery of thumbnail images embedded in photo file output.

Declaration

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

Discussion

By default, this property is nil, specifying that the photo output should not embed thumbnail images in photo file output. To enable embedding, set this property to a dictionary describing the format for thumbnail images, containing the following keys and values:

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

  • Optionally, you can also include the AVVideoWidthKey and AVVideoHeightKey keys to specify the size of the thumbnail 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 thumbnail image whose size matches the longer of the two specified dimensions, preserving the original aspect ratio.

See Also

Enabling Preview and Thumbnail Delivery

var previewPhotoFormat: [String : Any]?

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

var availableRawEmbeddedThumbnailPhotoCodecTypes: [AVVideoCodecType]

An array of video codec types compatible with the photo settings for embedding raw thumbnail images in photo file output.

var rawEmbeddedThumbnailPhotoFormat: [String : Any]?

A dictionary describing the format for delivery of raw thumbnail images embedded in photo file output.

var availableEmbeddedThumbnailPhotoCodecTypes: [AVVideoCodecType]

An array of video codec types compatible with the photo settings for embedding thumbnail images in photo file output.

var availablePreviewPhotoPixelFormatTypes: [OSType]

An array of available kCVPixelBufferPixelFormatTypeKeys available to specify a preview photo format.