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 UIKit. It is used to initialize our
RtcEngine, add the list of user permissions, define the channel properties and use extend theRtcEngineEventHandlerclass. - AgoraConnectionData
- AgoraEventHandlers
- 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
FloatingLayoutandGridLayout, enable active speaker, display number of users, display mic and video state of the user. - AudioVolumeInfo
- Properties of the audio volume information. Contains the user ID and volume information for each speaker.
- BeautyOptions
- Sets the image enhancement options.
- FacePositionInfo
- The information of the detected human face.
- LastmileProbeResult
- Statistics of the lastmile probe.
- LocalAudioStats
- Statistics of the local audio stream.
- LocalVideoStats
- Statistics of the local video.
- Permission
- Defines the permissions which can be checked and requested.
- PermissionWithService
- A special kind of permission, used to access a service.
- Rect
- Integer coordinates for a rectangle.
- RemoteAudioStats
- Statistics of the remote audio.
- RemoteVideoStats
- Statistics of the remote video.
- RtcStats
- Statistics of RTCEngine.
- UserInfo
- The UserInfo class.
- VideoEncoderConfiguration
- Definition of VideoEncoderConfiguration.
Enums
- AreaCode
- The area of connection.
- AudioLocalError
- The error information of the local audio.
- AudioLocalState
- The state of the local audio.
- AudioMixingReason
-
The reason for the change of the music file playback state, reported in the
RtcEngineEventHandler.audioMixingStateChanged. - AudioMixingStateCode
- The state of the audio mixing file.
- AudioOutputRouting
- Audio output routing.
- AudioProfile
- Audio profile.
- AudioRemoteState
- The state of the remote audio.
- AudioRemoteStateReason
- The reason of the remote audio state change.
- AudioScenario
- Audio scenario.
- BuiltInButtons
- ChannelMediaRelayError
- The error code in of channel media relay.
- ChannelMediaRelayEvent
- The event code in of channel media relay event.
- ChannelMediaRelayState
- The state code in channel media relay state.
- ChannelProfile
- Channel profile.
- ClientRole
- Client role in a live broadcast.
- ConnectionChangedReason
- Reasons for the connection state change.
- ConnectionStateType
- Connection states.
- ErrorCode
- Error codes occur when the SDK encounters an error that cannot be recovered automatically without any app intervention.
- InjectStreamStatus
- State of importing an external video stream in a live broadcast.
- Layout
- LighteningContrastLevel
- The lightening contrast level.
- LocalVideoStreamError
- The detailed error information of the local video.
- LocalVideoStreamState
- The state of the local video stream.
- NetworkQuality
- Network quality.
- NetworkType
- Network type.
- PermissionStatus
- Defines the state of a Permission.
- RtmpStreamingErrorCode
- The detailed error information for streaming.
- RtmpStreamingEvent
- Events during the RTMP or RTMPS streaming.
- RtmpStreamingState
- The RTMP or RTMPS streaming state.
- ServiceStatus
- Defines the different states a service can be in.
- StreamFallbackOptions
- Stream fallback option.
- StreamPublishState
- The publishing state.
- StreamSubscribeState
- The subscribing state.
- SuperResolutionStateReason
- The reason why the super-resolution algorithm is not successfully enabled.
- UploadErrorReason
- The reason for the upload failure.
- UserOfflineReason
- Reason for the user being offline.
- VideoRemoteState
- The state of the remote video.
- VideoRemoteStateReason
- The reason of the remote video state change.
- VideoRenderMode
- Video display mode.
- WarningCode
-
Warning codes occur when the SDK encounters an error that may be recovered automatically. These are only notifications, and can generally be ignored. For example, when the SDK loses connection to the server, the SDK reports the
OpenChannelTimeout(106) warning and tries to reconnect automatically. See WarningCode.OpenChannelTimeout.
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. - 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.