qq.createLivePusherContext

LivePlayerContext qq.createLivePusherContext()

基础库 1.9.0 开始支持,低版本需做兼容处理

创建live-pusher上下文LivePusherContext对象。

返回值

LivePusherContext

LivePusherContext

LivePusherContext 实例,可通过 qq.createLivePusherContext 获取。

LivePusherContext 与页面内唯一的 live-pusher 组件绑定,操作对应的 live-pusher 组件。

方法
LivePusherContext.start()

开始推流,同时开启摄像头预览

LivePusherContext.stop()

停止推流,同时停止摄像头预览

LivePusherContext.pause()

暂停推流

LivePusherContext.resume()

恢复推流

LivePusherContext.switchCamera()

切换前后摄像头

LivePusherContext.snapshot()

快照

LivePusherContext.toggleTorch()

切换手电筒

LivePusherContext.playBGM(Object object)

播放背景音

LivePusherContext.stopBGM()

停止背景音

LivePusherContext.pauseBGM()

暂停背景音

LivePusherContext.resumeBGM()

恢复背景音

LivePusherContext.setBGMPosition()

设置背景音进度(仅支持 mp3、aac 格式)

LivePusherContext.setMICVolume()

设置麦克风音量

LivePusherContext.setBGMVolume(Object object)

设置背景音音量

LivePusherContext.setAudioReverbType(Object object)

设置混音效果

LivePusherContext.startPreview()

开启摄像头预览

LivePusherContext.stopPreview()

关闭摄像头预览

LivePusherContext.startAudioRecord()

开始录音

LivePusherContext.stopAudioRecord()

结束录音

.start

LivePusherContext.start(Object object)

开始推流,同时开启摄像头预览

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.stop

LivePusherContext.stop(Object object)

停止推流,同时停止摄像头预览

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.pause

暂停推流

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.resume

LivePusherContext.resume(Object object)

恢复推流

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.switchCamera

LivePusherContext.switchCamera(Object object)

切换前后摄像头

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.snapshot

LivePusherContext.snapshot(Object object)

快照

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.toggleTorch

LivePusherContext.toggleTorch(Object object)

切换手电筒

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.playBGM

LivePusherContext.playBGM(Object object)

播放背景音

参数
Object object
属性 类型 默认值 必填 说明
url string 加入背景混音的资源地址
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.stopBGM

LivePusherContext.stopBGM(Object object)

停止背景音

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.pauseBGM

LivePusherContext.pauseBGM(Object object)

暂停背景音

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.resumeBGM

LivePusherContext.resumeBGM(Object object)

恢复背景音

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.setBGMPosition

LivePusherContext.setBGMPosition(Object object)

设置背景音进度

参数
Object object
属性 类型 默认值 必填 说明
position number 背景音进度,单位:秒
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.setMICVolume

LivePusherContext.setMICVolume(Object object)

设置麦克风音量

参数
Object object
属性 类型 默认值 必填 说明
volume string 音量大小,范围是 0-1
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.setBGMVolume

LivePusherContext.setBGMVolume(Object object)

设置背景音音量

参数
Object object
属性 类型 默认值 必填 说明
volume string 音量大小,范围是 0-1
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.setAudioReverbType

LivePusherContext.setAudioReverbType(Object object)

设置混音类型

参数
Object object
属性 类型 默认值 必填 说明
audioReverbType number 混音类型,0 ~ 6 分别对应 "关闭混响", "KTV", "小房间", "大会堂", "低沉", "洪亮", "磁性"
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.startPreview

LivePusherContext.startPreview(Object object)

开启摄像头预览

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.stopPreview

LivePusherContext.stopPreview(Object object)

关闭摄像头预览

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.startAudioRecord

LivePusherContext.startAudioRecord(Object object)

开始录音。当主动调用 LivePusherContext.stopAudioRecord,或者录音超过1分钟时自动结束录音。

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.stopAudioRecord

LivePusherContext.stopAudioRecord(Object object)

结束录音

参数
Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)
object.success 回调函数
参数

######Object res

属性 类型 说明
tempFilePath string 录音文件的临时路径 (本地路径)

qq.createLivePlayerContext

LivePlayerContext qq.createLivePlayerContext(string id, Object this)

基础库 1.5.0 开始支持,低版本需做兼容处理

创建live-player上下文LivePlayerContext对象。

参数

string id

live-player组件的 id

Object this

在自定义组件下,当前组件实例的 this,以操作组件内live-player组件

返回值

LivePlayerContext

LivePlayerContext

LivePlayerContext 实例,可通过qq.createLivePlayerContext获取。

LivePlayerContext通过id跟一个live-player组件绑定,操作对应的 live-player组件。

方法

LivePlayerContext.play()

播放

LivePlayerContext.stop()

停止

LivePlayerContext.mute()

静音

LivePlayerContext.pause()

暂停

LivePlayerContext.resume()

恢复

LivePlayerContext.requestFullScreen(Object object)

进入全屏

LivePlayerContext.exitFullScreen()

退出全屏

LivePlayerContext.snapshot()

截图

.exitfullscreen

LivePlayerContext.exitFullScreen(Object object)

退出全屏

参数

Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.mute

LivePlayerContext.mute(Object object)

静音

参数

Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.pause

LivePlayerContext.pause(Object object)

暂停

参数

Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.play

LivePlayerContext.play(Object object)

播放

参数

Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.requestFullScreen

LivePlayerContext.requestFullScreen(Object object)

进入全屏

参数

Object object
属性 类型 默认值 必填 说明
direction number 0 设置全屏时的方向
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)
object.direction 的合法值
说明
0 正常竖向
90 屏幕逆时针 90 度
-90 屏幕顺时针 90 度

.resume

LivePlayerContext.resume(Object object)

恢复

参数

Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

.snapshot

LivePlayerContext.snapshot(Object object)

截图

参数

Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

参数
Object res
属性 类型 说明
tempImagePath string 图片文件的临时路径
width string 图片的宽度
height string 图片的高度

.stop

LivePlayerContext.stop(Object object)

停止

参数

Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)