NVIDIA DeepStream SDK API Reference

9.1 Release

Detailed Description

Gets information such as the batch size and the number of streams.

Functions

GstQuery * gst_nvquery_batch_size_new (void)
 Creates a new batch-size query, which can be used by elements to query the number of buffers in upstream elements' batched buffers. More...
 
gboolean gst_nvquery_is_batch_size (GstQuery *query)
 Determines whether a query is a batch size query. More...
 
void gst_nvquery_batch_size_set (GstQuery *query, guint batch_size)
 Sets the batch size, used by the elements responding to the batch size query. More...
 
gboolean gst_nvquery_batch_size_parse (GstQuery *query, guint *batch_size)
 Parses batch size from a batch size query. More...
 
GstQuery * gst_nvquery_numStreams_size_new (void)
 Creates a number of streams query, used by elements to query upstream the number of input sources. More...
 
gboolean gst_nvquery_is_numStreams_size (GstQuery *query)
 Determines whether a query is a number-of-streams query. More...
 
void gst_nvquery_numStreams_size_set (GstQuery *query, guint numStreams_size)
 Sets the number of input sources. More...
 
gboolean gst_nvquery_numStreams_size_parse (GstQuery *query, guint *numStreams_size)
 Parses the number of streams from a number of streams query. More...
 
GstQuery * gst_nvquery_preprocess_poolsize_new (guint gieid)
 Creates a preprocess poolsize query, used by elements to query preprocess element for the size of buffer pool. More...
 
gboolean gst_nvquery_is_preprocess_poolsize (GstQuery *query)
 Determines whether a query is a preprocess poolsize query. More...
 
void gst_nvquery_preprocess_poolsize_set (GstQuery *query, guint preprocess_poolsize)
 Sets the preprocess poolsize as a reponse to query. More...
 
gboolean gst_nvquery_preprocess_poolsize_parse (GstQuery *query, guint *preprocess_poolsize)
 Parses the preprocess poolsize from a preprocess poolsize query. More...
 
gboolean gst_nvquery_preprocess_poolsize_gieid_parse (GstQuery *query, guint *gieId)
 Parses the preprocess gie id from a preprocess poolsize query. More...
 
gboolean gst_nvquery_is_update_caps (GstQuery *query)
 Checks if a query is update_caps query. More...
 
void gst_nvquery_parse_update_caps (GstQuery *query, guint *stream_index, const GValue *frame_rate)
 Parses the update_caps query. More...
 
gboolean gst_nvquery_update_caps_peer_query (GstPad *srcpad, GstStructure *str)
 Heterogeneous batching query for new streammux. More...
 
GstQuery * gst_nvquery_text_embedding_new (const gchar *text_input, const gchar *model)
 Creates a new text embedding query, which can be used to request text embedding information from the nvinfer plugin. More...
 
gboolean gst_nvquery_is_text_embedding (GstQuery *query)
 Determines whether a query is a text embedding query. More...
 
void gst_nvquery_text_embedding_set (GstQuery *query, const gchar *id, guint64 created, const gchar *model, const GValue *data)
 Sets the text embedding response data, used by elements responding to the text embedding query. More...
 
gboolean gst_nvquery_text_embedding_parse (GstQuery *query, const gchar **id, guint64 *created, const gchar **model, const GValue **data)
 Parses the text embedding response from a text embedding query. More...
 
gboolean gst_nvquery_text_embedding_parse_request (GstQuery *query, const gchar **text_input, const gchar **model)
 Parses the text embedding request parameters from a text embedding query. More...
 
GstQuery * gst_nvquery_image_embedding_new (const gchar *image_path, const gchar *model, gboolean has_bbox, gdouble bbox_left, gdouble bbox_top, gdouble bbox_width, gdouble bbox_height)
 Creates a new image embedding query, which can be used to request image embedding generation from the nvdsvisionencoder plugin. More...
 
gboolean gst_nvquery_is_image_embedding (GstQuery *query)
 Determines whether a query is an image embedding query. More...
 
void gst_nvquery_image_embedding_set (GstQuery *query, const gchar *id, guint64 created, const gchar *model, const GValue *data)
 Sets the image embedding response data, used by elements responding to the image embedding query. More...
 
gboolean gst_nvquery_image_embedding_parse (GstQuery *query, const gchar **id, guint64 *created, const gchar **model, const GValue **data)
 Parses the image embedding response from an image embedding query. More...
 
gboolean gst_nvquery_image_embedding_parse_request (GstQuery *query, const gchar **image_path, const gchar **model, gboolean *has_bbox, gdouble *bbox_left, gdouble *bbox_top, gdouble *bbox_width, gdouble *bbox_height)
 Parses the image embedding request parameters from an image embedding query. More...
 

Function Documentation

◆ gst_nvquery_batch_size_new()

GstQuery * gst_nvquery_batch_size_new ( void  )

Creates a new batch-size query, which can be used by elements to query the number of buffers in upstream elements' batched buffers.

Returns
A pointer to the new batch size query.

◆ gst_nvquery_batch_size_parse()

