oRTP  0.23.0
Functions | Variables
ortp.h File Reference

General purpose library functions. More...

#include "ortp/logging.h"
#include "ortp/rtpsession.h"
#include "ortp/sessionset.h"
Include dependency graph for ortp.h:

Go to the source code of this file.

Functions

ORTP_PUBLIC bool_t ortp_min_version_required (int major, int minor, int micro)
 
ORTP_PUBLIC void ortp_init (void)
 
ORTP_PUBLIC void ortp_scheduler_init (void)
 
ORTP_PUBLIC void ortp_exit (void)
 
ORTP_PUBLIC void ortp_global_stats_reset (void)
 
ORTP_PUBLIC rtp_stats_tortp_get_global_stats (void)
 
ORTP_PUBLIC void ortp_global_stats_display (void)
 
ORTP_PUBLIC void rtp_stats_display (const rtp_stats_t *stats, const char *header)
 
ORTP_PUBLIC void rtp_stats_reset (rtp_stats_t *stats)
 

Variables

rtp_stats_t ortp_global_stats
 

Detailed Description

General purpose library functions.

Function Documentation

◆ ortp_exit()

ORTP_PUBLIC void ortp_exit ( void  )

Gracefully uninitialize the library, including shutdowning the scheduler if it was started.

◆ ortp_global_stats_display()

ORTP_PUBLIC void ortp_global_stats_display ( void  )

Display global statistics (cumulative for all RtpSession)

References rtp_stats_display().

Here is the call graph for this function:

◆ ortp_init()

ORTP_PUBLIC void ortp_init ( void  )

Initialize the oRTP library. You should call this function first before using oRTP API.

◆ ortp_min_version_required()

ORTP_PUBLIC bool_t ortp_min_version_required ( int  major,
int  minor,
int  micro 
)

This function give the opportunity to programs to check if the libortp they link to has the minimum version number they need.

Returns: true if ortp has a version number greater or equal than the required one.

◆ ortp_scheduler_init()

ORTP_PUBLIC void ortp_scheduler_init ( void  )

Initialize the oRTP scheduler. You only have to do that if you intend to use the scheduled mode of the #RtpSession in your application.

◆ rtp_stats_display()

ORTP_PUBLIC void rtp_stats_display ( const rtp_stats_t stats,
const char *  header 
)

Print RTP statistics.

Referenced by ortp_global_stats_display().

Here is the caller graph for this function: