Video stream

Classes
struct	face_sdk__video_stream
	A video stream represents a sequence of frames. More...

Typedefs
typedef struct face_sdk__video_stream	face_sdk__video_stream_t
	A video stream represents a sequence of frames.

Functions
bool	face_sdk__video_stream__get_addr (const face_sdk__video_stream_t *video_stream, uint64_t *addr)
	Retrieves face_sdk__video_stream_t object address * *. More...
bool	face_sdk__video_stream__get_stream_id (const face_sdk__video_stream_t *video_stream, uint32_t *value)
	Retrieves stream_id which was passed into face_sdk__tracker__make_stream() function. More...
bool	face_sdk__video_stream__push_frame (const face_sdk__video_stream_t *video_stream, const face_sdk__video_frame_t *video_frame)
	Pushes video frame into the stream. More...
void	face_sdk__video_stream_free (face_sdk__video_stream_t *video_stream)
	Destroys face_sdk__video_stream object. More...

Detailed Description

Function Documentation

face_sdk__video_stream__get_addr()

bool face_sdk__video_stream__get_addr	(	const face_sdk__video_stream_t *	video_stream,
		uint64_t *	addr
	)

Retrieves face_sdk__video_stream_t object address * *.

Parameters

[in]	video_stream	face_sdk__video_stream_t object *
[out]	addr	Object address * *

Returns

true on success, false on failure. See last_error

face_sdk__video_stream__get_stream_id()

bool face_sdk__video_stream__get_stream_id	(	const face_sdk__video_stream_t *	video_stream,
		uint32_t *	value
	)

Retrieves stream_id which was passed into face_sdk__tracker__make_stream() function.

Parameters

[in]	video_stream	Video Stream object
[in]	value	Stream id

Returns

true on success, false on failure. See last_error

face_sdk__video_stream__push_frame()

bool face_sdk__video_stream__push_frame	(	const face_sdk__video_stream_t *	video_stream,
		const face_sdk__video_frame_t *	video_frame
	)

Pushes video frame into the stream.

Warning

Next pushed frame must have greater frame_id that previously pushed frame

Parameters

[in]	video_stream	Video Stream object
[in]	video_frame	Video Frame object

Returns

true on success, false on failure. See last_error

face_sdk__video_stream_free()

void face_sdk__video_stream_free

(

face_sdk__video_stream_t *

video_stream

)

Destroys face_sdk__video_stream object.

Parameters

[in]

video_stream

Video Stream object