LivePusherContext.exitPictureInPicture(Object object)

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

以 Promise 风格 调用:不支持

微信小程序插件:支持

功能描述

退出小窗,该方法可在任意页面调用

参数

Object object

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

LivePusherContext.clearStickers(Object object)

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

以 Promise 风格调用:不支持

微信小程序插件:不支持

功能描述

清除所有贴纸特效

参数

Object object

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

LivePusherContext.clearMakeups(Object object)

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

以 Promise 风格调用:不支持

微信小程序插件:不支持

功能描述

清除所有美妆特效

参数

Object object

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

LivePusherContext.clearFilters(Object object)

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

以 Promise 风格调用:不支持

微信小程序插件:不支持

功能描述

清除所有滤镜效果

参数

Object object

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

LivePusherContext.applySticker(Object object)

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

以 Promise 风格 调用:不支持

微信小程序插件:不支持

功能描述

添加贴纸特效

参数

Object object

属性 类型 默认值 必填 说明
type string 是 贴纸类型
stickers Array.<Object> 是 贴纸类型
结构属性 类型 默认值 必填 说明
title string 是 贴纸名称
path string 是 贴纸资源路径。资源必须为一个资源文件夹路径或一个压缩包路径,文件夹或压缩包内的贴纸资源必须按照 {title}_{index}.{ext} 格式命名。其中 {title} 为贴纸名称;{index} 为帧序号,从0开始;{ext} 为拓展名。
len number 是 贴纸帧数
id string 否 贴纸ID
pos Array.<string> 否 贴纸位置,格式为 [x1,y1,x2,y2] 。当 type 为 '2D' 或 'front' 时必填。仅 2D 贴纸和前景贴纸有效
md5 string 否 贴纸资源 md5
active number -1 否 贴纸触发动作
合法值 说明
-1 循环播放
10 张嘴
11 噘嘴/kiss
12 眨/闭左眼
13 眨/闭右眼
14 眨/闭眼
15 挑眉毛
16 左右摇头
17 上下点头
100 比心
101 张开手掌
102 剪刀手/比耶/胜利
103 握拳
104 数字1
105 我爱你
106 点赞
107 OK
108 Rock&Roll
109 数字6
110 数字8
111 暂不支持(留空)
112 双手抱拳/恭喜发财
segtype number 0 否 背景贴纸展示位置。仅背景贴纸有效
合法值 说明
0 背景贴纸
1 只在人像区域显示的贴纸
templateTransSet Object 否
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)

LivePusherContext.applyLipStickMakeup(Object object)

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

以 Promise 风格调用:不支持

微信小程序插件:不支持

功能描述

添加口红美妆特效

参数

Object object

属性 类型 默认值 必填 说明
alpha number 是 上色程度 0-1
blendMode string 是
path string 是
faceModel string 是
shimmerType string 是
shimmerPath string 是
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)

LivePusherContext.applyFilter(Object object)

需要基础库 2.14.0 或以上版本才支持,低版本请做兼容处理。

以 Promise 风格调用:不支持

微信小程序插件:不支持

功能描述

添加滤镜效果

参数

Object object

属性 类型 默认值 必填 说明
path string 是 滤镜资源的路径
alpha number 是 滤镜效果的透明度,取值范围为 0-1
md5 string 否 滤镜资源的 md5
success function 否 接口调用成功后的回调函数
fail function 否 接口调用失败后的回调函数
complete function 否 接口调用结束后的回调函数(无论调用成功还是失败都会执行)

LivePusherContext.applyFaceContourMakeup(Object object)

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

以 Promise 风格 调用:不支持

微信小程序插件:不支持

功能描述

添加修容美妆特效

参数

Object object

属性 类型 默认值 必填 说明
alpha number 是
path string 是 高光资源路径
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)

LivePusherContext.applyEyeShadowMakeup(Object object)

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

以 Promise 风格调用:不支持

微信小程序插件:不支持

功能描述

添加眼影美妆特效

参数

Object object

属性 类型 默认值 必填 说明
alpha number 是 上色程度,取值范围 0-1
path string 是 眼影资源路径
blendMode string 是
shimmerPosition string 否 细致效果图片资源路径
shimmerPositionMD5 string 否 细致效果图片资源的 md5
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)