实时音视频

  • 实时音视频 > API 文档 > Windows >API 概览

    API 概览

    最近更新时间:2021-09-26 20:13:29

    QNRTCWin 是七牛云推出的一款适用于 Win7 及以上版本 Windows 平台的实时音视频 C++ SDK,提供了灵活的接口,支持高度定制以及二次开发。

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

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

    老用户也可以继续使用 QNRTCWin 3.x 版本,我们也会持续在此版本上进行问题修复和版本更迭,但是后续的一些新功能有可能并不会在 3.x 版本上提供。

    QNRTC

    QNRTC 提供 SDK 的入口方法,可以通过它进行 SDK 的初始化,各个类型 Track 的创建等操作。其核心方法如下:

    创建 Track

    方法 描述
    CreateMicrophoneAudioTrack 创建麦克风音频轨道
    DestroyMicrophoneAudioTrack 销毁创建的麦克风音频轨道
    CreateCameraVideoTrack 创建摄像头视频轨道
    DestroyCameraVideoTrack 销毁创建的摄像头视频频轨道
    CreateScreenVideoTrack 创建屏幕采集的视频轨道
    DestroyScreenVideoTrack 销毁创建的屏幕采集的视频轨道
    CreateCustomAudioTrack 创建自定义导入音频数据轨道
    DestroyCustomAudioTrack 销毁创建的自定义导入音频数据轨道
    CreateCustomVideoTrack 创建自定义导入视频数据轨道
    DestroyCustomVideoTrack 销毁创建的自定义导入视频数据轨道
    QNRTCClient

    QNRTCClient 提供和房间相关的一些列方法,通过它我们可以实现加入房间,在房间内发布或者订阅相应的音视频轨道等操作。主要的核心方法如下:

    核心方法

    方法 描述
    Join 加入房间
    Leave 离开房间
    Publish 发布本地的音视频轨道
    UnPublish 取消发布本地的音视频轨道
    Subscribe 订阅远端用户发布的音视频轨道
    UnSubscribe 取消订阅远端用户发布的音视频轨道

    转推 CDN

    方法 描述
    StartLiveStreaming 开始单路转推或者合流转推
    StopLiveStreaming 停止单路转推或者合流转推
    SetTranscodingLiveStreamingTracks 更新合流转推的布局配置
    RemoveTranscodingLiveStreamingTracks 移除合流转推的布局配置
    SetLiveStreamingListener 设置转推相关事件的监听器
    QNLocalTrack

    QNLocalTrack 是本地创建的一个音视或者视频轨道,可以通过 QNRTC 来创建各种类型的音视频轨道,例如麦克风采集的音频轨道,摄像头采集的视频轨道,或者屏幕采集的视频轨道等等,我们真正用到的是它所衍生的子类。

    以 QNLocalTrack 为基类,向下衍生的子类如下:

    Hierarchy
    本地音频轨道
    • 本地音频轨道 描述
      QNMicrophoneAudioTrack 以麦克风采集到的音频数据为数据源创建的音频轨道,提供了音量控制,数据回调等接口,通过 CreateMicrophoneAudioTrack 创建。
      QNCustomAudioTrack 以外部导入的 PCM 音频数据为数据源创建的音频轨道,可以通过 PushAudioFrame 方法往房间内推送数据,通过 CreateCustomAudioTrack 创建。
      本地视频轨道 描述
      QNCameraVideoTrack 以摄像头采集到的视频数据为数据源创建的视频轨道,提供了包括摄像头采集镜像,推送图片流等接口。通过 CreateCameraVideoTrack 创建。
      QNScreenVideoTrack 以屏幕采集到的视频数据为数据源创建的视频轨道,通过 CreateScreenVideoTrack 创建。
      QNCustomVideoTrack 以外部导入的 kI420 kYUY2 kRGB24 格式的视频数据为数据源创建的音频轨道,可以通过 PushVideoFrame 方法往房间内推送视频数据,通过 CreateCameraVideoTrack 创建。
    QNRemoteTrack

    QNRemoteTrack 是远端用户创建的音视频轨道,本地用户可以通过房间中的事件回调获取。其衍生的子类如下:

    Hierarchy
    • 远端音视频轨道 描述
      QNRemoteAudioTrack 远端用户发布的音频轨道,当可以通过该类来调节播放的音量大小,并且还提供了回调音频数据等方法。
      QNRemoteVideoTrack 远端用户发布的视频轨道,当可以通过该类来把远端视频画面渲染到视图中,并且还提供了回调视频数据等方法。
    QNClientEventListener

    房间内的事件可以通过该接口类进行监听,通过调用 SetQNClientEventListener,把 QNClientEventListener 作为参数传入。其提供的主要回调方法如下:

    • 方法 描述
      OnConnectionStateChanged 房间状态改变时会触发此回调方法,自己加入房间成功,state 变为 CONNECTED,当离开房间时,state 变为 DISCONNECTED。详情可参看 QNConnectionState
      OnUserJoined 当远端用户加入房间时会触发此事件。
      OnUserPublished 当远端用户发布音视频轨道时会触发此事件。
      OnUserUnpublished 当远端用户取消发布音视频轨道时会触发此事件。
      OnUserLeft 当远端用户离开房间时会触发此事件。
      OnUserReconnecting 当远端用户正在重连时会触发此事件。
      OnUserReconnected 当远端用户重连成功时会触发此事件。
      OnSubscribed 当订阅远端用户的音视频轨道成功之后,会触发此事件。
      OnMessageReceived 当远端用户收到消息时会触发此事件。
    以上内容是否对您有帮助?
  • Qvm free helper
    Close