RegionsOfInterestControl RegionsOfInterestControl RegionsOfInterestControl RegionsOfInterestControl Class

Definition

Namespace:
Windows.Media.Devices Windows.Media.Devices Windows.Media.Devices Windows.Media.Devices
Edit

Provides functionality to mange the regions of interest on a device.

public : sealed class RegionsOfInterestControl : IRegionsOfInterestControlpublic sealed class RegionsOfInterestControl : IRegionsOfInterestControlPublic NotInheritable Class RegionsOfInterestControl Implements IRegionsOfInterestControl// You can use this class in JavaScript.
Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute ThreadingAttribute
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The region of interest specifies the rectangular area of preview that functions such as focus and exposure are computed over. This enables scenarios such as tap to focus.

You can access the RegionsOfInterestControl for the capture device through the MediaCapture.VideoDeviceController.

For how-to guidance for using the RegionOfInterest object, see Effects for analyzing camera frames.

Properties

AutoExposureSupported AutoExposureSupported AutoExposureSupported AutoExposureSupported

Edit

Gets a value that specifies if auto exposure is supported on the capture device.

public : PlatForm::Boolean AutoExposureSupported { get; }public bool AutoExposureSupported { get; }Public ReadOnly Property AutoExposureSupported As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

true if auto exposure is supported; otherwise, false.

AutoFocusSupported AutoFocusSupported AutoFocusSupported AutoFocusSupported

Edit

Gets a value that specifies if auto focus is supported on the capture device.

public : PlatForm::Boolean AutoFocusSupported { get; }public bool AutoFocusSupported { get; }Public ReadOnly Property AutoFocusSupported As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

true if auto focus is supported; otherwise, false.

AutoWhiteBalanceSupported AutoWhiteBalanceSupported AutoWhiteBalanceSupported AutoWhiteBalanceSupported

Edit

Gets a value that specifies if auto white balance is supported on the capture device.

public : PlatForm::Boolean AutoWhiteBalanceSupported { get; }public bool AutoWhiteBalanceSupported { get; }Public ReadOnly Property AutoWhiteBalanceSupported As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

true if auto white balance is supported; otherwise, false.

MaxRegions MaxRegions MaxRegions MaxRegions

Edit

Gets the maximum number of regions of interest that can be specified.

public : unsigned int MaxRegions { get; }public uint MaxRegions { get; }Public ReadOnly Property MaxRegions As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The maximum number of regions of interest.

Methods

ClearRegionsAsync() ClearRegionsAsync() ClearRegionsAsync() ClearRegionsAsync()

Edit

Asynchronously clears the regions of interests.

public : IAsyncAction ClearRegionsAsync()public IAsyncAction ClearRegionsAsync()Public Function ClearRegionsAsync() As IAsyncAction// You can use this method in JavaScript.
Returns
IAsyncAction IAsyncAction IAsyncAction IAsyncAction

The object that is used to control the asynchronous operation.

SetRegionsAsync(IIterable) SetRegionsAsync(IIterable) SetRegionsAsync(IIterable) SetRegionsAsync(IIterable)

Edit

Asynchronously sets the regions of interest.

public : IAsyncAction SetRegionsAsync(IIterable<RegionOfInterest> regions)public IAsyncAction SetRegionsAsync(IEnumerable<RegionOfInterest> regions)Public Function SetRegionsAsync(regions As IEnumerable<RegionOfInterest>) As IAsyncAction// You can use this method in JavaScript.
Parameters
regions
IIterable<RegionOfInterest> IEnumerable<RegionOfInterest> IEnumerable<RegionOfInterest> IEnumerable<RegionOfInterest>

The regions of interest.

Returns
IAsyncAction IAsyncAction IAsyncAction IAsyncAction

The object that is used to control the asynchronous operation.

See Also
SetRegionsAsync(IIterable<RegionOfInterest>, Boolean)SetRegionsAsync(IIterable<RegionOfInterest>, Boolean)SetRegionsAsync(IIterable<RegionOfInterest>, Boolean)SetRegionsAsync(IIterable<RegionOfInterest>, Boolean)

SetRegionsAsync(IIterable, Boolean) SetRegionsAsync(IIterable, Boolean) SetRegionsAsync(IIterable, Boolean) SetRegionsAsync(IIterable, Boolean)

Edit

Asynchronously sets the regions of interest and specifies if the values should be locked.

public : IAsyncAction SetRegionsAsync(IIterable<RegionOfInterest> regions, bool lockValues)public IAsyncAction SetRegionsAsync(IEnumerable<RegionOfInterest> regions, Boolean lockValues)Public Function SetRegionsAsync(regions As IEnumerable<RegionOfInterest>, lockValues As Boolean) As IAsyncAction// You can use this method in JavaScript.
Parameters
regions
IIterable<RegionOfInterest> IEnumerable<RegionOfInterest> IEnumerable<RegionOfInterest> IEnumerable<RegionOfInterest>

The regions of interests.

lockValues
bool Boolean Boolean Boolean

Specifies if the values should be locked.

Returns
IAsyncAction IAsyncAction IAsyncAction IAsyncAction

The object that is used to control the asynchronous operation.

See Also
SetRegionsAsync(IIterable<RegionOfInterest>)SetRegionsAsync(IIterable<RegionOfInterest>)SetRegionsAsync(IIterable<RegionOfInterest>)SetRegionsAsync(IIterable<RegionOfInterest>)

See Also