Article
11/18/2011

CaptureSource Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Provides methods that work with specific audio or video captures from the associated capture device.

Inheritance Hierarchy

System.Object
System.Windows.DependencyObject
System.Windows.Media.CaptureSource

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

Syntax

'Declaration
Public NotInheritable Class CaptureSource _
    Inherits DependencyObject

public sealed class CaptureSource : DependencyObject

The CaptureSource type exposes the following members.

Constructors

	Name	Description
	CaptureSource	Initializes a new instance of the CaptureSource class.

Top

Properties

	Name	Description
	AudioCaptureDevice	Gets or sets the associated audio capture device that is relevant to this capture.
	Dispatcher	Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
	State	Gets the CaptureState of this capture. State might indicate that the capture is still ongoing or has failed.
	VideoCaptureDevice	Gets or sets the associated video capture device that is relevant to this capture.

Top

Methods

	Name	Description
	CaptureImageAsync	Initiates an asynchronous image capture request. Retrieve the returned image by handling the CaptureImageCompleted event on this CaptureSource.
	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 Silverlight 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.)
	Start	Initiates capture from all capture devices that are relevant to this CaptureSource.
	Stop	Stops capture from all capture devices that are relevant to this CaptureSource.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	CaptureFailed	Occurs when a requested capture operation does not generate a captured sample.
	CaptureImageCompleted	Occurs when an asynchronous image capture request has returned a captured image.

Top

Fields

	Name	Description
	AudioCaptureDeviceProperty	Identifies the AudioCaptureDevice dependency property.
	VideoCaptureDeviceProperty	Identifies the VideoCaptureDevice dependency property.

Top

Remarks

By using CaptureSource APIs, you can enable the following scenarios:

Grab a video frame and convert it to a static image by calling CaptureImageAsync, and handling CaptureImageCompleted to obtain the result.
Capture a complete video into this CaptureSource by calling Start and Stop. Then use this CaptureSource as the value for SetSource to play back the video.

CaptureSource does not enable access to raw audio or video. To access this data, you must provide overrides for AudioSink.OnSamples or VideoSink.OnSample. You use Start and Stop for raw-format scenarios to start and stop the captures so that the sinks can process the resulting streams.

Version Notes

Silverlight for Windows Phone

To save video to a file, you can use the FileSink class.

In Windows Phone applications that use the CaptureSource class, you must also use the Microsoft.Devices.Camera, Microsoft.Devices.PhotoCamera, or Microsoft.Xna.Framework.Audio.Microphone class to enable audio capture and accurate capability detection in the application.

Version Information

Silverlight

Supported in: 5, 4

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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.

Share via