agora_rtc_engine library

Classes

AdvancedAudioOptions
音频的高级选项。
AdvancedConfigInfo
Local Access Point 的高级选项。
AdvanceOptions
视频编码的高级选项。
AgoraPipContentViewLayout
画中画视频流的布局配置。
AgoraPipController
管理画中画功能的控制器接口。
AgoraPipOptions
声网画中画模式的配置选项。
AgoraPipStateChangedObserver
画中画状态改变的观测器。
AgoraPipVideoStream
画中画模式的视频流配置。
AgoraRhythmPlayerConfig
虚拟节拍器配置。
AgoraVideoView
AgoraVideoView 类，用于渲染本地和远端视频。
AudioDeviceInfo
AudioDeviceInfo 类，包含音频设备的 ID 和设备名称。
AudioDeviceManager
音频设备管理方法。
AudioEncodedFrameObserver
编码后音频的观测器。
AudioEncodedFrameObserverConfig
编码后音频的观测器设置。
AudioFrame
原始音频数据。
AudioFrameObserver
音频观测器。
AudioFrameObserverBase
音频观测器。
AudioParams
音频数据格式。
AudioPcmFrame
外部 PCM 格式音频帧的信息。
AudioPcmFrameSink
该类用于获取原始的 PCM 音频数据。
AudioRecordingConfiguration
录音配置。
AudioSpectrumData
音频频谱数据。
AudioSpectrumObserver
音频频谱观测器。
AudioTrackConfig
自定义音频轨道的配置选项。
AudioVolumeInfo
用户音量信息。
BeautyOptions
美颜选项。
CacheStatistics
缓存文件的统计数据。
CameraCapturerConfiguration
摄像头采集配置。
ChannelMediaInfo
频道媒体信息。
ChannelMediaOptions
频道媒体设置选项。
ChannelMediaRelayConfiguration
跨频道媒体流转发配置信息。
ClientRoleOptions
用户角色属性设置。
ClimaxSegment
音乐高潮片段设置。
CodecCapInfo
SDK 支持的编解码能力信息。
CodecCapLevels
编解码能力等级。
ColorEnhanceOptions
色彩增强选项。
ContentInspectConfig
本地截图上传配置。
ContentInspectModule
ContentInspectModule 结构体，用于配置本地截图上传的频率。
DataStreamConfig
数据流设置。
DeviceInfo
音频设备信息。
DirectCdnStreamingEventHandler
DirectCdnStreamingEventHandler 接口类用于 SDK 向 App 发送 CDN 推流的事件通知，App 通过继承该接口类的方法获取 SDK 的事件通知。
DirectCdnStreamingMediaOptions
主播端的媒体选项。
DirectCdnStreamingStats
当前 CDN 推流的统计数据。
EchoTestConfiguration
音视频通话回路测试的配置。
EncodedAudioFrameInfo
编码后音频的信息。
EncodedVideoFrameInfo
外部编码视频帧的信息。
EncryptionConfig
配置内置加密模式和密钥。
ExtensionContext
插件上下文信息。
ExternalVideoFrame
外部视频帧。
FaceInfoObserver
人脸信息观测器。
FaceShapeAreaOptions
滤镜效果选项。
FaceShapeBeautyOptions
美型风格选项。
FilterEffectOptions
滤镜效果选项。
FocalLengthInfo
摄像头支持的焦距信息，包含摄像头的方向以及焦距类型。
ImageTrackOptions
垫片图片的设置选项。
LastmileProbeConfig
Last mile 网络探测配置。
LastmileProbeOneWayResult
上行或下行 Last mile 网络质量探测结果。
LastmileProbeResult
上下行 Last mile 网络质量探测结果。
LeaveChannelOptions
离开频道的选项。
LiveStreamAdvancedFeature
转码推流的高级功能配置。
LiveTranscoding
旁路推流的转码属性。
LocalAccessPointConfiguration
Local Access Point 配置。
LocalAudioMixerConfiguration
本地音频合流配置。
LocalAudioStats
本地音频统计数据。
LocalSpatialAudioEngine
该类通过 SDK 计算用户坐标，实现空间音频。
LocalTranscoderConfiguration
本地合图的配置。
LocalVideoStats
本地视频流统计信息。
LogConfig
SDK 日志文件的配置。
LogUploadServerInfo
日志服务器的配置信息。
LowlightEnhanceOptions
暗光增强选项。
MediaEngine
MediaEngine 类。
MediaPlayer
提供媒体播放器功能的类，支持多实例。
MediaPlayerCacheManager
该类提供管理媒体播放器中缓存媒体文件的方法。
MediaPlayerController
AgoraVideoView 的控制器，用于渲染媒体播放器的视频。
MediaPlayerSourceObserver
提供媒体播放器的回调。
MediaPlayerVideoFrameObserver
媒体播放器的视频数据观测器。
MediaRecorder
提供本地及远端音视频录制功能的类。
MediaRecorderConfiguration
音视频流录制配置。
MediaRecorderObserver
包含音视频录制的事件。
MediaSource
需播放的媒体文件的相关信息及播放设置。
Metadata
媒体附属信息。
MetadataObserver
Metadata 观测器。
MultipathStats
用于汇总多路径传输中各网络路径的统计数据。
Music
音乐资源的详细信息。
MusicCacheInfo
缓存的音乐资源的相关信息。
MusicChartCollection
音乐榜单的详细信息。
MusicChartInfo
音乐榜单的详细信息。
MusicCollection
音乐资源列表的详细信息。
MusicContentCenter
MusicContentCenter 接口类提供音乐内容中心的相关方法。
MusicContentCenterConfiguration
音乐内容中心的设置。
MusicContentCenterEventHandler
MusicContentCenterEventHandler 接口类，用于 SDK 向客户端发送音乐内容中心事件通知。
MusicPlayer
继承自 MediaPlayer 类，提供音乐播放器的相关方法。
PathStats
用于获取特定网络路径的统计数据。
PlayerPlaybackStats
当前播放的媒体资源的相关信息。
PlayerStreamInfo
播放器媒体流的所有信息。
PlayerUpdatedInfo
媒体播放器相关信息。
RecorderInfo
录制文件信息。
RecorderStreamInfo
需录制的音视频流的相关信息。
Rectangle
目标区域相对于整个屏幕或窗口的位置，如不填，则表示整个屏幕或窗口。
RemoteAudioStats
远端用户的音频统计数据。
RemoteVideoStats
远端视频流的统计信息。
RemoteVoicePositionInfo
远端用户或媒体播放器的空间位置信息。
RtcConnection
包含连接信息的类。
RtcEngine
RTC SDK 的基础接口类，实现实时音视频的主要功能。
RtcEngineContext
RtcEngineContext 定义。
RtcEngineEventHandler
接口类 RtcEngineEventHandler 用于 SDK 向 App 发送事件通知，App 通过继承该接口类的方法获取 SDK 的事件通知。
RtcEngineEx
提供多频道方法的接口类。
RtcImage
图像属性。
RtcStats
通话相关的统计信息。
ScreenAudioParameters
共享屏幕流的音频配置。
ScreenCaptureConfiguration
屏幕采集配置。
ScreenCaptureParameters
屏幕共享的参数配置。
ScreenCaptureParameters2
屏幕共享的参数配置。
ScreenCaptureSourceInfo
可共享窗口或屏幕的信息。
ScreenVideoParameters
共享屏幕流的视频编码配置。
SDKBuildInfo
SDK 版本信息。
SegmentationProperty
背景图像的处理属性。
SimulcastStreamConfig
视频小流的配置。
SnapshotConfig
视频截图设置。
SpatialAudioParams
空间音频参数。
SpatialAudioZone
隔声区域的设置。
SrcInfo
媒体资源播放时的视频码率相关信息。
ThumbImageBuffer
缩略图或图标的图像内容。在 ScreenCaptureSourceInfo 中设置。
TranscodingUser
参与转码合流的每个主播的设置。
TranscodingVideoStream
参与本地合图的视频流。
UplinkNetworkInfo
上行网络信息。
UserAudioSpectrumInfo
远端用户的音频频谱信息。
UserInfo
用户的信息。
VideoCanvas
视频画布对象的属性。
VideoDenoiserOptions
视频降噪选项。
VideoDeviceInfo
VideoDeviceInfo 类，包含视频设备的 ID 和设备名称。
VideoDeviceManager
视频设备管理方法。
VideoDimensions
视频尺寸。
VideoEffectObject
用于管理和配置视频特效，例如美颜、风格妆容和滤镜。
VideoEncodedFrameObserver
用于接收编码后的视频图像的类。
VideoEncoderConfiguration
视频编码器的配置。
VideoFormat
视频帧格式。
VideoFrame
视频帧的属性设置。
VideoFrameObserver
视频观测器。
VideoLayout
某一路合图子视频流的布局信息。
VideoRenderingTracingInfo
视频帧渲染过程中的指标信息。
VideoSubscriptionOptions
视频订阅设置。
VideoViewController
AgoraVideoView 的控制器，用于渲染本地和远端视频。
VideoViewControllerBase
AgoraVideoView 的控制器，用于渲染本地和远端视频。
VirtualBackgroundSource
自定义的背景。
WatermarkBuffer
用于配置水印图像的格式、尺寸和像素缓冲区。
WatermarkConfig
用于配置水印信息。
WatermarkLiteral
用于配置文字水印。
WatermarkOptions
配置水印图像。
WatermarkRatio
水印在屏幕中的位置和大小。
WatermarkTimestamp
用于配置时间戳水印。

