kiviMakeUp

openView showView hideView closeView switchCamera setRect loadMakeUp captureScreen comparedMakeUp makeUpOpacity foundation foundationOpacity beautifyOpacity onPause onResume switchFilter switchBeautify addListener

概述

该插件封装了kivisense的美妆sdk

openView

以view的形式打开

openView({params})

params

rect：

  • 类型：JSON 对象
  • 描述：（必填项）插件的位置及尺寸
  • 备注：iOS,Android 必须传此参数。iOS平台w和h不可设置过小switchBeautify
  • 内部字段：
{
    x: 0,   //（必填项）数字类型；插件左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
    y: 0,   //（必填项）数字类型；插件左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
    w: 300, //（必填项）数字类型；插件的宽度；默认值：300
    h: 300  //（必填项）数字类型；插件的高度；默认值：300
}

fixedOn：

  • 类型：字符串
  • 描述：（可选项）插件所属 Frame 的名字，若不传则插件归属于当前 Window

fixed：

  • 类型：布尔
  • 描述：（（可选项）插件是否随所属 Window 或 Frame 滚动
  • 默认值：true（不随之滚动）

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status:true // 布尔类型；是否加载完成
}

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.openView({
    rect:{
        x:0,
            y:0,
            w:300,
            h:300
    },
    fixedOn:'',
    fixed:true
});

可用性

iOS & Android系统

可提供的1.0.0及更高版本

showView

显示（注意该方法与openView对应）

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.showView();

可用性

iOS & Android系统

可提供的1.0.0及更高版本

hideView

隐藏 （注意该方法与openView对应）

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.hideView();

可用性

iOS & Android系统

可提供的1.0.0及更高版本

closeView

关闭视图

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.closeView();

可用性

iOS & Android系统

可提供的1.0.0及更高版本

switchCamera

切换摄像头

switchCamera({params})

params

resolution:

  • 类型：数字类型

  • 描述：（可选项）切换前后摄像头与分辨率

  • 默认：0

  • 取值范围：

    • 0：切换前置摄像头，分辨率设置为640x480
    • 1：切换后置摄像头，分辨率设置为640x480
    • 2：切换前置摄像头，分辨率设置为1280x720
    • 3：切换后置摄像后，分辨率设置为1280x720

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.switchCamera({
  resolution:1
});

可用性

iOS & Android系统

可提供的1.0.0及更高版本

setRect

重新设置视图位置大小

setRect({params})

params

rect：

  • 类型：JSON 对象
  • 描述：（可选项）插件的位置及尺寸
  • 备注：iOS平台w和h不可设置过小
  • 内部字段：
{
    x: 0,   //（可选项）数字类型；插件左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
    y: 0,   //（可选项）数字类型；插件左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
    w: 300, //（可选项）数字类型；插件的宽度；默认值：300
    h: 300  //（可选项）数字类型；插件的高度；默认值：300
}

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.setRect({
     rect : {
                        x : 0,
                        y : 20,
                        w : 400,
                        h : 700
                    }
}
);

可用性

iOS & Android系统

可提供的1.0.0及更高版本

loadMakeUp

加载美妆

loadMakeUp()

params

paths:

  • 类型：数组
  • 描述：妆品资源文件的沙盒绝对路径数组(android仅支持fs & 系统本地路径)

position:

  • 类型：字符串
  • 描述: （可选项）3d妆容还是2d妆容，腮红、修容、高光都是3d妆容，其余的都为2D妆容，加载3d妆容时position为"1"，2d的妆容时position为"0"
  • 默认："0"

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status:true // 布尔类型；是否加载完成
}

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.loadMakeUp({
    paths:['widget://res/le.png','widget://res/gg.png'],
    position:'0'
});

可用性

iOS & Android系统

可提供的1.0.0及更高版本

captureScreen

拍照

captureScreen({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   success: true,       //布尔类型；是否成功
   path: '',            //字符串类型；照片保存在本地的绝对路径	
}

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.captureScreen({
    path:"fs://test/makeup"
},function(ret) {
    if (ret) {
        api.alert({
            msg: JSON.stringify(ret)
        })
    }
});

可用性

iOS & Android系统

可提供的1.0.0及更高版本

comparedMakeUp

对比妆容

params

isOpen:

  • 类型：布尔类型
  • 描述：对比妆容，当为true时取消当前加载的所有妆容效果，当为false时，重新显示当前加载的妆容效果
  • 默认：true

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.comparedMakeUp({
    isOpen:true
});

可用性

iOS & Android系统

可提供的1.0.0及更高版本

makeUpOpacity

妆容透明度调整

params

opacity:

  • 类型：字符串
  • 描述：（可选项）妆品强度属性
  • 取值：[0, 255]
  • 默认：'255'

position:

  • 类型：字符串
  • 描述: （可选项）3d妆容还是2d妆容，腮红、修容、高光都是3d妆容，其余的都为2D妆容，加载3d妆容时position为"1"，2d的妆容时position为"0"；iOS不支持2d妆容，2d妆容只能通过改图片的透明度实现
  • 默认："0"

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.makeUpOpacity({
    opacity:"255",
});

可用性

iOS & Android系统

可提供的1.0.0及更高版本

foundation

粉底调整（滤镜）

params

path:

  • 类型：字符串
  • 描述：滤镜资源文件路径（android仅支持fs & 系统本地路径），详见：滤镜设计规范

opacity:

  • 类型：字符串
  • 描述：（可选项）妆品强度属性
  • 取值：[0, 1]
  • 默认：'1'

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.foundation({
    path:"",
    opacity:""
});

可用性

iOS & Android系统

可提供的1.0.0及更高版本

foundationOpacity

粉底强度调整（滤镜），仅仅调整强度，滤镜使用默认的或上一个下载加载的

params

opacity:

  • 类型：字符串
  • 描述：（可选项）妆品强度属性
  • 取值：[0, 1]
  • 默认：'1'

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.foundationOpacity({
    opacity:""
});

可用性

iOS & Android系统

可提供的1.0.0及更高版本

beautifyOpacity

美颜接口（iOS掉用此接口必须先掉用switchBeautify接口打开美颜功能，否者设置不会生效）

params

opacity:

  • 类型：字符串
  • 描述：（可选项）mmBeautify 范围 0-1，float
  • 取值：[0, 1]
  • 默认：'1.0'

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.beautifyOpacity({
    opacity:""
});

可用性

iOS & Android系统

可提供的1.0.0及更高版本

onPause

需要在window中监听pause事件调用 不调用该接口会导致app从后台切回前台时导致UnityPlayer画面卡住（该接口仅支持android）， iOS会自动监听退到后台事件并暂停unity

示例代码

api.addEventListener({
   name: 'pause'
}, function(ret, err){
   kiviMakeUp.onPause();
});

可用性

Android系统

可提供的1.0.0及更高版本

onResume

需要在window中监听resume事件调用 不调用该接口会导致app从后台切回前台时导致UnityPlayer画面卡住（该接口仅支持android），iOS会自动监听进入前台事件并恢复unity

示例代码

api.addEventListener({
   name: 'resume'
}, function(ret, err){
   kiviMakeUp.onResume();
});

可用性

Android系统

可提供的1.0.0及更高版本

switchFilter

打开或关闭滤镜

switchFilter()

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.switchFilter();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

switchBeautify

打开或关闭美颜

switchBeautify()

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.switchBeautify();

可用性

iOS系统

可提供的1.0.1及更高版本

addListener

添加监听

addListener(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    state: 'toast',    //字符串类型；美妆监听，取值范围如下：
                       //toast：启动监听
    text:''            //字符类型；启动回调字段，在SDK启动完成之后，会回调此字段，text的值为KiviToast-initDone。                    
}

示例代码

var kiviMakeUp = api.require('kiviMakeUp');
kiviMakeUp.addListener(function(ret) {
    api.alert({
            msg: JSON.stringify(ret)
        })
});

可用性

iOS系统，Android系统

可提供的1.0.4及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24