实时音视频

  • 实时音视频 > API 文档 > HarmonyOS >QNRTCClient

    QNRTCClient

    最近更新时间: 2024-11-27 17:44:20

    RTC 核心类,包含加入房间,离开房间,订阅、发布 Track,获取统计信息等功能
    Index
    Core Methods
    Core Methods
    SetAutoSubscribe
    • SetAutoSubscribe(auto: boolean): number
    • 是否自动订阅远端的流,默认为 YES

      当开启此选项后,房间内有任意用户新发布 Track 的时候,会自动订阅此路 Track,订阅成功后,会触发 QNClientEventListener.OnSubscribed 回调

      API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码

      Parameters
      • auto: booleam

        是否自动

      Returns 操作是否成功
    Join
    • Join(token: string): number
    • 加入房间

      接口调用成功后,将会触发 QNClientEventListener.OnConnectionStateChanged 回调

      API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码

      请确保在 QNConnectionStateDisconnected 状态下调用该接口加入房间,否则接口调用无效

      Parameters
      • token: string

        房间 Token

      Returns 操作是否成功
    Leave
    GetConnectionState
    • GetConnectionState(): QNConnectionState
    • 获取当前的房间连接状态

      Returns 当前房间连接状态
    Publish
    Unpublish
    • UnPublish(trackList: QNLocalTrack[]): number
    • 取消发布本地 Track

      API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码

      Parameters
      Returns 操作是否成功
    Subscribe
    Unsubscribe
    • UnSubscribe(trackList: QNRemoteTrack[]): number
    • 取消订阅远端 Track

      API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码

      Parameters
      Returns 操作是否成功
    GetPublishedTracks
    • GetPublishedTracks(): QNLocalTrack[]
    • 获取当前已经发布的 Track 列表

      Returns 已经发布的 Track 列表
    GetRemoteUsersByUserId
    • GetRemoteUsersByUserId(userId: string): QNRemoteUser | null
    • 获取对应 ID 的远端用户

      Returns 远端用户
    GetRemoteUsers
    • GetRemoteUsers(): QNRemoteUser[]
    • 获取所有远端用户

      Returns 所有远端用户
    GetLocalAudioTrackStats
    • GetLocalAudioTrackStats(): HashMap<string, QNLocalAudioTrackStats>
    • 获取已发布的近端音频轨道统计信息

      Returns 已发布的近端音频轨道统计信息
    GetLocalVideoTrackStats
    • GetLocalVideoTrackStats(): HashMap<string, QNLocalVideoTrackStats[]>
    • 获取已发布的近端视频轨道统计信息

      Returns 已发布的近端视频轨道统计信息
    GetRemoteAudioTrackStats
    • GetRemoteAudioTrackStats(): HashMap<string, QNRemoteAudioTrackStats>
    • 获取已订阅的远端音频轨道统计信息

      Returns 已订阅的远端音频轨道统计信息
    GetRemoteVideoTrackStats
    • GetRemoteVideoTrackStats(): HashMap<string, QNRemoteVideoTrackStats>
    • 获取已订阅的远端视频轨道统计信息

      Returns 已订阅的远端视频轨道统计信息
    SetClientEventListener
    • SetClientEventListener(listener: QNClientEventListener): number
    • 设置连接对象的事件监听函数

      API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码

      Parameters
      Returns 操作是否成功
    SetNetworkQualityListener
    • SetNetworkQualityListener(listener: QNNetworkQualityListener): number
    • 设置网络质量改变监听函数

      API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码

      Parameters
      Returns 操作是否成功
    SetLiveStreamingListener
    • SetLiveStreamingListener(listener: QNLiveStreamingListener): number
    • 设置单路转推事件监听函数

      API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码

      Parameters
      Returns 操作是否成功
    StartLiveStreaming
    StopLiveStreaming
    SendMessage
    • SendMessage(usersList: string[], messageId: string, message: string): number
    • 发送自定义消息

      远端用户会收到QNClientEventListener.OnMessageReceived的回调

      API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码

      Parameters
      • usersList: string[]

        指定发送的用户列表,为空的话,发给房间内所有用户

      • messageId: string

        消息 id

      • message: string

        消息内容

      Returns 操作是否成功
    以上内容是否对您有帮助?
  • Qvm free helper
    Close