OpenTok C SDK
|
Base functions. More...
#include "config.h"
Go to the source code of this file.
Typedefs | |
typedef int | otc_bool |
typedef int | otc_status |
typedef void(* | otc_logger_callback) (const char *message) |
Enumerations | |
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_CONNECTION_DROPPED = 1022, 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_FATAL = 2, OTC_LOG_LEVEL_ERROR = 3, OTC_LOG_LEVEL_WARN = 4, OTC_LOG_LEVEL_INFO = 5, OTC_LOG_LEVEL_DEBUG = 6, OTC_LOG_LEVEL_MSG = 7, OTC_LOG_LEVEL_TRACE = 8, OTC_LOG_LEVEL_ALL = 100 } |
Functions | |
otc_status | otc_init (void *reserved) |
otc_status | otc_destroy () |
void | otc_log_set_logger_callback (otc_logger_callback callback) |
void | otc_log_enable (enum otc_log_level log_level) |
enum otc_log_level | otc_get_log_level () |
Base functions.
This file includes functions uses to initialize and destroy the library engine, as well as other functions to enable console logging.
typedef int otc_bool |
Type definition for Boolean values.
Useful type for variables to represent Boolean values (true and false).
typedef void(* otc_logger_callback) (const char *message) |
Type definition for a function pointer to the function used as the custom logging callback to get messages logged by the SDK.
message | A pointer to the message being logged. |
typedef int otc_status |
Type definition for statuses.
This is the most common type for return value for functions in this library. This type includes values from the error code enumerations.
enum otc_constant |
enum otc_error_code |
This enumeration includes error codes.
enum otc_log_level |
Log level enumeration.
This enumeration represents the different log levels supported.
otc_status otc_destroy | ( | ) |
Destroys the library engine. You should call this function when you are done executing code that uses the library.
enum otc_log_level otc_get_log_level | ( | ) |
Gets the current console logging level.
otc_status otc_init | ( | void * | reserved | ) |
Initializes the library. You must call this function before the execution of any other code using the library.
reserved | A void pointer to a memory area holding reserved resources used for the internal implementation. This must be set to NULL . |
void otc_log_enable | ( | enum otc_log_level | log_level | ) |
Enables logging of SDK messages for a given log level.
log_level | The desired log level. |
void otc_log_set_logger_callback | ( | otc_logger_callback | callback | ) |
Sets the function pointer to a custom logging callback function to get messages logged by the SDK. If you do not set a logging callback function, the SDK will log messages to the console.
callback | A pointer to the callback function. |