二维码

优质

小牛编辑

202浏览

2023-12-01

BK.QRCode 二维码模块

二维码模块，可以将指定的字符串生成一张二维码图片，保存在指定位置。

makeQRCodeToFile(object)

生成二维码到指定位置的文件，异步接口

函数参数object：

属性名	类型	是否必填	说明
path	string	是	要保存的位置，以GameSandBox://开头
content	string	是	二维码内容
config	Object	否	二维码生成参数具体如下
success	Function	否	接口调用成功回调
fail	Function	否	接口调用失败回调
complete	Function	否	接口调用完成回调

config参数：

属性名	类型	是否必填	说明
width	number	否	图片宽度，单位像素，默认256
height	number	否	图片高度，单位像素，默认256
colorDark	Object	否	暗色颜色，默认黑色{r:0.0,g:0.0,b:0.0,a:0.0},
colorLight	Object	否	亮色颜色，默认白色{r:1.0,g:1.0,b:1.0,a:1.0}
correctLevel	number	否	纠错等级，默认为2 取值如下

correctLevel取值:

L=1,    //最大 7% 的错误能够被纠正 ;
M=0,    //最大 15% 的错误能够被纠正 ;
Q=3,    //最大 25% 的错误能够被纠正 ;
H=2     //最大30% 的错误能够被纠正 ;

object.success回调参数：

参数名	类型
res	Object

res成员

参数名	类型	说明
path	string	二维码保存的路径

object.fail回调参数：

参数名	类型
err	Object

参数名	类型	说明
msg	string	错误原因

示例：

    //异步接口    
    BK.QRCode.makeQRCodeToFile({
        path:'GameSandBox://qrcode.png',
        content:s,
        config:{
            width:128,
            height:128,
            colorDark:{r:0.0,g:0.0,b:0.0,a:1.0},
            colorLight:{r:1.0,g:1.0,b:1.0,a:1.0},
            correctLevel:BK.QRErrorCorrectLevel.H
        },
        success:function(succObj){
            BK.Script.log(0,0,"二维码生成成功 path:"+succObj.path);
        },
        fail:function(err){
            BK.Script.log(0, 0, "失败了，失败原因："+err.msg);
        },
        complete:function(){
            BK.Script.log(0, 0, '完成');
        }
    });

makeQRCodeToFileSync

生成二维码到指定位置的文件，同步接口

函数参数object：

属性名	类型	是否必填	说明
path	string	是	要保存的位置，以GameSandBox://开头
content	string	是	二维码内容
config	Object	否	二维码生成参数

config参数：

属性名	类型	是否必填	说明
width	number	否	图片宽度，单位像素，默认256
height	number	否	图片高度，单位像素，默认256
colorDark	Object	否	暗色颜色，默认黑色{r:0.0,g:0.0,b:0.0,a:0.0},
colorLight	Object	否	亮色颜色，默认白色{r:1.0,g:1.0,b:1.0,a:1.0}
correctLevel	number	否	纠错等级，默认为2 。具体取值如下

BK.QRErrorCorrectLevel取值:

    L=1,    //最大 7% 的错误能够被纠正 ;
    M=0,    //最大 15% 的错误能够被纠正 ;
    Q=3,    //最大 25% 的错误能够被纠正 ;
    H=2     //最大30% 的错误能够被纠正 ;

示例：

//同步接口
BK.QRCode.makeQRCodeToFileSync({path:'GameSandBox://qrcode2.png',content:'hello world',config:{width:256,height:256}});