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

#include <i_uncompressed_media_frame.h>

Inheritance diagram for nx::sdk::analytics::IUncompressedMediaFrame:
nx::sdk::Interface< IUncompressedMediaFrame, IDataPacket >

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::Interface< IUncompressedMediaFrame, IDataPacket >
virtual IRefCountablequeryInterface (IRefCountable::InterfaceId id) override
 
virtual IRefCountablequeryInterface (InterfaceId id)
 
const IRefCountablequeryInterface (InterfaceId id) const
 
InterfacequeryInterface ()
 
const InterfacequeryInterface () const
 

Static Public Member Functions

static auto interfaceId ()
 

Additional Inherited Members

- Protected Member Functions inherited from nx::sdk::Interface< IUncompressedMediaFrame, IDataPacket >
IRefCountablequeryInterfaceSupportingDeprecatedId (IRefCountable::InterfaceId id, const Uuid &deprecatedInterfaceId)
 

Detailed Description

Decoded media frame, e.g. video or audio.

Member Function Documentation

◆ data()

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

◆ dataSize()

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

◆ planeCount()

virtual int nx::sdk::analytics::IUncompressedMediaFrame::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: