ILTStlImgRd Interface

Interface Properties:

Type

Name

Description

VARIANT_BOOL

AudioExtension

(Read only) Indicates the availability of an audio stream in the loaded file. It will contain VARIANT_TRUE if there is an embedded audio stream in the loaded file, and VARIANT_FALSE otherwise.

VARIANT_BOOL

ConnectionState

(Read only) Gets the output pin's connection status.

It will contain VARIANT_TRUE if a video pin, an audio pin (if it exists) or all pins are connected, and VARIANT_FALSE otherwise.

long

Format

(Read only) This is updated with the loaded file format. For a list of possible values, refer to Summary of All Supported Image File Formats .

long

FrameRate

Sets or gets the frame rate in frames per second. This will change the frame duration, the time the frame will be displayed in multi-page files. Possible values range from 0.1 to 60.0 frames per second. For this property to take effect, the FrameRateControl property must be set to VARIANT_TRUE.

VARIANT_BOOL

FrameRateControl

Enables or disables the frame rate control process. Setting this property to VARIANT_FALSE will force the filter to use the default frame rate saved in the file. If no frame rate was saved in the file, the default value used for frame rate is 30 fps.

BSTR

InputFileName

Sets or gets the input file name. The filter can be loaded without specifying a file name, but in this case the output pin will have nothing to offer. Setting the file name while the output pin(s) is (are) connected will fail: you need to disconnect all pins in order to set a new file name.

If you are getting this property, you are responsible for freeing the buffer containing the file name. The buffer must be freed by calling the system function SysFreeString. See the Microsoft documentation for more details on this function.

long

LastErrorCode

(Read only) Gets the last error code. For a list of possible values, refer to   LEAD's Return Codes.

BSTR

LastErrorString

(Read only) Gets the last error string.

The user is responsible for freeing the allocated string.

long

PageNumber

Sets or gets the page number. This is the page to be displayed, for multi-page files.

If the value is 0, all pages will be played. To view only one page, set this property to a value between 1 and TotalPages. do not use zero-based indexing. For example, if there are 10 pages in a file, then to stream the first page set this property to 1, and to stream the last page set it to 10.

BSTR

RegisteredExtensions

Retrieves the list of currently registered file extensions. The extensions are separated by a comma (,).

long

TotalPages

(Read only) Gets the number of available pages in the loaded file. If the loaded file contains only one page, this property will return 1.

Long

Loop

Sets or gets the number of times the loaded image or sequence of images is to be repeated. The default value is 1 which means the sequence will be played once and not be repeated. Use 0 to continuously repeat the sequence.

Interface Methods:

HRESULT RegisterExtensions (BSTR strExtensions)

Parameters

strExtensions

String containing one or more extensions to be registered. The extensions must be separated by a comma (,), and they must contain only alphanumeric characters (a to z, A to Z, 0 to 9). Each extension should have less than 32 characters.

Description

Registers a group of file extensions.

Returns

S_OK if successful, or another error code otherwise.

HRESULT UnRegisterExtensions (BSTR strExtensions)

Parameters

strExtensions

String containing one or more extensions to be unregistered. The extensions must be separated by a comma (,), and they must contain only alphanumeric characters (a to z, A to Z, 0 to 9). Each extension should have less than 32 characters.

Description

Registers a group of file extensions.

Returns

S_OK if successful, or another error code otherwise.

Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Filters C API Help
Click or drag to resize