nx_video_source_sdk  1.0
Video Source SDK
Public Member Functions | List of all members
nxcip::CameraMediaEncoder2 Class Referenceabstract

Extends CameraMediaEncoder by adding functionality for plugin to directly provide live media stream. More...

#include <camera_plugin.h>

Inheritance diagram for nxcip::CameraMediaEncoder2:
nxcip::CameraMediaEncoder nxpl::PluginInterface MediaEncoder nxcip::CameraMediaEncoder3 rpi_cam::DefaultRefCounter< nxcip::CameraMediaEncoder3 > nxcip::CameraMediaEncoder4 rpi_cam::MediaEncoder nxcip::CameraMediaEncoder5

Public Member Functions

virtual StreamReadergetLiveStreamReader ()=0
 Returns stream reader, providing live data stream. More...
 
virtual int getAudioFormat (AudioFormat *audioFormat) const =0
 Returns audio format, if audio is supported.
 
- Public Member Functions inherited from nxcip::CameraMediaEncoder
virtual int getMediaUrl (char *urlBuf) const =0
 Returns url of media stream as NULL-terminated utf-8 string. More...
 
virtual int getResolutionList (ResolutionInfo *infoList, int *infoListCount) const =0
 Returns supported resolution list. More...
 
virtual int getMaxBitrate (int *maxBitrate) const =0
 Returns maximem bitrate in Kbps. 0 is interpreted as unlimited bitrate value. More...
 
virtual int setResolution (const Resolution &resolution)=0
 Change resolution on specified encoder. More...
 
virtual int setFps (const float &fps, float *selectedFps)=0
 
virtual int setBitrate (int bitrateKbps, int *selectedBitrateKbps)=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 int addRef () const =0
 Increment reference counter. More...
 
virtual int releaseRef () const =0
 Decrement reference counter. More...
 

Detailed Description

Extends CameraMediaEncoder by adding functionality for plugin to directly provide live media stream.

Member Function Documentation

◆ getLiveStreamReader()

virtual StreamReader* nxcip::CameraMediaEncoder2::getLiveStreamReader ( )
pure virtual

Returns stream reader, providing live data stream.

This method is only used if BaseCameraManager::nativeMediaStreamCapability is present, otherwise CameraMediaEncoder::getMediaUrl is used

Can be used if camera uses some proprietary media stream control protocol or wants to provide motion information

Implemented in MediaEncoder, and rpi_cam::MediaEncoder.


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