NVIDIA DeepStream SDK API Reference

6.1.1 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
DeepStream Yaml Parser API

Detailed Description

Defines an API for the GStreamer NvDsYaml plugin.

Typedefs

typedef enum NvDsYamlParserStatus NvDsYamlParserStatus
 Enum for Yaml parsing status for the API call on a GstElement. More...
 

Enumerations

enum  NvDsYamlParserStatus {
  NVDS_YAML_PARSER_SUCCESS,
  NVDS_YAML_PARSER_DISABLED,
  NVDS_YAML_PARSER_ERROR
}
 Enum for Yaml parsing status for the API call on a GstElement. More...
 

Functions

NvDsYamlParserStatus nvds_parse_file_source (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a filesrc element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_uridecodebin (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a uridecodebin element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_rtsp_source (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a rtspsrc element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_nvarguscamerasrc (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a nvarguscamerasrc element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_v4l2src (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a v4l2src element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_multifilesrc (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a multifilesrc element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_alsasrc (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a alsasrc element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_source_list (GList **src_list, gchar *cfg_file_path, const char *group)
 Parse semicolon separated uri(s) in the source-list group and store it in a GList. More...
 
NvDsYamlParserStatus nvds_parse_streammux (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a nvstreammux element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_tracker (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a nvtracker element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_osd (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a nvdsosd element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_tiler (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a nvtiler element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_msgbroker (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a nvmsgbroker element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_msgconv (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a nvmsgconv element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_gie (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a nvinfer element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_egl_sink (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a nveglglessink element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_file_sink (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a filesink element from values specified in a YAML configuration file. More...
 
NvDsYamlParserStatus nvds_parse_fake_sink (GstElement *element, gchar *cfg_file_path, const char *group)
 Set properties of a fakesink element from values specified in a YAML configuration file. More...
 

Typedef Documentation

Enum for Yaml parsing status for the API call on a GstElement.

Enumeration Type Documentation

Enum for Yaml parsing status for the API call on a GstElement.

Enumerator
NVDS_YAML_PARSER_SUCCESS 

Properties were set correctly.

NVDS_YAML_PARSER_DISABLED 

Property group was disabled, properties were not set.

NVDS_YAML_PARSER_ERROR 

Encountered an error while setting properties.

Definition at line 52 of file nvds_yml_parser.h.

Function Documentation

NvDsYamlParserStatus nvds_parse_alsasrc ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a alsasrc element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the alsasrc element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_egl_sink ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a nveglglessink element from values specified in a YAML configuration file.

Parameters
[in]elementGstreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the nveglglessink element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_fake_sink ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a fakesink element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the fakesink element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_file_sink ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a filesink element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the filesink element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_file_source ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a filesrc element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the filesrc element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_gie ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a nvinfer element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the nvinfer element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_msgbroker ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a nvmsgbroker element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the nmvsgbroker element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_msgconv ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a nvmsgconv element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the nvmsgconv element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_multifilesrc ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a multifilesrc element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]TheYAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the multifilesrc element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_nvarguscamerasrc ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a nvarguscamerasrc element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the nvarguscamerasrc element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_osd ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a nvdsosd element from values specified in a YAML configuration file.

Parameters
[in]elementThe gst element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupThe group in the YAML config file on which parsing is done and corresponding properties are set on the nvdsosd element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_rtsp_source ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a rtspsrc element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the rtspsrc element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_source_list ( GList **  src_list,
gchar *  cfg_file_path,
const char *  group 
)

Parse semicolon separated uri(s) in the source-list group and store it in a GList.

Parameters
[in]src_listThe empty GList address.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file on which parsing is done A key "location" is present in the group which contains semicolon separated uri(s). Once the API call finishes, the GList contains the uris(s).
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_streammux ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a nvstreammux element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the nvstreammux element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_tiler ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a nvtiler element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the nvmultistreamtiler element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_tracker ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a nvtracker element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the nvtracker element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_uridecodebin ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a uridecodebin element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the uridecodebin element.
Returns
Yaml parsing status for the API call.
NvDsYamlParserStatus nvds_parse_v4l2src ( GstElement *  element,
gchar *  cfg_file_path,
const char *  group 
)

Set properties of a v4l2src element from values specified in a YAML configuration file.

Parameters
[in]elementGStreamer element on which properties are to be set.
[in]cfg_file_pathThe YAML config file used by an application.
[in]groupGroup in the YAML config file to be parsed and corresponding properties set on the v4l2src element.
Returns
Yaml parsing status for the API call.