subscriber.h

Go to the documentation of this file.

#ifndef SUBSCRIBER_H
#define SUBSCRIBER_H
 
#include "audio_data.h"
#include "base.h"
#include "config.h"
#include "error.h"
#include "media_utils.h"
#include "stream.h"
#include "video_frame.h"
 
OTC_BEGIN_DECL
 
#ifndef OTC_SESSION_FWD_DECL
#define OTC_SESSION_FWD_DECL
typedef struct otc_session otc_session;
#endif

typedef struct otc_subscriber otc_subscriber;

enum otc_subscriber_error_code {
  OTC_SUBSCRIBER_INTERNAL_ERROR = 2000, 
  OTC_SUBSCRIBER_SESSION_DISCONNECTED = 1010, 
  OTC_SUBSCRIBER_SERVER_CANNOT_FIND_STREAM = 1604, 
  OTC_SUBSCRIBER_STREAM_LIMIT_EXCEEDED = 1605,     
  OTC_SUBSCRIBER_TIMED_OUT =
      1542, 
  OTC_SUBSCRIBER_WEBRTC_ERROR = 1600, 
  OTC_SUBSCRIBER_PEER_CONNECTION_NOT_CONNECTED =
      1606, 
  OTC_SUBSCRIBER_CAPTIONS_CHANGE_RATE_LIMIT_ERROR = 5010, 
  OTC_SUBSCRIBER_DECRYPTION_INTERNAL_ERROR =
      6002, 
  OTC_SUBSCRIBER_ENCRYPTION_SECRET_MISMATCH =
      6003, 
  OTC_SUBSCRIBER_DECRYPTION_UNSUPPORTED_CODEC = 6006,  
  OTC_SUBSCRIBER_ENCRYPTION_NOT_ENABLED =
      6007, 
};

struct otc_subscriber_audio_stats {
  uint64_t packets_lost;     
  uint64_t packets_received; 
  uint64_t bytes_received; 
  float audio_level;       
  double timestamp; 
  OPENTOK_DEPRECATED("Use otc_subscriber_media_link_stats instead")
  int64_t sender_connection_max_allocated_bitrate; 
  OPENTOK_DEPRECATED("Use otc_subscriber_media_link_stats instead")
  int64_t sender_connection_estimated_bandwidth;   
};

struct otc_subscriber_video_stats {
  uint64_t packets_lost;     
  uint64_t packets_received; 
  uint64_t bytes_received; 
  double timestamp; 
  OPENTOK_DEPRECATED("Use otc_subscriber_media_link_stats instead")
  int64_t sender_connection_max_allocated_bitrate; 
  OPENTOK_DEPRECATED("Use otc_subscriber_media_link_stats instead")
  int64_t sender_connection_estimated_bandwidth;   
  int32_t width;                                   
  int32_t height;                                  
  double decoded_frame_rate;                       
  int64_t bitrate;                                 
  int64_t total_bitrate;                           
  int64_t pause_count; 
  int64_t total_pauses_duration; 
  int64_t freeze_count; 
  int64_t total_freezes_duration; 
  const char* codec;              
  enum otc_quality_restriction
      sender_quality_restriction; 
  enum otc_quality_restriction remote_publisher_quality_restriction; 
};

struct otc_subscriber_media_link_stats {
  otc_transport_stats transport;                  
  otc_transport_stats remote_publisher_transport; 
  enum otc_network_degradation_source
      network_degradation_source; 
};

struct otc_subscriber_rtc_stats_report_cb {
  void* user_data;

  void (*on_rtc_stats_report)(otc_subscriber* subscriber,
                              void* user_data,
                              const char* json_array_of_reports);
 
  void* reserved;
};

struct otc_subscriber_callbacks {
  void (*on_connected)(otc_subscriber* subscriber,
                       void* user_data,
                       const otc_stream* stream);

  void (*on_disconnected)(otc_subscriber* subscriber, void* user_data);

  void (*on_reconnected)(otc_subscriber* subscriber, void* user_data);

  void (*on_render_frame)(otc_subscriber* subscriber,
                          void* user_data,
                          const otc_video_frame* frame);

  void (*on_video_disabled)(otc_subscriber* subscriber,
                            void* user_data,
                            enum otc_video_reason reason);

  void (*on_video_enabled)(otc_subscriber* subscriber,
                           void* user_data,
                           enum otc_video_reason reason);

  void (*on_audio_disabled)(otc_subscriber* subscriber, void* user_data);

  void (*on_audio_enabled)(otc_subscriber* subscriber, void* user_data);

  void (*on_video_data_received)(otc_subscriber* subscriber, void* user_data);

  void (*on_video_disable_warning)(otc_subscriber* subscriber, void* user_data);

