LivePlayerContext.switchCasting(Object object)

从基础库 2.32.0 版本开始支持,低版本需要做兼容处理。

以 Promise 风格调用:不支持

微信小程序插件:支持

限制:仅在点击行为时调用

相关文档: live-player 组件

功能描述

切换投屏设备。仅支持在 tap 事件回调内调用。

参数

Object object

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

LivePlayerContext.stop(Object object)

以 Promise 风格调用:不支持

微信小程序插件:支持

相关文档: live-player 组件

功能描述

停止

参数

Object object

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

LivePlayerContext.startCasting(Object object)

从基础库 2.32.0 开始支持,低版本需要做兼容处理。

以 Promise 风格调用:不支持

微信小程序插件:支持

限制:仅在点击行为时调用

相关文档: live-player 组件

功能描述

开始投屏,拉起半屏搜索设备。仅支持在 tap 事件回调内调用。

参数

Object object

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

LivePlayerContext.snapshot(Object object)

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

以 Promise 风格调用:不支持

微信小程序插件:支持

相关文档: live-player 组件

功能描述

截图

参数

Object object

属性 类型 默认值 必填 说明 最低版本
quality string raw 否 图片的质量 2.10.0
合法值 说明
raw 原图
compressed 压缩图
sourceType string stream 否 截取的源类型 2.25.0
合法值 说明
stream 截取视频源
view 截取渲染后的画面
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

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

LivePlayerContext.resume(Object object)

从基础库 1.9.90 开始支持,低版本需要做兼容处理。

以 Promise 风格调用:不支持

微信小程序插件:支持

相关文档: live-player 组件

功能描述

恢复

参数

Object object

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

LivePlayerContext.requestFullScreen(Object object)

以 Promise 风格调用:不支持

微信小程序插件:支持

相关文档: live-player 组件

功能描述

进入全屏

参数

Object object

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

LivePlayerContext.reconnectCasting(Object object)

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

以 Promise 风格调用:不支持

微信小程序插件:支持

限制:仅在点击行为时调用

相关文档: live-player 组件

功能描述

重连投屏设备。仅支持在 tap 事件回调内调用。

参数

Object object

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

LivePlayerContext.play(Object object)

以 Promise 风格调用:不支持

微信小程序插件:支持

相关文档: live-player 组件

功能描述

播放

参数

Object object

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

LivePlayerContext.pause(Object object)

从基础库 1.9.90 开始支持,低版本需要做兼容处理。

以 Promise 风格调用:不支持

微信小程序插件:支持

相关文档:live-player 组件

功能描述

暂停

参数

Object object

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