Class

AVCaptureDeviceFormat

A set of media format and capture settings (such as video resolution and frame rate) that you use to configure a capture device.

Declaration

@interface AVCaptureDeviceFormat : NSObject

Overview

An AVCaptureDeviceFormat object provides information about a media capture format for use with an AVCaptureDevice instance, such as video frame rates and zoom factors.

You can find more information about a capture format using its associated Core Media format description (see CMFormatDescriptionRef), available using the formatDescription property. Instances of this class are immutable.

Topics

Determining Supported Media Formats

mediaType

A constant describing the media type of an AVCaptureDevice active or supported format.

formatDescription

An object describing the capture format.

supportedColorSpaces

The list of color spaces the format supports for image and video capture.

videoHDRSupported

A Boolean value that indicates whether the format supports high dynamic range streaming.

unsupportedCaptureOutputClasses

The list of AVCaptureOutput subclasses not allowed for capture with this format, if any.

highResolutionStillImageDimensions

The highest resolution still image that can be produced by this format.

Examining Focus and Exposure Attributes

minExposureDuration

A CMTime indicating the minimum supported exposure duration.

maxExposureDuration

A CMTime indicating the maximum supported exposure duration.

minISO

A floating point number indicating the minimum supported exposure ISO value.

maxISO

A floating point number indicating the maximum supported exposure ISO value.

AVCaptureAutoFocusSystem

Constants that describe the autofocus system.

autoFocusSystem

Returns the autofocus system.

Examining Zoom Attributes

videoFieldOfView

Indicates the format’s horizontal field of view in degrees.

videoMaxZoomFactor

Indicates the maximum zoom factor allowed for the format.

videoZoomFactorUpscaleThreshold

Indicates the zoom factor at which pixel data is upscaled.

Examining Video Capture Attributes

videoBinned

Indicates whether video data is produced in a binned format.

multiCamSupported

A Boolean value that indicates whether AVCaptureMultiCamSession supports this format.

Beta
highestPhotoQualitySupported

A Boolean value that indicates whether this format supports the highest photo quality that the platform can deliver.

Beta
AVFrameRateRange

An AVFrameRateRange object expresses a range of valid frame rates as minimum and maximum rate and minimum and maximum duration.

videoSupportedFrameRateRanges

Indicates the format’s supported frame rate ranges.

AVCaptureVideoStabilizationMode

Constants that describe the modes of video stabilization supported by the device's format.

- isVideoStabilizationModeSupported:

A Boolean value that indicates whether the format supports a given video stabilization mode.

geometricDistortionCorrectedVideoFieldOfView

The format’s horizontal field of view after correction for geometric distortion.

Beta
videoStabilizationSupported

Indicates whether the device supports video stabilization.

Deprecated
globalToneMappingSupported

A Boolean value that indicates whether the format supports global tone mapping.

Beta

Examining Depth Capture Attributes

supportedDepthDataFormats

The list of data formats compatible with this video format.

portraitEffectsMatteStillImageDeliverySupported

A Boolean indicating whether the device supports portrait matte effects in still-image capture.

videoMinZoomFactorForDepthDataDelivery

The minimum zoom factor supported when the device is configured for depth data delivery.

videoMaxZoomFactorForDepthDataDelivery

The maximum zoom factor supported when the device is configured for depth data delivery.

activeDepthDataMinFrameDuration

The minimum frame duration of depth data.

AVCaptureLensStabilizationStatus

Constants that indicate the status of optical image stabilization hardware during a bracketed photo capture.

Relationships

Inherits From

See Also

Managing Formats

formats

The capture formats supported by the device.

activeFormat

The currently active media data format of the capture device.

activeDepthDataFormat

The currently active depth data format of the capture device.

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