  void (*on_caption_text)(otc_subscriber* subscriber,
                          void* user_data,
                          const char* text,
                          otc_bool is_final);

  void (*on_video_disable_warning_lifted)(otc_subscriber* subscriber,
                                          void* user_data);

  void (*on_audio_stats)(otc_subscriber* subscriber,
                         void* user_data,
                         struct otc_subscriber_audio_stats audio_stats);

  void (*on_video_stats)(otc_subscriber* subscriber,
                         void* user_data,
                         struct otc_subscriber_video_stats video_stats);

  void (*on_audio_level_updated)(otc_subscriber* subscriber,
                                 void* user_data,
                                 float audio_level);

  void (*on_error)(otc_subscriber* subscriber,
                   void* user_data,
                   const char* error_string,
                   enum otc_subscriber_error_code error);

  void (*on_audio_data)(otc_subscriber* subscriber,
                        void* user_data,
                        const struct otc_audio_data* audio_data);

  void (*on_video_quality_changed)(otc_subscriber* subscriber,
                                   void* user_data,
                                   const struct otc_subscriber_video_stats* stats,
                                   enum otc_video_reason reason);

  void (*on_network_condition_changed)(otc_subscriber* subscriber,
                                       void* user_data,
                                       const struct otc_subscriber_media_link_stats* media_link_stats,
                                       enum otc_network_reason reason);

  void (*on_media_link_stats)(otc_subscriber* subscriber,
                              void* user_data,
                              const struct otc_subscriber_media_link_stats* media_link_stats);

  void* user_data;

  void* reserved;
};

OTC_DECL(otc_subscriber*)
otc_subscriber_new(const otc_stream* stream,
                   const struct otc_subscriber_callbacks* callbacks);

OTC_DECL(otc_status) otc_subscriber_delete(otc_subscriber* subscriber);

OTC_DECL(otc_stream*)
otc_subscriber_get_stream(const otc_subscriber* subscriber);

OTC_DECL(otc_status)
otc_subscriber_set_subscribe_to_video(otc_subscriber* subscriber,
                                      otc_bool subscribe_to_video);

OTC_DECL(otc_status)
otc_subscriber_set_subscribe_to_audio(otc_subscriber* subscriber,
                                      otc_bool subscribe_to_audio);

OTC_DECL(otc_status)
otc_subscriber_set_subscribe_to_captions(otc_subscriber* subscriber,
                                         otc_bool subscribe_to_captions);

OTC_DECL(otc_status)
otc_subscriber_set_captions_translation_language(otc_subscriber* subscriber, const char* language);

OTC_DECL(const char*)
otc_subscriber_get_captions_translation_language(const otc_subscriber* subscriber);

OTC_DECL(otc_bool) otc_subscriber_get_subscribe_to_video(const otc_subscriber* subscriber);

OTC_DECL(otc_bool)
otc_subscriber_get_subscribe_to_audio(const otc_subscriber* subscriber);

OTC_DECL(otc_bool)
otc_subscriber_get_subscribe_to_captions(const otc_subscriber* subscriber);

OTC_DECL(otc_session*)
otc_subscriber_get_session(const otc_subscriber* subscriber);

OTC_DECL(otc_status)
otc_subscriber_set_preferred_resolution(otc_subscriber* subscriber,
                                        uint32_t preferred_width,
                                        uint32_t preferred_height);
OTC_DECL(otc_status)
otc_subscriber_get_preferred_resolution(const otc_subscriber* subscriber,
                                        uint32_t* preferred_width,
                                        uint32_t* preferred_height);

OTC_DECL(otc_status)
otc_subscriber_set_audio_volume(otc_subscriber* subscriber, double volume);

OTC_DECL(otc_status)
otc_subscriber_get_audio_volume(const otc_subscriber* subscriber,
                                double* volume);

OTC_DECL(otc_status)
otc_subscriber_set_preferred_framerate(otc_subscriber* subscriber,
                                       float preferred_framerate);

OTC_DECL(otc_status)
otc_subscriber_get_preferred_framerate(const otc_subscriber* subscriber,
                                       float* preferred_framerate);

OTC_DECL(const char*)
otc_subscriber_get_subscriber_id(const otc_subscriber* subscriber);

OTC_DECL(void*) otc_subscriber_get_user_data(const otc_subscriber* subscriber);

OTC_DECL(otc_status)
otc_subscriber_get_rtc_stats_report(otc_subscriber* subscriber);

OTC_DECL(otc_status)
otc_subscriber_set_rtc_stats_report_cb(
    otc_subscriber* subscriber,
    struct otc_subscriber_rtc_stats_report_cb cb);
 
OTC_END_DECL
 
#endif  // SUBSCRIBER_H