AVCaptureDevice Class

Definition

Namespace:

AVFoundation

Assembly:

Microsoft.iOS.dll

Support for accessing the audio and video capture hardware for AVCaptureSession.

[Foundation.Register("AVCaptureDevice", true)]
public class AVCaptureDevice : Foundation.NSObject

[<Foundation.Register("AVCaptureDevice", true)>]
type AVCaptureDevice = class
    inherit NSObject

Inheritance

Object

NSObject

AVCaptureDevice

Attributes

RegisterAttribute

Remarks

Once a capture session has begun, application developers must bracket configuration changes with calls to LockForConfiguration(NSError) and UnlockForConfiguration().

Constructors

Name	Description
AVCaptureDevice(NativeHandle)	A constructor used when creating managed representations of unmanaged objects. Called by the runtime.
AVCaptureDevice(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Name	Description
AccessibilityAttributedUserInputLabels	(Inherited from NSObject)
AccessibilityRespondsToUserInteraction	(Inherited from NSObject)
AccessibilityTextualContext	(Inherited from NSObject)
AccessibilityUserInputLabels	(Inherited from NSObject)
ActiveColorSpace
ActiveDepthDataFormat
ActiveDepthDataMinFrameDuration
ActiveExposureSignals	Gets the exposure signals currently influencing automatic exposure.
ActiveFormat
ActiveMaxExposureDuration
ActiveMicrophoneMode
ActivePrimaryConstituentDevice
ActivePrimaryConstituentDeviceRestrictedSwitchingBehaviorConditions
ActivePrimaryConstituentDeviceSwitchingBehavior
ActiveVideoMaxFrameDuration
ActiveVideoMinFrameDuration
AdjustingExposure	Whether the device is currently adjusting its exposure setting.
AdjustingFocus	Whether the device is currently adjusting its focus.
AdjustingSignalCompensationDelayWhileRunningSupported
AdjustingWhiteBalance	Whether the device is currently adjusting its white balance.
AutoExposureLensApertureRateLimit	Gets or sets the frame-to-frame aperture-area ratio limit used by automatic exposure.
AutoFocusRangeRestriction
AutoFocusRangeRestrictionSupported	Whether the device's autofocus can be restricted to specified ranges.
AutomaticallyAdjustsExposureDuration	Gets whether automatic exposure is currently allowed to adjust exposure duration.
AutomaticallyAdjustsFaceDrivenAutoExposureEnabled
AutomaticallyAdjustsFaceDrivenAutoFocusEnabled
AutomaticallyAdjustsISO	Gets whether automatic exposure is currently allowed to adjust ISO.
AutomaticallyAdjustsLensAperture	Gets whether automatic exposure is currently allowed to adjust lens aperture.
AutomaticallyAdjustsVideoHdrEnabled
AutomaticallyEnablesExposureSignals	Gets or sets whether the device automatically chooses which exposure signals to enable.
AutomaticallyEnablesLowLightBoostWhenAvailable
AutoVideoFrameRateEnabled
AvailableReactionTypes
BackgroundReplacementActive
BackgroundReplacementEnabled
CameraLensSmudgeDetectionEnabled
CameraLensSmudgeDetectionInterval
CameraLensSmudgeDetectionStatus
CanPerformReactionEffects
CenterStageActive
CenterStageControlMode
CenterStageEnabled
CenterStageRectOfInterest
CinematicVideoCaptureSceneMonitoringStatuses
Class	(Inherited from NSObject)
ClassHandle	The Objective-C class handle for this class.
CompanionDeskViewCamera
Connected	Whether the AVCaptureDevice is available for use.
ConstituentDevices
ContinuityCamera
ContinuousAutoFocusTrackingEnabled	Gets or sets whether continuous autofocus tracks a selected subject.
ContinuousAutoFocusTrackingLensPositionBias	Gets or sets the tracking lens-position bias, from -1 for the nearest part of a subject to 1 for the farthest.
ContinuousAutoFocusTrackingSubjectAcquired	Gets whether continuous autofocus tracking has acquired a subject.
DebugDescription	(Inherited from NSObject)
Description	(Inherited from NSObject)
Devices
DeviceType	Gets the AVCaptureDeviceType of the capturing device.
DeviceWhiteBalanceGains
DisplayVideoZoomFactorMultiplier
DualCameraSwitchOverVideoZoomFactor
DynamicAspectRatio
DynamicDimensions
EdgeLightActive
EdgeLightEnabled
EnabledExposureSignals	Gets or sets the enabled automatic exposure signals.
ExposureDuration
ExposureDurationAuto	Gets the sentinel that lets automatic exposure adjust the exposure duration.
ExposureDurationCurrent	Represents the value associated with the constant AVCaptureExposureDurationCurrent
ExposureMode
ExposurePointOfInterest
ExposurePointOfInterestSupported	Whether the device supports the ExposurePointOfInterest.
ExposureRectOfInterest
ExposureRectOfInterestSupported
ExposureTargetBias
ExposureTargetBiasCurrent	Represents the value associated with the constant AVCaptureExposureTargetBiasCurrent
ExposureTargetOffset
FaceDrivenAutoExposureEnabled
FaceDrivenAutoFocusEnabled
FallbackPrimaryConstituentDevices
FlashActive	Whether the flash will go off when a still is captured.
FlashAvailable	Whether the flash is available for use.
FlashMode
FocusMode
FocusModeLensPositionCurrent	Represents the value associated with the constant AVCaptureLensPositionCurrent
FocusPointOfInterest
FocusPointOfInterestSupported	Whether FocusPointOfInterest is available.
FocusRectOfInterest
FocusRectOfInterestSupported
FollowingExternalSyncDevice
Formats
GeometricDistortionCorrectionEnabled
GeometricDistortionCorrectionSupported
GlobalToneMappingEnabled
GrayWorldDeviceWhiteBalanceGains
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
HasFlash
HasTorch
IsDirectBinding	Gets or sets a value indicating whether this instance uses direct Objective-C binding. (Inherited from NSObject)
ISO
ISOAuto	Gets the sentinel that lets automatic exposure adjust ISO.
ISOCurrent	Represents the value associated with the constant AVCaptureISOCurrent
IsProxy	(Inherited from NSObject)
LensAperture
LensApertureAuto	Gets the sentinel that lets automatic exposure adjust the lens aperture.
LensApertureCurrent	Gets the sentinel that locks lens aperture at its current value.
LensPosition
LensPositionCurrent	Represents the value associated with the constant AVCaptureLensPositionCurrent
LocalizedName
LockingFocusWithCustomLensPositionSupported	Gets a Boolean value that tells whether the device can lock the focus to a specific position.
LockingWhiteBalanceWithCustomDeviceGainsSupported	Gets a Boolean value that tells whether the device can lock the white balance with custom device-specific gains.
LowLightBoostEnabled	Whether the low-light "boost mode" (ISO 3200) is enabled.
LowLightBoostSupported	Whether the device supports ISO 3200 "low-light boost mode".
Manufacturer
MaxAvailableTorchLevel	Represents the value associated with the constant AVCaptureMaxAvailableTorchLevel
MaxAvailableVideoZoomFactor
MaxExposureTargetBias
MaxWhiteBalanceGain
MinAvailableVideoZoomFactor
MinExposureRectOfInterestSize
MinExposureTargetBias
MinFocusRectOfInterestSize
MinimumFocusDistance
MinSupportedExternalSyncFrameDuration
MinSupportedLockedVideoFrameDuration
ModelID
NominalFocalLengthIn35mmFilm
PortraitEffectActive
PortraitEffectEnabled
Position
PreferredMicrophoneMode
PrimaryConstituentDeviceRestrictedSwitchingBehaviorConditions
PrimaryConstituentDeviceSwitchingBehavior
PrimaryConstituentDeviceSwitchingBehaviorLockedWithDeviceSupported	Gets whether primary constituent device switching can be locked to a specific device.
RampingVideoZoom	Whether a zoom transition is in progress.
ReactionEffectGesturesEnabled
ReactionEffectsEnabled
ReactionEffectsInProgress
RetainCount	(Inherited from NSObject)
Self	(Inherited from NSObject)
SmartFramingMonitor
SmoothAutoFocusEnabled	Whether autofocus should be slowed down,for instance, for video capture.
SmoothAutoFocusSupported	Whether autofocus can be slowed down.
SpatialCaptureDiscomfortReasons
StudioLightActive
StudioLightEnabled
SubjectAreaChangeMonitoringEnabled	Gets a Boolean value that tells whether the receiver should watch the video for lighting, movement, or etc.
SubjectAreaDidChangeNotification	Notification constant for SubjectAreaDidChange
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
SupportedExposureSignals	Gets the exposure signals supported by the device.
SupportedFallbackPrimaryConstituentDevices
Suspended
SystemPreferredCamera
SystemPressureState
TorchActive	Whether the torch / flashlight is active.
TorchAvailable	Whether the AVCaptureDevice has a torch / flashlight.
TorchLevel
TorchMode
UniqueID
UserPreferredCamera
VideoFrameDurationLocked
VideoHdrEnabled	Indicates if the device is currently streaming HDR video.
VideoZoomFactor
VirtualDevice
VirtualDeviceSwitchOverVideoZoomFactors
WasConnectedNotification	Notification constant for WasConnected
WasDisconnectedNotification	Notification constant for WasDisconnected
WeakActiveExposureSignals	Gets the native set of exposure signals currently influencing automatic exposure.
WeakCinematicVideoCaptureSceneMonitoringStatuses
WeakEnabledExposureSignals	Gets or sets the native set of enabled automatic exposure signals.
WeakSupportedExposureSignals	Gets the native set of exposure signals supported by the device.
WhiteBalanceGainsCurrent	Represents the value associated with the constant AVCaptureWhiteBalanceGainsCurrent
WhiteBalanceMode
Zone	(Inherited from NSObject)

Methods

Name	Description
AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AwakeFromNib()	(Inherited from NSObject)
BeginInvokeOnMainThread(Action)	Invokes the specified action asynchronously on the main UI thread. (Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchronously the specified code on the main UI thread. (Inherited from NSObject)
CancelVideoZoomRamp()
ConformsToProtocol(NativeHandle)	(Inherited from NSObject)
Copy()	(Inherited from NSObject)
DangerousAutorelease()	Calls the 'autorelease' selector on this object. (Inherited from NSObject)
DangerousRelease()	Calls the 'release' selector on this object. (Inherited from NSObject)
DangerousRetain()	Calls the 'retain' selector on this object. (Inherited from NSObject)
DevicesWithMediaType(String)
DeviceWithUniqueID(String)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	(Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)	Releases the resources used by this object.
DoesNotRecognizeSelector(Selector)	(Inherited from NSObject)
Equals(NSObject)	Determines whether the specified NSObject is equal to the current NSObject. (Inherited from NSObject)
Equals(Object)	Determines whether the specified object is equal to the current NSObject. (Inherited from NSObject)
GetAuthorizationStatus(AVAuthorizationMediaType)
GetAuthorizationStatus(NSString)
GetChromaticityValues(AVCaptureWhiteBalanceGains)
GetDefaultDevice(AVCaptureDeviceType, AVMediaTypes, AVCaptureDevicePosition)
GetDefaultDevice(AVCaptureDeviceType, String, AVCaptureDevicePosition)	Returns the default device for the provided device and media types and front or back facing position.
GetDefaultDevice(AVMediaTypes)	Returns the default device for the provided media type.
GetDefaultDevice(NSString)
GetDefaultRectForExposurePointOfInterest(CGPoint)
GetDefaultRectForFocusPointOfInterest(CGPoint)
GetDeviceWhiteBalanceGains(AVCaptureWhiteBalanceChromaticityValues)
GetDeviceWhiteBalanceGains(AVCaptureWhiteBalanceTemperatureAndTintValues)
GetDictionaryOfValuesFromKeys(NSString[])	(Inherited from NSObject)
GetExtrinsicMatrix(AVCaptureDevice, AVCaptureDevice)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
GetTemperatureAndTintValues(AVCaptureWhiteBalanceGains)
HasMediaType(AVMediaTypes)	Whether the device can provide the mediaType.
HasMediaType(String)
Init()	Initializes the object by calling the Objective-C init method. (Inherited from NSObject)
InitializeHandle(NativeHandle, String, Boolean)	Initializes the Handle property with the result of a native initializer. (Inherited from NSObject)
InitializeHandle(NativeHandle, String)	(Inherited from NSObject)
InitializeHandle(NativeHandle)	(Inherited from NSObject)
Invoke(Action, Double)	Invokes the specified action after the specified delay. (Inherited from NSObject)
Invoke(Action, TimeSpan)	Invokes the specified action after the specified delay. (Inherited from NSObject)
InvokeOnMainThread(Action)	Invokes the specified action synchronously on the main UI thread. (Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchronously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSObject)	(Inherited from NSObject)
IsExposureModeSupported(AVCaptureExposureMode)
IsFlashModeSupported(AVCaptureFlashMode)
IsFocusModeSupported(AVCaptureFocusMode)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
IsTorchModeSupported(AVCaptureTorchMode)
IsWhiteBalanceModeSupported(AVCaptureWhiteBalanceMode)
LockExposure(CMTime, Single, Action<CMTime>)
LockExposure(Single, CMTime, Single, Action<CMTime>)	Configures custom exposure using a lens aperture, exposure duration, and ISO.
LockExposureAsync(CMTime, Single)	Locks the exposure for the provided duration and ISO, and runs a completion handler when it is finished.
LockExposureAsync(Single, CMTime, Single)	Asynchronously configures custom exposure using a lens aperture, exposure duration, and ISO.
LockForConfiguration(NSError)
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	(Inherited from NSObject)
PerformEffect(String)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	(Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
RampToVideoZoom(NFloat, Single)
RemoveObserver(NSObject, NSString, IntPtr)	(Inherited from NSObject)
RemoveObserver(NSObject, NSString)	(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	(Inherited from NSObject)
RemoveObserver(NSObject, String)	(Inherited from NSObject)
RequestAccessForMediaType(AVAuthorizationMediaType, AVRequestAccessStatus)
RequestAccessForMediaType(NSString, AVRequestAccessStatus)
RequestAccessForMediaTypeAsync(AVAuthorizationMediaType)
RequestAccessForMediaTypeAsync(NSString)	Requests the application user's permission, if necessary, to capture the avMediaTypeToken.
RespondsToSelector(Selector)	(Inherited from NSObject)
SetCameraLensSmudgeDetectionEnabled(Boolean, CMTime)
SetCinematicVideoFixedFocus(CGPoint, AVCaptureCinematicVideoFocusMode)
SetCinematicVideoTrackingFocus(CGPoint, AVCaptureCinematicVideoFocusMode)
SetCinematicVideoTrackingFocus(IntPtr, AVCaptureCinematicVideoFocusMode)
SetDynamicAspectRatio(String, AVCaptureDeviceSetDynamicAspectRatioCallback)
SetDynamicAspectRatioAsync(String)
SetExposureTargetBias(Single, Action<CMTime>)
SetExposureTargetBiasAsync(Single)	Sets the exposure target bias (measured in Exposure Value units).
SetFocusModeLocked(Single, Action<CMTime>)
SetFocusModeLockedAsync(Single)	Locks the lens position at the specified position.
SetNilValueForKey(NSString)	(Inherited from NSObject)
SetPrimaryConstituentDeviceSwitchingBehavior(AVCapturePrimaryConstituentDeviceSwitchingBehavior, AVCapturePrimaryConstituentDeviceRestrictedSwitchingBehaviorConditions)
SetPrimaryConstituentDeviceSwitchingBehaviorLocked(AVCaptureDevice)	Locks primary constituent device switching to the specified constituent device.
SetTorchModeLevel(Single, NSError)
SetValueForKey(NSObject, NSString)	(Inherited from NSObject)
SetValueForKeyPath(NativeHandle, NSString)	Sets the value for the property identified by a given key path to a given value. (Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	(Inherited from NSObject)
SetWhiteBalanceModeLocked(AVCaptureWhiteBalanceTemperatureAndTintValue, Action<CMTime>)
SetWhiteBalanceModeLockedAsync(AVCaptureWhiteBalanceTemperatureAndTintValue)
SetWhiteBalanceModeLockedWithDeviceWhiteBalanceGains(AVCaptureWhiteBalanceGains, Action<CMTime>)
SetWhiteBalanceModeLockedWithDeviceWhiteBalanceGainsAsync(AVCaptureWhiteBalanceGains)	Locks the device's white balance to the provided device-specific gains.
ShowSystemUserInterface(AVCaptureSystemUserInterface)
SupportsAVCaptureSessionPreset(String)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
UnlockForConfiguration()
ValueForKey(NSString)	(Inherited from NSObject)
ValueForKeyPath(NSString)	(Inherited from NSObject)
ValueForUndefinedKey(NSString)	(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	(Inherited from NSObject)

Extension Methods

Name	Description
AccessibilityHitTest(NSObject, CGPoint, UIEvent)
BrowserAccessibilityDeleteTextAtCursor(NSObject, IntPtr)
BrowserAccessibilityInsertTextAtCursor(NSObject, String)
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.
GetAccessibilityLineEndPositionFromCurrentSelection(NSObject)
GetAccessibilityLineRangeForPosition(NSObject, IntPtr)
GetAccessibilityLineStartPositionFromCurrentSelection(NSObject)
GetAccessibilityNextTextNavigationElement(NSObject)
GetAccessibilityNextTextNavigationElementBlock(NSObject)
GetAccessibilityPreviousTextNavigationElement(NSObject)
GetAccessibilityPreviousTextNavigationElementBlock(NSObject)
GetAccessibilityTextInputResponder(NSObject)
GetAccessibilityTextInputResponderHandler(NSObject)
GetBrowserAccessibilityAttributedValue(NSObject, NSRange)
GetBrowserAccessibilityContainerType(NSObject)
GetBrowserAccessibilityCurrentStatus(NSObject)
GetBrowserAccessibilityDetailsElements(NSObject)
GetBrowserAccessibilityHasDomFocus(NSObject)
GetBrowserAccessibilityImageData(NSObject, NSDictionary)
GetBrowserAccessibilityImageDataSize(NSObject)
GetBrowserAccessibilityIsRequired(NSObject)
GetBrowserAccessibilityKeyboardShortcuts(NSObject)
GetBrowserAccessibilityOrientation(NSObject)
GetBrowserAccessibilityPressedState(NSObject)
GetBrowserAccessibilityRoleDescription(NSObject)
GetBrowserAccessibilitySelectedTextRange(NSObject)
GetBrowserAccessibilitySortDirection(NSObject)
GetBrowserAccessibilityValue(NSObject, NSRange)
GetDebugDescription(INSObjectProtocol)
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)
ProvideImageData(NSObject, IntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
ProvideImageToMTLTexture(NSObject, IMTLTexture, IMTLCommandBuffer, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.
SetAccessibilityNextTextNavigationElement(NSObject, NSObject)
SetAccessibilityNextTextNavigationElementBlock(NSObject, AXObjectReturnBlock)
SetAccessibilityPreviousTextNavigationElement(NSObject, NSObject)
SetAccessibilityPreviousTextNavigationElementBlock(NSObject, AXObjectReturnBlock)
SetAccessibilityTextInputResponder(NSObject, IUITextInput)
SetAccessibilityTextInputResponderHandler(NSObject, UITextInputReturnHandler)
SetBrowserAccessibilityContainerType(NSObject, BEAccessibilityContainerType)
SetBrowserAccessibilityCurrentStatus(NSObject, String)
SetBrowserAccessibilityDetailsElements(NSObject, NSObject[])
SetBrowserAccessibilityHasDomFocus(NSObject, Boolean)
SetBrowserAccessibilityIsRequired(NSObject, Boolean)
SetBrowserAccessibilityKeyboardShortcuts(NSObject, String)
SetBrowserAccessibilityOrientation(NSObject, BEAccessibilityOrientation)
SetBrowserAccessibilityPressedState(NSObject, BEAccessibilityPressedState)
SetBrowserAccessibilityRoleDescription(NSObject, String)
SetBrowserAccessibilitySelectedTextRange(NSObject, NSRange)
SetBrowserAccessibilitySortDirection(NSObject, String)
SetSharedObservers(NSObject, NSKeyValueSharedObserversSnapshot)

See also

• Apple documentation for AVCaptureDevice