AVCaptureDeviceFormat Class Reference

Inherits from
Conforms to
Framework
/System/Library/Frameworks/AVFoundation.framework
Availability
Available in iOS 7.0 and later.
Declared in
AVCaptureDevice.h

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.

AVCaptureDeviceFormat objects are immutable.

Tasks

Inspecting Capture Format Attributes

Properties

formatDescription

An object describing the capture format. (read-only)

@property(nonatomic, readonly) CMFormatDescriptionRef formatDescription
Discussion

Calling this method does not assume ownership of the returned CMFormatDescriptionRef.

Availability
  • Available in iOS 7.0 and later.
Declared In
AVCaptureDevice.h

mediaType

A cosntant describing the media type of an AVCaptureDevice active or supported format. (read-only)

@property(nonatomic, readonly) NSString *mediaType
Discussion

Supported media types are listed in Media Types.

Availability
  • Available in iOS 7.0 and later.
Declared In
AVCaptureDevice.h

videoBinned

Indicates whether video data is produced in a binned format. (read-only)

@property(nonatomic, readonly, getter=isVideoBinned) BOOL videoBinned
Discussion

Binning is a pixel-combining process which can result in greater low light sensitivity at the cost of reduced resolution.

Availability
  • Available in iOS 7.0 and later.
Declared In
AVCaptureDevice.h

videoFieldOfView

Indicates the format’s horizontal field of view in degrees. (read-only)

@property(nonatomic, readonly) float videoFieldOfView
Discussion

Returns zero if the format’s field of view is unknown.

Availability
  • Available in iOS 7.0 and later.
Declared In
AVCaptureDevice.h

videoMaxZoomFactor

Indicates the maximum zoom factor allowed for the format. (read-only)

@property(nonatomic, readonly) CGFloat videoMaxZoomFactor
Discussion

A maximum factor of 1.0 indicates that the format is not capable of zooming.

For more on device zoom controls, see “Managing Zoom Settings” in AVCaptureDevice Class Reference.

Availability
  • Available in iOS 7.0 and later.
Declared In
AVCaptureDevice.h

videoStabilizationSupported

Indicates whether the device supports video stabilization. (read-only)

@property(nonatomic, readonly, getter=isVideoStabilizationSupported) BOOL videoStabilizationSupported
Discussion

If video stabilization is supported, you can enable it on an AVCaptureConnection instance.

Availability
  • Available in iOS 7.0 and later.
Declared In
AVCaptureDevice.h

videoSupportedFrameRateRanges

Indicates the format’s supported frame rate ranges. (read-only)

@property(nonatomic, readonly) NSArray *videoSupportedFrameRateRanges
Discussion

The value is an array of AVFrameRateRange objects, one for each of the format’s supported video frame rate ranges.

Availability
  • Available in iOS 7.0 and later.
Declared In
AVCaptureDevice.h

videoZoomFactorUpscaleThreshold

Indicates the zoom factor at which pixel data is upscaled. (read-only)

@property(nonatomic, readonly) CGFloat videoZoomFactorUpscaleThreshold
Discussion

The device achieves a zoom effect by cropping around the center of the image captured by the sensor. At low zoom factors, the cropped images is equal to or larger than the output size. At higher zoom factors, the device must scale the cropped image up to the output size, resulting in a loss of image quality. This property indicates the factors at which upscaling will occur.

For more on device zoom controls, see “Managing Zoom Settings” in AVCaptureDevice Class Reference.

Availability
  • Available in iOS 7.0 and later.
Declared In
AVCaptureDevice.h