yodau::backend::event Struct Reference

Generic event produced by the backend. More...

#include <backend/include/event.hpp>

Public Attributes
event_kind	kind { event_kind::info }
	Type of the event.
std::string	stream_name
	Name/identifier of the stream that produced the event.
std::string	message
	Human-readable event description or payload.
std::chrono::steady_clock::time_point	ts
	Monotonic timestamp when the event was generated.
std::optional< point >	pos_pct
	Optional position associated with the event in percentage coordinates.
std::string	line_name
	Name of the line / ROI / rule responsible for this event.

Detailed Description

Generic event produced by the backend.

The event is associated with a particular stream and time. Depending on kind, optional spatial or semantic fields may be filled:

• pos_pct may contain a position in percentage coordinates ([0.0; 100.0]) relative to frame dimensions.
• line_name may contain a logical name for a tripwire/ROI/line that caused the event.

Note

Timestamps are stored as std::chrono::steady_clock::time_point, which is monotonic and suitable for measuring intervals, not for wall-clock time.

Definition at line 44 of file event.hpp.

Member Data Documentation

kind

event_kind yodau::backend::event::kind { event_kind::info }

Type of the event.

Defaults to event_kind::info.

Definition at line 50 of file event.hpp.

{ event_kind::info };

Referenced by controller::on_backend_event().

line_name

std::string yodau::backend::event::line_name

Name of the line / ROI / rule responsible for this event.

Used primarily for tripwire / ROI events; may be empty otherwise.

Definition at line 86 of file event.hpp.

Referenced by controller::on_backend_event().

message

std::string yodau::backend::event::message

Human-readable event description or payload.

Its semantics depend on the producer (may contain JSON, plain text, etc.).

Definition at line 65 of file event.hpp.

pos_pct

std::optional<point> yodau::backend::event::pos_pct

Optional position associated with the event in percentage coordinates.

When present, (x, y) are expressed in percent of frame width/height. For example, x=50 means horizontal center.

Definition at line 79 of file event.hpp.

stream_name

std::string yodau::backend::event::stream_name

Name/identifier of the stream that produced the event.

Could be a camera ID, pipeline name, or other unique stream label.

Definition at line 57 of file event.hpp.

ts

std::chrono::steady_clock::time_point yodau::backend::event::ts

Monotonic timestamp when the event was generated.

Definition at line 70 of file event.hpp.

---

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

• event.hpp