gboolean gst_nvquery_batch_size_parse ( GstQuery *  query,
guint *  batch_size 
)

Parses batch size from a batch size query.

params[in] query A pointer to a batch size query. params[out] batch_size A pointer to an unsigned integer in which the batch size is stored.

Returns
True if the query was successfully parsed.

◆ gst_nvquery_batch_size_set()

void gst_nvquery_batch_size_set ( GstQuery *  query,
guint  batch_size 
)

Sets the batch size, used by the elements responding to the batch size query.

This function fails if the query is not a batch size query.

params[in] query A pointer to a batch size query. params[in] batch_size The batch size to be set.

◆ gst_nvquery_image_embedding_new()

GstQuery * gst_nvquery_image_embedding_new ( const gchar *  image_path,
const gchar *  model,
gboolean  has_bbox,
gdouble  bbox_left,
gdouble  bbox_top,
gdouble  bbox_width,
gdouble  bbox_height 
)

Creates a new image embedding query, which can be used to request image embedding generation from the nvdsvisionencoder plugin.

params[in] image_path Filesystem path to the input image. params[in] model Model name string (for response metadata). params[in] has_bbox Whether a bounding box crop is specified. params[in] bbox_left Bounding box left coordinate (ignored if !has_bbox). params[in] bbox_top Bounding box top coordinate. params[in] bbox_width Bounding box width. params[in] bbox_height Bounding box height.

Returns
A pointer to the new image embedding query.

◆ gst_nvquery_image_embedding_parse()

gboolean gst_nvquery_image_embedding_parse ( GstQuery *  query,
const gchar **  id,
guint64 *  created,
const gchar **  model,
const GValue **  data 
)

Parses the image embedding response from an image embedding query.

params[in] query A pointer to an image embedding query. params[out] id A pointer to store the unique identifier string. params[out] created A pointer to store the creation timestamp. params[out] model A pointer to store the model name string. params[out] data A pointer to store the GValue containing embedding data.

Returns
True if the query was successfully parsed.

◆ gst_nvquery_image_embedding_parse_request()

gboolean gst_nvquery_image_embedding_parse_request ( GstQuery *  query,
const gchar **  image_path,
const gchar **  model,
gboolean *  has_bbox,
gdouble *  bbox_left,
gdouble *  bbox_top,
gdouble *  bbox_width,
gdouble *  bbox_height 
)

Parses the image embedding request parameters from an image embedding query.

params[in] query A pointer to an image embedding query. params[out] image_path A pointer to store the image path string. params[out] model A pointer to store the model name string. params[out] has_bbox A pointer to store the bbox flag. params[out] bbox_left A pointer to store left coordinate. params[out] bbox_top A pointer to store top coordinate. params[out] bbox_width A pointer to store width. params[out] bbox_height A pointer to store height.

Returns
True if the query was successfully parsed.

◆ gst_nvquery_image_embedding_set()

void gst_nvquery_image_embedding_set ( GstQuery *  query,
const gchar *  id,
guint64  created,
const gchar *  model,
const GValue data 
)

Sets the image embedding response data, used by elements responding to the image embedding query.

params[in] query A pointer to an image embedding query. params[in] id A pointer to the unique identifier string. params[in] created The creation timestamp (epoch). params[in] model A pointer to the model name string. params[in] data A pointer to a GValue containing the embedding data array.

◆ gst_nvquery_is_batch_size()

gboolean gst_nvquery_is_batch_size ( GstQuery *  query)

Determines whether a query is a batch size query.

params[in] query A pointer to the query to be checked.

Returns
True if the query is a batch size query.

◆ gst_nvquery_is_image_embedding()

gboolean gst_nvquery_is_image_embedding ( GstQuery *  query)

Determines whether a query is an image embedding query.

params[in] query A pointer to the query to be checked.

Returns
True if the query is an image embedding query.

◆ gst_nvquery_is_numStreams_size()

gboolean gst_nvquery_is_numStreams_size ( GstQuery *  query)

Determines whether a query is a number-of-streams query.

params[in] query A pointer to the query to be checked.

Returns
A Boolean; true if the query is a number of streams query.

◆ gst_nvquery_is_preprocess_poolsize()

gboolean gst_nvquery_is_preprocess_poolsize ( GstQuery *  query)

Determines whether a query is a preprocess poolsize query.

params[in] query A pointer to the query to be checked.

Returns
A Boolean; true if the query is a preprocess poolsize query.

◆ gst_nvquery_is_text_embedding()

gboolean gst_nvquery_is_text_embedding ( GstQuery *  query)

Determines whether a query is a text embedding query.

params[in] query A pointer to the query to be checked.

Returns
True if the query is a text embedding query.

◆ gst_nvquery_is_update_caps()

gboolean gst_nvquery_is_update_caps ( GstQuery *  query)

Checks if a query is update_caps query.

params[in] query A pointer to a query.

Returns
True if the query was update_caps query.

◆ gst_nvquery_numStreams_size_new()

GstQuery * gst_nvquery_numStreams_size_new ( void  )

Creates a number of streams query, used by elements to query upstream the number of input sources.

Returns
A pointer to the new query.

