base.h

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

Data structures: otc_on_mute_forced_info, otc_transport_stats

Includes: config.h

typedef otc_bool

Type definition for Boolean values.

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

typedef int otc_bool;

typedef 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.

typedef int otc_status;

typedef otc_logger_callback

Type definition for a function pointer to the function used as the custom logging callback to get messages logged by the SDK.

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

enum otc_video_reason

Enum for reasons for a video to be started, stopped, resumed, etc.

enum otc_network_reason

Enum describing reasons impacting the network condition.

These values indicate the primary factor affecting the current network condition assessment, such as bandwidth constraints, or packet loss.

enum otc_constant

This enumeration includes commonly used constants.

enum otc_error_code

This enumeration includes error codes.

enum otc_log_level

Log level enumeration.

This enumeration represents the different log levels supported.

enum otc_network_condition

This enum represents the overall health of the network connection for a given transport (local or remote). It is typically derived from metrics such as packet loss, and estimated available bandwidth. Higher values indicate better network conditions.

OTC_NETWORK_CONDITION_WARNING and OTC_NETWORK_CONDITION_CRITICAL indicate degraded network conditions that may trigger audio fallback callbacks. If audio fallback is enabled, the SDK will notify via the corresponding callbacks, and in the CRITICAL state, video is disabled to preserve call stability.

enum otc_quality_restriction

Enum describing reasons for sender quality restriction.

These values indicate media server quality adjustments (spatial/temporal switches) detected during a session.

enum otc_network_degradation_source

Indicates the source of video/network degradation in the session.

This enum identifies which side of the call is responsible for observed network issues impacting video quality. It complements per-transport network condition metrics.

Functions

otc_init(reserved) → {otc_status}

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

Parameters:

Returns:

Return value indicating either error or success.

otc_destroy() → {otc_status}

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_log_set_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:

See: : - otc_log_enable

otc_log_enable(log_level)

Enables logging of SDK messages for a given log level.

Parameters:

See: : - otc_log_set_logger_callback - otc_get_log_level

otc_get_log_level() → {enum otc_log_level}

Gets the current console logging level.

Returns:

The log level set.