client.h

Go to the documentation of this file.

#ifndef MILLICAST_API_CLIENT_H
#define MILLICAST_API_CLIENT_H

 
#ifdef __cplusplus
 
#include <functional>
#include <list>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#include "encoded_frames.h"
#include "event_handling.h"
#include "exports.h"
#include "mc_logging.h"
#include "promise.h"
#include "stats.h"
 
namespace millicast {
enum class DegradationPreferences {
  DISABLED, 
  MAINTAIN_RESOLUTION, 
  MAINTAIN_FRAMERATE,  
  BALANCED 
};

struct BitrateSettings {
  bool disable_bwe{true};
  std::optional<int> min_bitrate_kbps;
  std::optional<int> max_bitrate_kbps;
};

struct TrackInfo {
  std::string media;    
  std::string track_id; 
};

struct MILLICAST_API ClientConnectionOptions {
  bool auto_reconnect{true};
};

struct MILLICAST_API ClientOption {
  std::optional<bool> stereo; 
  std::optional<bool>
      dtx; 
  int stats_delay_ms{3000}; 
  std::optional<DegradationPreferences>
      degradation; 
 
  std::string rtc_event_log_output_path;
};

struct ClientJsonData {
  std::string ws_url; 
  std::string jwt;    
};
 
class MILLICAST_API ClientBase {
 public:
  using ConnectionOptions = ClientConnectionOptions;
  using Option = ClientOption;
  using JsonData = ClientJsonData;
 
  virtual ~ClientBase() = default;

  static std::list<std::string> get_supported_video_codecs();

  static std::list<std::string> get_supported_audio_codecs();

  static void cleanup();
};

class MILLICAST_API Client : public ClientBase {
 public:
  struct StatsEvent {
    std::shared_ptr<StatsReport> report{};
  };

  struct ViewerCount {
    int viewer_count{0};
  };

  struct SignalingError {
    std::string description;
  };

  struct HttpConnectionError {
    int status_code;
    std::string description;
  };

  enum class ConnectionState {
    IDLE, 
    CONNECTING, 
    CONNECTED, 
    RECONNECTING, 
    DISCONNECTING, 
    FAILED 
  };

  struct WebsocketState {
    ConnectionState state;
  };

  struct PeerConnectionState {
    ConnectionState state;
  };

  virtual Promise<void> connect(
      std::optional<ConnectionOptions>&& connection_options) = 0;

  virtual Promise<void> connect(
      JsonData&& data,
      std::optional<ConnectionOptions>&& connection_options) = 0;

  [[nodiscard]] virtual Promise<bool> is_connected() const = 0;

  virtual Promise<void> disconnect() = 0;

  virtual Promise<void> enable_stats(bool enable) = 0;
};
 
}  // namespace millicast
#endif /* MILLICAST_API_CLIENT_H */
#endif // __cplusplus