Face SDK  1.13.0 Mozart release
Face Recognition Software Development Kit
Typedefs
Event callbacks

Typedefs

typedef void(* face_sdk__on_track_appeared_cb_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, face_sdk__video_frame_t *frame, face_sdk__face_t *face)
 Raises when a person has appeared in the stream. More...
 
typedef void(* face_sdk__on_track_disappeared_cb_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track)
 Raises when a person is lost in the stream. More...
 
typedef void(* face_sdk__on_track_updated_cb_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, face_sdk__video_frame_t *frame, face_sdk__face_t *face)
 Raises when the track object has updated. More...
 
typedef void(* face_sdk__on_track_best_frame_cb_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, face_sdk__video_frame_t *frame, face_sdk__face_t *face)
 Raises when the best frame changed for the track. More...
 
typedef void(* face_sdk__on_frame_error_cb_t) (int32_t error_code, uint8_t *description, uint64_t description_size, face_sdk__video_stream_t *stream, face_sdk__video_frame_t *frame)
 Raises when error occurred while processing frame. More...
 
typedef void(* face_sdk__on_track_appeared_cb_2_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, face_sdk__video_frame_t *frame, face_sdk__face_t *face, void *opaque)
 Raises when a person has appeared in the stream. More...
 
typedef void(* face_sdk__on_track_disappeared_cb_2_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, void *opaque)
 Raises when a person is lost in the stream. More...
 
typedef void(* face_sdk__on_track_updated_cb_2_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, face_sdk__video_frame_t *frame, face_sdk__face_t *face, void *opaque)
 Raises when the track object has updated. More...
 
typedef void(* face_sdk__on_track_best_frame_cb_2_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, face_sdk__video_frame_t *frame, face_sdk__face_t *face, void *opaque)
 Raises when the best frame changed for the track. More...
 
typedef void(* face_sdk__on_frame_error_cb_2_t) (int32_t error_code, uint8_t *description, uint64_t description_size, face_sdk__video_stream_t *stream, face_sdk__video_frame_t *frame, void *opaque)
 Raises when error occurred while processing frame. More...
 

Detailed Description

Typedef Documentation

◆ face_sdk__on_frame_error_cb_2_t

typedef void(* face_sdk__on_frame_error_cb_2_t) (int32_t error_code, uint8_t *description, uint64_t description_size, face_sdk__video_stream_t *stream, face_sdk__video_frame_t *frame, void *opaque)

Raises when error occurred while processing frame.

Warning
user is responsible for destroying description, stream and frame objects
Parameters
[in]error_codeError code
[in]descriptionError description string. See text_encoding.
[in]description_sizeSize in bytes of description buffer
[in]streamThe stream where the error occurred
[in]frameThe frame where the error occurred

◆ face_sdk__on_frame_error_cb_t

typedef void(* face_sdk__on_frame_error_cb_t) (int32_t error_code, uint8_t *description, uint64_t description_size, face_sdk__video_stream_t *stream, face_sdk__video_frame_t *frame)

Raises when error occurred while processing frame.

Warning
user is responsible for destroying description, stream and frame objects
Parameters
[in]error_codeError code
[in]descriptionError description string. See text_encoding.
[in]description_sizeSize in bytes of description buffer
[in]streamThe stream where the error occurred
[in]frameThe frame where the error occurred

◆ face_sdk__on_track_appeared_cb_2_t

typedef void(* face_sdk__on_track_appeared_cb_2_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, face_sdk__video_frame_t *frame, face_sdk__face_t *face, void *opaque)

Raises when a person has appeared in the stream.

Warning
user is responsible for destroying stream, track, frame and face objects
Parameters
[in]streamThe stream where a person has detected
[in]trackThe track of a person
[in]frameThe frame where a person has detected
[in]faceThe detected face object in the frame

◆ face_sdk__on_track_appeared_cb_t

typedef void(* face_sdk__on_track_appeared_cb_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, face_sdk__video_frame_t *frame, face_sdk__face_t *face)

Raises when a person has appeared in the stream.

Warning
user is responsible for destroying stream, track, frame and face objects
Parameters
[in]streamThe stream where a person has detected
[in]trackThe track of a person
[in]frameThe frame where a person has detected
[in]faceThe detected face object in the frame

◆ face_sdk__on_track_best_frame_cb_2_t

typedef void(* face_sdk__on_track_best_frame_cb_2_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, face_sdk__video_frame_t *frame, face_sdk__face_t *face, void *opaque)

Raises when the best frame changed for the track.

Warning
user is responsible for destroying stream, track, frame and face objects
Parameters
[in]streamThe stream where the track object has updated
[in]trackThe track for which the best frame changed
[in]frameThe best frame for the track
[in]faceThe detected face in the frame

◆ face_sdk__on_track_best_frame_cb_t

typedef void(* face_sdk__on_track_best_frame_cb_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, face_sdk__video_frame_t *frame, face_sdk__face_t *face)

Raises when the best frame changed for the track.

Warning
user is responsible for destroying stream, track, frame and face objects
Parameters
[in]streamThe stream where the track object has updated
[in]trackThe track for which the best frame changed
[in]frameThe best frame for the track
[in]faceThe detected face in the frame

◆ face_sdk__on_track_disappeared_cb_2_t

typedef void(* face_sdk__on_track_disappeared_cb_2_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, void *opaque)

Raises when a person is lost in the stream.

Warning
user code is responsible for destroying stream and track objects
Parameters
[in]streamThe stream where a person is lost
[in]trackThe track of a person

◆ face_sdk__on_track_disappeared_cb_t

typedef void(* face_sdk__on_track_disappeared_cb_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track)

Raises when a person is lost in the stream.

Warning
user code is responsible for destroying stream and track objects
Parameters
[in]streamThe stream where a person is lost
[in]trackThe track of a person

◆ face_sdk__on_track_updated_cb_2_t

typedef void(* face_sdk__on_track_updated_cb_2_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, face_sdk__video_frame_t *frame, face_sdk__face_t *face, void *opaque)

Raises when the track object has updated.

Warning
user is responsible for destroying stream, track, frame and face objects
Parameters
[in]streamThe stream where the track object has updated
[in]trackThe updated track
[in]frameThe frame where track has updated
[in]faceThe detected face in the frame

◆ face_sdk__on_track_updated_cb_t

typedef void(* face_sdk__on_track_updated_cb_t) (face_sdk__video_stream_t *stream, face_sdk__track_t *track, face_sdk__video_frame_t *frame, face_sdk__face_t *face)

Raises when the track object has updated.

Warning
user is responsible for destroying stream, track, frame and face objects
Parameters
[in]streamThe stream where the track object has updated
[in]trackThe updated track
[in]frameThe frame where track has updated
[in]faceThe detected face in the frame