CaptureDevice Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Provides common properties for AudioCaptureDevice and VideoCaptureDevice.

Inheritance Hierarchy

System..::.Object
System.Windows..::.DependencyObject
System.Windows.Media..::.CaptureDevice
System.Windows.Media..::.AudioCaptureDevice
System.Windows.Media..::.VideoCaptureDevice

Namespace: System.Windows.Media
Assembly: System.Windows (in System.Windows.dll)

Syntax

Public Class CaptureDevice _
    Inherits DependencyObject
public class CaptureDevice : DependencyObject

The CaptureDevice type exposes the following members.

Properties

Name Description
Dispatcher Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
FriendlyName Gets the UI display name for the capture device.
IsDefaultDevice Gets a value that declares whether the capture device is the default device for its type (audio or video).

Top

Methods

Name Description
CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
GetAnimationBaseValue Returns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetType Gets the Type of the current instance. (Inherited from Object.)
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

Name Description
FriendlyNameProperty Identifies the FriendlyName dependency property.
IsDefaultDeviceProperty Identifies the IsDefaultDevice dependency property.

Top

Remarks

The properties of CaptureDevice are mainly used to determine how that device is represented in the Windows Phone configuration dialog box on the Webcam / Mic tab. Other properties that are more specific to working with captured data as part of a sink implementation are instead declared on either AudioCaptureDevice or VideoCaptureDevice.

Example scenarios for using CaptureDevice properties include prompting users to change either audio or video devices in their configuration UI. You might prompt the user to change settings if there are alternatives reported by GetAvailableAudioCaptureDevices or GetAvailableVideoCaptureDevices that would work, for cases where the current default device (GetDefaultAudioCaptureDevice, GetDefaultVideoCaptureDevice) is not supported. You can also display strings in the UI, for example, a button with localizable text "Capture video from * device" where * is the FriendlyName.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Platforms

Windows Phone

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Windows.Media Namespace

AudioCaptureDevice

VideoCaptureDevice

CaptureSource