RegionsOfInterestControl RegionsOfInterestControl RegionsOfInterestControl RegionsOfInterestControl Class

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

Syntax

Declaration

public sealed class RegionsOfInterestControlpublic sealed class RegionsOfInterestControlPublic NotInheritable Class RegionsOfInterestControlpublic sealed class RegionsOfInterestControl

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 VideoDeviceController.

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

Properties summary

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

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

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

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

Methods summary

Asynchronously clears the regions of interests.

Asynchronously sets the regions of interest.

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

Properties

  • AutoExposureSupported
    AutoExposureSupported
    AutoExposureSupported
    AutoExposureSupported

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

    public bool AutoExposureSupported { get; }public bool AutoExposureSupported { get; }Public ReadOnly Property AutoExposureSupported As boolpublic bool AutoExposureSupported { get; }

    Property Value

    • bool
      bool
      bool
      bool

      true if auto exposure is supported; otherwise, false.

  • AutoFocusSupported
    AutoFocusSupported
    AutoFocusSupported
    AutoFocusSupported

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

    public bool AutoFocusSupported { get; }public bool AutoFocusSupported { get; }Public ReadOnly Property AutoFocusSupported As boolpublic bool AutoFocusSupported { get; }

    Property Value

    • bool
      bool
      bool
      bool

      true if auto focus is supported; otherwise, false.

  • AutoWhiteBalanceSupported
    AutoWhiteBalanceSupported
    AutoWhiteBalanceSupported
    AutoWhiteBalanceSupported

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

    public bool AutoWhiteBalanceSupported { get; }public bool AutoWhiteBalanceSupported { get; }Public ReadOnly Property AutoWhiteBalanceSupported As boolpublic bool AutoWhiteBalanceSupported { get; }

    Property Value

    • bool
      bool
      bool
      bool

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

  • MaxRegions
    MaxRegions
    MaxRegions
    MaxRegions

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

    public uint MaxRegions { get; }public uint MaxRegions { get; }Public ReadOnly Property MaxRegions As uintpublic uint MaxRegions { get; }

    Property Value

    • uint
      uint
      uint
      uint

      The maximum number of regions of interest.

Methods

  • ClearRegionsAsync()
    ClearRegionsAsync()
    ClearRegionsAsync()
    ClearRegionsAsync()

    Asynchronously clears the regions of interests.

    public IAsyncAction ClearRegionsAsync()public IAsyncAction ClearRegionsAsync()Public Function ClearRegionsAsync() As IAsyncActionpublic IAsyncAction ClearRegionsAsync()

    Returns

  • SetRegionsAsync(IIterable<RegionOfInterest>)
    SetRegionsAsync(IIterable<RegionOfInterest>)
    SetRegionsAsync(IIterable<RegionOfInterest>)
    SetRegionsAsync(IIterable<RegionOfInterest>)

    Asynchronously sets the regions of interest.

    public IAsyncAction SetRegionsAsync(IIterable<RegionOfInterest> regions)public IAsyncAction SetRegionsAsync(IIterable<RegionOfInterest> regions)Public Function SetRegionsAsync(regions As IIterable<RegionOfInterest>) As IAsyncActionpublic IAsyncAction SetRegionsAsync(IIterable<RegionOfInterest> regions)

    Parameters

    • regions

      The regions of interest.

    Returns

  • SetRegionsAsync(IIterable<RegionOfInterest>, Boolean)
    SetRegionsAsync(IIterable<RegionOfInterest>, Boolean)
    SetRegionsAsync(IIterable<RegionOfInterest>, Boolean)
    SetRegionsAsync(IIterable<RegionOfInterest>, Boolean)

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

    public IAsyncAction SetRegionsAsync(IIterable<RegionOfInterest> regions, Boolean lockValues)public IAsyncAction SetRegionsAsync(IIterable<RegionOfInterest> regions, Boolean lockValues)Public Function SetRegionsAsync(regions As IIterable<RegionOfInterest>, lockValues As Boolean) As IAsyncActionpublic IAsyncAction SetRegionsAsync(IIterable<RegionOfInterest> regions, Boolean lockValues)

    Parameters

    • regions

      The regions of interests.

    • lockValues
      System.Boolean
      System.Boolean
      System.Boolean
      System.Boolean

      Specifies if the values should be locked.

    Returns

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.ThreadingAttribute

Details

Assembly

Windows.Media.Devices.dll