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

Public Attributes

const char * token
 
const char * channelId
 
user_id_t userId
 
agora::Optional< int64_t > appDefinedStartTimeMs
 

Member Data Documentation

◆ token

const char* agora::rtc::TConnectSettings::token

The app ID.

◆ channelId

const char* agora::rtc::TConnectSettings::channelId

The channel name. It must be in the string format and not exceed 64 bytes in length. Supported character scopes are:

  • All lowercase English letters: a to z.
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • The space character.
  • Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","

◆ userId

user_id_t agora::rtc::TConnectSettings::userId

The ID of the local user. If you do not specify a user ID or set userId as null, the SDK returns a user ID in the onConnected callback. Your app must record and maintain the userId since the SDK does not do so.

◆ appDefinedStartTimeMs

agora::Optional<int64_t> agora::rtc::TConnectSettings::appDefinedStartTimeMs