实时音视频

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

    API 概览

    最近更新时间: 2022-02-23 10:34:59

    QNWXAppRTC 是七牛推出的一款适用于微信小程序平台的音视频通话 SDK,提供了包括音视频通话、静音、发布、订阅等多种功能,基于此 SDK,您可以很方便地在微信小程序上开发出一款基于实时音视频的应用。

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

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

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

    QNRTC

    QNRTC 提供 SDK 的入口方法,可以通过它进行 SDK 的初始化。其核心方法如下:

    初始化

    方法 描述
    createClient 创建 QNRTCClient 对象

    日志设置

    方法 描述
    setLogLevel 设置日志打印等级
    QNRTCClient

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

    核心方法

    方法 描述
    join 加入房间
    leave 离开房间
    publish 发布本地 Track
    subscribe 订阅远端 Track
    sendMessage 发送自定义消息

    转推 CDN

    方法 描述
    startDirectLiveStreaming 开启单路转推
    stopDirectLiveStreaming 停止单路转推
    startTranscodingLiveStreaming 开启合流转推
    stopTranscodingLiveStreaming 停止合流转推
    setTranscodingLiveStreamingTracks 新增、更新合流转推的 Tracks
    removeTranscodingLiveStreamingTracks 删除合流转推的 Tracks
    QNRTCClientEvent

    QNRTCClient 继承于 QNRTCClientEvent,通过监听一系列事件,触发对应回调函数,例如:

    client.on('user-joined', function(remoteUserID, userData) {
        console.log('user-joined', remoteUserID, userData)
    })
    以上内容是否对您有帮助?
  • Qvm free helper
    Close