实时音视频

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

    QNRTC

    最近更新时间: 2022-02-22 15:14:21

    QNRTC 是 SDK 的入口,提供了 SDK 配置,创建本地音视频轨道,创建房间对象等一系列方法。
    Index
    Properties
    Callbacks
    Core Methods
    Properties
    VERSION
    • VERSION: string
    • 获取 SDK 版本号

    Callbacks
    onCameraChanged
    • onCameraChanged: undefined | (info: QNDeviceInfo) => void
    • 摄像头变化回调,提示有摄像头被添加或移除

      QNRTC.onCameraChanged = function(info) {
          console.log('camera changed!', info);
      };
      Parameters
    onMicrophoneChanged
    • onMicrophoneChanged: undefined | (info: QNDeviceInfo) => void
    • 麦克风变化回调,提示有麦克风被添加或移除

      QNRTC.onMicrophoneChanged = function(info) {
          console.log('microphone changed!', info);
      };
      Parameters
    onPlaybackDeviceChanged
    • onPlaybackDeviceChanged: undefined | (info: QNDeviceInfo) => void
    • 播放设备变化回调,提示有音频播放设备被添加或移除

      QNRTC.onPlaybackDeviceChanged = function(info) {
          console.log('speaker changed!', info);
      };
      Parameters
    Core Methods
    isBrowserSupported
    • isBrowserSupported(): boolean
    • 当前浏览器是否支持 QNRTC SDK

      Returns boolean
    checkSystemRequirements
    setLogLevel
    • setLogLevel(level: QNLogLevel): void
    • 设置日志打印等级。

      Parameters
      Returns void
    isChromeExtensionAvailable
    • isChromeExtensionAvailable(): Promise<boolean>
    • 检查 Chrome 浏览器插件是否已安装。

      Returns Promise<boolean>
    createClient
    getCameras
    • getCameras(skipPermissionCheck = false): Promise<MediaDeviceInfo[]>
    • 枚举可用的视频输入设备,比如摄像头

      Parameters
      • Optional skipPermissionCheck: boolean

        将该参数设置成 true 跳过权限检查,但是 SDK 将无法保证获取准确的媒体设备信息。

        🔹 true: 跳过权限检查

        🔹 false:(默认)不跳过权限检查。

      Returns Promise<MediaDeviceInfo[]>
    getMicrophones
    • getMicrophones(skipPermissionCheck = false): Promise<MediaDeviceInfo[]>
    • 枚举可用的音频输入设备,比如麦克风

      Parameters
      • Optional skipPermissionCheck: boolean

        将该参数设置成 true 跳过权限检查,但是 SDK 将无法保证获取准确的媒体设备信息。

        🔹 true: 跳过权限检查

        🔹 false:(默认)不跳过权限检查。

      Returns Promise<MediaDeviceInfo[]>
    getPlaybackDevices
    • getPlaybackDevices(skipPermissionCheck = false): Promise<MediaDeviceInfo[]>
    • 枚举可用的音频播放设备,比如扬声器

      Parameters
      • Optional skipPermissionCheck: boolean

        将该参数设置成 true 跳过权限检查,但是 SDK 将无法保证获取准确的媒体设备信息。

        🔹 true: 跳过权限检查

        🔹 false:(默认)不跳过权限检查。

      Returns Promise<MediaDeviceInfo[]>
    getDevices
    • getDevices(skipPermissionCheck?: boolean): Promise<MediaDeviceInfo[]>
    • 枚举可用的媒体输入和输出设备,比如麦克风、摄像头、耳机等

      Parameters
      • Optional skipPermissionCheck: boolean

        将该参数设置成 true 跳过权限检查,但是 SDK 将无法保证获取准确的媒体设备信息。

        🔹 true: 跳过权限检查

        🔹 false:(默认)不跳过权限检查。

      Returns Promise<MediaDeviceInfo[]>
    createCameraVideoTrack
    createMicrophoneAudioTrack
    createScreenVideoTrack
    createMicrophoneAndCameraTracks
    createBufferSourceAudioTrack
    createCanvasVideoTrack
    createCustomAudioTrack
    createCustomVideoTrack
    checkAudioTrackIsActive
    • checkAudioTrackIsActive(track: QNLocalAudioTrack | QNRemoteAudioTrack, timeout?: number): Promise<boolean>
    • 检测音频轨道是否活跃

      在一定时间内检测音频轨道声音是否有变化或者是否低于正常值。

      可以在开始通话前对音频输入设备进行可用性检测。

      当音频轨被 muted 的时候返回 false

      如果传入的音频轨道在处于极度安静的情况下,该接口可能会误报。

      Parameters
      • 需要检测的本地或远端音频 Track

      • Optional timeout: number

        sdk 最低检测事件为200 ms,若传入值小于200,则 sdk 会自动调整为 200ms。

      Returns Promise<boolean>
    checkVideoTrackIsActive
    • checkVideoTrackIsActive(track: QNLocalVideoTrack | QNRemoteVideoTrack, timeout?: number): Promise<boolean>
    • 检测视频轨道是否活跃

      在一定时间内检测视频轨道画面是否有变化。

      可以在开始通话前对视频输入设备进行可用性检测。

      当视频轨被 muted 的时候返回 false。

      Parameters
      • 需要检测的本地或远端视频 Track

      • Optional timeout: number

        sdk 最低检测事件为60 ms,若传入值小于60,则 sdk 会自动调整为 60ms。

      Returns Promise<boolean>
    setTransportPolicy
    getElectronScreenSources
    以上内容是否对您有帮助?
  • Qvm free helper
    Close