◆ gst_nvquery_numStreams_size_parse()

gboolean gst_nvquery_numStreams_size_parse ( GstQuery *  query,
guint *  numStreams_size 
)

Parses the number of streams from a number of streams query.

params[in] query A pointer to a number-of-streams query. params[out] batch_size A pointer to an unsigned integer in which the number of streams is stored.

Returns
True if the query was successfully parsed.

◆ gst_nvquery_numStreams_size_set()

void gst_nvquery_numStreams_size_set ( GstQuery *  query,
guint  numStreams_size 
)

Sets the number of input sources.

This function is used by elements responding to a number of streams query. It fails if the query is not of the correct type.

params[in] query A pointer to a number-of-streams query. params[in] numStreams_size The number of input sources.

◆ gst_nvquery_parse_update_caps()

void gst_nvquery_parse_update_caps ( GstQuery *  query,
guint *  stream_index,
const GValue frame_rate 
)

Parses the update_caps query.

params[in] query A pointer to a update_caps query. params[out] stream_index A pointer to an unsigned integer in which the stream_index is stored. params[out] frame_rate A pointer to an GValue string in which the frame_rate is stored.

Returns
Void.

◆ gst_nvquery_preprocess_poolsize_gieid_parse()

gboolean gst_nvquery_preprocess_poolsize_gieid_parse ( GstQuery *  query,
guint *  gieId 
)

Parses the preprocess gie id from a preprocess poolsize query.

params[in] query A pointer to a nv-preprocess-poolsize query. params[out] gieid A pointer to an unsigned integer in which the preprocess gie id is stored.

Returns
True if the query was successfully parsed.

◆ gst_nvquery_preprocess_poolsize_new()

GstQuery * gst_nvquery_preprocess_poolsize_new ( guint  gieid)

Creates a preprocess poolsize query, used by elements to query preprocess element for the size of buffer pool.

params[in] gieid An unsigned integer in which the preprocess gie id is stored.

Returns
A pointer to the new query.

◆ gst_nvquery_preprocess_poolsize_parse()

gboolean gst_nvquery_preprocess_poolsize_parse ( GstQuery *  query,
guint *  preprocess_poolsize 
)

Parses the preprocess poolsize from a preprocess poolsize query.

params[in] query A pointer to a nv-preprocess-poolsize query. params[out] preprocess_poolsize A pointer to an unsigned integer in which the preprocess poolsize is stored.

Returns
True if the query was successfully parsed.

◆ gst_nvquery_preprocess_poolsize_set()

void gst_nvquery_preprocess_poolsize_set ( GstQuery *  query,
guint  preprocess_poolsize 
)

Sets the preprocess poolsize as a reponse to query.

This function is used by elements responding to a number of streams query. It fails if the query is not of the correct type.

params[in] query A pointer to a nv-preprocess-poolsize query. params[in] preprocess_poolsize The preprocess poolsize to be set.

◆ gst_nvquery_text_embedding_new()

GstQuery * gst_nvquery_text_embedding_new ( const gchar *  text_input,
const gchar *  model 
)

Creates a new text embedding query, which can be used to request text embedding information from the nvinfer plugin.

params[in] text_input A pointer to the input text string. params[in] model A pointer to the model name string.

Returns
A pointer to the new text embedding query.

◆ gst_nvquery_text_embedding_parse()

gboolean gst_nvquery_text_embedding_parse ( GstQuery *  query,
const gchar **  id,
guint64 *  created,
const gchar **  model,
const GValue **  data 
)

Parses the text embedding response from a text embedding query.

params[in] query A pointer to a text embedding query. params[out] id A pointer to store the unique identifier string. params[out] created A pointer to store the creation timestamp. params[out] model A pointer to store the model name string. params[out] data A pointer to store the GValue containing embedding data.

Returns
True if the query was successfully parsed.

◆ gst_nvquery_text_embedding_parse_request()

gboolean gst_nvquery_text_embedding_parse_request ( GstQuery *  query,
const gchar **  text_input,
const gchar **  model 
)

Parses the text embedding request parameters from a text embedding query.

params[in] query A pointer to a text embedding query. params[out] text_input A pointer to store the input text string. params[out] model A pointer to store the model name string.

Returns
True if the query was successfully parsed.

◆ gst_nvquery_text_embedding_set()

void gst_nvquery_text_embedding_set ( GstQuery *  query,
const gchar *  id,
guint64  created,
const gchar *  model,
const GValue data 
)

Sets the text embedding response data, used by elements responding to the text embedding query.

params[in] query A pointer to a text embedding query. params[in] id A pointer to the unique identifier string. params[in] created The creation timestamp (epoch). params[in] model A pointer to the model name string. params[in] data A pointer to a GValue containing the embedding data array.

◆ gst_nvquery_update_caps_peer_query()

gboolean gst_nvquery_update_caps_peer_query ( GstPad *  srcpad,
GstStructure *  str 
)

Heterogeneous batching query for new streammux.

params[in] srcpad A pointer to a srcpad. params[in] str A pointer to a str of update_caps query.

Returns
True if the query was successfully pushed.