Skip to content

cvedia::rt::iface::AppSrc

Inherits from LiveReader, InputHandler, ModuleImpl, Module

Public Functions

Name
AppSrc(std::string const & moduleName)
virtual expected< void > pushRawFrame(cbuffer image, cmap const & metadata) =0
virtual expected< void > pushRawFrame(void const * buffer, int width, int height, SolutionManager::RawFrameType type, std::chrono::milliseconds timestamp, cmap const & metadata) =0
virtual expected< void > pushEncodedFrame(unsigned char const * data, size_t dataSize, iface::SolutionManager::EncodingType type, std::chrono::milliseconds timestamp) =0
virtual void setTargetFps(int fps) =0
virtual void setMaxPixels(int pixels) =0
virtual expected< void > setEncodedFrameParameters(int , int , int , int )
virtual int getQueueSize() =0
virtual std::pair< int, int > getSourceResolution()
virtual float getSourceFrameRate()

Additional inherited members

Public Functions inherited from LiveReader

Name
LiveReader(std::string const & moduleName)

Public Functions inherited from InputHandler

Name
InputHandler(std::string const & moduleName)
virtual expected< void > openUri(std::string const & uri) =0
virtual void close() =0
virtual expected< cvec > readFrame(bool ignoreSkipFrame =false, cmap frameSettings ={}) =0
virtual bool canRead()
virtual expected< void > start()
virtual void stop()
virtual void pause(bool state)
virtual void setFrameCallback(std::function< void(cmap &&)> cb)
virtual int getCurrentFrameIndex() =0
virtual float getCurrentFps(FPSType fpsType =FPSType::FPSType_TARGET) =0
virtual double getCurrentTimestamp() =0
virtual bool isEnded() =0
virtual std::vector< InputFormat > getSupportedFormats() =0
virtual void setSourceFormat(InputFormat fmt) =0
virtual InputFormat getSourceFormat() =0
virtual std::optional< Codec > getSourceCodec() =0

Protected Functions inherited from InputHandler

Name
void emitFramePayload(cmap && payload)
std::function< void(cmap &&)> const & frameCallback() const

Protected Attributes inherited from InputHandler

Name
std::function< void(cmap &&)> frameCallback_
std::thread pullThread_
std::atomic< bool > pullRunning_
std::atomic< bool > pullPaused_
std::condition_variable pullCv_
std::mutex pullCvMutex_

Public Functions inherited from ModuleImpl

Name
ModuleImpl(std::string moduleName)
virtual void * getPtr() override
virtual void verifyConfig(pCValue instanceConfig, ConfigCheckResults & configCheckResults) override
virtual pCValue getConfigSpecs() const override
virtual std::string const & getName() const override
virtual void setName(std::string const & name) override
virtual void setParent(iface::Module * parent) override
virtual iface::Module * getParent() const override
virtual expected< pCValue > getValue(std::string const & key, int dictType) const override
virtual expected< cvec > getValue(std::vector< std::string > const & keys, int dictType) const override
virtual expected< void > setValue(std::string const & key, pCValue const & value, int dictType) override
virtual expected< void > setValue(cmap const & values, int dictType) override
expected< void > unsetKey(std::string const & key, int const dictType)
virtual expected< std::unique_ptr< iface::CVDictRoot > > getStateDict() const override
virtual expected< std::unique_ptr< iface::CVDictRoot > > getConfigDict() const override
virtual expected< void > setConfig(pCValue const & conf) const override
virtual std::string getRootNode() const override

Public Attributes inherited from ModuleImpl

Name
std::shared_mutex pluginMut_

Public Functions inherited from Module

Name
Module() =default
virtual ~Module() =default
Module(Module const & other) =default
Module & operator=(Module const & other) =default
Module(Module && other) =default
Module & operator=(Module && other) =default
virtual void * getPtr() =0
virtual void verifyConfig(pCValue instanceConfig, ConfigCheckResults & configCheckResults) =0
virtual pCValue getConfigSpecs() const =0
virtual std::map< std::string, std::shared_ptr< ConfigDescriptor > > getConfigDescriptors() const
virtual std::string const & getName() const =0
virtual void setName(std::string const & name) =0
virtual void stop()
virtual void setParent(iface::Module * ) =0
virtual iface::Module * getParent() const =0
virtual expected< pCValue > getValue(std::string const & key, int dictType) const =0
virtual expected< cvec > getValue(std::vector< std::string > const & keys, int dictType) const =0
virtual expected< void > setValue(std::string const & key, pCValue const & value, int dictType) =0
virtual expected< void > setValue(cmap const & values, int dictType) =0
virtual expected< std::unique_ptr< iface::CVDictRoot > > getStateDict() const =0
virtual expected< std::unique_ptr< iface::CVDictRoot > > getConfigDict() const =0
virtual expected< void > setConfig(pCValue const & conf) const =0
virtual std::string getRootNode() const =0

Public Functions Documentation

function AppSrc

inline AppSrc(
    std::string const & moduleName
)

function pushRawFrame

virtual expected< void > pushRawFrame(
    cbuffer image,
    cmap const & metadata
) =0

Module API

function pushRawFrame

virtual expected< void > pushRawFrame(
    void const * buffer,
    int width,
    int height,
    SolutionManager::RawFrameType type,
    std::chrono::milliseconds timestamp,
    cmap const & metadata
) =0

function pushEncodedFrame

virtual expected< void > pushEncodedFrame(
    unsigned char const * data,
    size_t dataSize,
    iface::SolutionManager::EncodingType type,
    std::chrono::milliseconds timestamp
) =0

function setTargetFps

virtual void setTargetFps(
    int fps
) =0

function setMaxPixels

virtual void setMaxPixels(
    int pixels
) =0

function setEncodedFrameParameters

inline virtual expected< void > setEncodedFrameParameters(
    int ,
    int ,
    int ,
    int 
)

function getQueueSize

virtual int getQueueSize() =0

function getSourceResolution

inline virtual std::pair< int, int > getSourceResolution()

Reimplements: cvedia::rt::iface::InputHandler::getSourceResolution

function getSourceFrameRate

inline virtual float getSourceFrameRate()