Video frame

Classes
struct	face_sdk__video_frame
	A video frame contains image and meta-information about this image in video stream context. More...

Typedefs
typedef struct face_sdk__video_frame	face_sdk__video_frame_t
	A video frame contains image and meta-information about this image in video stream context. More...

Functions
bool	face_sdk__video_frame__get_addr (const face_sdk__video_frame_t *video_frame, uint64_t *addr)
	Retrieves face_sdk__video_frame_t object address * *. More...
bool	face_sdk__video_frame__get_frame_id (const face_sdk__video_frame_t *video_frame, uint64_t *value)
	Retrieves video frame id. More...
bool	face_sdk__video_frame__get_timestamp_ms (const face_sdk__video_frame_t *video_frame, uint64_t *value)
	Retrieves video frame timestamp. More...
bool	face_sdk__video_frame__get_image (const face_sdk__video_frame_t *video_frame, face_sdk__image_t **image)
	Retrieves video frame image. More...
bool	face_sdk__make_video_frame (uint64_t frame_id, uint64_t timestamp_ms, const face_sdk__image_t *image, face_sdk__video_frame_t **video_frame)
	Makes video frame with specified frame_id, timestamp and image. More...
void	face_sdk__video_frame_free (face_sdk__video_frame_t *video_frame)
	Destroys face_sdk__video_frame object. More...

Detailed Description

Typedef Documentation

face_sdk__video_frame_t

typedef struct face_sdk__video_frame face_sdk__video_frame_t

A video frame contains image and meta-information about this image in video stream context.

Use face_sdk__make_video_frame() function to make video_frame object

Function Documentation

face_sdk__make_video_frame()

bool face_sdk__make_video_frame	(	uint64_t	frame_id,
		uint64_t	timestamp_ms,
		const face_sdk__image_t *	image,
		face_sdk__video_frame_t **	video_frame
	)

Makes video frame with specified frame_id, timestamp and image.

Parameters

[in]	frame_id	Frame id
[in]	timestamp_ms	Frame timestamp in ms
[in]	image	Image object
[out]	video_frame	Video Frame object

Returns

true on success, false on failure. See last_error

face_sdk__video_frame__get_addr()

bool face_sdk__video_frame__get_addr	(	const face_sdk__video_frame_t *	video_frame,
		uint64_t *	addr
	)

Retrieves face_sdk__video_frame_t object address * *.

Parameters

[in]	video_frame	face_sdk__video_frame_t object *
[out]	addr	Object address * *

Returns

true on success, false on failure. See last_error

face_sdk__video_frame__get_frame_id()

bool face_sdk__video_frame__get_frame_id	(	const face_sdk__video_frame_t *	video_frame,
		uint64_t *	value
	)

Retrieves video frame id.

Parameters

[in]	video_frame	Video Frame object
[out]	value	Frame id

Returns

true on success, false on failure. See last_error

face_sdk__video_frame__get_image()

bool face_sdk__video_frame__get_image	(	const face_sdk__video_frame_t *	video_frame,
		face_sdk__image_t **	image
	)

Retrieves video frame image.

Parameters

[in]	video_frame	Video Frame object
[out]	image	Image object

Returns

true on success, false on failure. See last_error

face_sdk__video_frame__get_timestamp_ms()

bool face_sdk__video_frame__get_timestamp_ms	(	const face_sdk__video_frame_t *	video_frame,
		uint64_t *	value
	)

Retrieves video frame timestamp.

Parameters

[in]	video_frame	Video Frame object
[out]	value	Frame timestamp

Returns

true on success, false on failure. See last_error

face_sdk__video_frame_free()

void face_sdk__video_frame_free

(

face_sdk__video_frame_t *

video_frame

)

Destroys face_sdk__video_frame object.

Parameters

[in]

video_frame

Video Frame object