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

Inheritance diagram for ImageSequencePlaybackStrategy:

Public Member Functions
virtual unsigned int	getCurrentFrame () const override
	Gets the current frame index of the playback. More...

virtual unsigned int	getFps () const override
	Gets the amount of frames per second of the recording. More...

virtual unsigned int	getFrameCount () const override
	Gets the total amout of frames in the recording. More...

virtual unsigned int	getFrameHeight () const override
	Gets the height of a frame in pixel. More...

virtual unsigned int	getFrameWidth () const override
	Gets the width of a frame in pixel. More...

virtual bool	getNextFrame (::CByteImage &buffer) override
	Writes the next frame into an IVT CByteImage buffer (RGB) More...

virtual bool	getNextFrame (cv::Mat &buffer) override
	Writes the next frame into an OpenCV Mat buffer (BGR) More...

virtual bool	getNextFrame (void *buffer) override
	Writes the next frame into a buffer of any form (RGB) More...

virtual bool	hasNextFrame () const override
	Indicates whether the recording has a consecutive frame. More...

	ImageSequencePlaybackStrategy ()
	Default constructor to manually setup later. More...

	ImageSequencePlaybackStrategy (const std::filesystem::path &filePath)
	Constructor initialising the playback immediately. More...

virtual bool	isPlayingBack () const override
	Indicates whether the instance is configured to be able to play back. More...

virtual void	setCurrentFrame (unsigned int frame) override
	Sets the frame from there the playback should resume afterwards (seek) More...

virtual void	startPlayback (const std::filesystem::path &filePath) override
	Starts the playback. More...

virtual void	stopPlayback () override
	Stops the playback. More...

virtual	~ImageSequencePlaybackStrategy () override
	Destructor. More...

Public Member Functions inherited from AbstractPlaybackStrategy
virtual	~AbstractPlaybackStrategy ()
	Destructor. More...

Detailed Description

Definition at line 40 of file ImageSequencePlaybackStrategy.h.

Constructor & Destructor Documentation

◆ ImageSequencePlaybackStrategy() [1/2]

ImageSequencePlaybackStrategy ( )

Default constructor to manually setup later.

Definition at line 46 of file ImageSequencePlaybackStrategy.cpp.

◆ ImageSequencePlaybackStrategy() [2/2]

ImageSequencePlaybackStrategy ( const std::filesystem::path & filePath )

Constructor initialising the playback immediately.

Parameters

filePath Path to the recording

Definition at line 53 of file ImageSequencePlaybackStrategy.cpp.

◆ ~ImageSequencePlaybackStrategy()

~ImageSequencePlaybackStrategy ( )

overridevirtual

Destructor.

Definition at line 62 of file ImageSequencePlaybackStrategy.cpp.

Member Function Documentation

◆ getCurrentFrame()

unsigned int getCurrentFrame ( ) const

overridevirtual

Gets the current frame index of the playback.

Returns: The current frame index

Implements AbstractPlaybackStrategy.

Definition at line 108 of file ImageSequencePlaybackStrategy.cpp.

◆ 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.

Definition at line 74 of file ImageSequencePlaybackStrategy.cpp.

◆ 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.

Definition at line 84 of file ImageSequencePlaybackStrategy.cpp.

◆ getFrameHeight()

unsigned int getFrameHeight ( ) const

overridevirtual

Gets the height of a frame in pixel.

Returns: Height of a frame in pixel

Implements AbstractPlaybackStrategy.

Definition at line 90 of file ImageSequencePlaybackStrategy.cpp.

◆ getFrameWidth()

unsigned int getFrameWidth ( ) const

overridevirtual

Gets the width of a frame in pixel.

Returns: Width of a frame in pixel

Implements AbstractPlaybackStrategy.

Definition at line 96 of file ImageSequencePlaybackStrategy.cpp.

◆ 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.

Definition at line 159 of file ImageSequencePlaybackStrategy.cpp.

◆ 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.

Definition at line 165 of file ImageSequencePlaybackStrategy.cpp.

◆ 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.

Definition at line 133 of file ImageSequencePlaybackStrategy.cpp.

◆ 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.

Definition at line 114 of file ImageSequencePlaybackStrategy.cpp.

◆ 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.

Definition at line 68 of file ImageSequencePlaybackStrategy.cpp.

◆ 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.

Definition at line 102 of file ImageSequencePlaybackStrategy.cpp.

◆ startPlayback()

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

overridevirtual

Starts the playback.

Parameters

filePath Path to the recording to play back

Implements AbstractPlaybackStrategy.

Definition at line 120 of file ImageSequencePlaybackStrategy.cpp.

◆ stopPlayback()

void stopPlayback ( )

overridevirtual

Stops the playback.

Implements AbstractPlaybackStrategy.

Definition at line 186 of file ImageSequencePlaybackStrategy.cpp.

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

VisionX/libraries/imrec/playback/strats/ImageSequencePlaybackStrategy.h
VisionX/libraries/imrec/playback/strats/ImageSequencePlaybackStrategy.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ImageSequencePlaybackStrategy() [1/2]

◆ ImageSequencePlaybackStrategy() [2/2]

◆ ~ImageSequencePlaybackStrategy()

Member Function Documentation

◆ getCurrentFrame()

◆ getFps()

◆ getFrameCount()

◆ getFrameHeight()

◆ getFrameWidth()

◆ getNextFrame() [1/3]

◆ getNextFrame() [2/3]

◆ getNextFrame() [3/3]

◆ hasNextFrame()

◆ isPlayingBack()

◆ setCurrentFrame()

◆ startPlayback()

◆ stopPlayback()