牛牛截图控件浏览器版调用说明
本说明文档旨在对截图控件的浏览器控件进行说明,指导调用者顺利的将截图控件集成进第三方网页中,使第三方网页也能拥有完美的牛牛截图功能。
牛牛截图网页演示页面请访问:iu/testcapture.htm
写在前面的话:牛牛截图控件目前支持的功能比较丰富,接口比较丰富,但能保证基本功能的接口并不复杂,在查看文档时,请自行根据自己的需求查看相应的接口;添加水印、获取剪贴板中的图片属于高级功能,如果不需要,这部分可以忽略。
提醒:牛牛截图的核心的调用代码已经全部封装在了niuniucapture.js中,一般情况下,你不需要修改只文件内容,只需要引用,并且自己另外写JS来与UI集成即可,具体见示例(capturewrapper.js)。
牛牛截图控件浏览器版能在目前所有的主流浏览器上正常工作,以下的接口说明适用于所有浏览器,并且提供相应的Javascript调用示例。控件主要有三个接口:InitCapture,InitPara
m以及Capture,这些接口均是暴露给浏览器的Javascript调用,具体可以参考调用WebNiuniuCapturedemo_source.zip,接口的具体描述如下:
1. 接口初始化接口
intInitCapture(constchar* szAuth);
此接口函数用于初始化截图控件的授权信息,默认的授权码为:"niuniu"。
参数说明:
参数名 | 参数类型 | 参数说明 | 备注 |
szAuth | 字符串 | 接口调用的授权码 | 默认的授权码为:"niuniu" |
2. 参数初始化接口
intInitParam(int flag, unsignedlong flagvalue);
此接口函数用于初始化截图各个状态下的界面的显示效果,如果不调用,则以默认值处理。
参数说明:
参数名 | 参数类型 | 参数说明 | 备注 |
flag | int | 要设置的参数项 | 此处对应的枚举ExtendFlagTypeEnum的整形值 |
flagvalue | unsignedlong | 设置的参数值 | 根据不同的枚举来设置不同的值 |
枚举定义如下:
typedefenum ExtendFlagTypeEnum
{
emPensize = 1, //
emDrawType, //
emTrackColor, //
emEditBorderColor, //
emTransparent,//
emWindowAware,
emDetectSubWindowRect,
emSetSaveName,
emSetMagnifierBkColor, //设置放大镜的背景,不设置则透明
emSetMagnifierLogoText, //设置放大镜上的LOGO字符,可提示快捷键,如:牛牛截图(CTRL + SHIFT + A)
emSetPreCaptureWindowTitle, //设置网页上截图时弹出窗口的标题
emSetPreCaptureWindowTransparent=18,//设置预截图窗口的透明度
emSetWatermarkPictureType=20, //设置水印的类型
emSetWatermarkPicturePath, //设置水印的路径
emSetWatermarkTextType, //设置水印文字的类型
emSetWatermarkTextValue, //设置水印文字
emSetMosaicType,//设置马赛克的样式
emSetTooltipText, //设置工具栏图标的TOOLTIP及完成按钮的文字
};
枚举项的说明如下:
枚举参数名 | 枚举对应数值 | 参数值说明 | 备注 |
emPensize | 1 | 设置画笔大小 | 如不设置,默认为2 |
emDrawType | 2 | 设置是腾讯风格还是360风格 | 0表示腾讯风格,1表示360风格 |
emTrackColor | 3 | Track及自动识别的边框的颜 | 如:RGB(255, 0, 0) |
emEditBorderColor | 4 | 文本输入框的边框颜 | 如:RGB(0, 174, 255) |
emTransparent | 5 | 工具栏的透明度 | 默认为220 |
emWindowAware | 6 | 设置是否禁用随着DPI放大,flagvalue传递任意值均可 | 浏览器中建议不要调用 |
emDetectSubWindowRect | 7 | 是否自动检测子窗口,暂时无用 | 未使用 |
emSetSaveName | 8 | 设置保存时的文件名称 | 如: const char* szName = "测试名"; InitParam(emSetSaveName, (unsigned long) szName); 注:免费版本此接口无效,将会显示默认值 |
emSetMagnifierBkColor | 9 | 用于设置放大镜的背景 | 一般不建议设置,默认透明即可 |
emSetMagnifierLogoText | 10 | 设置放大镜上的显示的LOGO文字 | 如: const char* szName = "测试名"; InitParam(emSetMagnifierLogoText, (unsigned long) szName); 注:免费版本此接口无效,将会显示默认值 |
emSetPreCaptureWindowTitle | 11 | 设置网页上截图时弹出窗口的标题 | 如: const char* szName = "测试名"; InitParam(emSetPreCaptureWindowTitle, (unsigned long) szName); 注:免费版本此接口无效,将会显示默认值 |
emSetPreCaptureWindowTransparent | 18 | 设置预截图窗口的透明度 | InitParam(emSetPreCaptureWindowTransparent, 220); |
以下是水印设置功能,如果不需要则无需关注 | |||
emSetWatermarkPictureType | 20 | 用于设置水印图片的绘制方式 | 此参数设置具有默认值,仅在授权版本中才可修改设置,具体见下面的水印图片说明 |
emSetWatermarkPicturePath | 21 | 用于设置水印图片的BASE64的图片数据 | 注:仅支持PNG格式的图片的Base64的字符串 |
emSetWatermarkTextType | 22 | 用于设置水印文字绘制方式 | 此参数设置具有默认值,仅在授权版本中才可修改设置,具体见下面的水印文字设置说明 |
emSetWatermarkTextValue | 23 | 用于设置水印文字 | 注:此处传递的水印文字需要是经过BASE64编码的,调用接口: InitParamByBase64 |
emSetMosaicType | 24 | 指定马赛克的样式 | 1为矩形,2为随鼠标画线的方式 |
emSetTooltipText | 25 | 设置工具栏图标的TOOLTIP及完成按钮的文字 | 此参数设置具有默认值,仅在授权版本中才可修改设置,具体见下面的工具栏按钮文字设置说明 |
a). 水印图片设置参数说明:
此处的参数值是一个字符串,以|为分割符,如:
//nShowType|nMinWidth|nMinHeight|nMaxWidth|nMaxHeight|nShowOffset
未授权时,此参数对应的设置将采用默认值,不可修改;默认支持的图片大小为200*200,超过此大小的地方,将仅显示是在200*200范围内的图片。
各字段意义如下:
参数名 | 参数值说明 | 备注 |
nShowType | 设置绘制类型 | 1表示在中间显示水印; 2表示在右下显示水印; 3表示复合类型[默认在中间添加水印,当满足宽与高大于maxwidth及maxheight时同时在个角显示水印] 默认类型为1 |
nMinWidth | 设置图片绘制水印图片的最小尺寸 | 当图片尺寸宽或高小于设置时,则不会绘制水印 默认:60*60 |
nMinHeight | ||
nMaxWidth | 当宽度与高度大于MAX设置时将会在个角显示水印 | 这两个选项仅在nShowType为3时有效 默认:600*600 |
nMaxHeight | ||
nShowOffset | 控制在显示水印时的偏移[中间显示不生效],同时控制各角的偏移 | 例如:如显示在左上角时,此偏移表示离左边及上边的偏移值 默认20 |
示例:
constchar* szWatermarkFlag = "3|100|100|400|400|20";
b).水印文字的设置说明:
此处的参数值是一个字符串,以|为分割符,如:
//nShowType|nMinWidth|nMinHeight|nVerticalInterval|nOffset|nFontSize|nIsBold|nTextWidth|nTextHeight|colorText
//colorText的值为:A,R,G,B
未授权时,此参数对应的设置将采用默认值,不可修改。
各字段意义如下:
参数名 | 参数值说明 | 备注 |
nShowType | 设置绘制类型 | 1表示在中间显示水印文字; 2表示在右下显示水印文字; 3表示复合类型,在图中间从上至下循环添加45度倾斜的水印文字 默认类型为3 |
nMinWidth | 设置图片绘制水印图片的最小尺寸 | 当图片尺寸宽或高小于设置时,则不会绘制水印 默认60,60 |
nMinHeight | ||
nVerticalInterval | 循环绘制倾斜水印文字的间隔高度 | 此选项仅在nShowType为3时有效 默认150 |
nOffset | 控制在显示水印文字时的偏移[中间显示不生效] | 在nShowType为2时有效,表示离右下角的偏移; 在nShowType为3时,表示顶部起始位置的偏移 默认20 |
nFontSize | 水印文字的字号 | 默认20 |
nIsBold | 水印文字是否加粗 | 字符串截取逗号前面的 默认否 |
nTextWidth | 水印文字所占的宽度,当字所占宽度超过这个宽度时,将不会显示 | 建议在设置中测试好宽度再进行二次设置 默认150 |
nTextHeight | 水印文字所占的高度 | 建议在设置中测试好宽度再进行二次设置 默认50 |
colorText | 以逗号为分隔的ARGB彩设置 | 如:55,255,0,0 表示透明度是55的红 默认:#66333333 |
示例:
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论