API 概览

QNDroidRTC 是七牛推出的一款适用于 Android 平台的音视频通话 SDK，提供了包括美颜、滤镜、音视频通话等多种功能，提供灵活的接口，支持高度定制以及二次开发，您可以很方便地在 Android 平台上开发出一款基于实时音视频的应用。

本文档适用于 QNDroidRTC 4.x 版本的 SDK，并不向下兼容。

QNDroidRTC 4.x 是在 3.x 的基础上进行了 API 的重构和优化，从而使使用者能够更加高效的接入，所以新接入的用户推荐使用最新版本的 SDK。

老用户也可以继续使用 QNDroidRTC 3.x 版本，我们也会持续在此版本上进行问题修复和版本更迭，但是后续的一些新功能有可能并不会在 3.x 版本上提供。若您决定继续使用 3.x 版本 SDK，则可参考 3.x 及之前版本的相关文档

使用 3.x 或者更低版本的用户若想升级至 v4.x 版本，可参考 4.x 版本迁移指南 进行升级

初始化与反初始化

方法	描述
init	初始化 SDK
deinit	反初始化 SDK

创建 Track

方法	描述
createMicrophoneAudioTrack	创建麦克风音频轨道
createCameraVideoTrack	创建摄像头视频轨道
createScreenVideoTrack	创建屏幕采集的视频轨道
createCustomAudioTrack	创建自定义导入音频数据轨道
createCustomVideoTrack	创建自定义导入视频数据轨道

音频播放路由

方法	描述
setAudioRouteToSpeakerphone	设置默认音频播放路由为扬声器

核心方法

方法	描述
join	加入房间
leave	离开房间
publish	发布本地的音视频轨道
unpublish	取消发布本地的音视频轨道
subscribe	订阅远端用户发布的音视频轨道
unsubscribe	取消订阅远端用户发布的音视频轨道

CDN 转推

方法	描述
startLiveStreaming	开始单路转推或者合流转推
stopLiveStreaming	停止单路转推或者合流转推
setTranscodingLiveStreamingTracks	更新合流转推的布局配置
removeTranscodingLiveStreamingTracks	移除合流转推的布局配置
setLiveStreamingListener	设置转推相关事件的监听器

跨房媒体转发

方法	描述
startMediaRelay	开启跨房媒体转发
updateMediaRelay	更新跨房媒体转发状态
stopMediaRelay	停止跨房媒体转发

Hierarchy

• QNLocalTrack
  • QNLocalVideoTrack
    • QNCameraVideoTrack
    • QNScreenVideoTrack
    • QNCustomVideoTrack
  • QNLocalAudioTrack
    • QNMicrophoneAudioTrack
    • QNCustomAudioTrack

• 本地音频轨道	描述
  QNMicrophoneAudioTrack	以麦克风采集到的音频数据为数据源创建的音频轨道，提供了音量控制，播放，数据回调等接口，通过 QNRTC.createMicrophoneAudioTrack 创建。
  QNCustomAudioTrack	以外部导入的 PCM 音频数据为数据源创建的音频轨道，可以通过 pushAudioFrame 方法向房间内推送数据，通过 QNRTC.createCustomAudioTrack 创建。

  本地视频轨道	描述
  QNCameraVideoTrack	以摄像头采集到的视频数据为数据源创建的视频轨道，提供了包括摄像头采集，渲染播放，前后摄像头切换，开启闪光灯，设置曝光度等一系列操作摄像头的方法。通过 QNRTC.createCameraVideoTrack 创建。
  QNScreenVideoTrack	以屏幕采集到的视频数据为数据源创建的视频轨道，提供屏幕录制的权限申请等一些列方法，通过 QNRTC.createScreenVideoTrack 创建。
  QNCustomVideoTrack	以外部导入的 NV21 格式的视频数据或者纹理数据为数据源创建的音频轨道，可以通过 pushVideoFrame 方法往房间内推送视频数据，通过 QNRTC.createCustomVideoTrack 创建。

Hierarchy

• QNRemoteTrack
  • QNRemoteVideoTrack
  • QNRemoteAudioTrack

• 远端音视频轨道	描述
  QNRemoteAudioTrack	远端用户发布的音频轨道，可以通过该类来调节、获取播放音量的大小，同时还提供了音频数据回调等。
  QNRemoteVideoTrack	远端用户发布的视频轨道，可以通过该类来把远端视频画面渲染到视图中，同时还提供了视频数据回调等。

• 方法	描述
  onConnectionStateChanged	房间状态改变时会触发此回调方法，自己加入房间成功，state 变为 CONNECTED，当离开房间时，state 变为 DISCONNECTED。详情可参看 QNConnectionState
  onUserJoined	当远端用户加入房间时会触发此事件。
  onUserPublished	当远端用户发布音视频轨道时会触发此事件。
  onUserUnpublished	当远端用户取消发布音视频轨道时会触发此事件。
  onUserLeft	当远端用户离开房间时会触发此事件。
  onUserReconnecting	当远端用户正在重连时会触发此事件。
  onUserReconnected	当远端用户重连成功时会触发此事件。
  onSubscribed	当订阅远端用户的音视频轨道成功之后，会触发此事件。
  onMessageReceived	当远端用户收到消息时会触发此事件。
  onMediaRelayStateChanged	当媒体转发状态变更时会触发此事件。
  onUserVolumeIndication	周期性的进行用户音量提示回调。

• 方法	描述
  QNRTCEventListener	核心回调接口，定义了设备相关的回调事件，如音频路由改变等。
  QNClientEventListener	核心回调接口，定义了房间相关的回调事件，包括房间连接状态、用户加入离开状态等。
  QNCameraEventListener	摄像头状态回调接口，监听摄像头成功采集、错误等事件。
  QNTrackInfoChangedListener	音视频 Track 信息变化监听接口，监听大小流切换、Track 静默状态改变等事件。
  QNVideoFrameListener	视频数据帧回调接口。
  QNAudioFrameListener	音频数据帧回调接口。
  QNNetworkQualityListener	本地网络状态监听接口，定义了网络质量改变的回调事件。
  QNLiveStreamingListener	CDN 转推相关回调接口，监听任务转推成功、合流布局更新等事件。
  QNAudioMixerListener	混音相关回调接口，监听混音状态、进度等事件。
  QNAudioEffectMixerListener	音效混音相关回调接口，监听音效混音的状态等事件。
  QNAudioSourceMixerListener	音源(pcm)混音相关回调接口，监听音源(pcm)混音的错误等事件。