class dlstreamer::GSTFrame

Overview

#include <frame.h>

class GSTFrame: public dlstreamer::BaseFrame {
public:
    // construction

    GSTFrame(
        GstBuffer* buffer,
        const FrameInfo& info,
        bool take_ownership = false,
        ContextPtr context = nullptr
    );

    GSTFrame(
        GstBuffer* buffer,
        const GstVideoInfo* video_info,
        GstVideoRegionOfInterestMeta* roi = nullptr,
        bool take_ownership = false,
        ContextPtr context = nullptr
    );

    GSTFrame(
        MediaType media_type,
        Format format,
        TensorVector tensors,
        bool take_ownership = true
    );

    // methods

    GstBuffer* gst_buffer();
    operator GstBuffer * ();
    const GstVideoInfo* video_info();
    virtual Metadata& metadata();
    virtual std::vector<FramePtr> regions() const;
};

// direct descendants

class GSTFrameBatch;

Inherited Members

public:
    // typedefs

    typedef std::vector<TensorPtr>::iterator iterator;

    // methods

    Frame& operator = (const Frame&);
    virtual MediaType media_type() const = 0;
    virtual Format format() const = 0;
    virtual MemoryType memory_type() const = 0;
    virtual iterator begin() = 0;
    virtual iterator end() = 0;
    virtual TensorPtr tensor(int index = -1) = 0;
    virtual size_t num_tensors() const = 0;
    virtual Metadata& metadata() = 0;
    const Metadata& metadata() const;
    virtual FramePtr parent() const = 0;
    virtual std::vector<FramePtr> regions() const = 0;
    virtual size_t num_tensors() const;
    virtual TensorPtr tensor(int index);
    virtual iterator begin();
    virtual iterator end();
    virtual MediaType media_type() const;
    virtual Format format() const;
    virtual MemoryType memory_type() const;
    virtual Metadata& metadata();
    virtual FramePtr parent() const;
    void set_parent(FramePtr parent);
    virtual std::vector<FramePtr> regions() const;
    void add_region(FramePtr frame);

Detailed Documentation

Methods

virtual Metadata& metadata()

Returns metadata object.

virtual std::vector<FramePtr> regions() const

Returns list of regions. Each region typically represents an object detected on frame and may contain own metadata describing region specific attributes.