Agora C++ API Reference for All Platforms
|
Inherited by agora::rtc::RtcEngineContextInternal.
Public Member Functions | |
RtcEngineContext () | |
Public Attributes | |
IRtcEngineEventHandler * | eventHandler |
const char * | appId |
void * | context |
CHANNEL_PROFILE_TYPE | channelProfile |
const char * | license |
AUDIO_SCENARIO_TYPE | audioScenario |
unsigned int | areaCode |
commons::LogConfig | logConfig |
Optional< THREAD_PRIORITY_TYPE > | threadPriority |
bool | useExternalEglContext |
bool | domainLimit |
The context of IRtcEngine.
|
inline |
IRtcEngineEventHandler* agora::rtc::RtcEngineContext::eventHandler |
The event handler for IRtcEngine.
const char* agora::rtc::RtcEngineContext::appId |
The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one IRtcEngine
instance. To change your App ID, call release to destroy the current IRtcEngine instance, and then create a new one.
void* agora::rtc::RtcEngineContext::context |
CHANNEL_PROFILE_TYPE agora::rtc::RtcEngineContext::channelProfile |
The channel profile. See CHANNEL_PROFILE_TYPE.
const char* agora::rtc::RtcEngineContext::license |
The license used for verification when connectting channel. Charge according to the license
AUDIO_SCENARIO_TYPE agora::rtc::RtcEngineContext::audioScenario |
The audio application scenario. See AUDIO_SCENARIO_TYPE.
AUDIO_SCENARIO_DEFAULT(0)
AUDIO_SCENARIO_GAME_STREAMING(3)
unsigned int agora::rtc::RtcEngineContext::areaCode |
The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions.
For the regions that Agora supports, see AREA_CODE. The area codes support bitwise operation.
After specifying the region, the app integrated with the Agora SDK connects to the Agora servers within that region.
commons::LogConfig agora::rtc::RtcEngineContext::logConfig |
The log files that the SDK outputs. See LogConfig.
By default, the SDK generates five SDK log files and five API call log files with the following rules:
agorasdk.log
, agorasdk.1.log
, agorasdk.2.log
, agorasdk.3.log
, and agorasdk.4.log
.agoraapi.log
, agoraapi.1.log
, agoraapi.2.log
, agoraapi.3.log
, and agoraapi.4.log
.agorasdk.log
or agoraapi.log
.agorasdk.log
is full, the SDK processes the log files in the following order:agorasdk.4.log
file (if any).agorasdk.3.log
to agorasdk.4.log
.agorasdk.2.log
to agorasdk.3.log
.agorasdk.1.log
to agorasdk.2.log
.agorasdk.log
file. Optional<THREAD_PRIORITY_TYPE> agora::rtc::RtcEngineContext::threadPriority |
Thread priority for SDK common threads
bool agora::rtc::RtcEngineContext::useExternalEglContext |
Whether to use egl context in the current thread as sdk‘s root egl context, which is shared by all egl related modules. eg. camera capture, video renderer.
bool agora::rtc::RtcEngineContext::domainLimit |
Determines whether to enable domain limit -true: only connect to servers which already parsed by DNS -false: (Default) connect to servers with no limit