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

FormatReader Members

The FormatReader 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 current operation.

(Inherited from SyncHandler.)
Public method CheckForSupport Overloaded.

Checks if the image can be loaded with this reader.

Protected method CheckOpened

Checks if the format reader is opened.

Public method Close

Closes format reader, and detaches it from previously opened file (or other media).

Public method Continue

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

(Inherited from SyncHandler.)
Public method Dispose

Releases all resources used by this FormatReader.

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

Returns an enumerator for the frames allowing the writer to be used in foreach blocks.

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

Returns a frame with specified index. This frame contains a bitmap and possible other details describing it.

Public method Lock

Locks the object.

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

Checks if the codec can read the specified file.

Protected method OnClose

Frees resources when the reader closes.

Protected method OnOpen

Called when the reader is opened.

Public method Open Overloaded.

Opens format reader on specified media.

Public method Pause

Pauses execution of the current operation.

(Inherited from SyncHandler.)
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 FrameCount

Returns number of frames in the format reader.

Public property IsFrameSeekable

Check whether the reader supports random access to frames.

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 read from.

Public property MimeType

Returns mime type of the format.

Public property Opened

Returns value that specifies whether the reader is opened.

Public property Priority

Gets/sets a priority for the auxilary thread.

(Inherited from SyncHandler.)
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