agora_rtc_engine library Null safety

Classes

AgoraImage
Agora image properties. A class for setting the properties of the watermark and background images.
AudioRecordingConfiguration
Recording configuration, which is set in RtcEngine.startAudioRecordingWithConfig.
AudioVolumeInfo
Properties of the audio volume information. Contains the user ID and volume information for each speaker.
BeautyOptions
Sets the image enhancement options.
CameraCapturerConfiguration
The configuration of camera capturer.
ChannelMediaInfo
The ChannelMediaInfo class.
ChannelMediaOptions
The channel media options.
ChannelMediaRelayConfiguration
The ChannelMediaRelayConfiguration class.
ClientRoleOptions
The detailed options of a user.
DataStreamConfig
The configurations for the data stream. [...]
EncryptionConfig
Definition of EncryptionConfig.
FacePositionInfo
The information of the detected human face.
LastmileProbeConfig
Lastmile probe configuration.
LastmileProbeOneWayResult
The one-way last-mile probe result.
LastmileProbeResult
Statistics of the lastmile probe.
LiveInjectStreamConfig
Configuration of the imported live broadcast voice or video stream.
LiveTranscoding
A class for managing user-specific CDN live audio/video transcoding settings.
LocalAudioStats
Statistics of the local audio stream.
LocalVideoStats
Statistics of the local video.
LogConfig
Log file configurations.
Rect
Integer coordinates for a rectangle.
Rectangle
The position and size of the watermark image.
RemoteAudioStats
Statistics of the remote audio.
RemoteVideoStats
Statistics of the remote video.
RhythmPlayerConfig
The metronome configuration, which is set in RtcEngine.startRhythmPlayer or RtcEngine.configRhythmPlayer.
RtcEngine
RtcEngine is the main class of the Agora SDK.
RtcEngineConfig
Configurations for the RtcEngineConfig instance.
RtcEngineContext
Configurations for the RtcEngineContext instance.
RtcEngineEventHandler
The SDK uses the RtcEngineEventHandler class to send callbacks to the application, and the application inherits the methods of this class to retrieve these callbacks. [...]
RtcStats
Statistics of RTCEngine.
TranscodingUser
The transcodingUser class, which defines the audio and video properties in the CDN live. Agora supports a maximum of 17 transcoding users in a CDN live streaming channel.
UserInfo
The UserInfo class.
VideoDimensions
The video resolution.
VideoEncoderConfiguration
Definition of VideoEncoderConfiguration.
VirtualBackgroundSource
The custom background image.
WatermarkOptions
Agora watermark options. A class for setting the properties of watermark.

Extensions

RtcEngineExtension
Extension for RtcEngine

Enums

AreaCode
The area of connection.
AudienceLatencyLevelType
The latency level of an audience member in a interactive live streaming. [...]
AudioChannel
The audio channel of the sound.
AudioCodecProfileType
Self-defined audio codec profile.
AudioEffectPreset
The options for SDK preset audio effects.
AudioEqualizationBandFrequency
Audio equalization band frequency.
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.
AudioRecordingPosition
Recording content, which is set in RtcEngine.startAudioRecording.
AudioRecordingQuality
Audio recording quality, which is set in RtcEngine.startAudioRecording.
AudioRemoteState
The state of the remote audio.
AudioRemoteStateReason
The reason of the remote audio state change.
AudioReverbPreset
The preset local voice reverberation option.
AudioReverbType
Audio reverberation type.
AudioSampleRateType
Audio sample rate.
AudioScenario
Audio scenario.
AudioSessionOperationRestriction
Audio session restriction.
AudioVoiceChanger
The preset audio voice configuration used to change the voice effect.
BitRate
Sets the video bitrate (Kbps). Refer to the table below and set your bitrate. Video Bitrate Table [...]
CameraCaptureOutputPreference
The camera capture configuration.
CameraDirection
The camera direction.
CaptureBrightnessLevelType
The brightness level of the video image captured by the local camera.
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.
CloudProxyType
The cloud proxy type.
ConnectionChangedReason
Reasons for the connection state change.
ConnectionStateType
Connection states.
DegradationPreference
The video encoding degradation preference under limited bandwidth.
EncryptionMode
Encryption mode
ErrorCode
Error codes occur when the SDK encounters an error that cannot be recovered automatically without any app intervention.
ExperiencePoorReason
The reason for poor QoE of the local user when receiving a remote audio stream.
ExperienceQualityType
Experience quality types.
InjectStreamStatus
State of importing an external video stream in a live broadcast.
LastmileProbeResultState
The state of the probe test result.
LighteningContrastLevel
The lightening contrast level.
LocalVideoStreamError
The detailed error information of the local video.
LocalVideoStreamState
The state of the local video stream.
LogFilter
Output log filter level.
LogLevel
The output log level of the SDK.
NetworkQuality
Network quality.
NetworkType
Network type.
RtmpStreamingErrorCode
The detailed error information for streaming.
RtmpStreamingEvent
Events during the RTMP or RTMPS streaming.
RtmpStreamingState
The RTMP or RTMPS streaming state.
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.
UserPriority
The priority of the remote user.
VideoCodecProfileType
Self-defined video codec profile.
VideoCodecType
Video codec types.
VideoFrameRate
Video frame rate.
VideoMirrorMode
Video mirror mode.
VideoOutputOrientationMode
Video output orientation mode.
VideoQualityAdaptIndication
Quality change of the local video in terms of target frame rate and target bit rate since last count.
VideoRemoteState
The state of the remote video.
VideoRemoteStateReason
The reason of the remote video state change.
VideoRenderMode
Video display mode.
VideoStreamType
Video stream type.
VirtualBackgroundSourceStateReason
The reason why the virtual background is not successfully enabled or the message that confirms success:
VirtualBackgroundSourceType
The type of the custom background image.
VoiceBeautifierPreset
The options for SDK preset voice beautifier effects.
VoiceConversionPreset
The options for SDK preset voice conversion effects.
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.

