base.h

Go to the documentation of this file.

#ifndef BASE_H
#define BASE_H
 
#include "config.h"
 
 
OTC_BEGIN_DECL

enum otc_video_reason {
  OTC_VIDEO_REASON_NONE = 0,          
  OTC_VIDEO_REASON_PUBLISH_VIDEO = 1, 
  OTC_VIDEO_REASON_SUBSCRIBE_TO_VIDEO = 2,            
  OTC_VIDEO_REASON_QUALITY = 3,                       
  OTC_VIDEO_REASON_CODEC_NOT_SUPPORTED = 4,           
  OTC_VIDEO_REASON_QUALITY_DEGRADATION_BANDWIDTH = 5, 
  OTC_VIDEO_REASON_QUALITY_DEGRADATION_CPU =
      6, 
  OTC_VIDEO_REASON_QUALITY_DEGRADATION_OTHER = 7,  
  OTC_VIDEO_REASON_CODEC_CHANGE = 8,               
  OTC_VIDEO_REASON_RESOLUTION_CHANGE = 9,          
  OTC_VIDEO_REASON_VIDEO_INTERRUPTION = 10,        
  OTC_VIDEO_REASON_SENDER_QUALITY_RESTRICTION = 11 
};

enum otc_network_reason {
  OTC_NETWORK_REASON_NONE = 0,                     
  OTC_NETWORK_REASON_UNKNOWN = 1,                  
  OTC_NETWORK_REASON_BANDWIDTH = 2,                
  OTC_NETWORK_REASON_PACKET_LOSS = 3,              
  OTC_NETWORK_REASON_NETWORK_CONDITION_CHANGE = 4, 
  OTC_NETWORK_REASON_NO_SUBSCRIBERS =
      5, 
  OTC_NETWORK_REASON_DOWNSTREAM_CONSTRAINT =
      6 
};

enum otc_constant {
  OTC_SUCCESS = 0,      
  OTC_FALSE = 0,        
  OTC_TRUE = !OTC_FALSE 
};

enum otc_error_code {
  OTC_INVALID_PARAM = 1,
  OTC_FATAL = 2,
  OTC_INVALID_VIDEO_FORMAT = 3,
  OTC_CONNECTION_DROPPED = 1022,
  OTC_UNABLE_TO_FORCE_DISCONNECT = 1520,
  OTC_UNABLE_TO_FORCE_MUTE = 1540,
  OTC_CONNECTION_TIMED_OUT = 1542,
  OTC_UNKNOWN_PUBLISHER_INSTANCE = 2003,
  OTC_UNKNOWN_SUBSCRIBER_INSTANCE = 2004,
  OTC_VIDEO_CAPTURE_FAILED = 3000,
  OTC_CAMERA_FAILED = 3010,
  OTC_VIDEO_RENDER_FAILED = 4000,
  OT_UNABLE_TO_ACCESS_MEDIA_ENGINE = 5000,
};

enum otc_log_level {
  OTC_LOG_LEVEL_DISABLED = 0, 
  OTC_LOG_LEVEL_ERROR = 1,    
  OTC_LOG_LEVEL_WARN = 2,     
  OTC_LOG_LEVEL_INFO = 3,     
  OTC_LOG_LEVEL_DEBUG = 4,    
  OTC_LOG_LEVEL_TRACE = 5,    
 
  OTC_LOG_LEVEL_FATAL = OTC_LOG_LEVEL_ERROR, 
  OTC_LOG_LEVEL_MSG = OTC_LOG_LEVEL_DEBUG,   
  OTC_LOG_LEVEL_ALL = OTC_LOG_LEVEL_TRACE    
};

typedef int otc_bool;

typedef struct otc_on_mute_forced_info {
  otc_bool active;
} otc_on_mute_forced_info;

enum otc_network_condition {
  OTC_NETWORK_CONDITION_UNKNOWN = 0,  
  OTC_NETWORK_CONDITION_CRITICAL = 1, 
  OTC_NETWORK_CONDITION_WARNING = 2,  
  OTC_NETWORK_CONDITION_FAIR = 3,     
  OTC_NETWORK_CONDITION_GOOD = 4,     
  OTC_NETWORK_CONDITION_EXCELLENT = 5 
};

enum otc_quality_restriction {
  OTC_QUALITY_RESTRICTION_UNKNOWN = 0,             
  OTC_QUALITY_RESTRICTION_NONE = 1,                
  OTC_QUALITY_RESTRICTION_SPATIAL = 2,             
  OTC_QUALITY_RESTRICTION_TEMPORAL = 3,            
  OTC_QUALITY_RESTRICTION_SPATIAL_AND_TEMPORAL = 4 
};

enum otc_network_degradation_source {
  OTC_NETWORK_DEGRADATION_SOURCE_NONE = 0,        
  OTC_NETWORK_DEGRADATION_SOURCE_BOTH_OR_UNCLEAR, 
  OTC_NETWORK_DEGRADATION_SOURCE_LOCAL,           
  OTC_NETWORK_DEGRADATION_SOURCE_REMOTE           
};

typedef struct otc_transport_stats {
  int64_t connection_estimated_bandwidth; 
  enum otc_network_condition network_condition;   
  enum otc_network_reason network_condition_reason; 
} otc_transport_stats;

typedef int otc_status;

typedef void (*otc_logger_callback)(const char* message);

OTC_DECL(otc_status) otc_init(void* reserved);

OTC_DECL(otc_status) otc_destroy();

OTC_DECL(void) otc_log_set_logger_callback(otc_logger_callback callback);

OTC_DECL(void) otc_log_enable(enum otc_log_level log_level);

OTC_DECL(enum otc_log_level) otc_get_log_level();
 
OTC_END_DECL
 
#endif  // BASE_H