FormatWriter Members
The FormatWriter type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
{dtor} |
Enables using delete operator in C++ applications. It is strongly not recommended to use it directly. |
|
|
Abort |
Aborts file writing operation. (Overrides SyncHandler.Abort().) |
|
|
AddFrame |
Appends specified frame to the end of file (or other media). |
|
|
Close |
Closes format writer, flushes all unsaved data, and detaches the writer from previously opened file (or other media). |
|
|
Continue |
Resumes execution of the operation previously paused with Pause() method. (Overrides SyncHandler.Continue().) |
|
|
Dispose |
Releases all resources used by this FormatWriter. (Overrides SyncHandler.Dispose().) |
|
|
Equals | (Inherited from Object.) |
|
|
ExportEncoderOptions | Overloaded. Exports all writer settings into the encoder options object. |
|
|
GetEmptyFrame |
Returns Frame descendant class of the format supported with this writer. |
|
|
GetHashCode | (Inherited from Object.) |
|
|
GetType | (Inherited from Object.) |
|
|
ImportEncoderOptions |
Initialize the writer settings from the encoder options object. |
|
|
IsPixelFormatSupported |
Returns whether this format writer can handle bitmaps with specified pixel format. |
|
|
Lock |
Locks the object. (Inherited from SyncHandler.) |
|
MemberwiseClone | (Inherited from Object.) |
|
|
OnAfterAddFrame |
Called after the frame is added to the stream. |
|
|
OnBeforeAddFrame |
Called before the frame is added to the stream. |
|
|
OnExportEncoderOptions |
Exports encoder options. |
|
|
OnImportEncoderOptions |
Imports encoder options. |
|
|
Open | Overloaded. Opens format writer. |
|
|
Pause |
Pauses execution of the file writing operation. (Overrides SyncHandler.Pause().) |
|
|
ToString | (Inherited from Object.) |
|
|
Unlock |
Unlocks the object previously locked with method Lock(). (Inherited from SyncHandler.) |
|
|
WaitForCompletion |
Suspends the calling thread until the operation currently run is completed. (Inherited from SyncHandler.) |
Properties
| Name | Description | |
|---|---|---|
|
CodecPriority |
Returns the priority of the codec. |
|
|
Completed |
Returns value indicating if the operation is currently running. (Inherited from SyncHandler.) |
|
|
DefaultExtension |
Returns default extension for this format. |
|
|
ExceptionThrowEnabled |
Gets/sets value that specifies if to throw exception in synchronous mode. (Inherited from SyncHandler.) |
|
|
FilterString |
Returns filter string for this format. |
|
|
FormatDescription |
Returns user-friendly format description. |
|
|
FormatName |
Returns format name. |
|
|
Locked |
Indicates if the object has been locked. (Inherited from SyncHandler.) |
|
|
MediaFormat |
Returns the ID of the media format this reader can write to. |
|
|
MimeType |
Returns mime type of the format. |
|
|
Opened |
Returns value that specifies if the writer is opened. |
|
|
Priority |
Gets/sets a priority for the auxilary thread. (Inherited from SyncHandler.) |
|
|
SupportedPixelFormats |
Returns an array of pixel formats which are supported with this format writer. |
|
|
SynchronizationMode |
Gets/sets synchronization mode for the object. (Inherited from SyncHandler.) |
|
|
Timeout |
Gets/sets value specifying maximum time for which object can be locked. (Inherited from SyncHandler.) |
Events
| Name | Description | |
|---|---|---|
|
Aborted |
Fires when operation has been aborted. (Inherited from SyncHandler.) |
|
|
Continued |
Fires when operation has been resumed with Continue() method. (Inherited from SyncHandler.) |
|
|
Paused |
Fires when operation has been paused with Pause() method. (Inherited from SyncHandler.) |
|
Progress |
Fires on the operation progress notifications. (Inherited from SyncHandler.) |
|
|
Started |
Fires after operation has been started. (Inherited from SyncHandler.) |
|
|
Starting |
Fires before operation is started. (Inherited from SyncHandler.) |
|
|
Stopped |
Fires after operation has been stopped. (Inherited from SyncHandler.) |
|
|
Stopping |
Fires before operation is stopped. (Inherited from SyncHandler.) |