Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

base.h File Reference

Base functions. More...

#include "config.h"

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 ()

Detailed Description

Base functions.

This file includes functions uses to initialize and destroy the library engine, as well as other functions to enable console logging.

Typedef Documentation

◆ otc_bool

typedef int otc_bool

Type definition for Boolean values.

Useful type for variables to represent Boolean values (true and false).

◆ otc_logger_callback

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.

Parameters
messageA pointer to the message being logged.
See also
otc_log_set_logger_callback

◆ otc_status

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.

See also
otc_constant
otc_error_code
otc_session_error_code
otc_publisher_error_code
otc_subscriber_error_code

Enumeration Type Documentation

◆ otc_constant

This enumeration includes commonly used constants.

Enumerator
OTC_SUCCESS 

Constant that represents success.

OTC_FALSE 

Constant that represents false.

OTC_TRUE 

Constant that represents true.

◆ otc_error_code

This enumeration includes error codes.

Enumerator
OTC_INVALID_PARAM 

Invalid funtion argument error code.

An argment used in a function call is not valid.

OTC_FATAL 

Fatal error code.

Generic error.

OTC_CONNECTION_DROPPED 

Connection dropped error code.

The connection to the OpenTok messaging server was dropped. Check the network connection.

OTC_CONNECTION_TIMED_OUT 

Connection time out error code.

Time out while performing a connect action.

OTC_UNKNOWN_PUBLISHER_INSTANCE 

Unknown publisher instance error code.

An unknown Publisher instance was used as a function argument.

OTC_UNKNOWN_SUBSCRIBER_INSTANCE 

Unknown subscriber instance error code.

An unknown subscriber instance was used as a function argument.

OTC_VIDEO_CAPTURE_FAILED 

Video capture error code.

There was an error with videot capturer.

OTC_CAMERA_FAILED 

Acquiring video camera error code.

There was an error while acquiring video from the camera.

OTC_VIDEO_RENDER_FAILED 

Video rendering error code.

There was an error while rendering video.

OT_UNABLE_TO_ACCESS_MEDIA_ENGINE 

Media engine access error code.

There was an error when trying to get the list of supported video codecs.

◆ otc_log_level

Log level enumeration.

This enumeration represents the different log levels supported.

Enumerator
OTC_LOG_LEVEL_DISABLED 

No messages enum value.

OTC_LOG_LEVEL_FATAL 

Fatal level messages.

OTC_LOG_LEVEL_ERROR 

Error level messages.

OTC_LOG_LEVEL_WARN 

Warning level messages.

OTC_LOG_LEVEL_INFO 

Info level messages.

OTC_LOG_LEVEL_DEBUG 

Debug level messages.

OTC_LOG_LEVEL_MSG 

Message level messages.

OTC_LOG_LEVEL_TRACE 

Trace level messages.

OTC_LOG_LEVEL_ALL 

All messages.

Function Documentation

◆ otc_destroy()

otc_status otc_destroy ( )

Destroys the library engine. You should call this function when you are done executing code that uses the library.

Returns
Return value indicating either error or success.

◆ otc_get_log_level()

enum otc_log_level otc_get_log_level ( )

Gets the current console logging level.

Returns
The log level set.

◆ otc_init()

otc_status otc_init ( void *  reserved)

Initializes the library. You must call this function before the execution of any other code using the library.

Parameters
reservedA void pointer to a memory area holding reserved resources used for the internal implementation. This must be set to NULL.
Returns
Return value indicating either error or success.

◆ otc_log_enable()

void otc_log_enable ( enum otc_log_level  log_level)

Enables logging of SDK messages for a given log level.

Parameters
log_levelThe desired log level.
See also
otc_log_set_logger_callback
otc_get_log_level

◆ otc_log_set_logger_callback()

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.

Parameters
callbackA pointer to the callback function.
See also
otc_log_enable