video3d_stream_close :: Quanser C Functions

navigation bar

video3d_stream_close

Closes a video stream.

Description

The video3d_stream_close function closes the video stream and releases its resources. The stream cannot be used after it has been closed.

Prototype

t_error
video3d_stream_close(t_video3d_stream stream);

Parameters

t_video3d_stream stream

The handle to the video stream returned by video3d_stream_open.

Return value

The return value is 0 if the stream was closed successfully. Otherwise a negative error code is returned. Error codes are defined in quanser_errors.h. A suitable error message may be retrieved using msg_get_error_message.

Error codes

QERR_INVALID_ARGUMENT

One of the arguments is invalid.

QERR_OUT_OF_MEMORY

There is not enough memory to complete the operation.

Requirements

Include Files	Libraries
quanser_video3d.h	quanser_media.lib;quanser_communications.lib;quanser_runtime.lib;quanser_common.lib

Examples

t_video3d_stream stream;
t_error result;

result = video3d_stream_open(capture, VIDEO3D_STREAM_COLOR, 0, 30.0, 640, 480, IMAGE_FORMAT_COL_MAJOR_PLANAR_RGB, IMAGE_DATA_TYPE_UINT8, &stream);
if (result >= 0) {
    ...
    video3d_stream_close(stream);
}