Detailed Description

Defines an API for the GStreamer NvDsYaml plugin.

Data Structures
struct	NvDsYamlCodecStatus
	Enum for codec type for the API call on a encoder. More...

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

typedef struct NvDsYamlCodecStatus	NvDsYamlCodecStatus
	Enum for codec type for the API call on a encoder. 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...

enum	NvDsGieType { NVDS_GIE_PLUGIN_INFER = 0, NVDS_GIE_PLUGIN_INFER_SERVER }
	Enum for specifying the inference plugin type. 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_gie_type (NvDsGieType gie_type, gchar cfg_file_path, const char *group)
	Get the GIE type, nvinfer or invinferserver, from the 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_3d_sink (GstElement element, gchar cfg_file_path, const char *group)
	Set properties of a nv3dsink 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...

NvDsYamlParserStatus	nvds_parse_codec_status (gchar cfg_file_path, const char group, NvDsYamlCodecStatus *codec_status)
	Parses codec type and enable status values specified in a YAML configuration file. More...

NvDsYamlParserStatus	nvds_parse_nvv4l2h264enc (GstElement element, gchar cfg_file_path, const char *group)
	Set properties of a nvv4l2h264enc element from values specified in a YAML configuration file. More...

NvDsYamlParserStatus	nvds_parse_nvv4l2h265enc (GstElement element, gchar cfg_file_path, const char *group)
	Set properties of a nvv4l2h265enc element from values specified in a YAML configuration file. More...

NvDsYamlParserStatus	nvds_parse_multiurisrcbin (GstElement element, gchar cfg_file_path, const char *group)
	Set properties of a nvmultiurisrcbin element from values specified in a YAML configuration file. More...

NvDsYamlParserStatus	nvds_parse_nvxfer (GstElement element, gchar cfg_file_path, const char *group)
	Set properties of a nvdsxfer element from values specified in a YAML configuration file. More...

NvDsYamlParserStatus	nvds_parse_nvxfer_position (gchar cfg_file_path, const char group, guint *position)
	Parses nvdsxfer plugin position values specified in a YAML configuration file. More...

Typedef Documentation

◆ NvDsYamlCodecStatus

typedef struct NvDsYamlCodecStatus NvDsYamlCodecStatus

Enum for codec type for the API call on a encoder.

◆ NvDsYamlParserStatus

typedef enum NvDsYamlParserStatus NvDsYamlParserStatus

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

Enumeration Type Documentation

◆ NvDsGieType

enum NvDsGieType

Enum for specifying the inference plugin type.

Enumerator
NVDS_GIE_PLUGIN_INFER	Inference using nvinfer GIE.
NVDS_GIE_PLUGIN_INFER_SERVER	Inference using nvinferserver GIE.

Definition at line 75 of file nvds_yml_parser.h.

◆ NvDsYamlParserStatus

enum NvDsYamlParserStatus

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

◆ nvds_parse_3d_sink()

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

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

Parameters

[in]	element	Gstreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nv3dsink element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_alsasrc()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the alsasrc element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_codec_status()

NvDsYamlParserStatus nvds_parse_codec_status	(	gchar *	cfg_file_path,
		const char *	group,
		NvDsYamlCodecStatus *	codec_status
	)

Parses codec type and enable status values specified in a YAML configuration file.

Parameters

[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed. The Group contains codec type parameter, based on which h264 or h265 encoder is used.

Returns: codec type and enable status of encoder as pair for the API call.

◆ nvds_parse_egl_sink()

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]	element	Gstreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nveglglessink element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_fake_sink()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the fakesink element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_file_sink()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the filesink element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_file_source()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the filesrc element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_gie()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nvinfer element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_gie_type()

NvDsYamlParserStatus nvds_parse_gie_type	(	NvDsGieType *	gie_type,
		gchar *	cfg_file_path,
		const char *	group
	)

Get the GIE type, nvinfer or invinferserver, from the YAML configuration file.

Parameters

[out]	gie_type	Pointer to variable of NvDSGieType to be updated if the plugin type is specified.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nvinfer element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_msgbroker()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nmvsgbroker element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_msgconv()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nvmsgconv element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_multifilesrc()

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]	element	GStreamer element on which properties are to be set.
[in]	The	YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the multifilesrc element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_multiurisrcbin()

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

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

Parameters

[in]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nvv4l2h265enc element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_nvarguscamerasrc()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nvarguscamerasrc element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_nvv4l2h264enc()

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

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

Parameters

[in]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nvv4l2h264enc element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_nvv4l2h265enc()

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

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

Parameters

[in]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nvv4l2h265enc element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_nvxfer()

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

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

Parameters

[in]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nvdsxfer element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_nvxfer_position()

NvDsYamlParserStatus nvds_parse_nvxfer_position	(	gchar *	cfg_file_path,
		const char *	group,
		guint *	position
	)

Parses nvdsxfer plugin position values specified in a YAML configuration file.

Parameters

[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nvdsxfer element.
[out]	position	Pointer to variable holding position value.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_osd()

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]	element	The gst element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	The 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.

◆ nvds_parse_rtsp_source()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the rtspsrc element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_source_list()

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_list	The empty GList address.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file on which parsing is done A key "list" 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.

◆ nvds_parse_streammux()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nvstreammux element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_tiler()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nvmultistreamtiler element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_tracker()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the nvtracker element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_uridecodebin()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the uridecodebin element.

Returns: Yaml parsing status for the API call.

◆ nvds_parse_v4l2src()

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]	element	GStreamer element on which properties are to be set.
[in]	cfg_file_path	The YAML config file used by an application.
[in]	group	Group in the YAML config file to be parsed and corresponding properties set on the v4l2src element.

Returns: Yaml parsing status for the API call.

NVIDIA DeepStream SDK API Reference

6.4 Release

Detailed Description

Data Structures

Typedefs

Enumerations

Functions

Typedef Documentation

◆ NvDsYamlCodecStatus

◆ NvDsYamlParserStatus

Enumeration Type Documentation

◆ NvDsGieType

◆ NvDsYamlParserStatus

Function Documentation

◆ nvds_parse_3d_sink()

◆ nvds_parse_alsasrc()

◆ nvds_parse_codec_status()

◆ nvds_parse_egl_sink()

◆ nvds_parse_fake_sink()

◆ nvds_parse_file_sink()

◆ nvds_parse_file_source()

◆ nvds_parse_gie()

◆ nvds_parse_gie_type()

◆ nvds_parse_msgbroker()

◆ nvds_parse_msgconv()

◆ nvds_parse_multifilesrc()

◆ nvds_parse_multiurisrcbin()

◆ nvds_parse_nvarguscamerasrc()

◆ nvds_parse_nvv4l2h264enc()

◆ nvds_parse_nvv4l2h265enc()

◆ nvds_parse_nvxfer()

◆ nvds_parse_nvxfer_position()

◆ nvds_parse_osd()

◆ nvds_parse_rtsp_source()

◆ nvds_parse_source_list()

◆ nvds_parse_streammux()

◆ nvds_parse_tiler()

◆ nvds_parse_tracker()

◆ nvds_parse_uridecodebin()

◆ nvds_parse_v4l2src()