AgoraClient class
AgoraClient is the main class in this VideoUIKit. It is used to initialize our RtcEngine, add the list of user permissions, define the channel properties and use extend the RtcEngineEventHandler class.
Constructors
-
AgoraClient({required AgoraConnectionData agoraConnectionData, List<
Permission> ? enabledPermission, AgoraChannelData? agoraChannelData, AgoraRtcEventHandlers? agoraEventHandlers, AgoraRtmClientEventHandler? agoraRtmClientEventHandler, AgoraRtmChannelEventHandler? agoraRtmChannelEventHandler})
Properties
- agoraChannelData → AgoraChannelData?
-
AgoraChannelData is a class that contains all the Agora channel properties.
final
- agoraConnectionData → AgoraConnectionData
-
AgoraConnectionData is a class used to store all the connection details to authenticate your account with the Agora SDK.
final
- agoraEventHandlers → AgoraRtcEventHandlers?
-
AgoraRtcEventHandlers is a class that contains all the Agora RTC event handlers. Use it to add your own functions or methods.
final
- agoraRtmChannelEventHandler → AgoraRtmChannelEventHandler?
-
AgoraRtmChannelEventHandlersis a class that contains all the Agora RTM channel event handlers. Use it to add your own functions or methods.final - agoraRtmClientEventHandler → AgoraRtmClientEventHandler?
-
AgoraRtmClientEventHandlersis a class that contains all the Agora RTM Client event handlers. Use it to add your own functions or methods.final -
enabledPermission
→ List<
Permission> ? -
enabledPermission is a list of permissions that the user has to grant to the app. By default the UIKit asks for the camera and microphone permissions for every broadcaster that joins the channel.
final
- engine → RtcEngine
-
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isInitialized → bool
-
Useful to check if AgoraClient is ready for further usage
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sessionController → SessionController
-
no setter
-
users
→ List<
int> -
no setter
Methods
-
initialize(
) → Future< void> -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
release(
) → Future< void> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
platformVersion(
) → Future< String>