IDLffMJPEG2000::StopSequentialReading

The IDLffMJPEG2000::StopSequentialReading function method releases the frame buffer memory and shuts down the background processing thread, if it is still running. Call this method when a sequential playback has been completed. Until StopSequentialReading is called, the decompressed frames will remain in the frame buffer.

The StartSequentialReading, GetSequentialData, ReleaseSequentialData and StopSequentialReading methods are used with a timer mechanism to create a sequential playback.

Note: Always use a widget timer or IDLitWindow timer mechanism to control the playback rate. Avoid using the WAIT procedure with sequential playback as the interaction between the procedure and the background processing thread will cause adverse side effects on UNIX platforms.

This method will throw an error if the decompression fails. A CATCH statement can be used to trap these errors.

Syntax

Result = Obj->[IDLffMJPEG2000::]StopSequentialReading( )

Return Value

Returns an integer indicating success (1) or failure (0).

Arguments

None

Keywords

None

Examples

See the Examples section of IDLffMJPEG2000::GetSequentialData for a simple example that uses the four sequential playback methods.

Version History

6.3	Introduced