NVIDIA DeepStream SDK API Reference

9.2 Release
pydeepstreamdoc::nvmeta::UserMetaDoc Namespace Reference

Variables

constexpr const char * descr
 
constexpr const char * set_user_data_json
 
constexpr const char * get_user_data_json
 
constexpr const char * as_tensor_output = R"pydeepstream(Casts the user metadata to :class:`TensorOutputUserMetadata` object.)pydeepstream"
 
constexpr const char * as_segmentation = R"pydeepstream(Casts the user metadata to :class:`SegmentationUserMetadata` object.)pydeepstream"
 
constexpr const char * as_preprocess_batch = R"pydeepstream(Casts the user metadata to :class:`PreprocessBatchUserMetadata` object.)pydeepstream"
 
constexpr const char * as_nvdsanalytics_obj = R"pydeepstream(Casts the user metadata to :class:`NvDsAnalyticsObjInfo` object.)pydeepstream"
 
constexpr const char * as_nvdsanalytics_frame = R"pydeepstream(Casts the user metadata to :class:`NvDsAnalyticsFrameMeta` object.)pydeepstream"
 
constexpr const char * as_structure_str = R"pydeepstream(Returns the string representation of the underlying GstStructure of the Structure user metadata.)pydeepstream"
 
constexpr const char * as_obj_reid = R"pydeepstream(Casts the user metadata to :class:`ObjectReidUserMetadata` object for ReID features.)pydeepstream"
 

Variable Documentation

◆ as_nvdsanalytics_frame

constexpr const char * pydeepstreamdoc::nvmeta::UserMetaDoc::as_nvdsanalytics_frame = R"pydeepstream(Casts the user metadata to :class:`NvDsAnalyticsFrameMeta` object.)pydeepstream"
constexpr

◆ as_nvdsanalytics_obj

constexpr const char * pydeepstreamdoc::nvmeta::UserMetaDoc::as_nvdsanalytics_obj = R"pydeepstream(Casts the user metadata to :class:`NvDsAnalyticsObjInfo` object.)pydeepstream"
constexpr

◆ as_obj_reid

constexpr const char * pydeepstreamdoc::nvmeta::UserMetaDoc::as_obj_reid = R"pydeepstream(Casts the user metadata to :class:`ObjectReidUserMetadata` object for ReID features.)pydeepstream"
constexpr

◆ as_preprocess_batch

constexpr const char * pydeepstreamdoc::nvmeta::UserMetaDoc::as_preprocess_batch = R"pydeepstream(Casts the user metadata to :class:`PreprocessBatchUserMetadata` object.)pydeepstream"
constexpr

◆ as_segmentation

constexpr const char * pydeepstreamdoc::nvmeta::UserMetaDoc::as_segmentation = R"pydeepstream(Casts the user metadata to :class:`SegmentationUserMetadata` object.)pydeepstream"
constexpr

◆ as_structure_str

constexpr const char * pydeepstreamdoc::nvmeta::UserMetaDoc::as_structure_str = R"pydeepstream(Returns the string representation of the underlying GstStructure of the Structure user metadata.)pydeepstream"
constexpr

◆ as_tensor_output

constexpr const char * pydeepstreamdoc::nvmeta::UserMetaDoc::as_tensor_output = R"pydeepstream(Casts the user metadata to :class:`TensorOutputUserMetadata` object.)pydeepstream"
constexpr

◆ descr

constexpr const char * pydeepstreamdoc::nvmeta::UserMetaDoc::descr
constexpr
Initial value:
= R"pydeepstream(
Holds the user metadata. Can be casted to :class:`TensorOutputUserMetadata`, :class:`SegmentationUserMetadata`, or :class:`PreprocessBatchUserMetadata`.
:ivar meta_type: *int*, The metadata type identifier for this user metadata.)pydeepstream"

Definition at line 232 of file service-maker/sources/python/src/bindings/docstrings/metadatadoc.h.

Referenced by module_metadata_bind().

◆ get_user_data_json

constexpr const char * pydeepstreamdoc::nvmeta::UserMetaDoc::get_user_data_json
constexpr
Initial value:
= R"pydeepstream(
Gets the JSON-serialized user data as a Python object.
Deserializes the JSON string stored in user_meta_data back to a Python object.
:returns: The deserialized Python object, or None if no data is set.)pydeepstream"

Definition at line 249 of file service-maker/sources/python/src/bindings/docstrings/metadatadoc.h.

Referenced by module_metadata_bind().

◆ set_user_data_json

constexpr const char * pydeepstreamdoc::nvmeta::UserMetaDoc::set_user_data_json
constexpr
Initial value:
= R"pydeepstream(
Sets a Python object as JSON-serialized user data for this metadata.
The Python object is serialized to a JSON string and stored as a C string (char*).
This allows C/C++ components to access the data by reading the string directly
and parsing it with any JSON library.
:arg data: Any JSON-serializable Python object (dict, list, str, int, float, bool, None).
:arg meta_type: *int*, The metadata type identifier (e.g., NVDS_USER_META starting from 4096+4096+1).
Example C/C++ access:
const char* json_str = (const char*)user_meta->user_meta_data;
// Parse with nlohmann/json, rapidjson, etc.)pydeepstream"

Definition at line 236 of file service-maker/sources/python/src/bindings/docstrings/metadatadoc.h.

Referenced by module_metadata_bind().