FocusControl FocusControl FocusControl FocusControl Class

Gets a value that specifics if the capture device supports the FocusChanged event.

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

Gets a MediaCaptureFocusState value indicating the current focus state of the capture device.

public : MediaCaptureFocusState FocusState { get; }public MediaCaptureFocusState FocusState { get; }Public ReadOnly Property FocusState As MediaCaptureFocusState// You can use this property in JavaScript.

Gets the maximum focus length.

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

Gets the minimum focus length.

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

Gets the capture device's current focus mode.

public : FocusMode Mode { get; }public FocusMode Mode { get; }Public ReadOnly Property Mode As FocusMode// You can use this property in JavaScript.

Gets the focus preset.

public : FocusPreset Preset { get; }public FocusPreset Preset { get; }Public ReadOnly Property Preset As FocusPreset// You can use this property in JavaScript.

Gets the smallest focus increment supported by the capture device.

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

Gets a value that specifies if the capture device supports the focus control.

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

Remarks

If the device does not support the FocusControl, you can still use the Focus property on the VideoDeviceController to set the focus value.

Gets a list of values indicating the manual focus distances that are supported by the capture device.

public : IVectorView<ManualFocusDistance> SupportedFocusDistances { get; }public IReadOnlyList<ManualFocusDistance> SupportedFocusDistances { get; }Public ReadOnly Property SupportedFocusDistances As IReadOnlyList<ManualFocusDistance>// You can use this property in JavaScript.

Gets a list of values indicating the focus modes that are supported by the capture device.

public : IVectorView<FocusMode> SupportedFocusModes { get; }public IReadOnlyList<FocusMode> SupportedFocusModes { get; }Public ReadOnly Property SupportedFocusModes As IReadOnlyList<FocusMode>// You can use this property in JavaScript.

Gets a list of values indicating the auto focus ranges that are supported by the capture device.

public : IVectorView<AutoFocusRange> SupportedFocusRanges { get; }public IReadOnlyList<AutoFocusRange> SupportedFocusRanges { get; }Public ReadOnly Property SupportedFocusRanges As IReadOnlyList<AutoFocusRange>// You can use this property in JavaScript.

Gets the focus presets that the capture device supports.

public : IVectorView<FocusPreset> SupportedPresets { get; }public IReadOnlyList<FocusPreset> SupportedPresets { get; }Public ReadOnly Property SupportedPresets As IReadOnlyList<FocusPreset>// You can use this property in JavaScript.

Gets the current value that the focus is set to.

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

Remarks

To set a focus value, call SetValueAsync specifying a value between the Min and Max focus values.

See Also

MinMinMinMin

MaxMaxMaxMax

Gets a value that indicates whether WaitForFocus is supported by the capture device.

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

Configures the FocusControl object with values specified in the provided FocusSettings object.

public : void Configure(FocusSettings settings)public void Configure(FocusSettings settings)Public Function Configure(settings As FocusSettings) As void// You can use this method in JavaScript.

Remarks

Autofocus mode, enabled by using the FocusMode.Continuous value in the FocusSettings object supplied to this method, is only supported while the preview stream is running. Check to make sure that the preview stream is running before turning on continuous autofocus.

Asynchronously focuses the device.

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

Locks the capture device's focus.

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

Asynchronously sets the focus Preset.

public : IAsyncAction SetPresetAsync(FocusPreset preset)public IAsyncAction SetPresetAsync(FocusPreset preset)Public Function SetPresetAsync(preset As FocusPreset) As IAsyncAction// You can use this method in JavaScript.

See Also

SetPresetAsync(FocusPreset, Boolean)SetPresetAsync(FocusPreset, Boolean)SetPresetAsync(FocusPreset, Boolean)SetPresetAsync(FocusPreset, Boolean)

Asynchronously sets the focus Preset, specifying if the operation must complete before the device is focused.

public : IAsyncAction SetPresetAsync(FocusPreset preset, bool completeBeforeFocus)public IAsyncAction SetPresetAsync(FocusPreset preset, Boolean completeBeforeFocus)Public Function SetPresetAsync(preset As FocusPreset, completeBeforeFocus As Boolean) As IAsyncAction// You can use this method in JavaScript.

See Also

SetPresetAsync(FocusPreset)SetPresetAsync(FocusPreset)SetPresetAsync(FocusPreset)SetPresetAsync(FocusPreset)

Asynchronously sets the focus Value.

public : IAsyncAction SetValueAsync(unsigned int focus)public IAsyncAction SetValueAsync(UInt32 focus)Public Function SetValueAsync(focus As UInt32) As IAsyncAction// You can use this method in JavaScript.

See Also

MinMinMinMin

MaxMaxMaxMax

Unlocks the capture device's focus if it has previously been locked with a call to LockAsync.

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