ZoomControl
ZoomControl
ZoomControl
ZoomControl
Class
Definition
Provides functionality for controlling the zoom settings on a capture device.
public : sealed class ZoomControl : IZoomControl, IZoomControl2public sealed class ZoomControl : IZoomControl, IZoomControl2Public NotInheritable Class ZoomControl Implements IZoomControl, IZoomControl2// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
For how-to guidance for using the FocusControl, see Manual camera controls for photo and video capture.
Get an instance of this class by accessing the ZoomControl property.
Properties
Max Max Max Max
Gets the maximum zoom value supported by the capture device.
public : float Max { get; }public float Max { get; }Public ReadOnly Property Max As float// You can use this property in JavaScript.
- Value
- float float float float
The maximum zoom value supported by the capture device.
Min Min Min Min
Gets the minimum zoom value supported by the capture device.
public : float Min { get; }public float Min { get; }Public ReadOnly Property Min As float// You can use this property in JavaScript.
- Value
- float float float float
The minimum zoom value supported by the capture device.
Mode Mode Mode Mode
Gets a value indicating the current zoom transition mode.
public : ZoomTransitionMode Mode { get; }public ZoomTransitionMode Mode { get; }Public ReadOnly Property Mode As ZoomTransitionMode// You can use this property in JavaScript.
A value indicating the current zoom transition mode.
Remarks
Set the zoom transition mode by creating an instance of the ZoomSettings class and passing it into the Configure method.
Step Step Step Step
Gets the smallest zoom value increment supported by the capture device.
public : float Step { get; }public float Step { get; }Public ReadOnly Property Step As float// You can use this property in JavaScript.
- Value
- float float float float
The smallest zoom value increment supported by the capture device.
Supported Supported Supported Supported
Gets a value indicating whether zoom control is supported by the capture device.
public : PlatForm::Boolean Supported { get; }public bool Supported { get; }Public ReadOnly Property Supported As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
A value indicating whether zoom control is supported by the capture device.
SupportedModes SupportedModes SupportedModes SupportedModes
Gets the list of ZoomTransitionMode values indicating the modes supported by the capture device.
public : IVectorView<ZoomTransitionMode> SupportedModes { get; }public IReadOnlyList<ZoomTransitionMode> SupportedModes { get; }Public ReadOnly Property SupportedModes As IReadOnlyList<ZoomTransitionMode>// You can use this property in JavaScript.
- Value
- IVectorView<ZoomTransitionMode> IReadOnlyList<ZoomTransitionMode> IReadOnlyList<ZoomTransitionMode> IReadOnlyList<ZoomTransitionMode>
The list of supported ZoomTransitionMode values.
Value Value Value Value
Gets or sets the zoom value to be used by the capture device.
public : float Value { get; set; }public float Value { get; set; }Public ReadWrite Property Value As float// You can use this property in JavaScript.
- Value
- float float float float
The zoom value to be used by the capture device.
Methods
Configure(ZoomSettings) Configure(ZoomSettings) Configure(ZoomSettings) Configure(ZoomSettings)
Configures the zoom control with the provided zoom settings.
public : void Configure(ZoomSettings settings)public void Configure(ZoomSettings settings)Public Function Configure(settings As ZoomSettings) As void// You can use this method in JavaScript.
- settings
- ZoomSettings ZoomSettings ZoomSettings ZoomSettings
The zoom settings.