VideoDeviceController VideoDeviceController VideoDeviceController VideoDeviceController VideoDeviceController Class

Definition

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

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Controls device settings on the camera.

public : sealed class VideoDeviceController : IAdvancedVideoCaptureDeviceController, IAdvancedVideoCaptureDeviceController2, IAdvancedVideoCaptureDeviceController3, IAdvancedVideoCaptureDeviceController4, IAdvancedVideoCaptureDeviceController5, IMediaDeviceController, IVideoDeviceController
struct winrt::Windows::Media::Devices::VideoDeviceController : IAdvancedVideoCaptureDeviceController, IAdvancedVideoCaptureDeviceController2, IAdvancedVideoCaptureDeviceController3, IAdvancedVideoCaptureDeviceController4, IAdvancedVideoCaptureDeviceController5, IMediaDeviceController, IVideoDeviceController
public sealed class VideoDeviceController : IAdvancedVideoCaptureDeviceController, IAdvancedVideoCaptureDeviceController2, IAdvancedVideoCaptureDeviceController3, IAdvancedVideoCaptureDeviceController4, IAdvancedVideoCaptureDeviceController5, IMediaDeviceController, IVideoDeviceController
Public NotInheritable Class VideoDeviceController Implements IAdvancedVideoCaptureDeviceController, IAdvancedVideoCaptureDeviceController2, IAdvancedVideoCaptureDeviceController3, IAdvancedVideoCaptureDeviceController4, IAdvancedVideoCaptureDeviceController5, IMediaDeviceController, IVideoDeviceController
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

To get an instance of this object, retrieve the MediaCapture.VideoDeviceController property.

Some drivers may require that the camera device preview to be in a running state before it can determine which controls are supported by the VideoDeviceController. If you check whether a certain control is supported by the VideoDeviceController before the preview stream is running, the control may be described as unsupported even though it is supported by the video device.

Note

: This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX) and Using Windows Runtime objects in a multithreaded environment (.NET).

Properties

AdvancedPhotoControl AdvancedPhotoControl AdvancedPhotoControl AdvancedPhotoControl AdvancedPhotoControl

Gets the advanced photo capture control for this video device.

BacklightCompensation BacklightCompensation BacklightCompensation BacklightCompensation BacklightCompensation

Gets a MediaDeviceControl object that can be used to get or set the whether back-light compensation is enabled on the camera.

Brightness Brightness Brightness Brightness Brightness

Gets a MediaDeviceControl object that can be used to get or set the brightness level on the camera.

Contrast Contrast Contrast Contrast Contrast

Gets a MediaDeviceControl object that can be used to get or set the contrast level on the camera.

DesiredOptimization DesiredOptimization DesiredOptimization DesiredOptimization DesiredOptimization

Gets or sets a value that indicates the optimizations the capture device should use to prioritize high quality picture, low latency, or low power consumption during video capture.

Exposure Exposure Exposure Exposure Exposure

Gets a MediaDeviceControl object that can be used to get or set the camera's exposure time.

ExposureCompensationControl ExposureCompensationControl ExposureCompensationControl ExposureCompensationControl ExposureCompensationControl

Gets the exposure compensation control for this video device.

ExposureControl ExposureControl ExposureControl ExposureControl ExposureControl

Gets the exposure control for this video device.

ExposurePriorityVideoControl ExposurePriorityVideoControl ExposurePriorityVideoControl ExposurePriorityVideoControl ExposurePriorityVideoControl

Gets the ExposurePriorityVideoControl associated with the VideoDeviceController.

FlashControl FlashControl FlashControl FlashControl FlashControl

Gets the flash control for this video device.

Focus Focus Focus Focus Focus

Gets a MediaDeviceControl object that can be used to get or set the camera's focus setting.

FocusControl FocusControl FocusControl FocusControl FocusControl

Gets the focus control for this video device.

HdrVideoControl HdrVideoControl HdrVideoControl HdrVideoControl HdrVideoControl

Gets the HdrVideoControl associated with the VideoDeviceController. This allows you to enable and disable High Dynamic Range (HDR) video capture mode on devices that support it.

Hue Hue Hue Hue Hue

Gets a MediaDeviceControl object that can be used to get or set the camera's hue setting.

Id Id Id Id Id

Gets a string containing the identifier for the video device controller.

IsoSpeedControl IsoSpeedControl IsoSpeedControl IsoSpeedControl IsoSpeedControl

Gets the ISO film speed control for this video device.

LowLagPhoto LowLagPhoto LowLagPhoto LowLagPhoto LowLagPhoto

Gets the low shutter lag photo control for this video device.

LowLagPhotoSequence LowLagPhotoSequence LowLagPhotoSequence LowLagPhotoSequence LowLagPhotoSequence

Gets the low shutter lag photo sequence control for this video device.

OpticalImageStabilizationControl OpticalImageStabilizationControl OpticalImageStabilizationControl OpticalImageStabilizationControl OpticalImageStabilizationControl

Gets the OpticalImageStabilizationControl associated with the VideoDeviceController.

Pan Pan Pan Pan Pan

Gets a MediaDeviceControl object that can be used to get or set the camera's pan setting.

PhotoConfirmationControl PhotoConfirmationControl PhotoConfirmationControl PhotoConfirmationControl PhotoConfirmationControl

Gets the photo confirmation control for this video device.

PrimaryUse PrimaryUse PrimaryUse PrimaryUse PrimaryUse

Gets or sets the primary use for the device.

RegionsOfInterestControl RegionsOfInterestControl RegionsOfInterestControl RegionsOfInterestControl RegionsOfInterestControl

Gets the regions of interest control for this video device.

Roll Roll Roll Roll Roll

Gets a MediaDeviceControl object that can be used to get or set the camera's roll setting.

