video3d_frame_get_number :: Quanser C Functions

navigation bar

video3d_frame_get_number

Get the frame number.

Description

The video3d_frame_get_number function gets the frame number associated with the given frame.

Prototype

t_error
video3d_frame_get_number(t_video3d_frame frame, t_uint64 * number);

Parameters

t_video3d_frame frame

The handle to the frame returned by video3d_stream_get_frame.

t_uint64 * number

The address of a t_uint64 variable to receive the frame number.

Return value

The return value is 0 if the frame number was retrieved 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.

Requirements

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

Examples

t_uint64 frame_number;
t_error result;

result = video3d_frame_get_number(frame, &frame_number);