audio_in.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <string>
 
#include <viam/sdk/common/audio.hpp>
#include <viam/sdk/common/proto_value.hpp>
#include <viam/sdk/common/utils.hpp>
#include <viam/sdk/config/resource.hpp>
 
namespace viam {
namespace sdk {
 
 
class AudioIn : public Component {
   public:
    struct audio_chunk {
        std::vector<uint8_t> audio_data;
        audio_info info;
        std::chrono::nanoseconds start_timestamp_ns;
        std::chrono::nanoseconds end_timestamp_ns;
        int sequence_number;  // sequential chunk number
        std::string request_id;
    };
 
    // starting from the time the request was received by the server.
    inline void get_audio(std::string const& codec,
                          std::function<bool(audio_chunk&& chunk)> const& chunk_handler,
                          double const& duration_seconds,
                          int64_t const& previous_timestamp) {
        return get_audio(codec, chunk_handler, duration_seconds, previous_timestamp, {});
    }
 
    // starting from the time the request was received by the server.
    virtual void get_audio(std::string const& codec,
                           std::function<bool(audio_chunk&& chunk)> const& chunk_handler,
                           double const& duration_seconds,
                           int64_t const& previous_timestamp,
                           const ProtoStruct& extra) = 0;
 
    inline audio_properties get_properties() {
        return get_properties({});
    }
 
    virtual audio_properties get_properties(const ProtoStruct& extra) = 0;
 
    // @brief Send/receive arbitrary commands to the resource.
    virtual ProtoStruct do_command(const ProtoStruct& command) = 0;
 
    virtual ProtoStruct get_status() = 0;
 
    inline std::vector<GeometryConfig> get_geometries() {
        return get_geometries({});
    }
 
    virtual std::vector<GeometryConfig> get_geometries(const ProtoStruct& extra) = 0;
 
    API api() const override;
 
   protected:
    explicit AudioIn(std::string name);
};
 
template <>
struct API::traits<AudioIn> {
    static API api();
};
 
}  // namespace sdk
}  // namespace viam