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

#include <media_frame.h>

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

Public Member Functions

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

Interface for a decoded media frame, e.g. video or audio.

Member Function Documentation

◆ data()

virtual const char* nx::sdk::analytics::MediaFrame::data ( int  plane) const
pure virtual
Parameters
planeNumber of the plane, in range 0..planesCount().
Returns
Pointer to the byte data of the plane, or null if the data is not accessible.

◆ dataSize()

virtual int nx::sdk::analytics::MediaFrame::dataSize ( int  plane) const
pure virtual
Parameters
planeNumber of the plane, in range 0..planesCount().
Returns
Number of bytes accessible via data(plane), or 0 if the data is not accessible.

◆ planeCount()

virtual int nx::sdk::analytics::MediaFrame::planeCount ( ) const
pure virtual
Returns
Number of planes with contain war byte data. For video frame, each plane contains pixel data for a particular channel (e.g. Red, Green, Blue, or Alpha channel). 0 in case the raw byte data is not accessible for this type of frame.

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