文档中心
视频通话 (Legacy)
Console 官网 社区 技术支持
简体中文
search-icon

Agora C++ API Reference for All Platforms

Index IRtcEngine RtcEngineParameters IRtcEngineEventHandler IAudioDeviceManager IVideoDeviceManager 警告码 错误码

Public 成员函数

virtual void release ()=0
 
virtual int registerAudioFrameObserver (IAudioFrameObserver *observer)=0
 
virtual int registerVideoFrameObserver (IVideoFrameObserver *observer)=0
 
virtual int registerVideoRenderFactory (IExternalVideoRenderFactory *factory)=0
 
virtual int pushAudioFrame (MEDIA_SOURCE_TYPE type, IAudioFrameObserver::AudioFrame *frame, bool wrap)=0
 
virtual int pushAudioFrame (IAudioFrameObserver::AudioFrame *frame)=0
 
virtual int pullAudioFrame (IAudioFrameObserver::AudioFrame *frame)=0
 
virtual int setExternalVideoSource (bool enable, bool useTexture)=0
 
virtual int pushVideoFrame (ExternalVideoFrame *frame)=0
 

成员函数说明

◆ release()

virtual void agora::media::IMediaEngine::release ( )
pure virtual

◆ registerAudioFrameObserver()

virtual int agora::media::IMediaEngine::registerAudioFrameObserver ( IAudioFrameObserver *  observer)
pure virtual

注册语音观测器对象

该方法用于注册语音观测器对象，即注册回调。当需要引擎给出 onRecordAudioFrame 或 onPlaybackAudioFrame 回调时，需要使用该方法注册回调。

参数
observer接口对象实例。如果传入 NULL，则取消注册。详见： IAudioFrameObserver 。

◆ registerVideoFrameObserver()

virtual int agora::media::IMediaEngine::registerVideoFrameObserver ( IVideoFrameObserver *  observer)
pure virtual

注册视频观测器对象

你需要在该方法中实现一个 IVideoFrameObserver 类，并根据场景需要，注册该类的如下回调：

  • onCaptureVideoFrame ：获取本地摄像头采集到的视频数据。
  • onRenderVideoFrame ：获取远端发送的视频数据。
  • getVideoFormatPreference：设置想要获取的视频数据格式。如果你想获取 YUV420 以外格式的视频数据， 需要注册该回调。
  • getRotationApplied ：设置获取的视频数据是否根据 VideoFrame 中的旋转信息 rotation 进行旋转（仅适用于 RGBA 格式的视频帧）。
  • getMirrorApplied ：设置获取的视频数据是否为原始视频的镜像（仅适用于 RGBA 格式的视频帧）

成功注册视频观测器后，SDK 会在捕捉到每个视频帧时，触发你所注册的上述回调。

参数
observer接口对象实例。如果传入 NULL，则取消注册。详见： IVideoFrameObserver 。

◆ registerVideoRenderFactory()

virtual int agora::media::IMediaEngine::registerVideoRenderFactory ( IExternalVideoRenderFactory *  factory)
pure virtual

DEPRECATED

◆ pushAudioFrame() [1/2]

virtual int agora::media::IMediaEngine::pushAudioFrame ( MEDIA_SOURCE_TYPE  type,
IAudioFrameObserver::AudioFrame *  frame,
bool  wrap 
)
pure virtual

DEPRECATED 已被 pushAudioFrame2 代替。

推送外部音频帧

参数
type音频采集设备类型。详见： MEDIA_SOURCE_TYPE 。
frame音频帧指针。详见： AudioFrame 。
wrap设置是否占位使用。声网建议用户使用默认值即可。
  • true: 占位使用；
  • false:（默认）不占位使用。
返回
  • 0：方法调用成功
  • < 0：方法调用失败

◆ pushAudioFrame() [2/2]

virtual int agora::media::IMediaEngine::pushAudioFrame ( IAudioFrameObserver::AudioFrame *  frame)
pure virtual

推送外部音频帧

参数
frame音频帧指针。详见： AudioFrame 。
返回
  • 0：方法调用成功
  • < 0：方法调用失败

◆ pullAudioFrame()

virtual int agora::media::IMediaEngine::pullAudioFrame ( IAudioFrameObserver::AudioFrame *  frame)
pure virtual

拉取远端音频数据。

使用该方法前，你需要调用 setExternalAudioSink(enabled: true) 方法通知 App 开启并设置外部渲染。

调用该方法后，App 会采取主动拉取的方式获取远端已解码和混音后的音频数据，用于音频播放。

注解
  • 使用该方法后，App 会无法从 onPlaybackAudioFrame 回调中获得数据。
  • 该方法和 onPlaybackAudioFrame 回调相比，区别在于：
    • onPlaybackAudioFrame：SDK 每 10 毫秒通过该回调将音频数据传输给 App。 如果 App 处理延时，可能会导致音频播放抖动。
    • pullAudioFrame：App 主动拉取音频数据。通过设置音频数据， SDK 可以调整缓存，帮助 App 处理延时，从而有效避免音频播放抖动。
参数
frame指向 AudioFrame 的指针。
返回
  • 0：方法调用成功。
  • < 0：方法调用失败。

◆ setExternalVideoSource()

virtual int agora::media::IMediaEngine::setExternalVideoSource ( bool  enable,
bool  useTexture 
)
pure virtual

配置外部视频源

参数
enable是否使用外部视频源：
  • true：使用外部视频源
  • false：不使用外部视频源（默认）
useTexture是否使用 Texture 作为输入：
  • true：使用 texture 作为输入
  • false：不使用 texture 作为输入（默认）
返回
  • 0：方法调用成功
  • < 0：方法调用失败

◆ pushVideoFrame()

virtual int agora::media::IMediaEngine::pushVideoFrame ( ExternalVideoFrame *  frame)
pure virtual

使用 ExternalVideoFrame 将视频帧数据传递给 Agora SDK

注解
通信模式下，不支持 Texture 格式的视频帧，只支持非 Texture 格式的视频帧。
参数
frame待传输的视频帧。详见 ExternalVideoFrame。
返回
  • 0：方法调用成功
  • < 0：方法调用失败