NVIDIA DeepStream SDK API Reference

9.1 Release
sources/libs/gstnvdscustomhelper/gst-nvdscustommessage.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2022-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 
33 #ifndef __GST_NVDSCUSTOMMESSAGE_H__
34 #define __GST_NVDSCUSTOMMESSAGE_H__
35 
36 #include <gst/gst.h>
37 #include "gst-nvdscommonconfig.h"
38 #include "deepstream_perf.h"
39 G_BEGIN_DECLS
50  GstMessage * gst_nvmessage_new_stream_add (GstObject * obj,
51  NvDsSensorInfo * sensor_info);
52 
60 gboolean gst_nvmessage_is_stream_add (GstMessage * message);
61 
77 gboolean gst_nvmessage_parse_stream_add (GstMessage * message,
78  NvDsSensorInfo * sensor_info);
79 
91  NvDsSensorInfo * sensor_info);
92 
100 gboolean gst_nvmessage_is_stream_remove (GstMessage * message);
101 
117 gboolean gst_nvmessage_parse_stream_remove (GstMessage * message,
118  NvDsSensorInfo * sensor_info);
119 
136 gboolean gst_nvmessage_parse_fps_stream_add (GstMessage * message,
137  NvDsFPSSensorInfo * sensor_info);
138 
155 gboolean gst_nvmessage_parse_fps_stream_remove (GstMessage * message,
156  NvDsFPSSensorInfo * sensor_info);
157 
168  gboolean force_eos);
169 
170 
179 gboolean
180 gst_nvmessage_parse_force_pipeline_eos (GstMessage * message,
181  gboolean * force_eos);
182 
183 
191 gboolean gst_nvmessage_is_force_pipeline_eos (GstMessage * message);
192 
204  NvDsRtspAttemptsInfo *rtsp_info);
205 
214 gboolean
216  NvDsRtspAttemptsInfo *rtsp_info);
217 
225 gboolean gst_nvmessage_is_reconnect_attempt_exceeded (GstMessage * message);
226 
229 G_END_DECLS
230 #endif
gst_nvmessage_is_stream_remove
gboolean gst_nvmessage_is_stream_remove(GstMessage *message)
Determines whether a message is a stream REMOVE 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.
gst_nvmessage_reconnect_attempt_exceeded
GstMessage * gst_nvmessage_reconnect_attempt_exceeded(GstObject *obj, NvDsRtspAttemptsInfo *rtsp_info)
Creates a new attempt-exceeded message - denoting a reconnection attempt is exceeded for a rtsp uri.
gst-nvdscommonconfig.h
gst_nvmessage_is_stream_add
gboolean gst_nvmessage_is_stream_add(GstMessage *message)
Determines whether a message is a stream ADD message.
_NvDsRtspAttemptsInfo
Definition: sources/includes/gst-nvdscommonconfig.h:96
NvDsFPSSensorInfo
Definition: sources/apps/apps-common/includes/deepstream_perf.h:30
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_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_force_pipeline_eos
gboolean gst_nvmessage_parse_force_pipeline_eos(GstMessage *message, gboolean *force_eos)
Parses the force_eos from a force eos message.
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_fps_stream_add
gboolean gst_nvmessage_parse_fps_stream_add(GstMessage *message, NvDsFPSSensorInfo *sensor_info)
Parses the stream ID from a stream ADD message.
_NvDsSensorInfo
Definition: sources/includes/gst-nvdscommonconfig.h:88
gst_nvmessage_parse_reconnect_attempt_exceeded
gboolean gst_nvmessage_parse_reconnect_attempt_exceeded(GstMessage *message, NvDsRtspAttemptsInfo *rtsp_info)
Parses the NvDsRtspAttemptsInfo from a attempt-exceeded 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.
gst_nvmessage_is_reconnect_attempt_exceeded
gboolean gst_nvmessage_is_reconnect_attempt_exceeded(GstMessage *message)
Determines whether a message is a attempt-exceeded message.
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.
GstObject
struct _GstObject GstObject
Definition: service-maker/includes/object.hpp:39
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.