agora::base::AgoraServiceConfiguration Struct Reference

#include <IAgoraService.h>

Public Member Functions
	AgoraServiceConfiguration ()

Public Attributes
bool	enableAudioProcessor
bool	enableAudioDevice
bool	enableVideo
const char *	appId
unsigned int	areaCode
agora::CHANNEL_PROFILE_TYPE	channelProfile
rtc::AUDIO_SCENARIO_TYPE	audioScenario
commons::LogConfig	logConfig
bool	useStringUid
bool	domainLimit

Detailed Description

The global configurations for AgoraService.

Set these configurations when calling initialize.

Constructor & Destructor Documentation

AgoraServiceConfiguration()

agora::base::AgoraServiceConfiguration::AgoraServiceConfiguration ( )

inline

Member Data Documentation

appId

const char* agora::base::AgoraServiceConfiguration::appId

The App ID of your project. Do not pass the token in this parameter.

areaCode

unsigned int agora::base::AgoraServiceConfiguration::areaCode

The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see AREA_CODE.

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

audioScenario

rtc::AUDIO_SCENARIO_TYPE agora::base::AgoraServiceConfiguration::audioScenario

The audio scenario. See AUDIO_SCENARIO_TYPE. The default value is AUDIO_SCENARIO_DEFAULT.

channelProfile

agora::CHANNEL_PROFILE_TYPE agora::base::AgoraServiceConfiguration::channelProfile

The channel profile. For details, see CHANNEL_PROFILE_TYPE. The default channel profile is CHANNEL_PROFILE_LIVE_BROADCASTING.

domainLimit

bool agora::base::AgoraServiceConfiguration::domainLimit

Whether to enable domain name restriction:

• true: Enable domain name restriction. The SDK can only access the network of the specified domain name.
• false: (Default) Disable domain name restriction. The SDK can access the network of any domain name.

Note

• This parameter is only valid for IOT scenarios using targeted IoT SIM cards.
• To ensure that the device using the targeted IoT SIM card can communicate with other devices, you need to set this parameter as true. Before enabling domain name restriction, you need to contact sales.nosp@m.-us@.nosp@m.agora.nosp@m..io to enable this function.

enableAudioDevice

bool agora::base::AgoraServiceConfiguration::enableAudioDevice

Whether to enable the audio device module. The function of the audio device module is to manage audio devices, such as recording and playing audio.

• true: (Default) Enable the audio device module. Audio recording and playback is available.
• false: Disable the audio device module. Audio recording and playback is unavailable.

Note

If you set enableAudioDevice as false and set enableAudioProcessor as true, you cannot use audio devices, but you can push PCM audio data.

enableAudioProcessor

bool agora::base::AgoraServiceConfiguration::enableAudioProcessor

Whether to enable the audio processing module.

• true: (Default) Enable the audio processing module.
• false: Disable the audio processing module. If you disable the audio processing module, you cannot create audio tracks.

enableVideo

bool agora::base::AgoraServiceConfiguration::enableVideo

Whether to enable video.

• true: Enable video.
• false: (Default) Disable video.

logConfig

commons::LogConfig agora::base::AgoraServiceConfiguration::logConfig

The log files that the SDK outputs. See LogConfig for details.

useStringUid

bool agora::base::AgoraServiceConfiguration::useStringUid

Whether to enable string uid.

---

The documentation for this struct was generated from the following file:

• IAgoraService.h