lsl_stream_inlet.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef LSL_STREAM_INLET_H
#define LSL_STREAM_INLET_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "lsl_global.h"
#include "lsl_stream_info.h"
 
//=============================================================================================================
// STL INCLUDES
//=============================================================================================================
 
#include <vector>
#include <memory>
#include <type_traits>
 
//=============================================================================================================
// DEFINE NAMESPACE LSLLIB
//=============================================================================================================
 
namespace LSLLIB
{
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================

class StreamInletPrivate;
 
//=============================================================================================================
class LSLSHARED_EXPORT stream_inlet
{
public:
    //=========================================================================================================
    explicit stream_inlet(const stream_info& info);
 
    //=========================================================================================================
    ~stream_inlet();
 
    //=========================================================================================================
    void open_stream();
 
    //=========================================================================================================
    void close_stream();
 
    //=========================================================================================================
    [[nodiscard]] bool samples_available();
 
    //=========================================================================================================
    template<typename T>
    [[nodiscard]] std::vector<std::vector<T>> pull_chunk()
    {
        static_assert(std::is_same_v<T, float>,
                      "lsl::stream_inlet::pull_chunk<T>: only float is supported");
        return pull_chunk_float();
    }
 
    //=========================================================================================================
    [[nodiscard]] std::vector<std::vector<float>> pull_chunk_float();
 
private:
    std::unique_ptr<StreamInletPrivate> m_pImpl;
};
 
} // namespace LSLLIB
 
#endif // LSL_STREAM_INLET_H