SceneModeControl SceneModeControl SceneModeControl SceneModeControl SceneModeControl

Gets the scene mode control for this video device.

Tilt Tilt Tilt Tilt Tilt

Gets a MediaDeviceControl object that can be used to get or set the camera's tilt setting.

TorchControl TorchControl TorchControl TorchControl TorchControl

Gets the torch control for this video device.

VariablePhotoSequenceController VariablePhotoSequenceController VariablePhotoSequenceController VariablePhotoSequenceController VariablePhotoSequenceController

Gets the VariablePhotoSequenceController associated with the VideoDeviceController.

VideoTemporalDenoisingControl VideoTemporalDenoisingControl VideoTemporalDenoisingControl VideoTemporalDenoisingControl VideoTemporalDenoisingControl

Prerelease. Gets the VideoTemporalDenoisingControl associated with the VideoDeviceController. This allows you to enable and disable temporal denoising, which uses image data from adjacent frames to reduce the appearance of noise in captured video, on devices that support it.

WhiteBalance WhiteBalance WhiteBalance WhiteBalance WhiteBalance

Gets a MediaDeviceControl object that can be used to get or set the white balance on the camera.

WhiteBalanceControl WhiteBalanceControl WhiteBalanceControl WhiteBalanceControl WhiteBalanceControl

Gets the white balance control for this video device.

Zoom Zoom Zoom Zoom Zoom

Gets a MediaDeviceControl object that can be used to get or set the camera's zoom setting.

ZoomControl ZoomControl ZoomControl ZoomControl ZoomControl

Gets the ZoomControl associated with the VideoDeviceController.

Methods

GetAvailableMediaStreamProperties(MediaStreamType) GetAvailableMediaStreamProperties(MediaStreamType) GetAvailableMediaStreamProperties(MediaStreamType) GetAvailableMediaStreamProperties(MediaStreamType) GetAvailableMediaStreamProperties(MediaStreamType)

Gets a list of the supported encoding properties for the video device.

GetDeviceProperty(String) GetDeviceProperty(String) GetDeviceProperty(String) GetDeviceProperty(String) GetDeviceProperty(String)

Gets the value of the property with the specified ID from the capture device driver. You can use this method to query properties that are specific to a particular camera.

GetDevicePropertyByExtendedId(Byte[], IReference<UInt32>) GetDevicePropertyByExtendedId(Byte[], IReference<UInt32>) GetDevicePropertyByExtendedId(Byte[], IReference<UInt32>) GetDevicePropertyByExtendedId(Byte[], IReference<UInt32>) GetDevicePropertyByExtendedId(Byte[], IReference<UInt32>)

Gets the value of the property with the specified ID from the capture device driver, using an extended ID with custom header information and specifying the maximum buffer size required to store the result. You can use this method to query properties that are specific to a particular camera.

GetDevicePropertyById(String, IReference<UInt32>) GetDevicePropertyById(String, IReference<UInt32>) GetDevicePropertyById(String, IReference<UInt32>) GetDevicePropertyById(String, IReference<UInt32>) GetDevicePropertyById(String, IReference<UInt32>)

Gets a the value of the property from the capture device driver with the ID with custom header information. You can use this method to query properties that are specific to a particular camera.

GetMediaStreamProperties(MediaStreamType) GetMediaStreamProperties(MediaStreamType) GetMediaStreamProperties(MediaStreamType) GetMediaStreamProperties(MediaStreamType) GetMediaStreamProperties(MediaStreamType)

Gets the encoding properties for the specified media stream type for the video device.

SetDeviceProperty(String, Object) SetDeviceProperty(String, Object) SetDeviceProperty(String, Object) SetDeviceProperty(String, Object) SetDeviceProperty(String, Object)

Sets the value of the property with the specified ID on the capture device driver. You can use this method to set properties that are specific to a particular camera.

SetDevicePropertyByExtendedId(Byte[], Byte[]) SetDevicePropertyByExtendedId(Byte[], Byte[]) SetDevicePropertyByExtendedId(Byte[], Byte[]) SetDevicePropertyByExtendedId(Byte[], Byte[]) SetDevicePropertyByExtendedId(Byte[], Byte[])

Sets the value of the property with the specified ID from the capture device driver, using an extended ID with custom header information and and providing the value as a byte array.

SetDevicePropertyById(String, Object) SetDevicePropertyById(String, Object) SetDevicePropertyById(String, Object) SetDevicePropertyById(String, Object) SetDevicePropertyById(String, Object)

Sets the value of the property with the specified ID from the capture device driver, using an extended ID with custom header information and and providing the value as an object.

SetMediaStreamPropertiesAsync(MediaStreamType, IMediaEncodingProperties) SetMediaStreamPropertiesAsync(MediaStreamType, IMediaEncodingProperties) SetMediaStreamPropertiesAsync(MediaStreamType, IMediaEncodingProperties) SetMediaStreamPropertiesAsync(MediaStreamType, IMediaEncodingProperties) SetMediaStreamPropertiesAsync(MediaStreamType, IMediaEncodingProperties)

Sets the encoding properties asynchronously for the specified media stream type for the video device.

TryGetPowerlineFrequency(PowerlineFrequency) TryGetPowerlineFrequency(PowerlineFrequency) TryGetPowerlineFrequency(PowerlineFrequency) TryGetPowerlineFrequency(PowerlineFrequency) TryGetPowerlineFrequency(PowerlineFrequency)

Gets the local power line frequency.

TrySetPowerlineFrequency(PowerlineFrequency) TrySetPowerlineFrequency(PowerlineFrequency) TrySetPowerlineFrequency(PowerlineFrequency) TrySetPowerlineFrequency(PowerlineFrequency) TrySetPowerlineFrequency(PowerlineFrequency)

Sets the local power line frequency.