NVIDIA DeepStream SDK API Reference

6.1.1 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nvdsnmos.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
3  *
4  * NVIDIA Corporation and its licensors retain all intellectual property
5  * and proprietary rights in and to this software, related documentation
6  * and any modifications thereto. Any use, reproduction, disclosure or
7  * distribution of this software and related documentation without an express
8  * license agreement from NVIDIA Corporation is strictly prohibited.
9  *
10  */
11 
29 #ifndef NVDSNMOS_H
30 #define NVDSNMOS_H
31 
32 #include <stdbool.h>
33 
34 #ifdef __cplusplus
35 extern "C"
36 {
37 #endif
38 
40 
65  NvDsNmosNodeServer *server,
66  const char *id,
67  const char *sdp);
68 
73 enum {
88 };
89 
101 typedef void (* nmos_logging_callback)(
102  NvDsNmosNodeServer *server,
103  const char *categories,
104  int level,
105  const char *message);
106 
109 
114 typedef struct _NvDsNmosNodeConfig
115 {
119  const char *host_name;
122  unsigned int http_port;
123 
126  const char *seed;
127 
132  unsigned int num_receivers;
137  unsigned int num_senders;
138 
142 
150  const char **log_categories;
152  unsigned int num_log_categories;
154 
160 {
169  const char *sdp;
171 
176 typedef struct _NvDsNmosSenderConfig
177 {
186  const char *sdp;
188 
194 typedef struct _NvDsNmosNodeServer
195 {
201  void *user_data;
205  void *impl;
207 
219  const NvDsNmosNodeConfig *config,
220  NvDsNmosNodeServer *server);
221 
232  NvDsNmosNodeServer *server);
233 
257  NvDsNmosNodeServer *server,
258  const char *id,
259  const char *sdp);
260 
261 #ifdef __cplusplus
262 }
263 #endif
264 
265 #endif
266 
nmos_logging_callback log_callback
Holds the callback for handling log messages.
Definition: nvdsnmos.h:144
More serious recoverable errors such as rejected requests.
Definition: nvdsnmos.h:83
Holds the implementation details of a running NvDsNmos server.
Definition: nvdsnmos.h:194
struct _NvDsNmosReceiverConfig NvDsNmosReceiverConfig
Defines configuration settings used to create receivers in an NvDsNmosNodeServer. ...
Definition: nvdsnmos.h:107
nmos_connection_rtp_activation_callback rtp_connection_activated
Holds the callback for handling an IS-05 Connection API activation.
Definition: nvdsnmos.h:141
Defines configuration settings used to create receivers in an NvDsNmosNodeServer. ...
Definition: nvdsnmos.h:159
void * user_data
Holds a pointer to user data, not used by the NvDsNmos library.
Definition: nvdsnmos.h:201
Errors which are unlikely to be recoverable without restarting the server.
Definition: nvdsnmos.h:85
const char * sdp
Holds the Session Description Protocol data used to configure the receiver.
Definition: nvdsnmos.h:169
Defines configuration settings used to create senders in an NvDsNmosNodeServer.
Definition: nvdsnmos.h:176
Defines configuration settings used to create an NvDsNmosNodeServer.
Definition: nvdsnmos.h:114
struct _NvDsNmosNodeConfig NvDsNmosNodeConfig
Defines configuration settings used to create an NvDsNmosNodeServer.
NvDsNmosReceiverConfig * receivers
Holds configuration settings for the receivers.
Definition: nvdsnmos.h:130
unsigned int num_receivers
Holds the number of receivers.
Definition: nvdsnmos.h:132
struct _NvDsNmosSenderConfig NvDsNmosSenderConfig
Defines configuration settings used to create senders in an NvDsNmosNodeServer.
Definition: nvdsnmos.h:108
const char ** log_categories
Holds topics for which to make logging callbacks.
Definition: nvdsnmos.h:150
void(* nmos_logging_callback)(NvDsNmosNodeServer *server, const char *categories, int level, const char *message)
Type for a callback from NvDsNmos library for log messages.
Definition: nvdsnmos.h:101
unsigned int num_senders
Holds the number of senders.
Definition: nvdsnmos.h:137
Low level debugging information.
Definition: nvdsnmos.h:75
Errors which are likely to cause the server to immediately terminate.
Definition: nvdsnmos.h:87
const char * sdp
Holds the Session Description Protocol data used to configure the sender.
Definition: nvdsnmos.h:186
unsigned int num_log_categories
Holds the number log_categories.
Definition: nvdsnmos.h:152
int log_level
Holds the minimum severity/verbosity level for which to make logging callbacks.
Definition: nvdsnmos.h:147
NvDsNmosSenderConfig * senders
Holds configuration settings for the senders.
Definition: nvdsnmos.h:135
struct _NvDsNmosNodeServer NvDsNmosNodeServer
Holds the implementation details of a running NvDsNmos server.
Definition: nvdsnmos.h:39
bool create_nmos_node_server(const NvDsNmosNodeConfig *config, NvDsNmosNodeServer *server)
Initialize and start an NMOS Node server according to the specified configuration settings...
void * impl
Holds an opaque pointer used by the NvDsNmos library.
Definition: nvdsnmos.h:205
const char * seed
Holds a string used to ensure repeatable UUID generation.
Definition: nvdsnmos.h:126
bool nmos_connection_rtp_activate(NvDsNmosNodeServer *server, const char *id, const char *sdp)
Update the configuration settings of a sender or receiver.
Minor problems that could be recovered automatically by the library.
Definition: nvdsnmos.h:81
unsigned int http_port
Holds the port number for the HTTP APIs, e.g.
Definition: nvdsnmos.h:122
const char * host_name
Holds the fully-qualified host name, e.g.
Definition: nvdsnmos.h:119
bool destroy_nmos_node_server(NvDsNmosNodeServer *server)
Stop and deinitialize an NMOS Node server.
Chatty messages such as detailed API request/response tracking.
Definition: nvdsnmos.h:77
bool(* nmos_connection_rtp_activation_callback)(NvDsNmosNodeServer *server, const char *id, const char *sdp)
Type for a callback from NvDsNmos library when an IS-05 Connection API activation occurs...
Definition: nvdsnmos.h:64
Higher level information about expected API events.
Definition: nvdsnmos.h:79