IoT SDK for Linux v1.9.7
Loading...
Searching...
No Matches
rtc_service_option_t Struct Reference

#include <agora_rtc_api.h>

Data Fields

uint32_t area_code
char product_id [AGORA_RTC_PRODUCT_ID_MAX_LEN+1]
log_config_t log_cfg
char license_value [AGORA_LICENSE_VALUE_LEN+1]
bool domain_limit
bool use_string_uid

Detailed Description

The definition of the service option

Field Documentation

◆ area_code

uint32_t area_code

The server access region. This advanced setting is intended for scenarios with access-security restrictions. See area_code_e for supported regions. Region codes can be combined with bitwise operations. After a region is specified, the SDK connects only to Agora servers in that region.

◆ domain_limit

bool domain_limit

Whether to enable domain restrictions:

  • true: The SDK can access only networks for the specified domains.
  • false: (Default) The SDK can access networks without domain restrictions.
Note
  • This setting applies only when using a restricted IoT SIM card. To allow devices using such cards to communicate with other devices, set this parameter to true.
  • Before enabling domain restrictions, ask the IoT carrier to add the wildcard domains *.agora.io and *.agoraio.cn to its allowlist, and then contact sales.nosp@m.@she.nosp@m.ngwan.nosp@m.g.cn for configuration.

◆ license_value

char license_value[AGORA_LICENSE_VALUE_LEN+1]

The license string returned after license activation.

Note
The SDK uses license-based billing. To avoid service interruption, contact sales.nosp@m.@she.nosp@m.ngwan.nosp@m.g.cn to learn about and purchase a license.

◆ log_cfg

log_config_t log_cfg

SDK log configuration. See log_config_t.

◆ product_id

char product_id[AGORA_RTC_PRODUCT_ID_MAX_LEN+1]

the product_id (device name), the max product_id length is 63

◆ use_string_uid

bool use_string_uid
Since
v1.9.5

Whether to enable string user IDs:

  • true: Enable string user IDs. Ensure that every client joins the RTC channel with a string user ID.
  • false: (Default) Disable string user IDs.

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