ChunkedImageSequencePlaybackStrategy Class Reference

#include <VisionX/libraries/imrec/playback/strats/ChunkedImageSequencePlaybackStrategy.h>

Inheritance diagram for ChunkedImageSequencePlaybackStrategy:

Public Member Functions
	ChunkedImageSequencePlaybackStrategy ()
	Default constructor to manually setup later.
	ChunkedImageSequencePlaybackStrategy (const std::filesystem::path &filePath)
	Constructor initialising the playback immediately.
virtual unsigned int	getCurrentFrame () const override
	Gets the current frame index of the playback.
virtual unsigned int	getFps () const override
	Gets the amount of frames per second of the recording.
virtual unsigned int	getFrameCount () const override
	Gets the total amout of frames in the recording.
virtual unsigned int	getFrameHeight () const override
	Gets the height of a frame in pixel.
virtual unsigned int	getFrameWidth () const override
	Gets the width of a frame in pixel.
virtual bool	getNextFrame (::CByteImage &buffer) override
	Writes the next frame into an IVT CByteImage buffer (RGB)
virtual bool	getNextFrame (cv::Mat &buffer) override
	Writes the next frame into an OpenCV Mat buffer (BGR)
virtual bool	getNextFrame (void *buffer) override
	Writes the next frame into a buffer of any form (RGB)
virtual bool	hasNextFrame () const override
	Indicates whether the recording has a consecutive frame.
virtual bool	isPlayingBack () const override
	Indicates whether the instance is configured to be able to play back.
virtual void	setCurrentFrame (unsigned int frame) override
	Sets the frame from there the playback should resume afterwards (seek)
virtual void	startPlayback (const std::filesystem::path &filePath) override
	Starts the playback.
virtual void	stopPlayback () override
	Stops the playback.
virtual	~ChunkedImageSequencePlaybackStrategy () override
	Destructor.
Public Member Functions inherited from AbstractPlaybackStrategy
virtual	~AbstractPlaybackStrategy ()
	Destructor.

Constructor & Destructor Documentation

ChunkedImageSequencePlaybackStrategy() [1/2]

ChunkedImageSequencePlaybackStrategy

(

)

Default constructor to manually setup later.

ChunkedImageSequencePlaybackStrategy() [2/2]

ChunkedImageSequencePlaybackStrategy

(

const std::filesystem::path &

filePath

)

Constructor initialising the playback immediately.

Parameters

filePath

Path to the recording

~ChunkedImageSequencePlaybackStrategy()

~ChunkedImageSequencePlaybackStrategy ( )

overridevirtual

Destructor.

Member Function Documentation

getCurrentFrame()

unsigned int getCurrentFrame ( ) const

overridevirtual

Gets the current frame index of the playback.

Returns

The current frame index

Implements AbstractPlaybackStrategy.

getFps()

unsigned int getFps ( ) const

overridevirtual

Gets the amount of frames per second of the recording.

Returns

Amount of frames per second of the recording

Implements AbstractPlaybackStrategy.

getFrameCount()

unsigned int getFrameCount ( ) const

overridevirtual

Gets the total amout of frames in the recording.

Returns

Total amount of frames in the recording

Implements AbstractPlaybackStrategy.

getFrameHeight()

unsigned int getFrameHeight ( ) const

overridevirtual

Gets the height of a frame in pixel.

Returns

Height of a frame in pixel

Implements AbstractPlaybackStrategy.

getFrameWidth()

unsigned int getFrameWidth ( ) const

overridevirtual

Gets the width of a frame in pixel.

Returns

Width of a frame in pixel

Implements AbstractPlaybackStrategy.

getNextFrame() [1/3]

bool getNextFrame ( ::CByteImage & buffer )

overridevirtual

Writes the next frame into an IVT CByteImage buffer (RGB)

Parameters

buffer

Output parameter where the frame data of the next frame should be written to

Returns

True on success, false otherwise (no consecutive frame, error while loading frame)

Implements AbstractPlaybackStrategy.

getNextFrame() [2/3]

bool getNextFrame ( cv::Mat & buffer )

overridevirtual

Writes the next frame into an OpenCV Mat buffer (BGR)

Parameters

buffer

Output parameter where the frame data of the next frame should be written to

Returns

True on success, false otherwise (no consecutive frame, error while loading frame)

Implements AbstractPlaybackStrategy.

getNextFrame() [3/3]

bool getNextFrame ( void * buffer )

overridevirtual

Writes the next frame into a buffer of any form (RGB)

Parameters

buffer

Output parameter where the frame data of the next frame should be written to

Returns

True on success, false otherwise (no consecutive frame, error while loading frame)

Implements AbstractPlaybackStrategy.

hasNextFrame()

bool hasNextFrame ( ) const

overridevirtual

Indicates whether the recording has a consecutive frame.

Returns

True, if there is a consecutive frame, false otherwise

Implements AbstractPlaybackStrategy.

isPlayingBack()

bool isPlayingBack ( ) const

overridevirtual

Indicates whether the instance is configured to be able to play back.

Returns

True if it is playing back, false otherwise

Implements AbstractPlaybackStrategy.

setCurrentFrame()

void setCurrentFrame ( unsigned int frame )

overridevirtual

Sets the frame from there the playback should resume afterwards (seek)

Parameters

frame

Frame from where the playback should be resumed (e.g. "0" to replay from the beginning)

Implements AbstractPlaybackStrategy.

startPlayback()

void startPlayback ( const std::filesystem::path & filePath )

overridevirtual

Starts the playback.

Parameters

filePath

Path to the recording to play back

Implements AbstractPlaybackStrategy.

stopPlayback()

void stopPlayback ( )

overridevirtual

Stops the playback.

Implements AbstractPlaybackStrategy.

---

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

• VisionX/libraries/imrec/playback/strats/ChunkedImageSequencePlaybackStrategy.h
• VisionX/libraries/imrec/playback/strats/ChunkedImageSequencePlaybackStrategy.cpp