This documentation is for the old version. Go to the latest Graphics Mill docs

WMReader Class

This class is used to read frames from video files using Windows Media framework.

Namespace: Aurigma.GraphicsMill.Codecs
Assembly: Aurigma.GraphicsMill.Codecs.MediaProcessor (in Aurigma.GraphicsMill.Codecs.MediaProcessor.dll)


Visual Basic
Public NotInheritable Class WMReader _
	Inherits FormatReader _
	Implements IFrameEnumerator, IMediaProcessorMetadataReadSupport, ITimeReader


Windows Media is intended to work with the ASF, WMV, WMA and MP3 formats. Therefore, this framework is recommended to use when reading files of these types. Compared to other frameworks, Windows Media provides a better support of ID3 metadata. For the list of supported file formats, see the System Requirements section of the manual.

Video files are represented as a sequence of images which are called frames. The WMReader class allows extracting frames using the LoadFrame(Int32) method. Also, the reader object can be interpreted as a collection of frames, and therefore the frames can be enumerated using the foreach statement.

A WMReader object can be used not only to read video data, but also to extract some information about the opened file. For example, you can get:

In general the reader usage workflow should be as follows:

  1. Create a WMReader instance.
  2. Open the reader using the Open(String) method.

    You cannot get any data from the reader until you open it on some file.

  3. If necessary, read the Duration, Metadata and FramesPerSecond properties.
  4. Iterate through each frame in the reader using the LoadFrame(Int32) method. It will return a WMFrame class instance. To extract the image from the frame, use the GetBitmap(Bitmap) method.

    To get the total number of the frames in the reader, read the FrameCount property.


This example shows the general pattern of working with the reader.
Visual Basic
Private Sub WMReaderUsage(ByVal aPath As String)
    Dim aReader As WMReader = New WMReader(aPath)
    'Work with the reader
End Sub
private void WMReaderUsage(String aPath)
    WMReader aReader = new WMReader(aPath);
    //Work with the reader

Inheritance Hierarchy

Thread Safety

Static members of this type are safe for multi-threaded operations. Instance members of this type are safe for multi-threaded operations.

Object Model

See Also