NVIDIA DeepStream SDK API Reference

9.2 Release
pydeepstreamdoc::nvmeta::FrameMetaDoc Namespace Reference

Variables

constexpr const char * descr
 
constexpr const char * append = R"pydeepstream(Append a :class:`DisplayMetadata`, :class:`EventMessageUserMetadata`, :class:`ObjectMetadata` or :class:`TensorOutputUserMetadata` object to the current frame metadata.)pydeepstream"
 
constexpr const char * user_meta_items
 

Variable Documentation

◆ append

constexpr const char * pydeepstreamdoc::nvmeta::FrameMetaDoc::append = R"pydeepstream(Append a :class:`DisplayMetadata`, :class:`EventMessageUserMetadata`, :class:`ObjectMetadata` or :class:`TensorOutputUserMetadata` object to the current frame metadata.)pydeepstream"
constexpr

◆ descr

constexpr const char * pydeepstreamdoc::nvmeta::FrameMetaDoc::descr
constexpr
Initial value:
= R"pydeepstream(
Holds metadata for a frame in a batch.
:ivar frame_number: *int*, Current frame number of the source.
:ivar pad_index: *int*, Pad or port index of stream muxer component for the frame in the batch.
:ivar batch_id: *int*, Location of the frame in the batch.
:ivar source_id: *int*, ID of the source to which the frame belongs, generated through source config
:ivar source_width: *int*, Original width of the frame at input to Gst-streammux.
:ivar source_height: *int*, Original height of the frame at input to Gst-streammux.
:ivar pipeline_width: *int*, Width of the frame after batching.
:ivar pipeline_height: *int*, Height of the frame after batching.
:ivar buffer_pts: *int*, Presentation timestamp (PTS) of the frame.
:ivar ntp_timestamp: *int*, Network Time Protocol (NTP) timestamp.
:ivar object_items: *iterator* Iterator over items of type :class:`ObjectMetadata` in use in the current frame.
:ivar tensor_items: *iterator* Iterator over items of type :class:`UserMetadata` in use in the current frame as items of type :class:`TensorOutputUserMetadata`
Each item *user_meta* can be called as :class:`TensorOutputUserMetadata` by calling *user_meta.as_tensor_output()*.
:ivar segmentation_items: *iterator* Iterator over items of type :class:`UserMetadata` in use in the current frame as items of type :class:`SegmentationUserMetadata`
Each item *user_meta* can be called as :class:`SegmentationUserMetadata` by calling *user_meta.as_segmentation()*.)pydeepstream"

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

Referenced by module_metadata_bind().

◆ user_meta_items

constexpr const char * pydeepstreamdoc::nvmeta::FrameMetaDoc::user_meta_items
constexpr
Initial value:
= R"pydeepstream(
Gets an iterator over user metadata items of a specific type attached to the frame.
This generic method allows accessing any user metadata type without requiring
specific bindings for each type.
:arg meta_type: *int*, The NvDsMetaType value (e.g., NVDS_TRACKER_OBJ_REID_META).
:returns: Iterator over :class:`UserMetadata` items matching the specified type.)pydeepstream"

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

Referenced by module_metadata_bind().