agora_uikit library

Classes

AgoraChannelData
Use this class to define the properties of a channel and the behaviour of a user inside that channel.
AgoraClient
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.
AgoraConnectionData
AgoraRtcEventHandlers
AgoraRtmChannelEventHandler
AgoraRtmClientEventHandler
Handles all the callbacks or event handler for the Agora RTM client class
AgoraVideoButtons
A UI class to style how the buttons look. Use this class to add, remove or customize the buttons in your live video calling application.
AgoraVideoViewer
A UI class to style how the video layout looks like. Use this class to choose between the two default layouts FloatingLayout and GridLayout, enable active speaker, display number of users, display mic and video state of the user.
AudioVolumeInfo
The volume information of users.
BeautyOptions
Image enhancement options.
LastmileProbeResult
Results of the uplink and downlink last-mile network tests.
LocalAudioStats
Local audio statistics.
LocalVideoStats
The statistics of the local video stream.
Permission
Defines the permissions which can be checked and requested.
PermissionWithService
A special kind of permission, used to access a service.
Rectangle
The location of the target area relative to the screen or window. If you do not set this parameter, the SDK selects the whole screen or window.
RemoteAudioStats
Audio statistics of the remote user.
RemoteVideoStats
Statistics of the remote video stream.
RtcStats
Statistics of a call session.
RtmAttribute
RtmChannelAttribute
RtmChannelMember
RtmChannelMemberCount
RtmMessage
RtmServiceContext
UserInfo
The information of the user.
VideoEncoderConfiguration
Video encoder configurations.

Enums

AreaCode
The region for connection, which is the region where the server the SDK connects to is located.
AudioMixingReasonType
The reason why the playback state of the music file changes. Reported in the onAudioMixingStateChanged callback.
AudioMixingStateType
The playback state of the music file.
AudioProfileType
The audio profile.
AudioScenarioType
The audio scenarios.
BuiltInButtons
CameraState
ChannelMediaRelayError
The error code of the channel media relay.
ChannelMediaRelayState
The state code of the channel media relay.
ChannelProfileType
The channel profile.
ClientRoleType
The user role in the interactive live streaming.
ConnectionChangedReasonType
Reasons causing the change of the connection state.
ConnectionStateType
Connection states.
Device
ErrorCodeType
Error codes.
Layout
Level
LighteningContrastLevel
The contrast level.
LocalAudioStreamReason
Reasons for local audio state changes.
LocalAudioStreamState
The state of the local audio.
LocalVideoStreamReason
Reasons for local video state changes.
LocalVideoStreamState
Local video state types.
MicState
NetworkType
Network type.
PermissionStatus
Defines the state of a Permission.
RecordingState
RemoteAudioState
Remote audio states.
RemoteAudioStateReason
The reason for the remote audio state change.
RemoteVideoState
The state of the remote video stream.
RemoteVideoStateReason
The reason for the remote video state change.
RtmAreaCode
RtmCloudProxyType
RtmConnectionChangeReason
RtmConnectionState
RtmLocalInvitationState
RtmLogFilter
RtmMessageType
RtmPeerOnlineState
RtmPeerSubscriptionOption
RtmpStreamingEvent
Events during the Media Push.
RtmpStreamPublishReason
Reasons for changes in the status of RTMP or RTMPS streaming.
RtmpStreamPublishState
States of the Media Push.
RtmRemoteInvitationState
ServiceStatus
Defines the different states a service can be in.
StreamFallbackOptions
Options for handling audio and video stream fallback when network conditions are weak.
StreamPublishState
The publishing state.
StreamSubscribeState
The subscribing state.
UserOfflineReasonType
Reasons for a user being offline.

Extensions

FuturePermissionStatusGetters on Future<PermissionStatus>
Utility getter extensions for the Future<PermissionStatus> type.
FutureServiceStatusGetters on Future<ServiceStatus>
Utility getter extensions for the Future<ServiceStatus> type.
LevelExtension on Level
PermissionActions on Permission
Actions that can be executed on a permission.
PermissionCheckShortcuts on Permission
Shortcuts for checking the status of a Permission.
PermissionListActions on List<Permission>
Actions that can be taken on a List of Permissions.
PermissionStatusGetters on PermissionStatus
Utility getter extensions for the PermissionStatus type.
ServicePermissionActions on PermissionWithService
Actions that apply only to permissions that have an associated service.
ServiceStatusGetters on ServiceStatus
Utility getter extensions for the ServiceStatus type.

Functions

openAppSettings() Future<bool>
Opens the app settings page.