agora_rtc_engine library Null safety

Classes

AgoraImage
Agora 图像属性。用于设置直播视频的水印和背景图片的属性。
AudioRecordingConfiguration
录音配置，在 RtcEngine.setAudioRecording 中配置。
AudioVolumeInfo
声音音量信息。 一个数组，包含每个说话者的用户 ID 和音量信息。
BeautyOptions
美颜效果选项。
CameraCapturerConfiguration
CameraCapturerConfiguration 的定义。
ChannelMediaInfo
ChannelMediaInfo 类。
ChannelMediaOptions
频道媒体设置选项。
ChannelMediaRelayConfiguration
配置跨频道媒体流转发的 ChannelMediaRelayConfiguration 类。
ClientRoleOptions
用户具体设置。
DataStreamConfig
数据流设置。 [...]
EncryptionConfig
内置加密配置。
FacePositionInfo
检测到的人脸信息。
LastmileProbeConfig
Last-mile 网络探测配置。
LastmileProbeOneWayResult
The one-way last-mile probe result.单向 Last-mile 质量探测结果。
LastmileProbeResult
上下行 Last-mile 质量探测结果。
LiveInjectStreamConfig
外部导入音视频流定义。
LiveTranscoding
管理 CDN 直播推流转码的接口。
LocalAudioStats
本地音频统计数据。
LocalVideoStats
本地视频相关的统计信息。
LogConfig
设置 Agora SDK 输出的日志文件。
Rect
长方形区域。
Rectangle
水印图片的位置和大小。
RemoteAudioStats
远端音频统计信息。
RemoteVideoStats
远端视频相关的统计信息。
RhythmPlayerConfig
节拍器配置。在 RtcEngine.startRhythmPlayer 或 RtcEngine.configRhythmPlayer 中设置。
RtcEngine
RtcEngine 类提供了供 App 调用的主要接口方法。
RtcEngineConfig
RtcEngineConfig 实例的配置。
RtcEngineContext
RtcEngineConfig 实例的配置。
RtcEngineEventHandler
主回调事件。 [...]
RtcStats
通话相关的统计信息。
TranscodingUser
TranscodingUser 类用于管理参与旁路直播的音视频转码合图的用户。最多支持 17 人同时参与转码合图。
UserInfo
标识用户信息的 UserInfo 对象。
VideoDimensions
视频编码像素。
VideoEncoderConfiguration
视频编码属性的定义。
VirtualBackgroundSource
自定义的背景。
WatermarkOptions
待添加的水印图片的设置选项。

Extensions

RtcEngineExtension
RtcEngine 扩展

Enums

AreaCode
访问区域。
AudienceLatencyLevelType
直播频道中观众端（用户角色为观众的客户端）的延时级别。 [...]
AudioChannel
直播音频所在声道。
AudioCodecProfileType
用于旁路直播的输出音频的编码规格。
AudioEffectPreset
预设的音效选项。
AudioEqualizationBandFrequency
语音音效均衡波段的中心频率。
AudioLocalError
本地音频出错原因。
AudioLocalState
本地音频状态。
AudioMixingReason
混音音乐文件错误码。
AudioMixingStateCode
混音音乐文件状态。
AudioOutputRouting
语音路由。
AudioProfile
音频属性。
AudioRecordingPosition
AudioRecordingQuality
录音质量。
AudioRemoteState
远端音频流状态。
AudioRemoteStateReason
远端音频流状态改变的原因。
AudioReverbPreset
预设的本地语音混响效果选项。
AudioReverbType
音频混响类型。
AudioSampleRateType
音频采样率。
AudioScenario
音频应用场景。
AudioSessionOperationRestriction
音频会话控制权限
AudioVoiceChanger
本地语音变声、美音或语聊美声效果选项。
BitRate
视频编码的码率。单位为 Kbps。你可以根据场景需要，参考下面的视频基准码率参考表，手动设置你想要的码率。若设置的视频码率超出合理范围，SDK 会自动按照合理区间处理码率。 [...]
CameraCaptureOutputPreference
设置摄像头采集偏好。
CameraDirection
设置摄像头方向。
CaptureBrightnessLevelType
本地采集的画质亮度级别。
ChannelMediaRelayError
跨频道媒体流转发出错的错误码。
ChannelMediaRelayEvent
跨频道媒体流转发事件码。
ChannelMediaRelayState
跨频道媒体流转发状态。
ChannelProfile
频道场景。
ClientRole
直播场景里的用户角色。
CloudProxyType
云代理类型。
ConnectionChangedReason
网络连接状态发生改变的原因。
ConnectionStateType
网络连接状态。
DegradationPreference
带宽受限时，视频编码降级偏好。
EncryptionMode
加密模式。
ErrorCode
错误代码。SDK 上报的错误意味着 SDK 无法自动恢复，需要 App 干预或提示用户。
ExperiencePoorReason
接收远端音频时，本地用户主观体验质量较差的原因。
ExperienceQualityType
接收远端音频时，本地用户的主观体验质量。
InjectStreamStatus
输入进直播的外部视频源状态。
LastmileProbeResultState
Last-mile 质量探测结果的状态。
LighteningContrastLevel
亮度明暗对比度。
LocalVideoStreamError
本地视频出错原因。
LocalVideoStreamState
本地视频状态。
LogFilter
输出日志过滤分级。
LogLevel
Agora SDK 的日志输出等级。
NetworkQuality
网络质量。
NetworkType
网络类型。
RtmpStreamingErrorCode
详细的推流错误信息。
RtmpStreamingEvent
RTMP 推流事件码。
RtmpStreamingState
RTMP 推流状态。
StreamFallbackOptions
流回退选项。
StreamPublishState
发布状态。
StreamSubscribeState
订阅状态。
UserOfflineReason
用户离线原因。
UserPriority
远端用户的优先级。
VideoCodecProfileType
用于旁路直播的输出视频的编码规格。
VideoCodecType
视频的编码类型。
VideoFrameRate
视频编码的帧率。
VideoMirrorMode
视频镜像模式。
VideoOutputOrientationMode
视频输出方向模式。
VideoQualityAdaptIndication
自上次统计后本地视频质量的自适应情况（基于目标帧率和目标码率）。
VideoRemoteState
远端视频流状态。
VideoRemoteStateReason
远端视频流状态改变的具体原因。
VideoRenderMode
视频显示模式。
VideoStreamType
视频流类型。
VirtualBackgroundSourceStateReason
The reason why the virtual background is not successfully enabled or the message that confirms success:
VirtualBackgroundSourceType
自定义的背景图类型：
VoiceBeautifierPreset
预设的美声效果选项。
VoiceConversionPreset
预设的变声效果选项。
WarningCode
警告回调表示 SDK 运行时出现了（网络或媒体相关的）警告。通常情况下，SDK 上报的警告信息 App 可以忽略， SDK 会自动恢复。比如和服务器失去连接时，SDK 可能会上报 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)
WarningCallback = void Function(WarningCode warn)