NVIDIA DeepStream SDK API Reference
9.1 Release
sources/apps/apps-common/includes/deepstream_osd.h
Go to the documentation of this file.
1
/*
2
* SPDX-FileCopyrightText: Copyright (c) 2018-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3
* SPDX-License-Identifier: Apache-2.0
4
*
5
* Licensed under the Apache License, Version 2.0 (the "License");
6
* you may not use this file except in compliance with the License.
7
* You may obtain a copy of the License at
8
*
9
* http://www.apache.org/licenses/LICENSE-2.0
10
*
11
* Unless required by applicable law or agreed to in writing, software
12
* distributed under the License is distributed on an "AS IS" BASIS,
13
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
* See the License for the specific language governing permissions and
15
* limitations under the License.
16
*/
17
18
#ifndef __NVGSTDS_OSD_H__
19
#define __NVGSTDS_OSD_H__
20
21
#include <gst/gst.h>
22
23
#ifdef __cplusplus
24
extern
"C"
25
{
26
#endif
27
28
#include "nvll_osd_struct.h"
29
30
typedef
struct
31
{
32
GstElement *
bin
;
33
GstElement *
queue
;
34
GstElement *
nvvidconv
;
35
GstElement *
conv_queue
;
36
GstElement *
cap_filter
;
37
GstElement *
nvosd
;
38
}
NvDsOSDBin
;
39
40
typedef
struct
41
{
42
gboolean
enable
;
43
gboolean
text_has_bg
;
44
gboolean
enable_clock
;
45
gboolean
draw_text
;
46
gboolean
draw_bbox
;
47
gboolean
draw_mask
;
48
gint
text_size
;
49
gint
border_width
;
50
gint
clock_text_size
;
51
gint
clock_x_offset
;
52
gint
clock_y_offset
;
53
guint
gpu_id
;
54
guint
nvbuf_memory_type
;
/* For nvvidconv */
55
guint
num_out_buffers
;
56
gchar *
font
;
57
gchar *
hw_blend_color_attr
;
58
NvOSD_Mode
mode
;
59
NvOSD_ColorParams
clock_color
;
60
NvOSD_ColorParams
text_color
;
61
NvOSD_ColorParams
text_bg_color
;
62
}
NvDsOSDConfig
;
63
74
gboolean
create_osd_bin
(
NvDsOSDConfig
*config,
NvDsOSDBin
*bin);
75
76
#ifdef __cplusplus
77
}
78
#endif
79
80
#endif
NvDsOSDBin::queue
GstElement * queue
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:33
NvDsOSDConfig::clock_text_size
gint clock_text_size
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:50
NvDsOSDConfig::draw_bbox
gboolean draw_bbox
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:46
NvDsOSDConfig::enable_clock
gboolean enable_clock
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:44
NvDsOSDConfig::text_color
NvOSD_ColorParams text_color
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:60
NvDsOSDConfig::clock_y_offset
gint clock_y_offset
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:52
NvDsOSDConfig::nvbuf_memory_type
guint nvbuf_memory_type
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:54
NvDsOSDConfig::gpu_id
guint gpu_id
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:53
NvDsOSDConfig::draw_mask
gboolean draw_mask
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:47
NvDsOSDConfig::hw_blend_color_attr
gchar * hw_blend_color_attr
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:57
NvDsOSDBin::bin
GstElement * bin
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:32
NvDsOSDConfig::border_width
gint border_width
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:49
NvDsOSDBin::cap_filter
GstElement * cap_filter
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:36
NvDsOSDConfig::clock_x_offset
gint clock_x_offset
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:51
NvDsOSDConfig::font
gchar * font
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:56
NvOSD_Mode
NvOSD_Mode
Defines modes used to overlay boxes and text.
Definition:
sources/includes/nvll_osd_struct.h:47
NvDsOSDConfig::text_size
gint text_size
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:48
NvDsOSDBin::nvosd
GstElement * nvosd
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:37
NvDsOSDBin
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:30
NvDsOSDConfig::text_has_bg
gboolean text_has_bg
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:43
NvDsOSDConfig::draw_text
gboolean draw_text
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:45
NvDsOSDConfig::num_out_buffers
guint num_out_buffers
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:55
NvDsOSDConfig::enable
gboolean enable
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:42
NvDsOSDBin::nvvidconv
GstElement * nvvidconv
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:34
_NvOSD_ColorParams
Holds the color parameters of the box or text to be overlayed.
Definition:
sources/includes/nvll_osd_struct.h:86
NvDsOSDBin::conv_queue
GstElement * conv_queue
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:35
NvDsOSDConfig::clock_color
NvOSD_ColorParams clock_color
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:59
create_osd_bin
gboolean create_osd_bin(NvDsOSDConfig *config, NvDsOSDBin *bin)
Initialize NvDsOSDBin.
NvDsOSDConfig::text_bg_color
NvOSD_ColorParams text_bg_color
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:61
NvDsOSDConfig
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:40
NvDsOSDConfig::mode
NvOSD_Mode mode
Definition:
sources/apps/apps-common/includes/deepstream_osd.h:58
Privacy Policy
|
Manage My Privacy
|
Do Not Sell or Share My Data
|
Terms of Service
|
Accessibility
|
Corporate Policies
|
Product Security
|
Contact
© 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
NVIDIA Confidential | Subject to Change | For test and development only.
Thu Jul 9 2026 11:48:19 | PR-09318-R32