Framework

QuickLookThumbnailing

Generate thumbnails for common file types and add a Thumbnail Extension to your app to enable others to create thumbnails of your custom files.

Overview

You may want to create a miniature representation, or thumbnail, of a file and its contents to display within your app. The QuickLookThumbnailing framework provides an API to generate thumbnails using the QLThumbnailGenerator object. It can generate thumbnails for common file types, including:

  • Images

  • Live Photos

  • Text files

  • PDFs

  • Audio and video files

  • Augmented reality objects using the USDZ file format (iOS and iPadOS only)

Many apps use custom file types to persist their data. Finder and Spotlight on macOS, other features of the operating system, as well as other apps, often display a generic file icon instead of a thumbnail for these files. However, if an installed app implements a Thumbnail Extension that supports the custom file types, the operating system and other apps can leverage the extension to display rich thumbnails of the custom file types through the QLThumbnailGenerator object. Add a Thumbnail Extension to your app to provide rich thumbnails of your custom file types to your users throughout the operating system and third party apps.

Topics

Thumbnail Generation

Creating Quick Look Thumbnails to Preview Files in Your App

Generate thumbnails of images, text files, PDFs, audio files, videos, and more.

QLThumbnailGenerator

An object that generates thumbnail images based on provided requirements.

QLThumbnailGenerationRequest

A request to generate a thumbnail for a file.

QLThumbnailRepresentation

The representation of a thumbnail.

Thumbnails for Custom File Types

Providing Thumbnails of Your Custom File Types

Implement a Thumbnail Extension to allow the operating system and other apps to display thumbnails of your custom files.

QLThumbnailProvider

An abstract base class for creating thumbnails of custom file types.

QLFileThumbnailRequest

A request to generate a thumbnail for a custom file type.

QLThumbnailReply

The object that provides a thumbnail for a custom file type.

Error Information

QLThumbnailErrorDomain

The error domain of the QuickLookThumbnailing framework.

QLThumbnailError

Error codes that may be returned when generating a thumbnail.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software