FormatWriter Class

This is a base class for all format writers.

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

Syntax

Visual Basic

Public MustInherit Class FormatWriter _
	Inherits SyncHandler _
	Implements IFormatWriter, IPixelFormatSupport

C#

public abstract class FormatWriter : SyncHandler, IFormatWriter, 
	IPixelFormatSupport

Remarks

This class is derived by all format writers. It provides the follwoing base functionality:

Opening file or stream with appropriate overload of Open(String) method. To check whether the writer is already opened, use Opened property.
Writing frames (or one frame if only one is allowed) using AddFrame(IFrame) property.
Checking whether the bitmap with certain pixel format can be saved into this file format without conversion. Use IsPixelFormatSupported(PixelFormat) method and SupportedPixelFormats property for it.
Getting details about the format. Use FormatName, FormatDescription, MimeType, FilterString, DefaultExtension, and MediaFormat properties.

Typically you use this class (rather than its descendant) when you use CreateFormatWriter(String) method of the FormatManager class to get a format writer of proper type. It allows you to write the encoding code once for all formats you are going to save.

Inheritance Hierarchy

System..::.Object L Aurigma.GraphicsMill..::.SyncHandler L Aurigma.GraphicsMill.Codecs..::.FormatWriter L Aurigma.GraphicsMill.Codecs..::.AviWriter L Aurigma.GraphicsMill.Codecs..::.BmpWriter L Aurigma.GraphicsMill.Codecs..::.CustomFormatWriter L Aurigma.GraphicsMill.Codecs..::.JpegWriter L Aurigma.GraphicsMill.Codecs..::.GifWriter L Aurigma.GraphicsMill.Codecs..::.Jpeg2kWriter L Aurigma.GraphicsMill.Codecs..::.TiffWriter L Aurigma.GraphicsMill.Codecs..::.PngWriter L Aurigma.GraphicsMill.Codecs..::.WbmpWriter L Aurigma.GraphicsMill.Codecs..::.PdfWriter L Aurigma.GraphicsMill.Codecs..::.SwfWriter