MediaFrameSourceController.GetPropertyByExtendedIdAsync Method

Definition

Namespace:

Windows.Media.Capture.Frames

Asynchronously gets the value of the property with the specified ID from a MediaFrameSource, using an extended ID with custom header information and specifying the maximum buffer size required to store the result.

public:
 virtual IAsyncOperation<MediaFrameSourceGetPropertyResult ^> ^ GetPropertyByExtendedIdAsync(Platform::Array <byte> ^ extendedPropertyId, IReference<unsigned int> ^ maxPropertyValueSize) = GetPropertyByExtendedIdAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<MediaFrameSourceGetPropertyResult> GetPropertyByExtendedIdAsync(winrt::array_view <byte> const& extendedPropertyId, IReference<uint32_t> const& maxPropertyValueSize);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<MediaFrameSourceGetPropertyResult> GetPropertyByExtendedIdAsync(byte[] extendedPropertyId, System.Nullable<uint> maxPropertyValueSize);

function getPropertyByExtendedIdAsync(extendedPropertyId, maxPropertyValueSize)

Public Function GetPropertyByExtendedIdAsync (extendedPropertyId As Byte(), maxPropertyValueSize As Nullable(Of UInteger)) As IAsyncOperation(Of MediaFrameSourceGetPropertyResult)

Parameters

extendedPropertyId

Byte[]

byte[]

A byte array containing the extended identifier data.

maxPropertyValueSize

IReference<UInt32>

Nullable<UInt32>

Windows.Foundation.IReference

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

IAsyncOperation<MediaFrameSourceGetPropertyResult>

An asynchronous operation that, upon successful completion, returns a MediaFrameSourceGetPropertyResult object containing the status of the operation and, if successful, the returned property value.

Attributes

RemoteAsyncAttribute

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.