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 IRtcEngine instance. To change your App ID, call release to destroy the current IRtcEngine instance and then call createAgoraRtcEngine and initialize to create an IRtcEngine 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

The area of connection. This advanced feature applies to scenarios that have regional restrictions.

You can use the bitwise OR operator (|) to specify multiple areas. For details, see AREA_CODE.

After specifying the area of connection:

  • When the app that integrates the Agora SDK is used within the specified area, it connects to the Agora servers within the specified area under normal circumstances.
  • When the app that integrates the Agora SDK is used out of the specified area, it connects to the Agora servers either in the specified area or in the area where the app is located.