GstVvasOverlayMeta - GstVvasOverlayMeta - 6.3 English - XD056

GstVvasOverlayMeta holds VvasOverlayShapeInfo, which in turn holds the information of different geometric structures and text to be drawn on a frame.

struct GstVvasOverlayMeta

GStreamer metadata structure attached to each buffer carrying overlay draw instructions.

Definition

struct GstVvasOverlayMeta {
  GstMeta meta;
  VvasOverlayShapeInfo shape_info;
};

Members

meta

GStreamer metadata base object.

shape_info

Overlay shape information - rectangles, text, lines, arrows, circles, polygons, and masks to be drawn on the frame. See VvasOverlayShapeInfo in the following section.

struct VvasOverlayShapeInfo

Structure representing the complete overlay shape information for a frame. Aggregates all shape lists to be drawn in a single pass by vvas_xoverlay.

Definition

struct VvasOverlayShapeInfo {
  uint32_t num_rects;
  uint32_t num_text;
  uint32_t num_lines;
  uint32_t num_arrows;
  uint32_t num_circles;
  uint32_t num_polys;
  uint32_t num_masks;
  VvasList *rect_params;
  VvasList *text_params;
  VvasList *line_params;
  VvasList *arrow_params;
  VvasList *circle_params;
  VvasList *polygn_params;
  VvasList *mask_params;
};

Members

num_rects / rect_params

Number of rectangles and their parameter list (VvasOverlayRectParams).

num_text / text_params

Number of text overlays and their parameter list (VvasOverlayTextParams).

num_lines / line_params

Number of lines and their parameter list (VvasOverlayLineParams).

num_arrows / arrow_params

Number of arrows and their parameter list (VvasOverlayArrowParams).

num_circles / circle_params

Number of circles and their parameter list (VvasOverlayCircleParams).

num_polys / polygn_params

Number of polygons and their parameter list (VvasOverlayPolygonParams).

num_masks / mask_params

Number of masks and their parameter list.

enum VvasOverlayArrowDirection

Structure representing arrow direction information.

Constants

ARROW_DIRECTION_START

START

ARROW_DIRECTION_END

END

ARROW_DIRECTION_BOTH_ENDS

BOTH_ENDS

struct VvasOverlayCoordinates

Structure representing coordinate information.

Definition

struct VvasOverlayCoordinates {
    int32_t x;
    int32_t y;
};

Members

x

X offset.

y

Y offset.

struct VvasOverlayColorData

Structure representing color information.

Definition

struct VvasOverlayColorData {
    uint8_t red;
    uint8_t green;
    uint8_t blue;
    uint8_t alpha;
};

Members

red

Red value.

green

Green value.

blue

Blue value.

alpha

Alpha (transparency) value.

struct VvasOverlayFontData

Structure representing font information.

Definition

struct VvasOverlayFontData {
    uint32_t font_num;
    float font_size;
    VvasOverlayColorData font_color;
};

Members

font_num

Font style number from OpenCV. For more information, refer to OpenCV drawing functions.

font_size

Font size.

font_color

Font color.

struct VvasOverlayRectParams

Structure representing information to draw a rectangle on a frame.

Definition

struct VvasOverlayRectParams {
    VvasOverlayCoordinates points;
    uint32_t width;
    uint32_t height;
    uint32_t thickness;
    uint32_t apply_bg_color;
    VvasOverlayColorData rect_color;
    VvasOverlayColorData bg_color;
};

Members

points

Coordinates of the upper-left corner of the rectangle.

width

Width of the rectangle in pixels.

height

Height of the rectangle in pixels.

thickness

Thickness of the rectangle edges in pixels.

apply_bg_color

Set to non-zero to fill the rectangle interior with bg_color.

rect_color

Color of the rectangle edges.

bg_color

Background fill color (used when apply_bg_color is non-zero).

struct VvasOverlayTextParams

Structure representing text overlay information.

Definition

struct VvasOverlayTextParams {
    VvasOverlayCoordinates points;
    char *disp_text;
    uint32_t bottom_left_origin;
    uint32_t apply_bg_color;
    VvasOverlayFontData text_font;
    VvasOverlayColorData bg_color;
};

Members

points

Anchor coordinate for the text.

disp_text

Null-terminated string to display.

bottom_left_origin

Set to non-zero to draw the text above points (bottom-left origin).

apply_bg_color

Set to non-zero to fill the text background with bg_color.

text_font

Font style, size, and color.

bg_color

Background fill color (used when apply_bg_color is non-zero).

struct VvasOverlayLineParams

Structure representing line information.

Definition

struct VvasOverlayLineParams {
    VvasOverlayCoordinates start_pt;
    VvasOverlayCoordinates end_pt;
    uint32_t thickness;
    VvasOverlayColorData line_color;
};

Members

start_pt

Line start coordinate.

end_pt

Line end coordinate.

thickness

Line thickness in pixels.

line_color

Line color.

struct VvasOverlayArrowParams

Structure representing arrow information.

Definition

struct VvasOverlayArrowParams {
    VvasOverlayCoordinates start_pt;
    VvasOverlayCoordinates end_pt;
    VvasOverlayArrowDirection arrow_direction;
    uint32_t thickness;
    float tipLength;
    VvasOverlayColorData line_color;
};

Members

start_pt

Arrow start coordinate.

end_pt

Arrow end coordinate.

arrow_direction

Direction of the arrowhead(s).

thickness

Line thickness in pixels.

tipLength

Length of the arrowhead tip relative to the arrow length.

line_color

Arrow color.

struct VvasOverlayCircleParams

Structure representing circle information.

Definition

struct VvasOverlayCircleParams {
    VvasOverlayCoordinates center_pt;
    uint32_t thickness;
    uint32_t radius;
    VvasOverlayColorData circle_color;
};

Members

center_pt

Center coordinates of the circle.

thickness

Circle edge thickness in pixels.

radius

Circle radius in pixels.

circle_color

Circle color.

struct VvasOverlayPolygonParams

Structure representing polygon information.

Definition

struct VvasOverlayPolygonParams {
    VvasList *poly_pts;
    uint32_t thickness;
    int32_t num_pts;
    VvasOverlayColorData poly_color;
};

Members

poly_pts

List of VvasOverlayCoordinates defining the polygon vertices.

thickness

Polygon edge thickness in pixels.

num_pts

Number of polygon vertices.

poly_color

Polygon color.