tox.h

Go to the documentation of this file.

#ifndef TOX_H
#define TOX_H

#if defined _WIN32 || defined __CYGWIN__
#ifdef LIBTOX_EXPORTS
#define TOX_DEF_PREFIX __declspec(dllexport)
#else
#define TOX_DEF_PREFIX __declspec(dllimport)
#endif
#elif __GNUC__ >= 4
#ifdef TOX_EXPORT_SHARED
#define TOX_DEF_PREFIX __attribute__((visibility("default")))
#else
#define TOX_DEF_PREFIX
#endif
#else
#define TOX_DEF_PREFIX
#endif
 
#ifdef __cplusplus
extern "C" {
#endif


#define TOX_VERSION "1.9.0"

typedef struct {
  void* tox_internal_ptr;
} tox_instance_t;

typedef enum TOX_TRIAGE_SETTING {
  TOX_NONE = 0,
  TOX_LIGHT,
  TOX_HEAVY
} TOX_TRIAGE_SETTING;

typedef struct {
  int SSLOPT_REVOKE_BEST_EFFORT;
} tox_web_request_config_t;

typedef struct {
  const char* account_uuid;
  const char* api_key;
  const char* player_name_unique;
  int verbose;
  int disable_upload_after_delay;
  TOX_TRIAGE_SETTING triage_setting;
  int obscure_names;
  const char* single_tenant_prefix;
  int enable_proximity_chat;
  int enable_token_authentication;
  const char* initial_token;
} tox_config_t;

typedef enum TOX_ERROR {
  TOX_NO_ERROR = 0,
  TOX_UNKNOWN_ERROR,
  TOX_BAD_INSTANCE,
  TOX_BAD_CONFIG,
  TOX_BAD_ACCOUNT_UUID,
  TOX_BAD_API_KEY,
  TOX_BAD_PLAYER_NAME,
  TOX_BAD_SESSION_NAME,
  TOX_BAD_AUDIO,
  TOX_BAD_SAMPLE_RATE,
  TOX_SAMPLES_SKIPPED,
  TOX_NO_SESSION_SET,
  TOX_UPLOAD_METADATA_FAILED,
  TOX_BAD_TENANT_PREFIX,
  TOX_BAD_PLAYER_ALIAS,
  TOX_BAD_SESSION_ALIAS,
  TOX_BAD_SESSION_DATA,
  TOX_ALREADY_IN_SESSION,
  TOX_NOT_IN_SESSION,
  TOX_BAD_SESSION_DATA_TYPE,
  TOX_BAD_PLAYER_DATA_TYPE,
  TOX_BAD_PLAYER_DATA,
  TOX_BAD_PLAYER_LIST,
  TOX_PROXIMITY_CHAT_DISABLED,
  TOX_BAD_AUTH_MODE,
  TOX_INCONSISTENT_PROXIMITY_CHAT_UPDATE
} TOX_ERROR;

typedef enum TOX_PLAYER_DATA_TYPE {
  TOX_PLAYER_LANGUAGE_PREFERENCE,
  TOX_PLAYER_PLATFORM_INFO
} TOX_PLAYER_DATA_TYPE;

typedef enum TOX_SESSION_DATA_TYPE {
  TOX_SESSION_TYPE,
  TOX_SESSION_PASSTHROUGH_DATA
} TOX_SESSION_DATA_TYPE;

TOX_DEF_PREFIX TOX_ERROR tox_global_init(void);

TOX_DEF_PREFIX TOX_ERROR tox_init_default_web_config(tox_web_request_config_t* config);

TOX_DEF_PREFIX TOX_ERROR tox_global_init_with_web_config(const tox_web_request_config_t* config);

TOX_DEF_PREFIX TOX_ERROR tox_global_cleanup(void);

TOX_DEF_PREFIX const char* tox_error_name(TOX_ERROR error);

TOX_DEF_PREFIX TOX_ERROR tox_create_instance(tox_instance_t* tox_instance_ptr,
                                             const tox_config_t* tox_config_ptr);
TOX_DEF_PREFIX TOX_ERROR tox_destroy_instance(tox_instance_t* tox_instance_ptr);

TOX_DEF_PREFIX TOX_ERROR tox_set_session_name(tox_instance_t* tox_instance_ptr,
                                              const char* session_name_unique);

TOX_DEF_PREFIX TOX_ERROR tox_join_session(tox_instance_t* tox_instance_ptr,
                                          const char* session_name_unique);

TOX_DEF_PREFIX TOX_ERROR tox_leave_session(tox_instance_t* tox_instance_ptr);

TOX_DEF_PREFIX TOX_ERROR tox_get_internal_player_uuid(tox_instance_t* tox_instance_ptr,
                                                      const char** internal_player_uuid);

TOX_DEF_PREFIX TOX_ERROR tox_set_player_alias(tox_instance_t* tox_instance_ptr,
                                              const char* player_alias);

TOX_DEF_PREFIX TOX_ERROR tox_get_internal_session_uuid(tox_instance_t* tox_instance_ptr,
                                                       const char** internal_session_uuid);

TOX_DEF_PREFIX TOX_ERROR tox_set_session_alias(tox_instance_t* tox_instance_ptr,
                                               const char* session_alias);

TOX_DEF_PREFIX TOX_ERROR tox_add_structured_player_data(tox_instance_t* tox_instance_ptr,
                                                        TOX_PLAYER_DATA_TYPE data_type,
                                                        const char* data);

TOX_DEF_PREFIX TOX_ERROR tox_add_structured_session_data(tox_instance_t* tox_instance_ptr,
                                                         TOX_SESSION_DATA_TYPE data_type,
                                                         const char* language);
TOX_DEF_PREFIX TOX_ERROR tox_add_session_data(tox_instance_t* tox_instance_ptr,
                                              const char* session_data);

TOX_DEF_PREFIX TOX_ERROR tox_set_proximity_chat_player_can_hear(tox_instance_t* tox_instance_ptr,
                                                                const char* const* players,
                                                                unsigned int num_players);

TOX_DEF_PREFIX TOX_ERROR tox_set_proximity_chat_can_hear_player(tox_instance_t* tox_instance_ptr,
                                                                const char* const* players,
                                                                unsigned int num_players);

TOX_DEF_PREFIX TOX_ERROR tox_set_global_muted(tox_instance_t* tox_instance_ptr, int muted);

TOX_DEF_PREFIX TOX_ERROR tox_set_player_muted(tox_instance_t* tox_instance_ptr, const char* player,
                                              int muted);

TOX_DEF_PREFIX TOX_ERROR tox_set_players_muted_at_join(tox_instance_t* tox_instance_ptr,
                                                       const char* const* players,
                                                       unsigned int num_players);

TOX_DEF_PREFIX TOX_ERROR tox_add_audio_float(tox_instance_t* tox_instance_ptr, const float* audio,
                                             unsigned int num_samples, unsigned int sample_rate,
                                             unsigned int num_channels);

TOX_DEF_PREFIX TOX_ERROR tox_add_audio_short(tox_instance_t* tox_instance_ptr, const short* audio,
                                             unsigned int num_samples, unsigned int sample_rate,
                                             unsigned int num_channels);

TOX_DEF_PREFIX TOX_ERROR tox_add_audio(tox_instance_t* tox_instance_ptr, const float* audio,
                                       unsigned int num_samples, unsigned int sample_rate);

TOX_DEF_PREFIX TOX_ERROR tox_add_audio_nonrealtime_float(tox_instance_t* tox_instance_ptr,
                                                         const float* audio,
                                                         unsigned int num_samples,
                                                         unsigned int sample_rate,
                                                         unsigned int num_channels);

TOX_DEF_PREFIX TOX_ERROR tox_add_audio_nonrealtime_short(tox_instance_t* tox_instance_ptr,
                                                         const short* audio,
                                                         unsigned int num_samples,
                                                         unsigned int sample_rate,
                                                         unsigned int num_channels);

TOX_DEF_PREFIX TOX_ERROR tox_add_audio_nonrealtime(tox_instance_t* tox_instance_ptr,
                                                   const float* audio, unsigned int num_samples,
                                                   unsigned int sample_rate);

TOX_DEF_PREFIX TOX_ERROR tox_set_single_tenant_prefix(tox_instance_t* tox_instance_ptr,
                                                      const char* prefix);

TOX_DEF_PREFIX TOX_ERROR tox_set_log_info_callback(void (*log_info_callback)(const char*));

TOX_DEF_PREFIX TOX_ERROR tox_set_log_error_callback(void (*log_error_callback)(const char*));

TOX_DEF_PREFIX const char* tox_get_version(void);

TOX_DEF_PREFIX TOX_ERROR tox_set_instance_token(tox_instance_t* tox_instance_ptr,
                                                const char* token);
 
#ifdef __cplusplus
}
#endif
 
#endif