NVIDIA DeepStream SDK API Reference

6.4 Release
libs/gstnvdscustomhelper/gst-nvdscustommessage.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2022-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: MIT
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21  * DEALINGS IN THE SOFTWARE.
22  */
23 
39 #ifndef __GST_NVDSCUSTOMMESSAGE_H__
40 #define __GST_NVDSCUSTOMMESSAGE_H__
41 
42 #include <gst/gst.h>
43 #include "gst-nvdscommonconfig.h"
44 #include "deepstream_perf.h"
45 G_BEGIN_DECLS
56  GstMessage * gst_nvmessage_new_stream_add (GstObject * obj,
57  NvDsSensorInfo * sensor_info);
58 
66 gboolean gst_nvmessage_is_stream_add (GstMessage * message);
67 
83 gboolean gst_nvmessage_parse_stream_add (GstMessage * message,
84  NvDsSensorInfo * sensor_info);
85 
96 GstMessage *gst_nvmessage_new_stream_remove (GstObject * obj,
97  NvDsSensorInfo * sensor_info);
98 
106 gboolean gst_nvmessage_is_stream_remove (GstMessage * message);
107 
123 gboolean gst_nvmessage_parse_stream_remove (GstMessage * message,
124  NvDsSensorInfo * sensor_info);
125 
142 gboolean gst_nvmessage_parse_fps_stream_add (GstMessage * message,
143  NvDsFPSSensorInfo * sensor_info);
144 
161 gboolean gst_nvmessage_parse_fps_stream_remove (GstMessage * message,
162  NvDsFPSSensorInfo * sensor_info);
163 
173 GstMessage *gst_nvmessage_force_pipeline_eos (GstObject * obj,
174  gboolean force_eos);
175 
176 
185 gboolean
186 gst_nvmessage_parse_force_pipeline_eos (GstMessage * message,
187  gboolean * force_eos);
188 
189 
197 gboolean gst_nvmessage_is_force_pipeline_eos (GstMessage * message);
200 G_END_DECLS
201 #endif
gst-nvdscommonconfig.h
gst_nvmessage_new_stream_add
G_BEGIN_DECLS GstMessage * gst_nvmessage_new_stream_add(GstObject *obj, NvDsSensorInfo *sensor_info)
Creates a new Stream ADD message - denoting a new stream getting added to nvmultiurisrcbin.
gst_nvmessage_parse_stream_remove
gboolean gst_nvmessage_parse_stream_remove(GstMessage *message, NvDsSensorInfo *sensor_info)
Parses the stream ID from a stream REMOVE message.
NvDsFPSSensorInfo
Definition: deepstream_perf.h:35
gst_nvmessage_is_stream_remove
gboolean gst_nvmessage_is_stream_remove(GstMessage *message)
Determines whether a message is a stream REMOVE message.
gst_nvmessage_parse_stream_add
gboolean gst_nvmessage_parse_stream_add(GstMessage *message, NvDsSensorInfo *sensor_info)
Parses the stream ID from a stream ADD message.
deepstream_perf.h
gst_nvmessage_parse_force_pipeline_eos
gboolean gst_nvmessage_parse_force_pipeline_eos(GstMessage *message, gboolean *force_eos)
Parses the force_eos from a force eos message.
_NvDsSensorInfo
Definition: libs/gstnvdscustomhelper/gst-nvdscommonconfig.h:73
gst_nvmessage_is_force_pipeline_eos
gboolean gst_nvmessage_is_force_pipeline_eos(GstMessage *message)
Determines whether a message is a force pipeline eos message.
gst_nvmessage_parse_fps_stream_add
gboolean gst_nvmessage_parse_fps_stream_add(GstMessage *message, NvDsFPSSensorInfo *sensor_info)
Parses the stream ID from a stream ADD message.
gst_nvmessage_force_pipeline_eos
GstMessage * gst_nvmessage_force_pipeline_eos(GstObject *obj, gboolean force_eos)
Sends custom message to force-eos on the pipeline.
gst_nvmessage_parse_fps_stream_remove
gboolean gst_nvmessage_parse_fps_stream_remove(GstMessage *message, NvDsFPSSensorInfo *sensor_info)
Parses the stream ID from a stream REMOVE message.
gst_nvmessage_is_stream_add
gboolean gst_nvmessage_is_stream_add(GstMessage *message)
Determines whether a message is a stream ADD message.
gst_nvmessage_new_stream_remove
GstMessage * gst_nvmessage_new_stream_remove(GstObject *obj, NvDsSensorInfo *sensor_info)
Creates a new Stream REMOVE message - denoting a new stream getting removed from nvmultiurisrcbin.