agora_rtc_engine library

Classes

AdvancedAudioOptions
Advanced options for audio.
AdvancedConfigInfo
Advanced options for Local Access Point.
AdvanceOptions
Advanced options for video encoding.
AgoraCallController
AgoraCallUIKit
Pre-built out-of-the-box Call UI Kit Widget with Full Theme, Builder, Callbacks & Visibility Customization
AgoraChannelService
AgoraPipContentViewLayout
Layout configuration for picture-in-picture video streams.
AgoraPipController
Controller interface for managing picture-in-picture functionality.
AgoraPipOptions
Configuration options for Agora picture-in-picture mode.
AgoraPipStateChangedObserver
Observer for picture-in-picture state changes.
AgoraPipVideoStream
Video stream configuration for picture-in-picture mode.
AgoraRhythmPlayerConfig
Virtual metronome configuration.
AgoraTokenService
AgoraVideoView
The AgoraVideoView class, used to render local and remote video.
AudioCallView
AudioDeviceInfo
The AudioDeviceInfo class, containing the audio device ID and device name.
AudioDeviceManager
Methods for managing audio devices.
AudioEncodedFrameObserver
Observer for encoded audio.
AudioEncodedFrameObserverConfig
Observer settings for encoded audio.
AudioFrame
Raw audio data.
AudioFrameObserver
Audio observer.
AudioFrameObserverBase
Audio observer.
AudioParams
Audio data format.
AudioPcmFrame
Information of external PCM format audio frame.
AudioPcmFrameSink
This class is used to obtain raw PCM audio data.
AudioRecordingConfiguration
Recording configuration.
AudioSpectrumData
Audio spectrum data.
AudioSpectrumObserver
Audio spectrum observer.
AudioTrackConfig
Configuration options for custom audio tracks.
AudioVolumeInfo
User volume information.
BeautyOptions
Beauty effect options.
CacheStatistics
Statistics of cached files.
CallParticipant
CameraCapturerConfiguration
Camera capture configuration.
ChannelMediaInfo
Channel media information.
ChannelMediaOptions
Channel media configuration options.
ChannelMediaRelayConfiguration
Configuration information for media stream relay across channels.
ClientRoleOptions
User role property settings.
CodecCapInfo
Information about codec capabilities supported by the SDK.
CodecCapLevels
Codec capability levels.
ColorEnhanceOptions
Color enhancement options.
ContentInspectConfig
Local screenshot upload configuration.
ContentInspectModule
ContentInspectModule struct for configuring the upload frequency of local screenshots.
DataStreamConfig
Data stream settings.
DeviceInfo
Audio device information.
EchoTestConfiguration
Configuration for audio and video echo test.
EncodedAudioFrameInfo
Information about the encoded audio.
EncodedVideoFrameInfo
Information about externally encoded video frames.
EncryptionConfig
Configures built-in encryption mode and key.
ExtensionContext
Plugin context information.
ExternalVideoFrame
External video frame.
FaceInfoObserver
Face information observer.
FaceShapeAreaOptions
Filter effect options.
FaceShapeBeautyOptions
Face shaping style options.
FilterEffectOptions
Filter effect options.
FocalLengthInfo
Focal length information supported by the camera, including camera direction and focal length type.
GroupVideoGridView
GroupVideoSpeakerView
ImageTrackOptions
Settings for placeholder image.
LastmileProbeConfig
Last mile network probe configuration.
LastmileProbeOneWayResult
Uplink or downlink last mile network probe result.
LastmileProbeResult
Last mile uplink and downlink network quality probe result.
LeaveChannelOptions
Options for leaving a channel.
LiveStreamAdvancedFeature
Advanced feature configuration for transcoding live streaming.
LiveTranscoding
Transcoding properties for CDN live streaming.
LocalAccessPointConfiguration
Local Access Point configuration.
LocalAudioMixerConfiguration
Local audio mixing configuration.
LocalAudioStats
Local audio statistics.
LocalSpatialAudioEngine
This class calculates user coordinates through the SDK to implement spatial audio.
LocalTranscoderConfiguration
Local video compositing configuration.
LocalVideoStats
Statistics of the local video stream.
LogConfig
Configuration of SDK log files.
LogUploadServerInfo
Configuration information of the log server.
LowlightEnhanceOptions
Low light enhancement options.
MediaEngine
MediaEngine class.
MediaPlayer
Class that provides media player functionality and supports multiple instances.
MediaPlayerCacheManager
This class provides methods for managing cached media files in the media player.
MediaPlayerController
Controller for AgoraVideoView, used to render media player video.
MediaPlayerSourceObserver
Provides callbacks for the media player.
MediaPlayerVideoFrameObserver
Video data observer for the media player.
MediaSource
Information and playback settings for the media file to be played.
Metadata
Media metadata.
MetadataObserver
Metadata observer.
MultipathStats
Used to summarize statistics of each network path in multipath transmission.
PathStats
Used to obtain statistics for a specific network path.
PlayerPlaybackStats
Information related to the currently playing media resource.
PlayerStreamInfo
All information of the player media stream.
PlayerUpdatedInfo
Information related to the media player.
Rectangle
The position of the target area relative to the entire screen or window. If not specified, it refers to the entire screen or window.
RemoteAudioStats
Audio statistics of the remote user.
RemoteVideoStats
Statistics of the remote video stream.
RemoteVoicePositionInfo
Spatial position information of the remote user or media player.
RtcConnection
Class containing connection information.
RtcEngine
The base interface class of the RTC SDK that implements core real-time audio and video features.
RtcEngineContext
Definition of RtcEngineContext.
RtcEngineEventHandler
The RtcEngineEventHandler interface class is used by the SDK to send event notifications to the app. The app receives SDK event notifications by inheriting the methods of this interface class.
RtcEngineEx
Interface class that provides multi-channel methods.
RtcImage
Image properties.
RtcStats
Call-related statistics.
ScreenAudioParameters
Audio configuration for screen sharing stream.
ScreenCaptureConfiguration
Screen capture configuration.
ScreenCaptureParameters
Parameter configuration for screen sharing.
ScreenCaptureParameters2
Parameter configuration for screen sharing.
ScreenCaptureSourceInfo
Information about shareable windows or screens.
ScreenVideoParameters
Video encoding configuration for screen sharing stream.
SDKBuildInfo
SDK version information.
SegmentationProperty
Processing properties for background images.
SimulcastStreamConfig
Configuration for the video low stream.
SingleVideoCallView
SnapshotConfig
Video snapshot settings.
SpatialAudioParams
Spatial audio parameters.
SpatialAudioZone
Sound insulation zone settings.
SrcInfo
Video bitrate information during media playback.
ThumbImageBuffer
Image content of a thumbnail or icon. Set in ScreenCaptureSourceInfo.
TranscodingUser
Settings for each host involved in transcoding and mixing.
TranscodingVideoStream
Video streams involved in local compositing.
UplinkNetworkInfo
Uplink network information.
UserAudioSpectrumInfo
Audio spectrum information of a remote user.
UserInfo
User information.
VideoCanvas
Properties of the video canvas object.
VideoDenoiserOptions
Video denoising options.
VideoDeviceInfo
The VideoDeviceInfo class, contains the video device ID and device name.
VideoDeviceManager
Methods for managing video devices.
VideoDimensions
Video dimensions.
VideoEffectObject
Used to manage and configure video effects, such as beauty, makeup styles, and filters.
VideoEncodedFrameObserver
Class used to receive encoded video frames.
VideoEncoderConfiguration
Configuration for the video encoder.
VideoFormat
Video frame format.
VideoFrame
Video frame property settings.
VideoFrameObserver
Video observer.
VideoLayout
Layout information of a sub video stream in a composite stream.
VideoRenderingTracingInfo
Metric information during video frame rendering.
VideoSubscriptionOptions
Video subscription settings.
VideoViewController
The controller for AgoraVideoView, used to render local and remote video.
VideoViewControllerBase
The controller for AgoraVideoView, used to render local and remote video.
VirtualBackgroundSource
Custom background.
WatermarkOptions
Configure watermark image.
WatermarkRatio
Position and size of the watermark on the screen.

