stub_analytics_plugin  1.6
Network Optix Video Analytics SDK
Public Types | Public Member Functions | List of all members
nx::sdk::analytics::VideoFrame Class Referenceabstract

The VideoFrame class represents interface of decoded video frame. More...

#include <video_frame.h>

Inheritance diagram for nx::sdk::analytics::VideoFrame:
nx::sdk::analytics::MediaFrame nx::sdk::analytics::DataPacket nxpl::PluginInterface

Public Types

enum  PixelFormat {
  yuv420, yuv422, yuv444, rgba,
  rgb, bgr, bgra
}
 
enum  Handle { NoHandle, GLTexture, EGLImageHandle, UserHandle = 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
 handle type
 
virtual int handle () const =0
 Return handle number or 0 if handle is not used.
 
virtual bool map ()=0
 maps the contents of a video frame to system (CPU addressable) memory. More...
 
virtual void unmap ()=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...
 

Detailed Description

The VideoFrame class represents interface of decoded video frame.

Member Function Documentation

◆ height()

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

◆ map()

virtual bool nx::sdk::analytics::VideoFrame::map ( )
pure virtual

maps the contents of a video frame to system (CPU addressable) memory.

Returns
true if map success. If handle is not zero function 'bits' should be called only after map call. otherwise function 'bits' returns zero. If function handle

◆ sampleAspectRatio()

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

◆ width()

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

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