VideoDeviceController.GetDevicePropertyById Method

Reference

Definition

Namespace:: Windows.Media.Devices

Important

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

Edit

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:
 virtual VideoDeviceControllerGetDevicePropertyResult ^ GetDevicePropertyById(Platform::String ^ propertyId, IReference<unsigned int> ^ maxPropertyValueSize) = GetDevicePropertyById;

VideoDeviceControllerGetDevicePropertyResult GetDevicePropertyById(winrt::hstring const& propertyId, IReference<uint32_t> const& maxPropertyValueSize);

public VideoDeviceControllerGetDevicePropertyResult GetDevicePropertyById(string propertyId, System.Nullable<uint> maxPropertyValueSize);

function getDevicePropertyById(propertyId, maxPropertyValueSize)

Public Function GetDevicePropertyById (propertyId As String, maxPropertyValueSize As Nullable(Of UInteger)) As VideoDeviceControllerGetDevicePropertyResult

Parameters

propertyId: String
Platform::String

winrt::hstring

The identifier of the property for which the value is retrieved.

maxPropertyValueSize: IReference<UInt32>

Nullable<UInt32>

Windows.Foundation.IReference<unsigned int>

IReference<uint32_t>

The size of the buffer that should be allocated to store the result of the operation. If the driver does not require that a size be specified for the returned property, set this value to null. If the size is required, and you do not provide a value, the Status property of the returned VideoDeviceControllerGetDevicePropertyResult object will be MaxPropertyValueSizeRequired. If the value supplied is too small to store the result of the operation, the returned Status object will be MaxPropertyValueSizeTooSmall, which means that you can retry the call with a larger buffer size.

Returns

VideoDeviceControllerGetDevicePropertyResult

A VideoDeviceControllerGetDevicePropertyResult object containing the status of the operation and, if successful, the returned property value.

Windows requirements

Device family	Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v4.0)

Remarks

Common device properties are exposed as properties of the VideoDeviceController class. Additional properties are defined in the KSPROPERTYSETID_ExtendedCameraControl property set. Legacy properties are defined in the PROPSETID_VIDCAP_CAMERACONTROL property set. For an example of accessing camera properties by ID, see the Extended Control and Metadata sample.

Applies to

Jaa