AVCapturePhotoOutput Class

Reference

Definition

Namespace:: AVFoundation

Assembly:: Xamarin.iOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides an interface for capturing still images, Live Photos, RAW capture, wide-gamut color, and bracketed images.

[Foundation.Register("AVCapturePhotoOutput", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.WatchOS, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.TvOS, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.MacOSX, ObjCRuntime.PlatformArchitecture.All, null)]
public class AVCapturePhotoOutput : AVFoundation.AVCaptureOutput

type AVCapturePhotoOutput = class
    inherit AVCaptureOutput

Inheritance: Object

NSObject

AVCaptureOutput
AVCapturePhotoOutput

Attributes: RegisterAttribute IntroducedAttribute UnavailableAttribute

Constructors

AVCapturePhotoOutput()	Default constructor, initializes a new instance of this class.
AVCapturePhotoOutput(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
AVCapturePhotoOutput(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AutoRedEyeReductionSupported
AvailableLivePhotoVideoCodecTypes	Gets the available codecs for live photos.
AvailablePhotoCodecTypes	Gets an array of strings that identifies the currently supported codecs for capture.
AvailablePhotoPixelFormatTypes	Gets an array of numbers that identifies the currently supported pixel formats for capture.
AvailableRawPhotoPixelFormatTypes	Gets an array of numbers that identifies the currently supported pixel formats for RAW capture.
CameraCalibrationDataDeliverySupported	Gets a Boolean value that tells whether the capture output can deliver calibration data.
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
Connections	Object connections for the output. (Inherited from AVCaptureOutput)
DebugDescription	A developer-meaningful description of this object. (Inherited from NSObject)
DepthDataDeliveryEnabled
DepthDataDeliverySupported
Description	Description of the object, the Objective-C version of ToString. (Inherited from NSObject)
DualCameraDualPhotoDeliveryEnabled	Gets or sets a Boolean value that tells if delivery of two formats for each capture is enabled.
DualCameraDualPhotoDeliverySupported	Gets a Boolean value that tells if delivery of two formats for each capture is supported.
DualCameraFusionSupported	Gets a value that tells whether the device can fuse two camera images to produce 1 higher quality image.
GetAvailablePhotoFileTypes
GetAvailableRawPhotoFileTypes
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IsDirectBinding	(Inherited from NSObject)
IsFlashScene	Gets a Boolean value that tells whether flash is needed for a shot.
IsHighResolutionCaptureEnabled	Gets or sets a Boolean value that controls whether high resolution capture is enabled.
IsLensStabilizationDuringBracketedCaptureSupported	Gets a Boolean value that tells whether stabilization is supported while capturing bracketed images.
IsLivePhotoAutoTrimmingEnabled	Gets or sets a Boolean value that controls whether to trim Live Photos to reduce movement.
IsLivePhotoCaptureEnabled	Gets or sets a Boolean value that controls whether Live Photo capture is enabled.
IsLivePhotoCaptureSupported	Gets a Boolean value that tells whether Live Photo capture is supported.
IsLivePhotoCaptureSuspended	Gets or sets a Boolean value that controls whether live photo capture is suspended.
IsProxy	(Inherited from NSObject)
IsStillImageStabilizationScene	Gets a Boolean value that tells whether the current scene requires stabilization.
IsStillImageStabilizationSupported	Gets a Boolean value that tells whether image stabilization is supported for still images.
MaxBracketedCapturePhotoCount	Gets the maximum number of image brackets supported for a bracketed image.
PhotoSettingsForSceneMonitoring	Gets or sets a settings object for controlling how flash and stabilization modes are detected by the photo output.
PortraitEffectsMatteDeliveryEnabled
PortraitEffectsMatteDeliverySupported
PreparedPhotoSettings	Gets the array of photo settings for which capture resources have been prepared.
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
Self	(Inherited from NSObject)
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
SupportedFlashModes	Gets the supported flash modes.
Zone	(Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (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()	Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)	Obsolete. (Inherited from NSObject)
BindingInfo(String)	Obsolete. (Inherited from NSObject)
BindingOptionDescriptions(String)	Obsolete. (Inherited from NSObject)
BindingValueClass(String)	Obsolete. (Inherited from NSObject)
CapturePhoto(AVCapturePhotoSettings, IAVCapturePhotoCaptureDelegate)	Captures a photo.
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(IntPtr)	Invoked to determine if this object implements the specified protocol. (Inherited from NSObject)
ConnectionFromMediaType(NSString)	Creates a AVCaptureConnection for the `avMediaType`. (Inherited from AVCaptureOutput)
Copy()	Performs a copy of the underlying Objective-C object. (Inherited from NSObject)
DangerousAutorelease()	(Inherited from NSObject)
DangerousRelease()	(Inherited from NSObject)
DangerousRetain()	(Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	Indicates that a change occurred on the specified key. (Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)	Releases the resources used by the NSObject object. (Inherited from NSObject)
DoesNotRecognizeSelector(Selector)	Indicates that this object does not recognize the specified selector. (Inherited from NSObject)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
ExposedBindings()	(Inherited from NSObject)
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])	Retrieves the values of the specified keys. (Inherited from NSObject)
GetDngPhotoDataRepresentation(CMSampleBuffer, CMSampleBuffer)	Returns DNG data for the captured RAW photo in `rawSampleBuffer`.
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetJpegPhotoDataRepresentation(CMSampleBuffer, CMSampleBuffer)	Returns a JPEG representation of the data in `previewPhotoSampleBuffer`.
GetMetadataOutputRectOfInterestForRect(CGRect)	Transforms a rectangle in the capture output's coordinate system into the coordinate system used for metadata. (Inherited from AVCaptureOutput)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeField(String)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
GetRectForMetadataOutputRectOfInterest(CGRect)	Transforms a rectangle in the coordinate system used for metadata into the capture output's coordinate system. (Inherited from AVCaptureOutput)
GetSupportedPhotoCodecTypesForFileType(String)
GetSupportedPhotoPixelFormatTypesForFileType(String)
GetSupportedRawPhotoPixelFormatTypesForFileType(String)
GetTransformedMetadataObject(AVMetadataObject, AVCaptureConnection)	Converts the visual properties of the `metadataObject` into the coordinate system of the capture output. (Inherited from AVCaptureOutput)
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
InitializeHandle(IntPtr)	(Inherited from NSObject)
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	Creates a mutable copy of the specified NSObject. (Inherited from NSObject)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	Invokes the selector on the current instance and if the `obj` is not null, it passes this as its single parameter. (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)
RemoveObserver(NSObject, NSString, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, NSString)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
SetNativeField(String, NSObject)	Obsolete. (Inherited from NSObject)
SetNilValueForKey(NSString)	Sets the value of the specified key to null. (Inherited from NSObject)
SetPreparedPhotoSettings(AVCapturePhotoSettings[], Action<Boolean,NSError>)	Prepares the photo capture output for future requests with the provided photo settings, and runs a completion handler when it is finished.
SetPreparedPhotoSettingsAsync(AVCapturePhotoSettings[])	Prepares the photo capture output for future requests with the provided photo settings, and runs a completion handler when it is finished.
SetValueForKey(NSObject, NSString)	Sets the value of the property specified by the key to the specified value. (Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	Sets the value of a property that can be reached using a keypath. (Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
Unbind(String)	Obsolete. (Inherited from NSObject)
ValueForKey(NSString)	Returns the value of the property associated with the specified key. (Inherited from NSObject)
ValueForKeyPath(NSString)	Returns the value of a property that can be reached using a keypath. (Inherited from NSObject)
ValueForUndefinedKey(NSString)	Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	Indicates that the value of the specified key is about to change. (Inherited from NSObject)

Extension Methods

GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.

Applies to

Share via