VideoDeviceController VideoDeviceController VideoDeviceController VideoDeviceController Class

Gets the advanced photo capture control for this video device.

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

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

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

Remarks

If the value is 1, back-light compensation is enabled. If the value is 0, back-light compensation is disabled.

For more information on getting or setting this value, see MediaDeviceControl.

See Also

MediaDeviceControlMediaDeviceControlMediaDeviceControlMediaDeviceControl

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

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

Remarks

For NTSC sources, brightness is expressed in IRE units multiplied by 100. For non-NTSC sources, the units are arbitrary, with 0 representing blanking and 10000 representing pure white.

For more information on getting or setting this value, see MediaDeviceControl.

See Also

MediaDeviceControlMediaDeviceControlMediaDeviceControlMediaDeviceControl

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

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

Remarks

Contrast is specified as a gain factor multiplied by 100.

For more information on getting or setting this value, see MediaDeviceControl.

See Also

MediaDeviceControlMediaDeviceControlMediaDeviceControlMediaDeviceControl

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.

public : MediaCaptureOptimization DesiredOptimization { get; set; }public MediaCaptureOptimization DesiredOptimization { get; set; }Public ReadWrite Property DesiredOptimization As MediaCaptureOptimization// You can use this property in JavaScript.

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

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

Remarks

Exposure is specified in log base 2 seconds. For values less than zero, the exposure time is 1/(2ⁿ) seconds. For values of zero and above, the exposure time is 2ⁿ seconds.

For more information on getting or setting this value, see MediaDeviceControl.

See Also

MediaDeviceControlMediaDeviceControlMediaDeviceControlMediaDeviceControl

Gets the exposure compensation control for this video device.

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

Gets the exposure control for this video device.

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

Gets the ExposurePriorityVideoControl associated with the VideoDeviceController.

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

Gets the flash control for this video device.

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

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

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

Remarks

Focus is specified in millimeters.

For more information on getting or setting this value, see MediaDeviceControl.

See Also

MediaDeviceControlMediaDeviceControlMediaDeviceControlMediaDeviceControl

Gets the focus control for this video device.

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

Gets the HdrVideoControl associated with the VideoDeviceController.

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

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

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

Remarks

Hue is specified in degrees multiplied by 100.

For more information on getting or setting this value, see MediaDeviceControl.

See Also

MediaDeviceControlMediaDeviceControlMediaDeviceControlMediaDeviceControl

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

public : PlatForm::String Id { get; }public string Id { get; }Public ReadOnly Property Id As string// You can use this property in JavaScript.

Device family	Windows 10 Creators Update (introduced v10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v4)

Gets the ISO film speed control for this video device.

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

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

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

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

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

Gets the OpticalImageStabilizationControl associated with the VideoDeviceController.

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

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

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

Remarks

