实时音视频

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

    QNRTCClient

    最近更新时间:2021-11-22 14:48:47

    RTC 核心类,包含加入房间,离开房间,订阅、发布 Track,获取统计信息等功能
    Hierarchy
    • EventEmitter
      • QNRTCClient
    Index
    Properties
    Event
    Core Methods
    Properties
    userID
    • string | undefined
    • 本地用户的用户 ID

    userData
    • string | undefined
    • 用户自定义数据

    roomName
    • string | undefined
    • 当前房间的名称

    remoteUsers
    Event
    user-joined
    • (remoteUserID: string, userData?: string): void
    • 用户加入房间

      client.on('user-joined', function(remoteUserID, userData){
          console.log('user-joined', remoteUserID, userData)
      })
      Parameters
      • remoteUserID: string

        远端用户 ID

      • Optional userData: string

        用户自定义数据

    user-left
    • (remoteUserID: string): void
    • 用户离开房间

      client.on('user-left', function(remoteUserID){
          console.log('user-left', remoteUserID)
      })
      Parameters
      • remoteUserID: string

        用户 ID

    user-published
    user-unpublished
    connection-state-changed
    message-received
    • (message: QNCustomMessage): void
    • 信息接收

      client.on('message-received',function(message){
          console.log('message-received',message)
      })
      Parameters
    user-reconnecting
    • (remoteUserID: string): void
    • 用户重连中

      client.on('user-reconnecting', function(remoteUserID){
          console.log('user-reconnecting', remoteUserID)
      })
      Parameters
      • remoteUserID: string

        用户 ID

    user-reconnected
    • (remoteUserID: string): void
    • 用户重连成功

      client.on('user-reconnected', function(remoteUserID) {
          console.log('user-reconnected', remoteUserID)
      })
      Parameters
      • remoteUserID: string

        用户信息

    direct-livestreaming-state-changed
    • (streamID: string, state: QNLiveStreamingState ): void
    • CDN 转推状态变化

      client.on('direct-livestreaming-state-changed',function(streamID,state){
          console.log('direct-livestreaming-state-changed',streamID,state)
      })
      Parameters
      • streamID: string

        转推任务 streamID

      • state: QNLiveStreamingState

        转推状态

    transcoding-livestreaming-state-changed
    • (streamID: string, state: QNLiveStreamingState ): void
    • 合流转推状态变化

      client.on('transcoding-livestreaming-state-changed',function(streamID,state){
          console.log('transcoding-livestreaming-state-changed',streamID,state)
      })
      Parameters
      • streamID: string

        合流任务 streamID

      • state: QNLiveStreamingState

        合流状态

    Core Methods
    join
    • join(token: string, userData?: string): Promise<void>
    • 加入房间

      Parameters
      • token: string

        房间 Token

      • Optional userData: string

        用户自定义数据

      Returns Promise<void>
    leave
    • leave(): Promise<void>
    • 离开房间

      Returns Promise<void>
    publish
    unpublish
    subscribe
    unsubscribe
    sendMessage
    • sendMessage(messageID: string, message: string, users?: QNRemoteUser[]): Promise<void>
    • 发送自定义消息

      Parameters
      • messageID: string

        自定义消息 ID

      • message: string

        自定义消息内容

      • Optional users: QNRemoteUser[]

        默认群发,接收消息用户

        传入值若为非数组或空数组,则会采用默认行为进行群发

      Returns Promise<void>
    startDirectLiveStreaming
    stopDirectLiveStreaming
    • stopDirectLiveStreaming(streamID: string): Promise<void>
    • 停止单路转推

      Parameters
      • streamID: string

        转推任务的 streamID

      Returns Promise<void>
    startTranscodingLiveStreaming
    stopTranscodingLiveStreaming
    • stopTranscodingLiveStreaming(streamID: string): Promise<void>
    • 停止合流转推

      Parameters
      • streamID: string

        转推任务的 streamID

      Returns Promise<void>
    setTranscodingLiveStreamingTracks
    • setTranscodingLiveStreamingTracks(streamID: string | null, transcodingTracks: QNTranscodingLiveStreamingTrack[]): Promise<void>
    • 新增、更新合流转推的布局

      Parameters
      • streamID: string | null

        合流任务 streamID

        streamID 为 null 时表示设置默认合流任务

      • transcodingTracks: QNTranscodingLiveStreamingTrack

        待新增、更新的合流转推布局配置

      Returns Promise<void>
    removeTranscodingLiveStreamingTracks
    • removeTranscodingLiveStreamingTracks(streamID: string | null, transcodingTracks: QNTranscodingLiveStreamingTrack[]): Promise<void>
    • 新增、更新合流转推的布局

      Parameters
      • streamID: string | null

        合流任务 streamID

        streamID 为 null 时表示设置默认合流任务

      • transcodingTracks: QNTranscodingLiveStreamingTrack

        需要移除的合流转推布局配置

      Returns Promise<void>
    getNetworkQuality
    getUserNetworkQuality
    • getUserNetworkQuality(userID: string): QNNetworkQuality
    • 获取远端用户的网络质量等级

      Parameters
      • userID: string

        远端用户的 userID

    以上内容是否对您有帮助?
  • Qvm free helper
    Close