Auterion App SDK
Auterion SDK is a library that can be used by AuterionOS apps to communicate with the system.
Loading...
Searching...
No Matches
auterion::DisplayedViewProvider Class Reference

Publisher for the displayed video view. More...

#include <auterion_sdk/video/displayed_view_provider.hpp>

Public Member Functions

 DisplayedViewProvider (SDK &sdk)
 Construct a new Displayed View Provider object.
 
virtual ~DisplayedViewProvider ()
 Destroy the Displayed View Provider object.
 
 DisplayedViewProvider (const DisplayedViewProvider &)=delete
 
DisplayedViewProvideroperator= (const DisplayedViewProvider &)=delete
 
 DisplayedViewProvider (DisplayedViewProvider &&)=delete
 
DisplayedViewProvideroperator= (DisplayedViewProvider &&)=delete
 
void updateDisplayedView (const DisplayedView &view)
 Publishes the displayed view of one output frame.
 

Detailed Description

Publisher for the displayed video view.

The producer of the displayed video stream publishes, for every output frame, the region of the source frame it is currently showing (see DisplayedView). Consumers use it to map between source-frame and displayed-frame coordinates; in particular, ObjectDetectionProvider uses it to emit detection boxes in displayed-frame coordinates over MAVLink.

Publish for every output frame, including the identity view when no zoom, crop, or rotation is active: a live identity publisher tells consumers "displayed = source", while silence means no view information exists on this system.

Example usage:

// For each displayed output frame:
view.frame_id = source_frame_id;
view.timestamp = source_frame_timestamp;
view.x = crop_rect.x; // signed source px, may be off-frame under stabilisation
view.y = crop_rect.y;
view.width = crop_rect.width;
view.height = crop_rect.height;
view.rotation_deg = displayed_rotation_deg;
view.source_width = source_frame_width;
view.source_height = source_frame_height;
view_provider.updateDisplayedView(view);
Publisher for the displayed video view.
Definition displayed_view_provider.hpp:74
SDK execution class. All callbacks are called on the same thread.
Definition auterion.hpp:119
The region of a source frame that is shown in the displayed video output.
Definition displayed_view.hpp:62
uint16_t frame_id
Id of the source frame (0 = unset).
Definition displayed_view.hpp:63
float y
Top edge of the displayed region [source px, signed].
Definition displayed_view.hpp:66
float width
Width of the displayed region [source px] (0 = unset).
Definition displayed_view.hpp:67
uint32_t source_width
Source frame width [px] (0 = unset).
Definition displayed_view.hpp:70
float height
Height of the displayed region [source px] (0 = unset).
Definition displayed_view.hpp:68
int16_t rotation_deg
Display rotation [deg], multiple of 90, CCW positive.
Definition displayed_view.hpp:69
uint32_t source_height
Source frame height [px] (0 = unset).
Definition displayed_view.hpp:71
float x
Left edge of the displayed region [source px, signed].
Definition displayed_view.hpp:65
rclcpp::Time timestamp
Source frame capture time from its header (RCL_ROS_TIME).
Definition displayed_view.hpp:64

Constructor & Destructor Documentation

◆ DisplayedViewProvider()

auterion::DisplayedViewProvider::DisplayedViewProvider ( SDK sdk)
explicit

Construct a new Displayed View Provider object.

Parameters
sdkThe SDK instance to use for creating providers.

Member Function Documentation

◆ updateDisplayedView()

void auterion::DisplayedViewProvider::updateDisplayedView ( const DisplayedView view)

Publishes the displayed view of one output frame.

Parameters
viewThe displayed view to publish.

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