Pan is rotation around the base of the camera (the camera's Y axis). Pan is specified in degrees.

For more information on getting or setting this value, see MediaDeviceControl.

See Also

MediaDeviceControlMediaDeviceControlMediaDeviceControlMediaDeviceControl

Gets the photo confirmation control for this video device.

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

Gets or sets the primary use for the device.

public : CaptureUse PrimaryUse { get; set; }public CaptureUse PrimaryUse { get; set; }Public ReadWrite Property PrimaryUse As CaptureUse// You can use this property in JavaScript.

Remarks

This property enables device to make optimization based on the intended use for the device.

Gets the regions of interest control for this video device.

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

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

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

Remarks

Roll is rotation around the camera's image-viewing axis. Roll is specified in degrees.

For more information on getting or setting this value, see MediaDeviceControl.

See Also

MediaDeviceControlMediaDeviceControlMediaDeviceControlMediaDeviceControl

Gets the scene mode control for this video device.

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

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

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

Remarks

Tilt points the camera's imaging plane up or down. Tilt is specified in degrees.

For more information on getting or setting this value, see MediaDeviceControl.

See Also

MediaDeviceControlMediaDeviceControlMediaDeviceControlMediaDeviceControl

Gets the torch control for this video device.

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

Gets the VariablePhotoSequenceController associated with the VideoDeviceController.

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

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

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

Remarks

White balance is specified as a color temperature in degrees Kelvin.

For more information on getting or setting this value, see MediaDeviceControl.

See Also

MediaDeviceControlMediaDeviceControlMediaDeviceControlMediaDeviceControl

Gets the white balance control for this video device.

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

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

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

Remarks

Zoom is specified in millimeters.

For more information on getting or setting this value, see MediaDeviceControl.

See Also

MediaDeviceControlMediaDeviceControlMediaDeviceControlMediaDeviceControl

Gets the ZoomControl associated with the VideoDeviceController.

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

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

public : IVectorView<IMediaEncodingProperties> GetAvailableMediaStreamProperties(MediaStreamType mediaStreamType)public IReadOnlyList<IMediaEncodingProperties> GetAvailableMediaStreamProperties(MediaStreamType mediaStreamType)Public Function GetAvailableMediaStreamProperties(mediaStreamType As MediaStreamType) As IReadOnlyList( Of IMediaEncodingProperties )// You can use this method in JavaScript.

Remarks

The encoding properties returned from this method can either be of type VideoEncodingProperties or ImageEncodingProperties, regardless of the stream type you specify. For this reason, you must check the type of each returned IMediaEncodingProperties object and cast to the appropriate type before accessing the properties of the object. The article Set media encoding properties for MediaCapture provides the complete code for a helper class that handles all necessary type-checking and casting for you.

See Also

Set media encoding properties for MediaCapture

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.

public : PlatForm::Object GetDeviceProperty(PlatForm::String propertyId)public object GetDeviceProperty(String propertyId)Public Function GetDeviceProperty(propertyId As String) As object// You can use this method in JavaScript.

See Also

VideoDeviceControllerVideoDeviceControllerVideoDeviceControllerVideoDeviceController

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.

public : VideoDeviceControllerGetDevicePropertyResult GetDevicePropertyByExtendedId(Byte[] extendedPropertyId, IReference<unsigned int> maxPropertyValueSize)public VideoDeviceControllerGetDevicePropertyResult GetDevicePropertyByExtendedId(Byte[] extendedPropertyId, Nullable<UInt32> maxPropertyValueSize)Public Function GetDevicePropertyByExtendedId(extendedPropertyId As Byte[], maxPropertyValueSize As Nullable<UInt32>) As VideoDeviceControllerGetDevicePropertyResult// You can use this method in JavaScript.

Device family	Windows 10 Creators Update (introduced v10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v4)

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.

public : VideoDeviceControllerGetDevicePropertyResult GetDevicePropertyById(PlatForm::String propertyId, IReference<unsigned int> maxPropertyValueSize)public VideoDeviceControllerGetDevicePropertyResult GetDevicePropertyById(String propertyId, Nullable<UInt32> maxPropertyValueSize)Public Function GetDevicePropertyById(propertyId As String, maxPropertyValueSize As Nullable<UInt32>) As VideoDeviceControllerGetDevicePropertyResult// You can use this method in JavaScript.

Device family	Windows 10 Creators Update (introduced v10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v4)

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

public : IMediaEncodingProperties GetMediaStreamProperties(MediaStreamType mediaStreamType)public IMediaEncodingProperties GetMediaStreamProperties(MediaStreamType mediaStreamType)Public Function GetMediaStreamProperties(mediaStreamType As MediaStreamType) As IMediaEncodingProperties// You can use this method in JavaScript.

Remarks

The encoding properties returned from this method can either be of type VideoEncodingProperties or ImageEncodingProperties, regardless of the stream type you specify. For this reason, you must check the type of each returned IMediaEncodingProperties object and cast to the appropriate type before accessing the properties of the object. The article Set media encoding properties for MediaCapture provides the complete code for a helper class that handles all necessary type-checking and casting for you.

See Also

Set media encoding properties for MediaCapture

Camera resolution sample (Windows 10)

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.

public : void SetDeviceProperty(PlatForm::String propertyId, PlatForm::Object propertyValue)public void SetDeviceProperty(String propertyId, Object propertyValue)Public Function SetDeviceProperty(propertyId As String, propertyValue As Object) As void// You can use this method in JavaScript.

See Also

VideoDeviceControllerVideoDeviceControllerVideoDeviceControllerVideoDeviceController

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.

public : VideoDeviceControllerSetDevicePropertyStatus SetDevicePropertyByExtendedId(Byte[] extendedPropertyId, Byte[] propertyValue)public VideoDeviceControllerSetDevicePropertyStatus SetDevicePropertyByExtendedId(Byte[] extendedPropertyId, Byte[] propertyValue)Public Function SetDevicePropertyByExtendedId(extendedPropertyId As Byte[], propertyValue As Byte[]) As VideoDeviceControllerSetDevicePropertyStatus// You can use this method in JavaScript.

Device family	Windows 10 Creators Update (introduced v10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v4)

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.

public : VideoDeviceControllerSetDevicePropertyStatus SetDevicePropertyById(PlatForm::String propertyId, PlatForm::Object propertyValue)public VideoDeviceControllerSetDevicePropertyStatus SetDevicePropertyById(String propertyId, Object propertyValue)Public Function SetDevicePropertyById(propertyId As String, propertyValue As Object) As VideoDeviceControllerSetDevicePropertyStatus// You can use this method in JavaScript.

Device family	Windows 10 Creators Update (introduced v10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v4)

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

public : IAsyncAction SetMediaStreamPropertiesAsync(MediaStreamType mediaStreamType, IMediaEncodingProperties mediaEncodingProperties)public IAsyncAction SetMediaStreamPropertiesAsync(MediaStreamType mediaStreamType, IMediaEncodingProperties mediaEncodingProperties)Public Function SetMediaStreamPropertiesAsync(mediaStreamType As MediaStreamType, mediaEncodingProperties As IMediaEncodingProperties) As IAsyncAction// You can use this method in JavaScript.

Remarks

This method sets the properties on the media source, which is the video capture device. This is unlike MediaCapture.SetEncodingPropertiesAsync, which changes the properties of the media encoding. For this reason, with SetMediaStreamPropertiesAsync you can only set properties and values that are supported natively by the capture device. Get a list of a capture device's supported resolutions, frame rates, and other properties by calling GetAvailableMediaStreamProperties. The benefit of setting the capture device properties instead of the media encoding is that the device only needs to generate enough data for the specified resolution, which can provide better performance than capturing at a high resolution and then downscaling at another point in the media capture pipeline. For more information, see Set format, resolution, and frame rate for MediaCapture and the Camera Resolution Sample.

See Also

Set format, resolution, and frame rate for MediaCapture

Camera Resolution Sample

Gets the local power line frequency.

public : PlatForm::Boolean TryGetPowerlineFrequency(PowerlineFrequency value)public bool TryGetPowerlineFrequency(PowerlineFrequency value)Public Function TryGetPowerlineFrequency(value As PowerlineFrequency) As bool// You can use this method in JavaScript.

Remarks

You can use this method if the camera supports anti-flicker processing for fluorescent lights.

For how-to guidance for handling powerline frequency, see Manual camera controls for photo and video capture.

See Also

Manual camera controls for photo and video capture

Sets the local power line frequency.

public : PlatForm::Boolean TrySetPowerlineFrequency(PowerlineFrequency value)public bool TrySetPowerlineFrequency(PowerlineFrequency value)Public Function TrySetPowerlineFrequency(value As PowerlineFrequency) As bool// You can use this method in JavaScript.

Remarks

You can use this method if the camera supports anti-flicker processing for fluorescent lights.

For how-to guidance for handling powerline frequency, see Manual camera controls for photo and video capture.

See Also

Manual camera controls for photo and video capture