MediaFrameSourceController MediaFrameSourceController MediaFrameSourceController MediaFrameSourceController Class

Definition

Allows you to get and set properties of a MediaFrameSource and to get a VideoDeviceController, which provides camera controls such as exposure, focus, and zoom.

public : sealed class MediaFrameSourceController : IMediaFrameSourceController, IMediaFrameSourceController2public sealed class MediaFrameSourceController : IMediaFrameSourceController, IMediaFrameSourceController2Public NotInheritable Class MediaFrameSourceController Implements IMediaFrameSourceController, IMediaFrameSourceController2// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

Get an instance of the MediaFrameSourceController class by accessing the Controller property of a MediaFrameSource.

For how-to guidance on using MediaFrameSource to capture frames, see Process media frames with MediaFrameReader.

Properties

VideoDeviceController VideoDeviceController VideoDeviceController VideoDeviceController

Gets a VideoDeviceController for a MediaFrameSource, which provides camera controls such as exposure, focus, and zoom.

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

Methods

GetPropertyAsync(String) GetPropertyAsync(String) GetPropertyAsync(String) GetPropertyAsync(String)

Asynchronously gets an object that contains the value of a MediaFrameSource property, if the property value is successfully retrieved, and describes the result status of the get operation.

public : IAsyncOperation<MediaFrameSourceGetPropertyResult> GetPropertyAsync(PlatForm::String propertyId)public IAsyncOperation<MediaFrameSourceGetPropertyResult> GetPropertyAsync(String propertyId)Public Function GetPropertyAsync(propertyId As String) As IAsyncOperation( Of MediaFrameSourceGetPropertyResult )// You can use this method in JavaScript.
Parameters
propertyId
PlatForm::String String String String

The identifier of the media frame source property to be retrieved.

Returns

Remarks

To set the value of a media frame source property, use SetPropertyAsync.

GetPropertyByExtendedIdAsync(Byte[], IReference) GetPropertyByExtendedIdAsync(Byte[], IReference) GetPropertyByExtendedIdAsync(Byte[], IReference) GetPropertyByExtendedIdAsync(Byte[], IReference)

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 : IAsyncOperation<MediaFrameSourceGetPropertyResult> GetPropertyByExtendedIdAsync(Byte[] extendedPropertyId, IReference<unsigned int> maxPropertyValueSize)public IAsyncOperation<MediaFrameSourceGetPropertyResult> GetPropertyByExtendedIdAsync(Byte[] extendedPropertyId, Nullable<UInt32> maxPropertyValueSize)Public Function GetPropertyByExtendedIdAsync(extendedPropertyId As Byte[], maxPropertyValueSize As Nullable<UInt32>) As IAsyncOperation( Of MediaFrameSourceGetPropertyResult )// You can use this method in JavaScript.
Parameters
extendedPropertyId
Byte[] Byte[] Byte[] Byte[]

A byte array containing the extended identifier data.

maxPropertyValueSize
IReference<unsigned int> Nullable<UInt32> Nullable<UInt32> Nullable<UInt32>

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

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

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

SetPropertyAsync(String, Object) SetPropertyAsync(String, Object) SetPropertyAsync(String, Object) SetPropertyAsync(String, Object)

Asynchronously sets the value of a MediaFrameSource property and returns a MediaFrameSourceSetPropertyStatus object describing the result status of the set operation.

public : IAsyncOperation<MediaFrameSourceSetPropertyStatus> SetPropertyAsync(PlatForm::String propertyId, PlatForm::Object propertyValue)public IAsyncOperation<MediaFrameSourceSetPropertyStatus> SetPropertyAsync(String propertyId, Object propertyValue)Public Function SetPropertyAsync(propertyId As String, propertyValue As Object) As IAsyncOperation( Of MediaFrameSourceSetPropertyStatus )// You can use this method in JavaScript.
Parameters
propertyId
PlatForm::String String String String

The identifier of the media frame source property to be set.

propertyValue
PlatForm::Object Object Object Object

The value of the media frame source property to be set.

Returns

Remarks

To get the value of a media frame source property, use GetPropertyAsync.

SetPropertyByExtendedIdAsync(Byte[], Byte[]) SetPropertyByExtendedIdAsync(Byte[], Byte[]) SetPropertyByExtendedIdAsync(Byte[], Byte[]) SetPropertyByExtendedIdAsync(Byte[], Byte[])

Asynchronously sets the value of the property with the specified ID on a MediaFrameSource, using an extended ID with custom header information.

public : IAsyncOperation<MediaFrameSourceSetPropertyStatus> SetPropertyByExtendedIdAsync(Byte[] extendedPropertyId, Byte[] propertyValue)public IAsyncOperation<MediaFrameSourceSetPropertyStatus> SetPropertyByExtendedIdAsync(Byte[] extendedPropertyId, Byte[] propertyValue)Public Function SetPropertyByExtendedIdAsync(extendedPropertyId As Byte[], propertyValue As Byte[]) As IAsyncOperation( Of MediaFrameSourceSetPropertyStatus )// You can use this method in JavaScript.
Parameters
extendedPropertyId
Byte[] Byte[] Byte[] Byte[]

A byte array containing the extended identifier data.

propertyValue
Byte[] Byte[] Byte[] Byte[]

A byte array containing the value to be set for the property.

Returns
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

See Also