Skip to content

cvedia::rt::iface::VideoReader

Inherits from InputHandler, ModuleImpl, Module

Public Functions

Name
VideoReader(std::string const & moduleName)
virtual void setCurrentFrame(int frameNum) =0
virtual int getFrameCount() const =0
virtual bool canSeek() =0
virtual void setRepeatMode(iface::InputRepeatMode mode) =0
virtual iface::InputRepeatMode getRepeatMode() =0
virtual expected< void > readConfig() =0
virtual bool setSourceList(std::vector< std::string > const & source) =0
virtual std::vector< std::string > getSourceList() =0
virtual bool setSourceByIndex(int index) =0
virtual int getSourceListIndex() =0
virtual int getSourceListSize() =0
virtual bool playlistReachedEnd() =0
virtual expected< void > setStartFrame(int frame) =0
virtual expected< void > setEndFrame(int frame) =0
virtual bool fileReachedEnd() =0
virtual bool isEnded() =0
virtual bool setNextSource() =0
virtual bool setPreviousSource() =0
virtual std::string getSourceUri() =0
virtual std::string getSourceDesc() =0

Additional inherited members

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 std::vector< InputFormat > getSupportedFormats() =0
virtual void setSourceFormat(InputFormat fmt) =0
virtual InputFormat getSourceFormat() =0
virtual std::optional< Codec > getSourceCodec() =0
virtual std::pair< int, int > getSourceResolution()

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 VideoReader

inline VideoReader(
    std::string const & moduleName
)

function setCurrentFrame

virtual void setCurrentFrame(
    int frameNum
) =0

function getFrameCount

virtual int getFrameCount() const =0

function canSeek

virtual bool canSeek() =0

function setRepeatMode

virtual void setRepeatMode(
    iface::InputRepeatMode mode
) =0

function getRepeatMode

virtual iface::InputRepeatMode getRepeatMode() =0

function readConfig

virtual expected< void > readConfig() =0

function setSourceList

virtual bool setSourceList(
    std::vector< std::string > const & source
) =0

function getSourceList

virtual std::vector< std::string > getSourceList() =0

function setSourceByIndex

virtual bool setSourceByIndex(
    int index
) =0

function getSourceListIndex

virtual int getSourceListIndex() =0

function getSourceListSize

virtual int getSourceListSize() =0

function playlistReachedEnd

virtual bool playlistReachedEnd() =0

function setStartFrame

virtual expected< void > setStartFrame(
    int frame
) =0

function setEndFrame

virtual expected< void > setEndFrame(
    int frame
) =0

function fileReachedEnd

virtual bool fileReachedEnd() =0

function isEnded

virtual bool isEnded() =0

Reimplements: cvedia::rt::iface::InputHandler::isEnded

function setNextSource

virtual bool setNextSource() =0

function setPreviousSource

virtual bool setPreviousSource() =0

function getSourceUri

virtual std::string getSourceUri() =0

function getSourceDesc

virtual std::string getSourceDesc() =0