aditof::FrameHandler Class Reference

Handles operations on a frame such as saving it to file and creating a new frame with content read from file. More...

#include <frame_handler.h>

Public Member Functions
SDK_API	FrameHandler (FrameHandler &&) noexcept
	Move constructor.
SDK_API FrameHandler &	operator= (FrameHandler &&) noexcept
	Move assignment.
SDK_API aditof::Status	setOutputFilePath (const std::string &filePath)
	Set the output path/output folder for the frames. More...
SDK_API aditof::Status	setInputFileName (const std::string &fullFileName)
	Set the input file for the frames. More...
SDK_API aditof::Status	saveFrameToFile (aditof::Frame &frame, const std::string &fileName="")
	Store frame to file. More...
SDK_API aditof::Status	saveFrameToFileMultithread (aditof::Frame &frame, const std::string &fileName="")
	Store frame to file using a separate thread. More...
SDK_API aditof::Status	readNextFrame (aditof::Frame &frame, const std::string &fullFileName="")
	Reads frame from a file. If same file is provided it will continue to read from the last position. More...
SDK_API aditof::Status	setCustomFormat (const std::string &format)
	A custom format in which the frames will be stored/read. More...
SDK_API aditof::Status	storeFramesToSingleFile (bool enable)
	Enable/disable if single file is intended to use for storing data. More...
SDK_API aditof::Status	setFrameContent (const std::string &frameContent)
	Set which frame element you want to store/read (depth/ab/conf) More...

Detailed Description

Handles operations on a frame such as saving it to file and creating a new frame with content read from file.

Definition at line 57 of file frame_handler.h.

Member Function Documentation

readNextFrame()

SDK_API aditof::Status aditof::FrameHandler::readNextFrame	(	aditof::Frame &	frame,
		const std::string &	fullFileName = ""
	)

Reads frame from a file. If same file is provided it will continue to read from the last position.

Parameters

[out]	frame	- Frame object in which the frame will be stored
[in]	fullFileName	- Full file name

Returns

Status

saveFrameToFile()

SDK_API aditof::Status aditof::FrameHandler::saveFrameToFile	(	aditof::Frame &	frame,
		const std::string &	fileName = ""
	)

Store frame to file.

Parameters

[in]	frame	- frame object to be stored in file
[in]	fileName	- the name of the file. If none provided it will automatically generate one depending on time and frame number.

Returns

Status

saveFrameToFileMultithread()

SDK_API aditof::Status aditof::FrameHandler::saveFrameToFileMultithread	(	aditof::Frame &	frame,
		const std::string &	fileName = ""
	)

Store frame to file using a separate thread.

Parameters

[in]	frame	- frame object to be stored in file
[in]	fileName	- the name of the file. If none provided it will automatically generate one depending on time and frame number.

Returns

Status

setCustomFormat()

SDK_API aditof::Status aditof::FrameHandler::setCustomFormat

(

const std::string &

format

)

A custom format in which the frames will be stored/read.

Parameters

[in]

format

- Format name

Returns

Status

setFrameContent()

SDK_API aditof::Status aditof::FrameHandler::setFrameContent

(

const std::string &

frameContent

)

Set which frame element you want to store/read (depth/ab/conf)

Parameters

[in]

frameContent

- a string providing the frame subelements that will be stored

Returns

Status

setInputFileName()

SDK_API aditof::Status aditof::FrameHandler::setInputFileName

(

const std::string &

fullFileName

)

Set the input file for the frames.

Parameters

[in]

fullFileName

- Input file name

Returns

Status

setOutputFilePath()

SDK_API aditof::Status aditof::FrameHandler::setOutputFilePath

(

const std::string &

filePath

)

Set the output path/output folder for the frames.

Parameters

[in]

filePath

- File path

Returns

Status

storeFramesToSingleFile()

SDK_API aditof::Status aditof::FrameHandler::storeFramesToSingleFile

(

bool

enable

)

Enable/disable if single file is intended to use for storing data.

Parameters

[in]

enable

- true for single file use/ false for multiple file use

Returns

Status

---

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

• /home/vsts/work/1/s/sdk/include/aditof/frame_handler.h