 |
ImFusion C++ SDK 4.5.0
|
|
ImFusion C++ SDK 4.5.0
|
#include <RGBD/Include/ImFusion/RGBD/Hardware/KinectAzureStreamRecordingAlgorithm.h>
Provides recording functionality for streams from Kinect Azure RGB-D sensors. More...
Provides recording functionality for streams from Kinect Azure RGB-D sensors.
This class manages the acquisition, encoding, and storage of color, depth, infrared, and custom video streams. It supports global and per-frame metadata, compression options, and multi-stream recording.
Typical usage:
Classes | |
| class | FrameEncoder |
| Encoder for video frames in Kinect Azure recordings. More... | |
| struct | PerFrameMetaData |
| Structure for per-frame metadata. More... | |
Public Types | |
| enum | Quantization { GRAY8 = 8 , GRAY9 = 9 , GRAY10 = 10 , GRAY12 = 12 , GRAY16 = 16 } |
| Supported quantization levels for grayscale encoding. | |
| Public Types inherited from ImFusion::Algorithm | |
| enum | Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 } |
| Status codes. More... | |
Public Member Functions | |
| KinectAzureStreamRecordingAlgorithm (KinectAzureStream *stream, std::vector< VideoCameraStream * > videoStreams={}) | |
| Constructs a recording algorithm for the given Kinect Azure stream and optional video streams. | |
| void | compute () override |
| Starts or stops stream recording. | |
| bool | stopRecording () |
| Stops stream recording. Returns true upon success. | |
| bool | startRecording () |
| Starts stream recording. Returns true upon success. | |
| bool | isRecording () |
| Returns true if recording is active. | |
| void | addStream (VideoCameraStream *videoStream) |
| Adds an additional video stream for recording. | |
| bool | addGlobalMetaData (const std::string &name, const std::string &value) |
| Adds global metadata with the provided name and value. Value can contain binary data. Name must be all upper-case. | |
| bool | addPerFrameMetaData (const PerFrameMetaData &pfMetaData) |
| Registers callback for adding per-frame metadata. Name must be all upper-case. | |
| Public Member Functions inherited from ImFusion::Algorithm | |
| Algorithm () | |
| Default constructor will registers a single "compute" action that calls compute() and returns status(). | |
| virtual OwningDataList | takeOutput () |
| Return any new Data that was created by the Algorithm during the last call to compute(). | |
| virtual void | setProgress (Progress *progress) |
| Sets a Progress interface the algorithm can use to notify observers about its computing progress. | |
| Progress * | progress () const |
| Returns the progress interface if set. | |
| virtual int | status () const |
| Indicates the status of the last call to compute(). | |
| virtual bool | survivesDataDeletion (const Data *) const |
| Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list. | |
| const FactoryInfo & | factoryInfo () const |
| Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| void | setFactoryInfo (const FactoryInfo &value) |
| Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| Status | runAction (const std::string &id) |
| Run the action with name id if it exists. | |
| const std::vector< Action > & | actions () |
| Get a mapping from Action id to Action as registered in this algorithm. | |
| Public Member Functions inherited from ImFusion::Configurable | |
| virtual void | configure (const Properties *p) |
| Configure this object instance by de-serializing the given Properties. | |
| virtual void | configuration (Properties *p) const |
| Serialize the current object configuration into the given Properties object. | |
| virtual void | configureDefaults () |
| Retrieve the properties of this object, replaces values with their defaults and sets it again. | |
| void | registerParameter (ParameterBase *param) |
| Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration(). | |
| void | unregisterParameter (const ParameterBase *param) |
| Remove the given Parameter or SubProperty from the list of registered parameters. | |
| Configurable (const Configurable &rhs) | |
| Configurable (Configurable &&rhs) noexcept | |
| Configurable & | operator= (const Configurable &) |
| Configurable & | operator= (Configurable &&) noexcept |
| Public Member Functions inherited from ImFusion::SignalReceiver | |
| SignalReceiver ()=default | |
| Default constructor. | |
| SignalReceiver (const SignalReceiver &other) | |
| Copy constructor, does not copy any existing signal connections from other. | |
| SignalReceiver & | operator= (SignalReceiver rhs) |
| Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs. | |
| virtual | ~SignalReceiver () |
| Virtual destructor disconnects from all connected signals. | |
Static Public Member Functions | |
| static bool | createCompatible (const DataList &data, Algorithm **a) |
| Factory method for compatibility checking and creation. | |
| Static Public Member Functions inherited from ImFusion::Algorithm | |
| static bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| Factory function to check algorithm compatibility with input data and optionally instantiate it. | |
Public Attributes | |
| Parameter< std::string > | p_outputFilename = {"Output filename", "", *this} |
| Parameter< bool > | p_recordIMU = {"Record IMU", true, *this} |
| Parameter< bool > | p_recordDeviceIndex = {"Record device index", true, *this} |
| Parameter< bool > | p_recordTemperature = {"Record temperature", true, *this} |
| Parameter< bool > | p_recordWhiteBalance = {"Record white balance", true, *this} |
| Parameter< bool > | p_recordColorIsoSpeed = {"Record color iso speed", true, *this} |
| Parameter< bool > | p_recordColorExposure = {"Record color exposure", true, *this} |
| Parameter< bool > | p_recordDeviceTimestamp = {"Record device timestamp", true, *this} |
| Parameter< bool > | p_compress = {"Compress third-party streams", true, *this} |
| Parameter< bool > | p_compressKinect = {"Compress Kinect RGB stream", true, *this} |
| Parameter< std::string > | m_encoderParameters = {"Encoder parameters", "delay=0", *this} |
| Parameter< bool > | p_compressIrAndDepth = {"Compress IR and depth streams", true, *this} |
| Parameter< Quantization > | p_quantization = {"Quantization", GRAY16, *this} |
| Public Attributes inherited from ImFusion::Algorithm | |
| Signal | signalOutputChanged |
| Signal should be emitted by Algorithms when their output/result has changed. | |
| Signal | signalParametersChanged |
| Signal should be emitted by Algorithms when their parameter configuration has changed. | |
| Public Attributes inherited from ImFusion::Configurable | |
| Signal | signalParametersChanged |
| Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
Additional Inherited Members | |
| Protected Member Functions inherited from ImFusion::Algorithm | |
| void | loadDefaults () |
| void | registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action) |
| Register an action to be run via runAction. | |
| template<typename D> | |
| void | registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void)) |
| Template version of runAction that can be used with a pointer to a member function. | |
| void | registerAction (const Action &action) |
| Register an action. | |
| Protected Member Functions inherited from ImFusion::SignalReceiver | |
| void | disconnectAll () |
| Disconnects all existing connections. | |
| Protected Attributes inherited from ImFusion::Algorithm | |
| std::string | m_name |
| Algorithm name. | |
| Progress * | m_progress = nullptr |
| Non-owing pointer to a progress interface. May be a nullptr. | |
| FactoryInfo | m_factoryInfo = {} |
| Record describing how this algorithm was instantiated by the AlgorithmFactory. | |
| int | m_status = Status::Unknown |
| Algorithm status after last call to compute(). | |
| std::vector< Action > | m_actions |
| Map of key given by the id of the action, of the available actions of this algorithm. | |
| Protected Attributes inherited from ImFusion::Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
|
overridevirtual |
Starts or stops stream recording.
Implements ImFusion::Algorithm.