agora_chat_callkit library

Classes

AdvancedAudioOptions
The advanced options for audio.
AdvanceOptions
Advanced options for video encoding.
AgoraRhythmPlayerConfig
The metronome configuration.
AgoraVideoView
The AgoraVideoView Class for rendering local and remote video.
AudioDeviceInfo
The AudioDeviceInfo class that contains the ID, name and type of the audio devices.
AudioDeviceManager
Audio device management methods.
AudioEncodedFrameObserver
The encoded audio observer.
AudioEncodedFrameObserverConfig
Observer settings for the encoded audio.
AudioFrame
Raw audio data.
AudioFrameObserver
The audio frame observer.
AudioFrameObserverBase
The audio frame observer.
AudioParams
Audio data format.
AudioPcmFrame
The parameters of the audio frame in PCM format.
AudioPcmFrameSink
This class is used to get raw PCM audio.
AudioRecordingConfiguration
Recording configurations.
AudioSpectrumData
The audio spectrum data.
AudioSpectrumObserver
The audio spectrum observer.
AudioTrackConfig
The configuration of custom audio tracks.
AudioVolumeInfo
The volume information of users.
BeautyOptions
Image enhancement options.
CacheStatistics
Statistics about the media files being cached.
CameraCapturerConfiguration
The camera capturer preference.
ChannelMediaInfo
Channel media information.
ChannelMediaOptions
The channel media options.
ChannelMediaRelayConfiguration
Configuration of cross channel media relay.
ChatAreaCode
ChatCallKit
ChatCallKitErrorProcessCode
Call error code
ChatCallKitManager
ChatCallKitObserver
ChatCallKitState
ChatCallKitUserMapper
User information Mapper, used to obtain the mapping between agoraUid and userId.
ChatClient
~english The ChatClient class, which is the entry point of the Chat SDK. With this class, you can log in, log out, and access other functionalities such as group and chatroom. ~end
ChatCmdMessageBody
~english The command message body. ~end
ChatContact
ChatContactEventHandler
~english The contact event handler.
ChatContactManager
~english The contact manager class, which manages chat contacts such as adding, deleting, retrieving, and modifying contacts. ~end
ChatConversation
~english The conversation class, indicating a one-to-one chat, a group chat, or a conversation chat. It contains the messages that are sent and received within the conversation.
ChatCursorResult<T>
~english The ChatCursorResult class, which specifies the cursor from which to query results. When querying using this class, the SDK returns the queried instance and the cursor.
ChatCustomMessageBody
~english The custom message body. ~end
ChatDeviceInfo
~english The ChatDeviceInfo class, which contains the multi-device information. ~end
ChatDownloadCallback
~english The group shared download callback. ~end
ChatError
~english The error class defined by the SDK. ~end
ChatEventHandler
~english The chat event handler.
ChatFileMessageBody
~english The base class of file messages. ~end
ChatGroup
~english The ChatGroup class, which contains the information of the chat group. ~end
ChatGroupEventHandler
~english The group event handler.
ChatGroupInfo
~english The class that defines basic information of chat groups. ~end
ChatGroupManager
~english The group manager class, which manages group creation and deletion, user joining and exiting the group, etc. ~end
ChatGroupMessageAck
~english The class for group message read receipts.
ChatGroupOptions
~english The group options to be configured when the chat group is created. ~end
ChatGroupSharedFile
~english The ChatGroupSharedFile class, which manages the chat group shared files.
ChatImageMessageBody
~english The image message body class. ~end
ChatLocationMessageBody
~english The location message class. ~end
ChatManager
~english The chat manager class, responsible for sending and receiving messages, loading and deleting conversations, and downloading attachments.
ChatMessage
~english The message class.
ChatMessageBody
ChatMessageEvent
~english The message status event class. During message delivery, the message ID will be changed from a local uuid to a global unique ID that is generated by the server to uniquely identify a message on all devices using the SDK. This API should be implemented in the chat page widget to listen for message status changes. ~end
ChatMessageReaction
~english The message Reaction instance class, which has the following attributes: Reaction: The message Reaction. UserCount: The count of users that added the Reaction. UserList: The list of users that added the Reaction. isAddedBySelf: Whether the current user added this Reaction. ~end
ChatMessageReactionEvent
~english The message reaction change event class. ~end
ChatMultiDeviceEventHandler
~english The multi-device event handler. Listens for callback for the current user's actions on other devices, including contact changes, group changes, and thread changes.
ChatOptions
~english The ChatOptions class, which contains the settings of the Chat SDK.
ChatPageResult<T>
~english The ChatPageResult class, which is returned when calling the methods that fetch data by pagination. The SDK also returns the number of remaining pages and the data count of the next page. If the dada count is less than the count you set, there is no more data on server.
ChatPresence
~english The presence property class that contains presence properties, including the publisher's user ID and current presence state, and the platform used by the online device, as well as the presence's extension information, update time, and subscription expiration time. ~end
ChatPresenceEventHandler
~english The presence event handler.
ChatPresenceManager
~english The Manager that defines how to manage presence states. ~end
ChatPresenceStatusDetail
~english The presence details, including the platform used by the publisher's current online device and the current presence state. ~end
ChatPushConfigs
~english The push configuration class. ~end
ChatPushManager
~english The message push configuration options. ~end
ChatRoom
~english The chat room instance class.
ChatRoomEventHandler
~english The chat room event handler.
ChatRoomManager
~english The chat room manager class, which manages user joining and exiting the chat room, retrieving the chat room list, and managing member privileges. The sample code for joining a chat room:
ChatSilentModeParam
~english Offline push Settings parameter entity class. ~end
ChatSilentModeResult
~english Offline push DND result class. ~end
ChatSilentModeTime
~english For offline push DND time class. ~end
ChatTextMessageBody
~english The text message class. ~end
ChatThread
~english The message thread class. ~end
ChatThreadEvent
~english The message thread event class. ~end
ChatThreadEventHandler
~english The message thread event handler, which handles message thread events such as creating or leaving a message thread.
ChatThreadManager
~english The chat thread manager class. ~end
ChatTranslateLanguage
~english The translation language class, which contains the information of the translation languages. ~end
ChatUserInfo
~english The ChatUserInfo class, which contains the user attributes, such as the nickname, description, and avatar. ~end
ChatUserInfoManager
~english The user attribute manager class, which gets and sets the user attributes. ~end
ChatVideoMessageBody
~english The video message body class. ~end
ChatVoiceMessageBody
~english The voice message body class. ~end
ClientRoleOptions
Setting of user role properties.
CodecCapInfo
The codec capability of the SDK.
CodecCapLevels
The level of the codec capability.
ColorEnhanceOptions
The color enhancement options.
CombineMessageBody
ConnectionEventHandler
~english The connection event handler.
ContentInspectConfig
Screenshot and upload configuration.
ContentInspectModule
ContentInspectModule A structure used to configure the frequency of video screenshot and upload.
ConversationFetchOptions
~english The conversation filter class. ~end
DataStreamConfig
The configurations for the data stream.
DeviceInfo
The audio device information.
DirectCdnStreamingEventHandler
The DirectCdnStreamingEventHandler interface class is used by the SDK to send event notifications of CDN streaming to your app. Your app can get those notifications through methods that inherit this interface class.
DirectCdnStreamingMediaOptions
The media setting options for the host.
DirectCdnStreamingStats
The statistics of the current CDN streaming.
EchoTestConfiguration
The configuration of the audio and video call loop test.
EncodedAudioFrameInfo
Audio information after encoding.
EncodedVideoFrameInfo
Information about externally encoded video frames.
EncryptionConfig
Built-in encryption configurations.
ExtensionContext
The context information of the extension.
ExternalVideoFrame
The external video frame.
FaceInfoObserver
Facial information observer.
FetchMessageOptions
~english The parameter configuration class for pulling historical messages from the server. ~end
FilterEffectOptions
Filter effect options.
FocalLengthInfo
Focal length information supported by the camera, including the camera direction and focal length type.
ImageTrackOptions
Image configurations.
LastmileProbeConfig
Configurations of the last-mile network test.
LastmileProbeOneWayResult
Results of the uplink or downlink last-mile network test.
LastmileProbeResult
Results of the uplink and downlink last-mile network tests.
LeaveChannelOptions
The options for leaving a channel.
LiveStreamAdvancedFeature
The configuration for advanced features of the RTMP or RTMPS streaming with transcoding.
LiveTranscoding
Transcoding configurations for Media Push.
LocalAudioMixerConfiguration
The configurations for mixing the lcoal audio.
LocalAudioStats
Local audio statistics.
LocalSpatialAudioEngine
This class calculates user positions through the SDK to implement the spatial audio effect.
LocalTranscoderConfiguration
The configuration of the video mixing on the local client.
LocalVideoStats
The statistics of the local video stream.
LogConfig
Configuration of Agora SDK log files.
LowlightEnhanceOptions
The low-light enhancement options.
MediaEngine
The MediaEngine class.
MediaPlayer
This class provides media player functions and supports multiple instances.
MediaPlayerCacheManager
This class provides methods to manage cached media files.
MediaPlayerController
The AgoraVideoView controller used to render the video for the media player.
MediaPlayerSourceObserver
Provides callbacks for media players.
MediaPlayerVideoFrameObserver
The video frame observer for the media player.
MediaSource
Information related to the media file to be played and the playback scenario configurations.
MessagePinInfo
~english The message pinning information. ~end
Metadata
Media metadata.
MetadataObserver
The metadata observer.
MixedAudioStream
The source of the audio streams that are mixed locally.
PlayerPlaybackStats
The information of the media file being played.
PlayerStreamInfo
The detailed information of the media stream.
PlayerUpdatedInfo
Information related to the media player.
ReactionOperation
~english Reaction operation. ~end
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.
RemoteVoicePositionInfo
The spatial position of the remote user or the media player.
RtcConnection
Contains connection information.
RtcEngine
The basic interface of the Agora SDK that implements the core functions of real-time communication.
RtcEngineContext
Configurations for the RtcEngineContext instance.
RtcEngineEventHandler
The SDK uses the RtcEngineEventHandler interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
RtcEngineEx
This interface class contains multi-channel methods.
RtcImage
Image properties.
RtcStats
Statistics of a call session.
ScreenAudioParameters
The audio configuration for the shared screen stream.
ScreenCaptureConfiguration
The configuration of the captured screen.
ScreenCaptureParameters
Screen sharing configurations.
ScreenCaptureParameters2
Screen sharing configurations.
ScreenCaptureSourceInfo
The information about the specified shareable window or screen.
ScreenVideoParameters
The video configuration for the shared screen stream.
SDKBuildInfo
SDK version information.
SegmentationProperty
Processing properties for background images.
SimulcastStreamConfig
The configuration of the low-quality video stream.
SnapshotConfig
The snapshot configuration.
SpatialAudioParams
The spatial audio parameters.
SpatialAudioZone
Sound insulation area settings.
SrcInfo
Information about the video bitrate of the media resource being played.
ThumbImageBuffer
The image content of the thumbnail or icon. Set in ScreenCaptureSourceInfo.
TranscodingUser
Transcoding configurations of each host.
TranscodingVideoStream
The video streams for local video mixing.
UplinkNetworkInfo
The uplink network information.
UserAudioSpectrumInfo
Audio spectrum information of the remote user.
UserInfo
The information of the user.
VideoCanvas
Attributes of the video canvas object.
VideoDenoiserOptions
Video noise reduction options.
VideoDeviceInfo
The VideoDeviceInfo class that contains the ID and device name of the video devices.
VideoDeviceManager
Video device management methods.
VideoDimensions
The video dimension.
VideoEncodedFrameObserver
Receives encoded video images.
VideoEncoderConfiguration
Video encoder configurations.
VideoFormat
The format of the video frame.
VideoFrame
Configurations of the video frame.
VideoFrameObserver
The IVideoFrameObserver class.
VideoLayout
Layout information of a specific sub-video stream within the mixed stream.
VideoRenderingTracingInfo
Indicators during video frame rendering progress.
VideoSubscriptionOptions
Video subscription options.
VideoViewController
A AgoraVideoView controller for rendering local and remote video.
VideoViewControllerBase
A AgoraVideoView controller for rendering local and remote video.
VirtualBackgroundSource
The custom background.
WatermarkOptions
Configurations of the watermark image.
WatermarkRatio
The position and size of the watermark on the screen.

