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

FormatWriter Members

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.)


Name Description
Public property CodecPriority

Returns the priority of the codec.

Public property Completed

Returns value indicating if the operation is currently running.

(Inherited from SyncHandler.)
Public property DefaultExtension

Returns default extension for this format.

Public property ExceptionThrowEnabled

Gets/sets value that specifies if to throw exception in synchronous mode.

(Inherited from SyncHandler.)
Public property FilterString

Returns filter string for this format.

Public property FormatDescription

Returns user-friendly format description.

Public property FormatName

Returns format name.

Public property Locked

Indicates if the object has been locked.

(Inherited from SyncHandler.)
Public property MediaFormat

Returns the ID of the media format this reader can write to.

Public property MimeType

Returns mime type of the format.

Public property Opened

Returns value that specifies if the writer is opened.

Public property Priority

Gets/sets a priority for the auxilary thread.

(Inherited from SyncHandler.)
Public property SupportedPixelFormats

Returns an array of pixel formats which are supported with this format writer.

Public property SynchronizationMode

Gets/sets synchronization mode for the object.

(Inherited from SyncHandler.)
Public property Timeout

Gets/sets value specifying maximum time for which object can be locked.

(Inherited from SyncHandler.)


Name Description
Public event Aborted

Fires when operation has been aborted.

(Inherited from SyncHandler.)
Public event Continued

Fires when operation has been resumed with Continue() method.

(Inherited from SyncHandler.)
Public event Paused

Fires when operation has been paused with Pause() method.

(Inherited from SyncHandler.)
Protected event Progress

Fires on the operation progress notifications.

(Inherited from SyncHandler.)
Public event Started

Fires after operation has been started.

(Inherited from SyncHandler.)
Public event Starting

Fires before operation is started.

(Inherited from SyncHandler.)
Public event Stopped

Fires after operation has been stopped.

(Inherited from SyncHandler.)
Public event Stopping

Fires before operation is stopped.

(Inherited from SyncHandler.)

See Also