Agora C++ API Reference for All Platforms
Public Member Functions | Public Attributes | List of all members
agora::rtc::RtcEngineContext Struct Reference

#include <IAgoraRtcEngine.h>

Public Member Functions

 RtcEngineContext ()
 

Public Attributes

IRtcEngineEventHandlereventHandler
 
const char * appId
 
void * context
 
int areaCode
 

Detailed Description

Definition of RtcEngineContext.

Constructor & Destructor Documentation

◆ RtcEngineContext()

agora::rtc::RtcEngineContext::RtcEngineContext ( )
inline

Member Data Documentation

◆ eventHandler

IRtcEngineEventHandler* agora::rtc::RtcEngineContext::eventHandler

◆ appId

const char* agora::rtc::RtcEngineContext::appId

The App ID issued to you by Agora. See How to get the App ID. Only users in apps with the same App ID can join the same channel and communicate with each other. Use an App ID to create only one RtcEngine instance. To change your App ID, call release to destroy the current RtcEngine instance and then call createAgoraRtcEngine and initialize to create an RtcEngine instance with the new App ID.

◆ context

void* agora::rtc::RtcEngineContext::context

The video window handle. Once set, this parameter enables you to plug or unplug the video devices while they are powered.

◆ areaCode

int agora::rtc::RtcEngineContext::areaCode

Specify the area of IP addresses. You can use the OR operator (||) to specify multiple areas. For details, see AREA_CODE.

After specifying the area:

  • If the DNS lookup returns an IP address, the SDK chooses the best one from this IP address and the IP addresses in the specified area.
  • If the DNS lookup does not return an IP address, the SDK directly connects to the Agora server in the specified area.