Enums

AgoraPipState
Represents the current state of Picture-in-Picture mode.
AlphaStitchMode
The relative position of alphaBuffer and the video frame.
AreaCode
Access region, i.e., the region of the server that the SDK connects to.
AudienceLatencyLevelType
Latency level for audience in a live broadcast channel. This enum is effective only when the user role is set to clientRoleAudience.
AudioAinsMode
AI noise reduction mode.
AudioCodecProfileType
Audio codec profile for stream output. Defaults to LC-AAC.
AudioCodecType
Audio codec format.
AudioDualMonoMode
Channel mode.
AudioEffectPreset
Preset audio effect options.
AudioEncodedFrameObserverPosition
Audio encoding content.
AudioEncodingType
Audio encoding type.
AudioEqualizationBandFrequency
Center frequency of voice equalization bands.
AudioFileRecordingType
Recording content. Set in startAudioRecording.
AudioFrameType
Audio frame type.
AudioMixingDualMonoMode
Channel mode.
AudioMixingReasonType
Reason for music file playback state change. Reported in the onAudioMixingStateChanged callback.
AudioMixingStateType
Music file playback state.
AudioProfileType
Audio encoding attributes.
AudioRecordingQualityType
Audio recording quality.
AudioReverbType
Audio reverb types.
AudioRoute
Audio routing types.
AudioSampleRateType
Sampling rate of the audio output during streaming.
AudioScenarioType
Audio scenarios.
AudioSessionOperationRestriction
SDK's operation permissions for Audio Session.
AudioSourceType
Audio source types.
AudioTrackType
Types of custom audio capture tracks.
BackgroundBlurDegree
Degree of background blur for custom background images.
BackgroundSourceType
Custom background.
CallMode
Call mode: 1-to-1 single call or group call
CallState
State lifecycle of an active call
CallType
Type of call: audio or video
CameraDirection
Camera direction.
CameraFocalLengthType
Camera focal length type.
CameraStabilizationMode
Camera stabilization mode.
CaptureBrightnessLevelType
Brightness level of locally captured video quality.
ChannelMediaRelayError
Error codes for media stream relay across channels.
ChannelMediaRelayState
State codes for media stream relay across channels.
ChannelProfileType
Channel profile.
ClientRoleChangeFailedReason
Reason for failing to switch user roles.
ClientRoleType
User role in live broadcasting profile.
CloudProxyType
Cloud proxy type.
CodecCapMask
Codec capability bit mask.
CompressionPreference
Compression preference type for video encoding.
ConnectionChangedReasonType
Reason for changes in network connection state.
ConnectionStateType
Network connection state.
ContentInspectType
Type of video content inspection module.
DegradationPreference
Video encoding degradation preference when bandwidth is limited.
EarMonitoringFilterType
Ear monitoring audio filter type.
EncodingPreference
Video encoder preference.
EncryptionErrorType
Built-in encryption error type.
EncryptionMode
Built-in encryption mode.
ErrorCodeType
Error codes.
ExperiencePoorReason
The reason for poor subjective experience quality of the local user when receiving remote audio.
ExperienceQualityType
The subjective experience quality of the local user when receiving remote audio.
ExternalVideoSourceType
Encoding type of external video frames.
FaceShapeArea
Selects the specific facial area to adjust.
FaceShapeBeautyStyle
Face shaping style makeup effect options.
FeatureType
Advanced feature types.
FrameRate
Video frame rate.
GroupViewMode
View mode for group video calls
HeadphoneEqualizerPreset
Preset headphone equalizer types.
InterfaceIdType
Interface class.
LastmileProbeResultState
Status of last mile quality probe result.
LighteningContrastLevel
Brightness contrast level.
LocalAudioStreamReason
Reasons for local audio state change.
LocalAudioStreamState
Local audio state.
LocalVideoEventType
Local video event types.
LocalVideoStreamReason
Reason for local video state change.
LocalVideoStreamState
Local video state.
LogFilterType
Log filter level.
LogLevel
Log output level.
LowLightEnhanceLevel
Low-light enhancement level.
LowLightEnhanceMode
Low-light enhancement mode.
MaxDeviceIdLengthType
Maximum length of device ID.
MaxUserAccountLengthType
Maximum length of user account.
MediaDeviceStateType
Device state.
MediaDeviceType
Device type.
MediaPlayerEvent
Player events.
MediaPlayerMetadataType
Media metadata types.
MediaPlayerReason
Reason for media player state change.
MediaPlayerState
Player states.
MediaSourceType
Media source types.
MediaStreamType
Media stream types.
MediaTraceEvent
Rendering status of media frames.
MetadataType
The type of Metadata for the observer. Currently, only video-type Metadata is supported.
MultipathMode
Mode for multipath data transmission.
MultipathType
Network path types used for multipath transmission.
NetworkType
Network connection type.
OrientationMode
Orientation mode for video encoding.
PermissionType
Device permission types.
PlayerPreloadEvent
Events that occur during media resource preloading.
ProxyType
Proxy type.
QualityAdaptIndication
Local video quality adaptation since the last statistics (based on target frame rate and target bitrate).
QualityType
Network quality.
RawAudioFrameOpModeType
Usage mode of audio data.
RecorderReasonCode
Reason for recording state error.
RecorderState
Current recording state.
RemoteAudioState
Remote audio stream state.
RemoteAudioStateReason
Reason for remote audio stream state change.
RemoteVideoState
Remote video stream state.
RemoteVideoStateReason
Reason for remote video stream state change.
RenderModeType
Video display mode.
RhythmPlayerReason
Virtual metronome error information.
RhythmPlayerStateType
Virtual metronome state.
RtmpStreamingEvent
Events that occur during RTMP streaming.
RtmpStreamLifeCycleType
Lifecycle of server-side transcoding stream.
RtmpStreamPublishReason
The reason for RTMP stream publishing state change.
RtmpStreamPublishState
The state of RTMP streaming.
ScreenCaptureFramerateCapability
Maximum frame rate supported by the screen sharing device.
ScreenCaptureSourceType
Type of the shared target. Set in ScreenCaptureSourceInfo.
ScreenScenarioType
Screen sharing scenario.
SegModelType
Algorithm for background processing.
SimulcastStreamMode
Mode for sending video streams.
StreamFallbackOptions
Options for audio and video stream fallback under poor network conditions.
StreamPublishState
Publish state.
StreamSubscribeState
Subscribe state.
UserOfflineReasonType
Reason for user going offline.
VideoApplicationScenarioType
Video application scenario type.
VideoBufferType
Video buffer type.
VideoCodecCapabilityLevel
Video codec capability level.
VideoCodecProfileType
Codec profile for video in CDN streaming.
VideoCodecType
Video codec format.
VideoCodecTypeForStream
Codec type for transcoded output video stream.
VideoContentHint
Content type for screen sharing.
VideoDenoiserLevel
Video denoising level.
VideoDenoiserMode
Video denoising mode.
VideoEffectAction
Operation types for video effect nodes.
VideoEffectNodeId
Video effect node types.
VideoFrameProcessMode
Video frame processing mode.
VideoFrameType
Video frame type.
VideoMirrorModeType
Mirror mode type.
VideoModulePosition
Video observation position.
VideoOrientation
Video clockwise rotation information.
VideoPixelFormat
Video pixel format.
VideoSourceType
Type of video source.
VideoStreamType
Video stream type.
VideoTranscoderError
Local video mixing error codes.
VideoViewSetupMode
View setup mode.
VoiceAiTunerType
AI tuner voice effect types.
VoiceBeautifierPreset
Preset voice beautifier options.
VoiceConversionPreset
Preset voice conversion options.
WatermarkFitMode
Watermark fit mode.

Typedefs

OnCallEnded = void Function(CallSession? session)
OnCallStateChanged = void Function(CallState state)
OnErrorCallback = void Function(String errorMessage)
OnUserJoinedCallback = void Function(CallParticipant participant)
OnUserMuteAudioCallback = void Function(int uid, bool isMuted)
OnUserMuteVideoCallback = void Function(int uid, bool isMuted)
OnUserOfflineCallback = void Function(int uid)

Exceptions / Errors

AgoraRtcException
Error code and description.