Skip to content

cvedia::rt::iface::Input

Inherits from ModuleImpl, Module

Public Types

Name
enum PrivacyMode

Public Functions

Name
Input(std::string const & moduleName)
virtual NODISCARD expected< bool > setSource(std::string const & source) =0
virtual NODISCARD expected< bool > setSourceFromConfig() =0
virtual NODISCARD expected< cvec > readFrame(bool ignore_skip_frame =false, cmap frameSettings ={}) =0
virtual int getCurrentFrameIndex() =0
virtual bool setFps(float fps) =0
virtual float getCurrentFps(iface::FPSType fpsType =iface::FPSType::FPSType_TARGET) =0
virtual double getCurrentTimestamp() =0
virtual expected< bool > setBufferSize(size_t size) =0
virtual expected< void > setPrivacyMasks(std::vector< std::vector< Point2f > > const & masks) =0
virtual expected< void > setPrivacyMode(std::string mode, CValue const & options) =0
virtual expected< iface::InputHandler * > getInputHandler() =0
virtual bool canRead() =0
virtual void forceRead() =0
virtual bool isPaused() =0
virtual void pause(bool state) =0
virtual std::vector< InputFormat > getSupportedFormats() =0
virtual void setSourceFormat(InputFormat fmt) =0
virtual InputFormat getSourceFormat() =0
virtual bool setOrientation(int orientation) =0
virtual void clearFrameQueue() =0
virtual int getFrameQueueSize() =0
virtual int getDroppedFramesCount() const =0
virtual double getReadFrameLatency() =0
virtual expected< void > setBackpressurePolicy(BackpressurePolicy policy) =0
virtual BackpressurePolicy getBackpressurePolicy() const =0

Additional inherited members

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 Types Documentation

enum PrivacyMode

Enumerator Value Description
NONE 0
BLUR
PIXELATE
FILL

Public Functions Documentation

function Input

inline Input(
    std::string const & moduleName
)

function setSource

virtual NODISCARD expected< bool > setSource(
    std::string const & source
) =0

function setSourceFromConfig

virtual NODISCARD expected< bool > setSourceFromConfig() =0

function readFrame

virtual NODISCARD expected< cvec > readFrame(
    bool ignore_skip_frame =false,
    cmap frameSettings ={}
) =0

function getCurrentFrameIndex

virtual int getCurrentFrameIndex() =0

function setFps

virtual bool setFps(
    float fps
) =0

function getCurrentFps

virtual float getCurrentFps(
    iface::FPSType fpsType =iface::FPSType::FPSType_TARGET
) =0

function getCurrentTimestamp

virtual double getCurrentTimestamp() =0

function setBufferSize

virtual expected< bool > setBufferSize(
    size_t size
) =0

function setPrivacyMasks

virtual expected< void > setPrivacyMasks(
    std::vector< std::vector< Point2f > > const & masks
) =0

function setPrivacyMode

virtual expected< void > setPrivacyMode(
    std::string mode,
    CValue const & options
) =0

function getInputHandler

virtual expected< iface::InputHandler * > getInputHandler() =0

function canRead

virtual bool canRead() =0

function forceRead

virtual void forceRead() =0

function isPaused

virtual bool isPaused() =0

function pause

virtual void pause(
    bool state
) =0

function getSupportedFormats

virtual std::vector< InputFormat > getSupportedFormats() =0

function setSourceFormat

virtual void setSourceFormat(
    InputFormat fmt
) =0

function getSourceFormat

virtual InputFormat getSourceFormat() =0

function setOrientation

virtual bool setOrientation(
    int orientation
) =0

function clearFrameQueue

virtual void clearFrameQueue() =0

function getFrameQueueSize

virtual int getFrameQueueSize() =0

function getDroppedFramesCount

virtual int getDroppedFramesCount() const =0

function getReadFrameLatency

virtual double getReadFrameLatency() =0

function setBackpressurePolicy

virtual expected< void > setBackpressurePolicy(
    BackpressurePolicy policy
) =0

function getBackpressurePolicy

virtual BackpressurePolicy getBackpressurePolicy() const =0