Agora C++ API Reference for All Platforms
agora::base::IAgoraService Class Referenceabstract

#include <IAgoraService.h>

Public Member Functions

virtual int initialize (const AgoraServiceContext &context)=0
 
virtual const char * getVersion (int *build)=0
 
virtual rtm::IRtmService * createRtmService ()=0
 

Static Public Member Functions

static AGORA_CPP_API void release ()
 

Protected Member Functions

virtual ~IAgoraService ()
 

Constructor & Destructor Documentation

◆ ~IAgoraService()

virtual agora::base::IAgoraService::~IAgoraService ( )
inlineprotectedvirtual

Member Function Documentation

◆ release()

static AGORA_CPP_API void agora::base::IAgoraService::release ( )
static

◆ initialize()

virtual int agora::base::IAgoraService::initialize ( const AgoraServiceContext context)
pure virtual

Initializes the engine.

Parameters
contextRtcEngine context.
Returns
  • 0: Success.
  • < 0: Failure.

◆ getVersion()

virtual const char * agora::base::IAgoraService::getVersion ( int *  build)
pure virtual

Gets the SDK version number.

Parameters
buildBuild number.
Returns
The current SDK version in the string format. For example, 2.4.0

◆ createRtmService()

virtual rtm::IRtmService * agora::base::IAgoraService::createRtmService ( )
pure virtual