Agora Java API Reference for Android
Public Attributes | List of all members
agora::rtc::RtcEngineContext Struct Reference

Public Attributes

IRtcEngineEventHandlereventHandler
 
const char * appId
 
void * context
 
bool enableAudioDevice
 
CHANNEL_PROFILE_TYPE channelProfile
 
AUDIO_SCENARIO_TYPE audioScenario
 
unsigned int areaCode
 
commons::LogConfig logConfig
 

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.

◆ enableAudioDevice

bool agora::rtc::RtcEngineContext::enableAudioDevice

Determines whether to enable audio device -true: (Default) enable audio device -false, disable audio device. If you want to pull the decoded and mixed audio data for playback from pullAudioFrame. This value must be false

◆ 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)
  • AUDIO_SCENARIO_HIGH_DEFINITION(6)

◆ 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