Enums

AlphaStitchMode
The relative position of alphaBuffer and video frames.
AreaCode
The region for connection, which is the region where the server the SDK connects to is located.
AudienceLatencyLevelType
The latency level of an audience member in interactive live streaming. This enum takes effect only when the user role is set to clientRoleAudience .
AudioAinsMode
AI noise suppression modes.
AudioCodecProfileType
Self-defined audio codec profile.
AudioCodecType
The codec type of audio.
AudioDualMonoMode
The channel mode.
AudioEffectPreset
Preset audio effects.
AudioEncodedFrameObserverPosition
Audio profile.
AudioEncodingType
Audio encoding type.
AudioEqualizationBandFrequency
The midrange frequency for audio equalization.
AudioFileRecordingType
Recording content. Set in startAudioRecording.
AudioFrameType
Audio frame type.
AudioMixingDualMonoMode
The channel mode.
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.
AudioRecordingQualityType
Recording quality.
AudioReverbType
Audio reverberation types.
AudioRoute
The type of the audio route.
AudioSampleRateType
The audio sampling rate of the stream to be pushed to the CDN.
AudioScenarioType
The audio scenarios.
AudioSessionOperationRestriction
The operation permissions of the SDK on the audio session.
AudioSourceType
The audio source type.
AudioTrackType
The type of the audio track.
BackgroundBlurDegree
The degree of blurring applied to the custom background image.
BackgroundSourceType
The custom background.
CameraDirection
The camera direction.
CameraFocalLengthType
The camera focal length types.
CameraStabilizationMode
Camera stabilization modes.
CaptureBrightnessLevelType
The brightness level of the video image captured by the local camera.
ChannelMediaRelayError
The error code of the channel media relay.
ChannelMediaRelayState
The state code of the channel media relay.
ChannelProfileType
The channel profile.
ChatCallKitCallEndReason
End of call cause
ChatCallKitCallType
Call type
ChatCallKitErrorType
Call error type
ChatConversationType
~english The conversation types. ~end
ChatGroupPermissionType
~english The group roles. ~end
ChatGroupStyle
~english The group types. ~end
ChatMultiDevicesEvent
~english Multi-device event types.
ChatPushRemindType
~english The push notification modes. ~end
ChatRoomMessagePriority
~english Chat room message priorities. ~end
ChatRoomPermissionType
~english The chat room roles. ~end
ChatSearchDirection
~english The message search directions. ~end
ChatSilentModeParamType
~english The offline push settings. ~end
ChatThreadOperation
~english The message thread events. ~end
ChatType
~english The chat types.
ClientRoleChangeFailedReason
The reason for a user role switch failure.
ClientRoleType
The user role in the interactive live streaming.
CloudProxyType
The cloud proxy type.
CodecCapMask
The bit mask of the codec type.
CompressionPreference
Compression preference for video encoding.
ConnectionChangedReasonType
Reasons causing the change of the connection state.
ConnectionStateType
Connection states.
ContentInspectType
The type of video content moderation module.
ConversationMarkType
~english The conversation mark types.
DegradationPreference
Video degradation preferences when the bandwidth is a constraint.
DirectCdnStreamingReason
Reasons for the changes in CDN streaming status.
DirectCdnStreamingState
The current CDN streaming state.
DisplayStyle
~english The push display styles. ~end
DownloadStatus
~english The download status of the attachment file. ~end
EarMonitoringFilterType
The audio filter types of in-ear monitoring.
EncodingPreference
Video encoder preference.
EncryptionErrorType
Encryption error type.
EncryptionMode
The built-in encryption mode.
ErrorCodeType
Error codes.
ExperiencePoorReason
Reasons why the QoE of the local user when receiving a remote audio stream is poor.
ExperienceQualityType
The Quality of Experience (QoE) of the local user when receiving a remote audio stream.
ExternalVideoSourceType
The external video frame encoding type.
FeatureType
The type of the advanced feature.
FrameRate
The video frame rate.
HeadphoneEqualizerPreset
Preset headphone equalizer types.
InterfaceIdType
The interface class.
LastmileProbeResultState
The status of the last-mile probe test.
LeaveReason
~english Leave chat room reason ~end ~chinese 离开聊天室原因 ~end
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.
LogFilterType
The output log level of the SDK.
LogLevel
The output log level of the SDK.
LowLightEnhanceLevel
The low-light enhancement level.
LowLightEnhanceMode
The low-light enhancement mode.
MaxDeviceIdLengthType
The maximum length of the device ID.
MaxUserAccountLengthType
The maximum length of the user account.
MediaDeviceStateType
Media device states.
MediaDeviceType
Media device types.
MediaPlayerEvent
Media player events.
MediaPlayerMetadataType
The type of media metadata.
MediaPlayerReason
Reasons for the changes in the media player status.
MediaPlayerState
The playback state.
MediaRecorderStreamType
The recording content.
MediaSourceType
Media source type.
MediaStreamType
The type of the media stream.
MediaTraceEvent
The rendering state of the media frame.
MessageDirection
~english The message directions.
MessagePinOperation
MessageSearchScope
~english The message search scopes. ~end
MessageStatus
~english The message sending/reception status. ~end
MessageType
~english The message types. ~end
MetadataType
Metadata type of the observer. We only support video metadata for now.
NetworkType
Network type.
OrientationMode
Video output orientation mode.
PermissionType
The type of the device permission.
PlayerPreloadEvent
Events that occur when media resources are preloaded.
ProxyType
The cloud proxy type.
QualityAdaptIndication
Quality change of the local video in terms of target frame rate and target bit rate since last count.
QualityType
Network quality types.
RawAudioFrameOpModeType
The use mode of the audio data.
ReactionOperate
~english Reaction operations. ~end
RecorderReasonCode
The reason for the state change.
RecorderState
The current recording state.
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.
RenderModeType
Video display modes.
RhythmPlayerReason
Virtual Metronome error message.
RhythmPlayerStateType
Virtual metronome state.
RtmpStreamingEvent
Events during the Media Push.
RtmpStreamLifeCycleType
Lifecycle of the CDN live video stream.
RtmpStreamPublishReason
Reasons for changes in the status of RTMP or RTMPS streaming.
RtmpStreamPublishState
States of the Media Push.
ScreenCaptureFramerateCapability
The highest frame rate supported by the screen sharing device.
ScreenCaptureSourceType
The type of the shared target. Set in ScreenCaptureSourceInfo.
ScreenScenarioType
The screen sharing scenario.
SegModelType
The type of algorithms to user for background processing.
SimulcastStreamMode
The mode in which the video stream is sent.
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.
VideoApplicationScenarioType
The video application scenarios.
VideoBufferType
The video buffer type.
VideoCodecCapabilityLevel
The level of the codec capability.
VideoCodecProfileType
Video codec profile types.
VideoCodecType
Video codec types.
VideoCodecTypeForStream
The codec type of the output video.
VideoContentHint
The content hint for screen sharing.
VideoDenoiserLevel
Video noise reduction level.
VideoDenoiserMode
Video noise reduction mode.
VideoFrameProcessMode
The process mode of the video frame:
VideoFrameType
The video frame type.
VideoMirrorModeType
Video mirror mode.
VideoModulePosition
The frame position of the video observer.
VideoOrientation
The clockwise rotation of the video.
VideoPixelFormat
The video pixel format.
VideoSourceType
The type of the video source.
VideoStreamType
The type of video streams.
VideoTranscoderError
The error code of the local video mixing failure.
VideoViewSetupMode
Setting mode of the view.
VoiceAiTunerType
Voice AI tuner sound types.
VoiceBeautifierPreset
The options for SDK preset voice beautifier effects.
VoiceConversionPreset
The options for SDK preset voice conversion effects.
WatermarkFitMode
The adaptation mode of the watermark.

Functions

createAgoraRtcEngine({Object? sharedNativeHandle}) → RtcEngine
Creates one RtcEngine object.
createAgoraRtcEngineEx({Object? sharedNativeHandle}) → RtcEngineEx
Creates one RtcEngineEx object.
getMediaPlayerCacheManager(RtcEngine rtcEngine) → MediaPlayerCacheManager
Gets one MediaPlayerCacheManager instance.

Typedefs

CursorResultCallback = Object Function(dynamic obj)
PageResultCallback = Object Function(dynamic obj)
RtcTokenHandler = Future<Map<String, int>> Function(String channel, String agoraAppId)
Returns a Map where key is agoraToken and value is agoraUid
UserMapperHandler = Future<ChatCallKitUserMapper?> Function(String channel, int agoraUid)
Returns a ChatCallKitUserMapper, See ChatCallKitUserMapper

Exceptions / Errors

AgoraRtcException
Error codes and error messages.
ChatCallKitError
Agora chat callkit error.