publisher.h

Go to the documentation of this file.

#ifndef MILLICAST_API_PUBLISHER_H
#define MILLICAST_API_PUBLISHER_H
 
#ifdef __cplusplus
 
#include "client.h"
 
namespace millicast {
 
// Forward declarations ///////////////////////////////////////////////////////
 
class VideoTrack;
class AudioTrack;
class Track;
 
// Scalability mode ///////////////////////////////////////////////////////////
 
enum class ScalabilityMode {
  L1_T2,
  L1_T2_H,
  L1_T3,
  L1_T3_H,
  L2_T1,
  L2_T1_H,
  L2_T1_KEY,
  L2_T2,
  L2_T3,
  L2_T2_H,
  L2_T2_KEY,
  L2_T2_KEY_SHIFT,
  L2_T3_H,
  L3_T1,
  L3_T2,
  L3_T3,
  L3_T3_KEY,
  S2_T1,
  S2_T2,
  S2_T3,
  S3_T1,
  S3_T2,
  S3_T3,
  S2_T1_H,
  S2_T2_H,
  S2_T3_H,
  S3_T1_H,
  S3_T2_H,
  S3_T3_H
};
 
// Publisher //////////////////////////////////////////////////////////////////
 
struct PublisherCredentials {
  bool is_valid; 
  std::string stream_name; 
  std::string
      token; 
  std::string
      api_url; 
};
 
 
struct PublisherOption : public Client::Option {
  /* multisource options */
  struct {
    std::optional<std::string> source_id; 
  } multisource;
 
  struct {
    std::optional<std::string>
        video; 
    std::optional<std::string>
        audio; 
  } codecs;
 
  bool simulcast{false};
 
  std::optional<ScalabilityMode> svc_mode; 
  BitrateSettings
      bitrate_settings; 
  bool record_stream{false}; 
  std::optional<int> priority; 
};
 
class MILLICAST_API Publisher : public virtual Client {
 public:
 using Credentials = PublisherCredentials;
  using Option = PublisherOption;
 
  struct FirstViewerActive {
    std::string description;
  };
 
  struct LastViewerInactive {
    std::string description;
  };
 
  virtual Promise<void> publish(
      std::optional<PublisherOption>&& options = std::nullopt) = 0;
 
  virtual Promise<void> unpublish() = 0;
 
  [[nodiscard]] virtual Promise<bool> is_publishing() const = 0;
 
  virtual Promise<void> set_credentials(PublisherCredentials&& creds) = 0;
 
  [[nodiscard]] virtual Promise<PublisherCredentials> get_credentials()
      const = 0;
 
  // to be deprecated
  virtual Promise<void> add_track(std::weak_ptr<Track> track) = 0;
 
  // to be deprecated
  virtual Promise<void> add_track(std::weak_ptr<VideoTrack> track) = 0;
 
  // to be deprecated
  virtual Promise<void> add_track(std::weak_ptr<AudioTrack> track) = 0;
 
  // to be deprecated
  virtual Promise<void> clear_tracks() = 0;
 
  virtual Promise<void> set_frame_metadata_handler(
      EncodedVideoFrameCallback&& callback) = 0;
 
  static std::unique_ptr<Publisher> create();
 
  virtual Promise<void> record() = 0;
 
  virtual Promise<void> unrecord() = 0;
 
  virtual EventConnectionPtr add_event_handler(
      EventHandler<FirstViewerActive>&& handler) = 0;
 
  virtual EventConnectionPtr add_event_handler(
      EventHandler<LastViewerInactive>&& handler) = 0;
 
  virtual EventConnectionPtr add_event_handler(
      EventHandler<StatsEvent>&& handler) = 0;
 
  virtual EventConnectionPtr add_event_handler(
      EventHandler<ViewerCount>&& handler) = 0;
 
  virtual EventConnectionPtr add_event_handler(
      EventHandler<SignalingError>&& handler) = 0;
 
  virtual EventConnectionPtr add_event_handler(
      EventHandler<HttpConnectionError>&& handler) = 0;
 
  virtual EventConnectionPtr add_event_handler(
      EventHandler<WebsocketState>&& handler) = 0;
 
  virtual EventConnectionPtr add_event_handler(
      EventHandler<PeerConnectionState>&& handler) = 0;
};
 
}  // namespace millicast
 
#endif // __cplusplus
#endif /* MILLICAST_API_PUBLISHER_H */