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

Inherited by agora::rtc::RtcEngineContextInternal.

Public Member Functions

 RtcEngineContext ()
 

Public Attributes

IRtcEngineEventHandler * eventHandler
 
const char * appId
 
void * context
 
CHANNEL_PROFILE_TYPE channelProfile
 
AUDIO_SCENARIO_TYPE audioScenario
 
unsigned int areaCode
 
commons::LogConfig logConfig
 
Optional< THREAD_PRIORITY_TYPE > threadPriority
 
bool useExternalEglContext
 

Constructor & Destructor Documentation

◆ RtcEngineContext()

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

Member Data Documentation

◆ eventHandler

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

The event handler for IRtcEngine.

◆ appId

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

The App ID issued to the developers by Agora. Apply for a new one from Agora if it is missing from your kit.

◆ context

void* agora::rtc::RtcEngineContext::context
  • For Android, it is the context of Activity or Application.
  • For Windows, it is the window handle of app. Once set, this parameter enables you to plug or unplug the video devices while they are powered.

◆ channelProfile

CHANNEL_PROFILE_TYPE agora::rtc::RtcEngineContext::channelProfile

The channel profile. See CHANNEL_PROFILE_TYPE.

◆ audioScenario

AUDIO_SCENARIO_TYPE agora::rtc::RtcEngineContext::audioScenario

The audio application scenario. See AUDIO_SCENARIO_TYPE.

Note
Agora recommends the following scenarios:
  • AUDIO_SCENARIO_DEFAULT(0)
  • AUDIO_SCENARIO_GAME_STREAMING(3)

◆ areaCode

unsigned int agora::rtc::RtcEngineContext::areaCode

The region for connection. This advanced feature applies to scenarios that have regional restrictions.

For the regions that Agora supports, see AREA_CODE.

After specifying the region, the SDK connects to the Agora servers within that region.

◆ logConfig

commons::LogConfig agora::rtc::RtcEngineContext::logConfig

The config for custumer set log path, log size and log level

◆ threadPriority

Optional<THREAD_PRIORITY_TYPE> agora::rtc::RtcEngineContext::threadPriority

Thread priority for SDK common threads

◆ useExternalEglContext

bool agora::rtc::RtcEngineContext::useExternalEglContext

Whether use egl context in current thread as sdk‘s root egl context which shared by all egl related modules. eg. camera capture, video renderer.

Note
This property applies to Android only.