public_api.h File Reference

#include <filesystem>
#include <map>
#include <VisionX/libraries/imrec/playback/AbstractPlaybackStrategy.h>
#include <VisionX/libraries/imrec/record/AbstractRecordingStrategy.h>

Include dependency graph for public_api.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	RegistryEntry

Namespaces
namespace	cv
namespace	visionx
	ArmarX headers.
namespace	visionx::imrec

Enumerations
enum class	Compression { lossy , lossless }
enum class	Format {   bmp_img_seq , png_img_seq , png_fast_img_seq , png_mt_img_seq ,   png_fast_mt_img_seq , jpg_img_seq , avi_default , mp4_default }
	Supported recording Formats. More...
enum class	Framerate { static_fps , dynamic_fps }

Functions
const std::string &	format2hrstr (const Format format)
const std::string &	format2str (const Format format)
std::vector< Format >	getFormats ()
std::map< Format, RegistryEntry >	getFormatsMap ()
bool	isFormatDynamicFramerate (Format format)
bool	isFormatLossless (Format format)
visionx::imrec::Playback	newPlayback (const std::filesystem::path &path)
	Instantiates and returns a new playback strategy which is capable of replaying the file or collection at path.
visionx::imrec::Recording	newRecording (const std::filesystem::path &filePath, double fps)
	Creates a new recording given the file extension and additional parameters.
visionx::imrec::Recording	newRecording (const std::filesystem::path &path, const std::string &name, const Format format, double fps)
Format	str2format (const std::string &format_str)
void	takeSnapshot (const CByteImage &image, const std::filesystem::path &filePath)
	Takes a snapshot using the default recording method for snapshots.
void	takeSnapshot (const cv::Mat &image, const std::filesystem::path &filePath)
	Takes a snapshot using the default recording method for snapshots.