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

FormatWriter Methods

The FormatWriter type exposes the following members.


Name Description
Public method {dtor}

Enables using delete operator in C++ applications. It is strongly not recommended to use it directly.

Public method Abort

Aborts file writing operation.

(Overrides SyncHandler.Abort().)
Public method AddFrame

Appends specified frame to the end of file (or other media).

Public method Close

Closes format writer, flushes all unsaved data, and detaches the writer from previously opened file (or other media).

Public method Continue

Resumes execution of the operation previously paused with Pause() method.

(Overrides SyncHandler.Continue().)
Public method Dispose

Releases all resources used by this FormatWriter.

(Overrides SyncHandler.Dispose().)
Public method Equals (Inherited from Object.)
Public method ExportEncoderOptions Overloaded.

Exports all writer settings into the encoder options object.

Public method GetEmptyFrame

Returns Frame descendant class of the format supported with this writer.

Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method ImportEncoderOptions

Initialize the writer settings from the encoder options object.

Public method IsPixelFormatSupported

Returns whether this format writer can handle bitmaps with specified pixel format.

Public method Lock

Locks the object.

(Inherited from SyncHandler.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnAfterAddFrame

Called after the frame is added to the stream.

Protected method OnBeforeAddFrame

Called before the frame is added to the stream.

Protected method OnExportEncoderOptions

Exports encoder options.

Protected method OnImportEncoderOptions

Imports encoder options.

Public method Open Overloaded.

Opens format writer.

Public method Pause

Pauses execution of the file writing operation.

(Overrides SyncHandler.Pause().)
Public method ToString (Inherited from Object.)
Public method Unlock

Unlocks the object previously locked with method Lock().

(Inherited from SyncHandler.)
Public method WaitForCompletion

Suspends the calling thread until the operation currently run is completed.

(Inherited from SyncHandler.)

See Also