Enums

AgoraPipState
表示画中画模式的当前状态。
AlphaStitchMode
alphaBuffer 和视频帧的相对位置。
AreaCode
访问区域，即 SDK 连接的服务器所在的区域。
AudienceLatencyLevelType
直播频道中观众的延时级别。该枚举仅在用户角色设为 clientRoleAudience 时才生效。
AudioAinsMode
AI 降噪的模式。
AudioCodecProfileType
推流输出音频的编解码规格，默认为 LC-AAC。
AudioCodecType
音频编解码格式。
AudioDualMonoMode
声道模式。
AudioEffectPreset
预设的音效选项。
AudioEncodedFrameObserverPosition
音频编码内容。
AudioEncodingType
音频编码类型。
AudioEqualizationBandFrequency
语音音效均衡波段的中心频率。
AudioFileRecordingType
录音内容。在 startAudioRecording 中设置。
AudioFrameType
音频帧类型。
AudioMixingDualMonoMode
声道模式。
AudioMixingReasonType
音乐文件播放状态改变的原因。在 onAudioMixingStateChanged 回调中报告。
AudioMixingStateType
音乐文件播放状态。
AudioProfileType
音频编码属性。
AudioRecordingQualityType
录音音质。
AudioReverbType
音频混响类型。
AudioRoute
音频路由的类型。
AudioSampleRateType
推流输出音频的采样率。
AudioScenarioType
音频场景。
AudioSessionOperationRestriction
SDK 对 Audio Session 的操作权限。
AudioSourceType
音频源类型。
AudioTrackType
自定义音频采集轨道的类型。
BackgroundBlurDegree
自定义背景图的虚化程度。
BackgroundSourceType
自定义的背景。
CameraDirection
摄像头方向。
CameraFocalLengthType
摄像头的焦距类型。
CameraStabilizationMode
摄像头防抖模式。
CaptureBrightnessLevelType
本地采集的画质亮度级别。
ChannelMediaRelayError
跨频道媒体流转发出错的错误码。
ChannelMediaRelayState
跨频道媒体流转发状态码。
ChannelProfileType
频道场景。
ClientRoleChangeFailedReason
切换用户角色失败的原因。
ClientRoleType
直播场景里的用户角色。
CloudProxyType
云代理类型。
CodecCapMask
编解码类型 bit mask。
CompressionPreference
视频编码的压缩偏好类型。
ConnectionChangedReasonType
网络连接状态发生变化的原因。
ConnectionStateType
网络连接状态。
ContentInspectType
视频内容审核模块的类型。
DegradationPreference
带宽受限时的视频编码降级偏好。
DirectCdnStreamingReason
CDN 推流状态改变的原因。
DirectCdnStreamingState
当前 CDN 推流状态。
EarMonitoringFilterType
耳返 Audio filter 类型。
EncodingPreference
视频编码器偏好。
EncryptionErrorType
内置加密的错误类型。
EncryptionMode
内置加密模式。
ErrorCodeType
错误代码。
ExperiencePoorReason
接收远端音频时，本地用户主观体验质量较差的原因。
ExperienceQualityType
接收远端音频时，本地用户的主观体验质量。
ExternalVideoSourceType
外部视频帧编码类型。
FaceShapeArea
选择需要调整的具体美型区域。
FaceShapeBeautyStyle
美型风格妆特效选项。
FeatureType
进阶功能类型。
FrameRate
视频帧率。
HeadphoneEqualizerPreset
预设的耳机均衡器类型。
InterfaceIdType
接口类。
LastmileProbeResultState
Last mile 质量探测结果的状态。
LighteningContrastLevel
亮度明暗对比度。
LocalAudioStreamReason
本地音频状态改变原因。
LocalAudioStreamState
本地音频状态。
LocalProxyMode
与声网私有媒体服务器的连接模式。
LocalVideoEventType
本地视频事件类型。
LocalVideoStreamReason
本地视频状态改变原因。
LocalVideoStreamState
本地视频状态。
LogFilterType
日志过滤等级。
LogLevel
日志输出等级。
LowLightEnhanceLevel
暗光增强等级。
LowLightEnhanceMode
暗光增强模式。
MaxDeviceIdLengthType
设备 ID 的最大长度。
MaxUserAccountLengthType
用户 User Account 的最大长度。
MediaDeviceStateType
设备状态。
MediaDeviceType
设备类型。
MediaPlayerEvent
播放器事件。
MediaPlayerMetadataType
媒体附属信息数据类型。
MediaPlayerReason
播放器状态改变的原因。
MediaPlayerState
播放器的状态。
MediaRecorderContainerFormat
录制文件的格式。
MediaRecorderStreamType
录制内容。
MediaSourceType
媒体源类型。
MediaStreamType
媒体流的类型。
MediaTraceEvent
媒体帧的渲染状态。
MetadataType
观测器的 Metadata 类型。当前仅支持视频类型的 Metadata 。
MultipathMode
多路径数据传输的模式。
MultipathType
多路径传输使用的网络路径类型。
MusicCacheStatusType
音乐资源的缓存状态。
MusicContentCenterStateReason
音乐内容中心的请求状态码。
MusicPlayMode
音乐资源的播放模式。
NetworkType
网络连接类型。
OrientationMode
视频编码的方向模式。
PermissionType
设备权限类型。
PlayerPreloadEvent
预加载媒体资源时发生的事件。
PreloadState
音乐资源的加载状态。
ProxyType
代理类型。
QualityAdaptIndication
自上次统计后本地视频质量的自适应情况（基于目标帧率和目标码率）。
QualityType
网络质量。
RawAudioFrameOpModeType
音频数据的使用模式。
RecorderReasonCode
录制状态出错的原因。
RecorderState
当前的录制状态。
RecorderStreamType
需录制的视频流类型。
RemoteAudioState
远端音频流状态。
RemoteAudioStateReason
远端音频流状态切换原因。
RemoteVideoState
远端视频流状态。
RemoteVideoStateReason
远端视频流状态切换原因。
RenderModeType
视频显示模式。
RenewTokenErrorCode
调用 renewToken 后的错误码。
RhythmPlayerReason
虚拟节拍器错误信息。
RhythmPlayerStateType
虚拟节拍器状态。
RtmpStreamingEvent
旁路推流时发生的事件。
RtmpStreamLifeCycleType
服务端转码推流的生命周期。
RtmpStreamPublishReason
推流状态改变的原因。
RtmpStreamPublishState
推流状态。
ScreenCaptureFramerateCapability
屏幕共享设备支持的最高帧率。
ScreenCaptureSourceType
共享目标的类型。在 ScreenCaptureSourceInfo 中设置。
ScreenColorType
屏幕颜色类型。
ScreenScenarioType
屏幕共享的场景。
SegModelType
进行背景处理的算法。
SimulcastStreamMode
发送视频流的模式。
StreamFallbackOptions
网络条件较差时，音视频流回退处理的选项。
StreamPublishState
发布状态。
StreamSubscribeState
订阅状态。
UserOfflineReasonType
用户离线原因。
VideoApplicationScenarioType
视频业务场景类型。
VideoBufferType
视频 buffer 类型。
VideoCodecCapabilityLevel
视频编解码能力等级。
VideoCodecProfileType
旁路推流输出视频的编解码规格。
VideoCodecType
视频编码格式。
VideoCodecTypeForStream
转码输出视频流的编解码类型。
VideoContentHint
屏幕共享的内容类型。
VideoDenoiserLevel
视频降噪等级。
VideoDenoiserMode
视频降噪模式。
VideoEffectAction
对视频特效节点执行的操作类型。
VideoEffectNodeId
视频特效节点类型。
VideoFrameProcessMode
视频帧处理模式。
VideoFrameType
视频帧类型。
VideoMirrorModeType
镜像模式类型。
VideoModulePosition
视频观测位置。
VideoOrientation
视频顺时针旋转信息。
VideoPixelFormat
视频像素格式。
VideoSourceType
视频源的类型。
VideoStreamType
视频流类型。
VideoTranscoderError
本地合图错误代码。
VideoViewSetupMode
视图设置模式。
VoiceAiTunerType
AI 调音器音效类型。
VoiceBeautifierPreset
预设的美声效果选项。
VoiceConversionPreset
预设的变声效果选项。
WatermarkFitMode
水印的适配模式。
WatermarkSourceType
水印源类型。

Exceptions / Errors

AgoraRtcException
错误码及错误描述。