API 列表
本页列出 Unity 所有的接口类以及其中包含的 API。
IRtcEngine
RTC SDK 的基础接口类,实现实时音视频的主要功能。
IRtcEngine 提供了 App 调用的主要方法。
在调用其他 API 之前,必须先调用 CreateAgoraRtcEngine 创建 IRtcEngine 对象。
IRtcEngineEx
提供多频道方法的接口类。
继承自 IRtcEngine。
相关参考IRtcEngineEventHandler
接口类 IRtcEngineEventHandler
用于 SDK 向 App 发送事件通知,App 通过继承该接口类的方法获取 SDK 的事件通知。
该接口类的所有方法都有缺省(空)实现, App 可以根据需要只继承关心的事件。
- 在回调方法中,App 不应该做耗时或者调用可能会引起阻塞的 API(如
sendMessage
),否则可能影响 SDK 的运行。 - SDK 不再捕获开发者在 IRtcEngineEventHandler 类回调中自行实现的代码逻辑中的异常。你需要自行处理该异常,否则异常出现时可能引起 App 崩溃。
IMediaPlayer
提供媒体播放器功能的类,支持多实例。
相关参考IAudioEncodedFrameObserver
编码后音频的观测器。
相关参考IAudioDeviceManager
音频设备管理方法。
相关参考IVideoDeviceManager
视频设备管理方法。
相关参考IMediaPlayerAudioFrameObserver
媒体播放器的音频数据观测器。
你可以调用 RegisterAudioFrameObserver [2/2] 注册或取消注册 IMediaPlayerAudioFrameObserver 观测器。
IMediaPlayerCacheManager
该类提供管理媒体播放器中缓存媒体文件的方法。
相关参考IMediaPlayerCustomDataProvider
提供打开自定义媒体资源文件的回调。
相关参考IMediaPlayerSourceObserver
提供媒体播放器的回调。
相关参考IAudioFrameObserver
音频观测器。
你可以调用 RegisterAudioFrameObserver 注册或取消注册 IAudioFrameObserver 音频观测器。
IAudioSpectrumObserver
音频频谱观测器。
相关参考IMetadataObserver
Metadata 观测器。
相关参考IVideoEncodedFrameObserver
用于接收编码后的视频图像的类。
相关参考IVideoFrameObserver
视频观测器。
你可以调用 RegisterVideoFrameObserver 注册或取消注册 IVideoFrameObserver 视频观测器。
相关参考ILocalSpatialAudioEngine
该类通过 SDK 计算用户坐标,实现空间音频。
调用该类下其他 API 前,你需要调用 Initialize 方法初始化该类。
相关参考IMediaRecorder
提供本地及远端音视频录制功能的类。
相关参考IMediaRecorderObserver
包含音视频录制的事件。
相关参考IMusicContentCenter
IMusicContentCenter
接口类提供音乐内容中心的相关方法。该接口类下的方法仅适用于 Android 和 iOS 平台。
IMusicContentCenterEventHandler
IMusicContentCenterEventHandler
接口类,用于 SDK 向客户端发送音乐内容中心事件通知。
IMusicPlayer
继承自 IMediaPlayer
类,提供音乐播放器的相关方法。
VideoSurface
该类包含视频渲染相关的 Unity 原生方法。
相关参考VideoSurfaceYUV
提供视频渲染相关的方法。该类继承自 VideoSurface
,但是在渲染较大分辨率 (如 4K) 的视频图像时,渲染速度更快,帧率更高。自 v4.2.0 起,声网 Unity SDK 不支持同时使用 VideoSurface
和 VideoSurfaceYUV
来渲染不同的视频源,即在成功创建 IRtcEngine
后,如果第一个视图是通过 VideoSurfaceYUV
渲染,则在整个 IRtcEngine
生命周期中,只能通过 VideoSurfaceYUV
渲染。