IMcStream Interface

This is a shortcut to the Artist TIFF Tag, but it can also be used by other formats to retrieve information about the ownner of an image file. If there is no Author, an empty BSTR will be returned.

Gets a pointer to the McStreamAttributes Collection

This property determines whether to apply a best-fit display range to the image after it is opened.

Returns the number of bits each channel occupies.

Gets or Sets the Channels property in the image file. Usually 1 (Monochrome) or 3 (RGB,HSI, etc).

Returns a String that indicates which colorspace the image data is in HSI, HSV, Yuv, YCC, RGB, Monochrome, etc....

This is a shortcut to the Comments TIFF Tag, but it can also be used by other formats to retrieve extended comments out of an image file. If there are no Comments, an empty String will be returned.

Gets/Sets the compression used for this image file.

The Current Frame that will be read.

Returns a textual string describing the Number of Bytes per pixel the image is in. Typical return values are "Unsigned Char", "Float", "Unsigned Short", etc....

If the file format supports an internal Date and Time value (such as TIFF), then this information is used. If there is no support, the file sytems date/time information is returned.

Gets or Sets the VARIANT with the pathname or object that is the destination for writing an image, if this is a writing stream. If it is a reading stream, the destination is usually an IMcImage object that will contain the data and image information

The last frame to read.

On Get, fills the String parameter with the name of the file that is being used as the Source (reading) or Destination (writing) If the Source/Destination is actually an Istream/IStorage, then the name of that particular IStream/IStorage is returned. If there is no FileName set, an empty String is returned. This property is generated from the FullPathName. The FileName differs in that it is only the name of the image and the extension, but does not include any qualifying directory names.

Gets/Sets any defined flags for the McStream.

Gets or Sets the String Format with the file format descriptor string that is used to create the Helper Subclass. If this property is Set, the Helper Subclass is created.

Read-only property indicating the characteristics and capabilities of the selected file format.

To Read non-contiguous frames out of a sequence, pass a SAFEARRAY filled with the 0-based frame numbers you wish to read to this property

This property returns the fully qualified path of the file that is being used as the Source (reading) or Destination (writing) On Set, Sets the internal property to the String passed.

On Get, Fills the long parameter with the height of the image read from the image file. On Set, sets the local property to the long value The Height is determined by the number of Pixels from OriginY to the bottom of the image. The Height must be less than or equal to the Height of the File data. If you wish to Subsample the image, see PreviewHeight.

Read-only property reporting whether the selected file format/compression combination may be lossy (see Remarks).

If this file is being read from disk, the return is False. If it is a virtual image, usually created by a filter or other type, the return is True.

Returns whether this image file is a sequence (or movie).

Returns the total number of bytes that make up 1 line of the image. Usually computed by (Width - OriginX) * Channels * sizeof(datatype)

McStream can load all frames of a sequence at once into memory (the default), or a single frame at a time via this method. It will be one of these enumerated values: mcLoadAllFrames mcLoadSingleFrame

A read-only property that returns an mcslsLoadStatus value indicating the status of the previously Read image file.

Read-only property reporting whether the selected file includes multiple resolutions.

Gets or Sets the horizontal integer offset for the beginning of a subsectional valid area of the data. This defaults to 0 (left-most pixel). Setting this value allows only saving/loading a section of an image.

Retrieves the vertical integer offset for the beginning of a subsectional valid area of the data. This defaults to 0. Setting this value allows only saving/loading a section of an image.

Read-only property that gives the Height of the previewed image, determined by the sub-sampled image height minus any fill.

Read-only property that gives the Width of the previewed image, determined by the sub-sampled image width minus any fill.

Read-Only property to access the Maximum clipping range that was identified in an image file.

Read-Only property to access the Minimum clipping range that was identified in an image file.

Returns a Boolean value that indicates whether the McStream is able to be Written to. Many factors can affect this status, such as support for a writable McStream Format, the current File's Permissions, Licensing, etc.... True means the file cannot be Written, False means the file may be Written.

Gets/Sets the file access mode, for reading or for writing. Not all formats are supported for writing.

This read/write property determines the image resolution that will be opened.

Read-only property returning a list of resolution descriptions.

Gets or Sets a Boolean value that indicates whether the McStream library should update a Progress Bar during operations. Default is True, meaning to update the progress bar.

Returns the number of bytes for each of the image file's pixels.

Read-Only property used to access an indicator in some image files that identifies which software was used to create this image file.

Gets or Sets the VARIANT with the pathname or object that is the source for writing an image, such as an McImage object, if this is a writing stream. If it is a reading stream, the source is usually a Filename that will contain the data and image information

The first frame to read.

Property to determine the size, in bytes, of the complete file. Notice that this may be larger or smaller than the image size due to Compression and/or the File Format's structure.

Returns the file format specific class

Returns the Title (if any) in the Image File as a BSTR.

Total frames read or to be written.

Gets/Sets the level of Feedback the Stream library will provide.

Gets or Sets the Width property. Width indicates the number of Pixel columns from the left (originX) of the image.

Creates a new tag for the image file.

Copies properties from one McStream to another

Closes the stream and calls Close() on the Subclass. This should always be called after completing a read or write operation (Open, Read or Write, then Close).

This method copies the file indicated by either Source or FileName to the Destination. The file is copied byte by byte, bypassing the normal McStream functionality of reading the image. This method is analagous to an Operating System copy/paste of a File.

BSTR *Description, mcsovtValueType* ValueType, mcsguiGuiRepresentation* GuiRep, VARIANT* ValueMin, VARIANT* ValueMax, VARIANT* DefaultValue, long* PropertyID)

Method used to query for installed File Formats in a certain Access Mode.

Method that returns the descriptive name of the specified compression setting.

This method queries the Registry entries of McStream format indicated by "format", in the access mode indicated by "Mode", and fills the "descriptions" VARIANT with a safe-array of BSTR's with compression names, and a corresponding safe array stored in the VARIANT "ids" with the mccsCompression numbers in the same order as descriptions. The VARIANT image argument is either the image to query, an image type, or an image QuickType. This is to ensure that the compression schemes available support the data type of the image you wish to save.

Method used to retrive textual descriptions for a list of file extensions

Method used to retrive textual descriptions for a list of file extensions

When a call to Open returns the error MCSTREAM_MULTIPLE_RESOLUTION, it means that this image file contains multiple sub-images, but at least one of the images is of a different imaging class. Usually, this is determined by differing resolutions of the image. Therefore, this image file must be opened as independent images rather than as a sequence. This method allows the UI to query for a textual description (usually resolution) of each sub-image. The list is then presented to the User for selection. The UI will then SetCurrentFrame to the offset selected, and open that image as single framed image.

Read-Only property used to indicate whether dynamic ranges are present in the image file.

Creates the Subclass (Helper class) COM object and initializes data. Calls the Subclass's Open for further initialization

Reads the File or Image object.

This method allows the client to read an array of frames from a sequence, and place them in particular frames of an existing image. For example, the client may wish to read frames 6,10, and 12 of a sequence file, and place them in Frame locations 3,9,and 11 of the image, respectively. The two SAFEARRAY's are matched descriptor to descriptor, for example, the first array member of the stream_range array will be placed into the first array member of the image_range.

Description Deletes the tag referenced by key from the image file

This method provides some of the same functionality as Close(), but it does not destroy the Subclass helper object (file format specific). It resets any internal file names and flushes data buffers.

Given an mcImageType or an mcImageQuicktype, will inform the client whether the underlying SubClass will support the Image.

Writes an image to a destination.