audio_out.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <functional>
#include <string>
#include <vector>
 
#include <boost/optional/optional.hpp>
 
#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 AudioOut : public Component {
   public:
    using audio_info = viam::sdk::audio_info;
 
    inline void play(std::vector<uint8_t> const& audio_data, boost::optional<audio_info> info) {
        return play(audio_data, info, {});
    }
 
    virtual void play(std::vector<uint8_t> const& audio_data,
                      boost::optional<audio_info> info,
                      const ProtoStruct& extra) = 0;
 
    inline void play_stream(audio_info info,
                            std::function<boost::optional<std::vector<uint8_t>>()> chunk_source) {
        return play_stream(std::move(info), std::move(chunk_source), {});
    }
 
    virtual void play_stream(audio_info info,
                             std::function<boost::optional<std::vector<uint8_t>>()> chunk_source,
                             const ProtoStruct& extra) = 0;
 
    inline audio_properties get_properties() {
        return get_properties({});
    }
 
    virtual audio_properties get_properties(const ProtoStruct& extra) = 0;
 
    virtual ProtoStruct do_command(const ProtoStruct& command) = 0;
 
    virtual ProtoStruct get_status() = 0;
 
    // @brief Returns `GeometryConfig`s associated with the calling audioout.
    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 AudioOut(std::string name);
};
 
template <>
struct API::traits<AudioOut> {
    static API api();
};
 
}  // namespace sdk
}  // namespace viam