AgoraConnectionData class
Constructors
-
AgoraConnectionData({required String appId, required String channelName, String? rtmChannelName, int? uid = 0, String? rtmUid, String? username, String? tokenUrl, String? cloudRecordingUrl, String? tempToken, String? tempRtmToken, List<AreaCode> areaCode = const [AreaCode.areaCodeGlob], bool rtmEnabled = true, int? screenSharingUid = 1000, bool screenSharingEnabled = true, Function? cloudRecordingCallback})
-
Properties
-
appId
→ String
-
The App ID issued to you by Agora. See How to get the App ID. Only users in apps with the same App ID can join the same channel and communicate with each other.
final
-
areaCode
→ List<AreaCode>
-
(Optional) The region for connection. This advanced feature applies to scenarios that have regional restrictions.
final
-
channelName
→ String
-
Specifies the channel to join
final
-
cloudRecordingCallback
→ Function?
-
final
-
cloudRecordingUrl
→ String?
-
(Optional) Link to the deployed cloud recording server. Have a look at this guide to learn how to set up your cloud recording server
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
rtmChannelName
→ String?
-
final
-
rtmEnabled
→ bool
-
Whether you want to enable RTM or not. Enabling RTM adds the host controls which helps you to request a remote user to mute/unmute their video/mic. Host Controls are enabled by default, set this to
false to disable it.
final
-
rtmUid
→ String?
-
(Optional) The RTM user ID. A String value. If you don't provide a rtmUid, the UIKit automatically assigns a rtmUid based on timestamp.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
screenSharingEnabled
→ bool
-
final
-
screenSharingUid
→ int?
-
final
-
tempRtmToken
→ String?
-
(Optional) RTM Token value generated from the Agora dashboard.
final
-
tempToken
→ String?
-
(Optional) RTC Token value generated from the Agora dashboard.
final
-
tokenUrl
→ String?
-
(Optional) Link to the deployed token server. The UIKit automatically generates the token after a fixed interval. Have a look at this guide to learn how to set up your token server
final
-
uid
→ int?
-
(Optional) The RTC user ID. A 32-bit unsigned integer with a value ranging from 1 to (232-1). This parameter must be unique. If uid is not assigned (or set as 0), the SDK assigns a uid and reports it in the onJoinChannelSuccess callback.
final
-
username
→ String?
-
(Optional) If you want to enable RTM to your application (for features like host control) make sure that you pass in a username to AgoraConnectionData.
final
Methods
-
copyWith({String? appId, String? channelName, String? rtmChannelName, int? uid, String? rtmUid, String? username, String? tempToken, String? tempRtmToken, String? tokenUrl, String? cloudRecordingUrl, List<AreaCode>? areaCode, bool? rtmEnabled, int? screenSharingUid, bool? screenSharingEnabled, Function? cloudRecordingCallback})
→ AgoraConnectionData
-
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
