image_stream

`image_stream` represents a changing image source. It can receive frames from `image_data`, play an image sequence from a folder, or play an MJPEG AVI file. The GUI `image` object can display an `image_stream`.

`image_stream` is not cloneable because it represents active playback/source state.

Creates an empty stream.

stream = image_stream();
print(stream.has_frame);     // false

`clone()` is not supported for `image_stream`.

Stops and clears any active player, clears the stream, and returns the stream object.

Example:

stream.clear();

Pushes one `image_data` frame into the stream.

Returns: `true` if the frame was pushed, or `false` if the image is not valid.

Example:

img = image_data().load("frame.png");
stream = image_stream();
ok = stream.push(img);

Loads a folder as an image sequence using the default filter `*.jpg`.

Returns: boolean-style number.

Example:

stream = image_stream();
stream.load_folder("frames");

Loads a folder as an image sequence using a file filter such as `*.png` or `frame_*.jpg`.

Returns: boolean-style number.

Example:

stream = image_stream();
stream.load_folder("frames", "*.png");
stream.fps(10).loop(true).start();

Loads an MJPEG AVI file as the active player.

Returns: boolean-style number.

Example:

stream = image_stream();
if (stream.load_avi("capture.avi"))
{
    stream.start();
}

Sets playback speed in frames per second.

Returns: image_stream object.

Example:

stream.fps(25);

Enables or disables looping.

Returns: image_stream object.

Example:

stream.loop(false);

Starts the active player.

If no folder or AVI player is active, it returns `false`.

Example:

stream.load_folder("frames", "*.jpg");
stream.start();

Stops playback.

Example:

stream.stop();

Use the GUI `image` object to show an image stream.

stream = image_stream().load_folder("frames", "*.jpg");
view = image().position(10, 10).size(320, 240).load(stream).play();
window().title("Stream").size(360, 300).add(view).show();

Previous: image_data

Next: Utils