Typedefs

ApiCallCallback = void Function(ErrorCode error, String api, String result)
AudioMixingStateCallback = void Function(AudioMixingStateCode state, AudioMixingReason reason)
AudioQualityCallback = void Function(int uid, int quality, int delay, int lost)
AudioRouteCallback = void Function(AudioOutputRouting routing)
AudioVolumeCallback = void Function(List<AudioVolumeInfo> speakers, int totalVolume)
ClientRoleCallback = void Function(ClientRole oldRole, ClientRole newRole)
ConnectionStateCallback = void Function(ConnectionStateType state, ConnectionChangedReason reason)
ElapsedCallback = void Function(int elapsed)
EmptyCallback = void Function()
EnabledCallback = void Function(bool enabled)
ErrorCallback = void Function(ErrorCode err)
FacePositionCallback = void Function(int imageWidth, int imageHeight, List<FacePositionInfo> faces)
FallbackCallback = void Function(bool isFallbackOrRecover)
FallbackWithUidCallback = void Function(int uid, bool isFallbackOrRecover)
LastmileProbeCallback = void Function(LastmileProbeResult result)
LocalAudioStateCallback = void Function(AudioLocalState state, AudioLocalError error)
LocalAudioStatsCallback = void Function(LocalAudioStats stats)
LocalVideoStateCallback = void Function(LocalVideoStreamState localVideoState, LocalVideoStreamError error)
LocalVideoStatsCallback = void Function(LocalVideoStats stats)
MediaRelayEventCallback = void Function(ChannelMediaRelayEvent code)
MediaRelayStateCallback = void Function(ChannelMediaRelayState state, ChannelMediaRelayError code)
MetadataCallback = void Function(String buffer, int uid, int timeStampMs)
NetworkQualityCallback = void Function(NetworkQuality quality)
NetworkQualityWithUidCallback = void Function(int uid, NetworkQuality txQuality, NetworkQuality rxQuality)
NetworkTypeCallback = void Function(NetworkType type)
RectCallback = void Function(Rect rect)
RemoteAudioStateCallback = void Function(int uid, AudioRemoteState state, AudioRemoteStateReason reason, int elapsed)
RemoteAudioStatsCallback = void Function(RemoteAudioStats stats)
RemoteVideoStateCallback = void Function(int uid, VideoRemoteState state, VideoRemoteStateReason reason, int elapsed)
RemoteVideoStatsCallback = void Function(RemoteVideoStats stats)
RtcStatsCallback = void Function(RtcStats stats)
RtmpStreamingEventCallback = void Function(String url, RtmpStreamingEvent eventCode)
RtmpStreamingStateCallback = void Function(String url, RtmpStreamingState state, RtmpStreamingErrorCode errCode)
SoundIdCallback = void Function(int soundId)
StreamInjectedStatusCallback = void Function(String url, int uid, InjectStreamStatus status)
StreamMessageCallback = void Function(int uid, int streamId, String data)
StreamMessageErrorCallback = void Function(int uid, int streamId, ErrorCode error, int missed, int cached)
StreamPublishStateCallback = void Function(String channel, StreamPublishState oldState, StreamPublishState newState, int elapseSinceLastState)
StreamSubscribeStateCallback = void Function(String channel, int uid, StreamSubscribeState oldState, StreamSubscribeState newState, int elapseSinceLastState)
TokenCallback = void Function(String token)
TransportStatsCallback = void Function(int uid, int delay, int lost, int rxKBitRate)
UidCallback = void Function(int uid)
UidWithElapsedAndChannelCallback = void Function(String channel, int uid, int elapsed)
UidWithElapsedCallback = void Function(int uid, int elapsed)
UidWithEnabledCallback = void Function(int uid, bool enabled)
UidWithMutedCallback = void Function(int uid, bool muted)
UploadLogResultCallback = void Function(String requestId, bool success, UploadErrorReason reason)
UrlCallback = void Function(String url)
UrlWithErrorCallback = void Function(String url, ErrorCode error)
UserAccountCallback = void Function(int uid, String userAccount)
UserInfoCallback = void Function(int uid, UserInfo userInfo)
UserOfflineCallback = void Function(int uid, UserOfflineReason reason)
UserSuperResolutionEnabledCallback = void Function(int uid, bool enabled, SuperResolutionStateReason reason)
VideoFrameCallback = void Function(int width, int height, int elapsed)
VideoFrameWithUidCallback = void Function(int uid, int width, int height, int elapsed)
VideoSizeCallback = void Function(int uid, int width, int height, int rotation)
VirtualBackgroundSourceEnabledCallback = void Function(bool enabled, VirtualBackgroundSourceStateReason reason)
WarningCallback = void Function(WarningCode warn)