stub_analytics_plugin  1.6
Network Optix Video Analytics SDK
Public Types | Public Member Functions | List of all members
nx::sdk::analytics::UncompressedVideoFrame Class Referenceabstract
Inheritance diagram for nx::sdk::analytics::UncompressedVideoFrame:
nx::sdk::analytics::MediaFrame nx::sdk::analytics::DataPacket nxpl::PluginInterface

Public Types

enum  PixelFormat {
  yuv420, argb, abgr, rgba,
  bgra, rgb, bgr, count
}
 
enum  Handle { none = 0, glTexture, eglImage, user = 1000 }
 

Public Member Functions

virtual int width () const =0
 
virtual int height () const =0
 
virtual Ratio sampleAspectRatio () const =0
 
virtual PixelFormat pixelFormat () const =0
 
virtual Handle handleType () const =0
 
virtual int handle () const =0
 
virtual int lineSize (int plane) const =0
 
virtual bool map () const =0
 
virtual void unmap () const =0
 
- Public Member Functions inherited from nx::sdk::analytics::MediaFrame
virtual int planeCount () const =0
 
virtual int dataSize (int plane) const =0
 
virtual const char * data (int plane) const =0
 
- Public Member Functions inherited from nx::sdk::analytics::DataPacket
virtual int64_t timestampUsec () const =0
 
- Public Member Functions inherited from nxpl::PluginInterface
virtual void * queryInterface (const nxpl::NX_GUID &interfaceID)=0
 Cast to type, specified by interfaceID. More...
 
virtual unsigned int addRef ()=0
 Increment reference counter. More...
 
virtual unsigned int releaseRef ()=0
 Decrement reference counter. More...
 

Member Function Documentation

◆ handle()

virtual int nx::sdk::analytics::UncompressedVideoFrame::handle ( ) const
pure virtual
Returns
Handle, or 0 if there is no handle for this frame.

◆ height()

virtual int nx::sdk::analytics::UncompressedVideoFrame::height ( ) const
pure virtual
Returns
height of decoded frame in pixels.

◆ lineSize()

virtual int nx::sdk::analytics::UncompressedVideoFrame::lineSize ( int  plane) const
pure virtual
Parameters
planeNumber of the plane, in range 0..planesCount().
Returns
Number of bytes in each pixel line of the plane, or 0 if the data is not accessible.

◆ map()

virtual bool nx::sdk::analytics::UncompressedVideoFrame::map ( ) const
pure virtual

Maps the raw data of the video frame to the system (CPU addressable) memory. If handle() is non-zero, data() should be called only after map call, otherwise data() returns null.

Returns
Success.

◆ sampleAspectRatio()

virtual Ratio nx::sdk::analytics::UncompressedVideoFrame::sampleAspectRatio ( ) const
pure virtual
Returns
aspect ratio of frame pixels.

◆ width()

virtual int nx::sdk::analytics::UncompressedVideoFrame::width ( ) const
pure virtual
Returns
width of decoded frame in pixels.

The documentation for this class was generated from the following file: