talk-api.md 2.2 KB

语音通讯 API

JessibucaProTalk(options)

options 支持的参数有:

encType

  • 类型string
  • 默认值g711a
  • 用法

语音编码类型,支持g711ag711u,默认是g711a

packetType

  • 类型string
  • 默认值rtp
  • 用法

语音包类型,支持rtp,默认是rtp

rtpSsrc

  • 类型string

  • 用法

rtp包的ssrc,10位

numberChannels

  • 类型number
  • 默认值1
  • 用法

采样通道

sampleRate

  • 类型number
  • 默认值8000
  • 用法: 采样率

sampleBitsWidth

  • 类型number
  • 默认值16
  • 用法: 采样精度

debug

  • 类型boolean
  • 默认值:false
  • 用法: 是否开启debug模式

debugLevel(pro)

  • 类型string
  • 默认值warn
  • 用法

debug模式下的日志级别,支持debugwarn,默认是warn

error 的信息默认就是会输出出来的。

testMicrophone

  • 类型boolean
  • 默认值:false
  • 用法: 是否开启测试麦克风,不连接ws

engine

  • 类型string
  • 默认值worklet
  • 用法

语音引擎,支持workletscript,默认是worklet

checkGetUserMediaTimeout

  • 类型boolean
  • 默认值:false
  • 用法: 是否开启检测getUserMedia超时

getUserMediaTimeout

  • 类型number
  • 默认值10 * 1000
  • 用法

getUserMedia超时时间,单位ms

方法

startTalk(wsUrl, options)

  • 参数
    • {string} wsUrl
    • {object} options
  • 用法: 开启语音
  • 返回值Promise

options 参数通初始化 new JessibucaProTalk(options) 时的参数一致

stopTalk()

  • 用法: 关闭语音
  • 返回值Promise

getTalkVolume()

  • 用法: 获取语音音量
  • 返回值Promise(number)

返回值是一个0-100的数字,表示当前语音音量

setTalkVolume(volume)

  • 用法: 设置语音音量
  • 返回值Promise
  • 参数
    • {number} volume 0-100的数字,表示当前语音音量