Face SDK  1.13.0 Mozart release
Face Recognition Software Development Kit
Public Member Functions | List of all members
face_sdk::itracker_events Class Referenceabstract

Callback-interface for handling tracker events. More...

#include <face_sdk_tracker.h>

Inheritance diagram for face_sdk::itracker_events:
face_sdk::itracker_log_events face_sdk::itracker_metrics_events

Public Member Functions

virtual void on_track_appeared (const std::shared_ptr< face_sdk::video_stream > &stream, const std::shared_ptr< face_sdk::track > &track, const std::shared_ptr< face_sdk::video_frame > &frame, const std::shared_ptr< face_sdk::face > &face)=0
 Raises when a person has appeared in the stream. More...
 
virtual void on_track_disappeared (const std::shared_ptr< face_sdk::video_stream > &stream, const std::shared_ptr< face_sdk::track > &track)=0
 Raises when a person is lost in the stream. More...
 
virtual void on_track_updated (const std::shared_ptr< face_sdk::video_stream > &stream, const std::shared_ptr< face_sdk::track > &track, const std::shared_ptr< face_sdk::video_frame > &frame, const std::shared_ptr< face_sdk::face > &face)=0
 Raises when the track object has updated. More...
 
virtual void on_track_best_frame (const std::shared_ptr< face_sdk::video_stream > &stream, const std::shared_ptr< face_sdk::track > &track, const std::shared_ptr< face_sdk::video_frame > &frame, const std::shared_ptr< face_sdk::face > &face)=0
 Raises when the track object find new best face. More...
 
virtual void on_frame_process_error (const face_sdk::exception &exc, const std::shared_ptr< face_sdk::video_stream > &stream, const std::shared_ptr< face_sdk::video_frame > &frame)=0
 Raises when failed to process frame in stream. More...
 

Detailed Description

Callback-interface for handling tracker events.

Examples:
tracker.cpp.

Member Function Documentation

◆ on_frame_process_error()

virtual void face_sdk::itracker_events::on_frame_process_error ( const face_sdk::exception exc,
const std::shared_ptr< face_sdk::video_stream > &  stream,
const std::shared_ptr< face_sdk::video_frame > &  frame 
)
pure virtual

Raises when failed to process frame in stream.

Parameters
[in]excThe exception. Use format_exception function to get error contents
[in]streamThe stream to which the exception was thrown
[in]frameThe invalid frame

◆ on_track_appeared()

virtual void face_sdk::itracker_events::on_track_appeared ( const std::shared_ptr< face_sdk::video_stream > &  stream,
const std::shared_ptr< face_sdk::track > &  track,
const std::shared_ptr< face_sdk::video_frame > &  frame,
const std::shared_ptr< face_sdk::face > &  face 
)
pure virtual

Raises when a person has appeared in the stream.

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
Examples:
tracker.cpp.

◆ on_track_best_frame()

virtual void face_sdk::itracker_events::on_track_best_frame ( const std::shared_ptr< face_sdk::video_stream > &  stream,
const std::shared_ptr< face_sdk::track > &  track,
const std::shared_ptr< face_sdk::video_frame > &  frame,
const std::shared_ptr< face_sdk::face > &  face 
)
pure virtual

Raises when the track object find new best face.

Parameters
[in]streamThe stream where the track object has updated
[in]trackThe updated track
[in]frameThe frame where track has updated
[in]faceThe detected new best face in the frame
Examples:
tracker.cpp.

◆ on_track_disappeared()

virtual void face_sdk::itracker_events::on_track_disappeared ( const std::shared_ptr< face_sdk::video_stream > &  stream,
const std::shared_ptr< face_sdk::track > &  track 
)
pure virtual

Raises when a person is lost in the stream.

Parameters
[in]streamThe stream where a person is lost
[in]trackThe track of a person
Examples:
tracker.cpp.

◆ on_track_updated()

virtual void face_sdk::itracker_events::on_track_updated ( const std::shared_ptr< face_sdk::video_stream > &  stream,
const std::shared_ptr< face_sdk::track > &  track,
const std::shared_ptr< face_sdk::video_frame > &  frame,
const std::shared_ptr< face_sdk::face > &  face 
)
pure virtual

Raises when the track object has updated.

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
Examples:
tracker.cpp.

The documentation for this class was generated from the following file: