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
  • 内部字段:
  1. {
  2. x: 0, //(必填项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
  3. y: 0, //(必填项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
  4. w: 300, //(必填项)数字类型;模块的宽度;默认值:300
  5. h: 300 //(必填项)数字类型;模块的高度;默认值:300
  6. }

fixedOn:

  • 类型:字符串
  • 描述:(可选项)模块所属 Frame 的名字,若不传则模块归属于当前 Window

fixed:

  • 类型:布尔
  • 描述:((可选项)模块是否随所属 Window 或 Frame 滚动
  • 默认值:true(不随之滚动)

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status:true // 布尔类型;是否加载完成
  3. }

示例代码

  1. var kiviMakeUp = api.require('kiviMakeUp');
  2. kiviMakeUp.openView({
  3. rect:{
  4. x:0,
  5. y:0,
  6. w:300,
  7. h:300
  8. },
  9. fixedOn:'',
  10. fixed:true
  11. });

可用性

iOS & Android系统

可提供的1.0.0及更高版本

showView

显示(注意该方法与openView对应)

示例代码

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

可用性

iOS & Android系统

可提供的1.0.0及更高版本

hideView

隐藏 (注意该方法与openView对应)

示例代码

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

可用性

iOS & Android系统

可提供的1.0.0及更高版本

closeView

关闭视图

示例代码

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

可用性

iOS & Android系统

可提供的1.0.0及更高版本

switchCamera

切换摄像头

switchCamera({params})

params

resolution:

  • 类型:数字类型
  • 描述:(可选项)切换前后摄像头与分辨率
  • 默认:0
  • 取值范围:

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

示例代码

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

可用性

iOS & Android系统

可提供的1.0.0及更高版本

setRect

重新设置视图位置大小

setRect({params})

params

rect:

  • 类型:JSON 对象
  • 描述:(可选项)模块的位置及尺寸
  • 备注:iOS平台w和h不可设置过小
  • 内部字段:
  1. {
  2. x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
  3. y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
  4. w: 300, //(可选项)数字类型;模块的宽度;默认值:300
  5. h: 300 //(可选项)数字类型;模块的高度;默认值:300
  6. }

示例代码

  1. var kiviMakeUp = api.require('kiviMakeUp');
  2. kiviMakeUp.setRect({
  3. rect : {
  4. x : 0,
  5. y : 20,
  6. w : 400,
  7. h : 700
  8. }
  9. }
  10. );

可用性

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 对象
  • 内部字段:
  1. {
  2. status:true // 布尔类型;是否加载完成
  3. }

示例代码

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

可用性

iOS & Android系统

可提供的1.0.0及更高版本

captureScreen

拍照

captureScreen({params}, callback(ret))

callback(ret)

ret:

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

示例代码

  1. var kiviMakeUp = api.require('kiviMakeUp');
  2. kiviMakeUp.captureScreen({
  3. path:"fs://test/makeup"
  4. },function(ret) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. }
  8. });

可用性

iOS & Android系统

可提供的1.0.0及更高版本

comparedMakeUp

对比妆容

Params

isOpen:

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

示例代码

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

可用性

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”

示例代码

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

可用性

iOS & Android系统

可提供的1.0.0及更高版本

foundation

粉底调整(滤镜)

Params

path:

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

opacity:

  • 类型:字符串
  • 描述:(可选项)妆品强度属性
  • 取值:[0, 1]
  • 默认:’1’

示例代码

  1. var kiviMakeUp = api.require('kiviMakeUp');
  2. kiviMakeUp.foundation({
  3. path:"",
  4. opacity:""
  5. });

可用性

iOS & Android系统

可提供的1.0.0及更高版本

foundationOpacity

粉底强度调整(滤镜),仅仅调整强度,滤镜使用默认的或上一个下载加载的

Params

opacity:

  • 类型:字符串
  • 描述:(可选项)妆品强度属性
  • 取值:[0, 1]
  • 默认:’1’

示例代码

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

可用性

iOS & Android系统

可提供的1.0.0及更高版本

beautifyOpacity

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

Params

opacity:

  • 类型:字符串
  • 描述:(可选项)mmBeautify 范围 0-1,float
  • 取值:[0, 1]
  • 默认:’1.0’

示例代码

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

可用性

iOS & Android系统

可提供的1.0.0及更高版本

onPause

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

示例代码

  1. api.addEventListener({
  2. name: 'pause'
  3. }, function(ret, err){
  4. kiviMakeUp.onPause();
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

onResume

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

示例代码

  1. api.addEventListener({
  2. name: 'resume'
  3. }, function(ret, err){
  4. kiviMakeUp.onResume();
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

switchFilter

打开或关闭滤镜

switchFilter()

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

switchBeautify

打开或关闭美颜

switchBeautify()

示例代码

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

可用性

iOS系统

可提供的1.0.1及更高版本

addListener

添加监听

addListener(callback(ret))

callback(ret)

ret:

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

示例代码

  1. var kiviMakeUp = api.require('kiviMakeUp');
  2. kiviMakeUp.addListener(function(ret) {
  3. alert(JSON.stringify(ret));
  4. });

可用性

iOS系统,Android系统

可提供的1.0.4及更高版本