牛牛截图控件浏览器版调用说明.DOC

资源描述

1、牛牛截图控件浏览器版调用说明牛牛截图控件浏览器版调用说明 .11. 接口初始化接口 .22. 参数初始化接口 .23. 启动截图接口 .74. 截图完成后向浏览器通知的事件 .85. 其他接口 .96. 调用示例 .10本说明文档旨在对截图控件的浏览器控件进行说明，指导调用者顺利的将截图控件集成进第三方网页中，使第三方网页也能拥有完美的牛牛截图功能。牛牛截图网页演示页面请访问：http:/ Javascript 调用示例。控件主要有三个接口：InitCapture，InitParam 以及 Capture，这些接口均是暴露给浏览器的 Javascript 调用,具体可以参考调用WebNiuni

2、uCapturedemo_source.zip，接口的具体描述如下：1. 接口初始化接口 int InitCapture (const char* szAuth);此接口函数用于初始化截图控件的授权信息，默认的授权码为：“niuniu“。参数说明：参数名参数类型参数说明备注szAuth 字符串接口调用的授权码默认的授权码为：“niuniu“2. 参数初始化接口int InitParam (int flag, unsigned long flagvalue);此接口函数用于初始化截图各个状态下的界面的显示效果，如果不调用，则以默认值处理。参数说明：参数名参数类型参数说明备注flag

3、 int 要设置的参数项此处对应的枚举ExtendFlagTypeEnum的整形值 flagvalue unsigned long设置的参数值根据不同的枚举来设置不同的值枚举定义如下:typedef enum ExtendFlagTypeEnumemPensize = 1, / emDrawType, / emTrackColor, / emEditBorderColor, / emTransparent, / emWindowAware,emDetectSubWindowRect,emSetSaveName,emSetMagnifierBkColor, /设置放大镜的背景色，不设置则透

4、明emSetMagnifierLogoText, /设置放大镜上的LOGO字符，可提示快捷键，如：牛牛截图(CTRL + SHIFT + A)emSetPreCaptureWindowTitle, /设置网页上截图时弹出窗口的标题emSetPreCaptureWindowTransparent=18,/设置预截图窗口的透明度emSetWatermarkPictureType=20, /设置水印的类型emSetWatermarkPicturePath, /设置水印的路径emSetWatermarkTextType, /设置水印文字的类型emSetWatermarkTextValue, /设置水印

5、文字emSetMosaicType, /设置马赛克的样式emSetTooltipText, /设置工具栏图标的TOOLTIP及完成按钮的文字;枚举项的说明如下：枚举参数名枚举对应数值参数值说明备注emPensize 1 设置画笔大小如不设置，默认为 2emDrawType 2 设置是腾讯风格还是 360 风格0 表示腾讯风格，1表示 360 风格emTrackColor 3 Track 及自动识别的边框的颜色如：RGB(255, 0, 0)emEditBorderColor 4 文本输入框的边框颜色如：RGB(0, 174, 255)emTransparent 5 工具栏的透明度默认

6、为 220emWindowAware 6 设置是否禁用随着 DPI 放大，flagvalue 传递任意值均可浏览器中建议不要调用emDetectSubWindowRect7 是否自动检测子窗口，暂时无用未使用emSetSaveName 8 设置保存时的文件名称如：const char* szName = “测试名“;InitParam (emSetSaveName, (unsigned long) szName);注：免费版本此接口无效，将会显示默认值emSetMagnifierBkColor9 用于设置放大镜的背景色一般不建议设置，默认透明即可emSetMagnifierLogoTex

7、t10 设置放大镜上的显示的LOGO 文字如：const char* szName = “测试名“;InitParam (emSetMagnifierLogoText, (unsigned long) szName);注：免费版本此接口无效，将会显示默认值 emSetPreCaptureWindowTitle11 设置网页上截图时弹出窗口的标题如：const char* szName = “测试名“;InitParam (emSetPreCaptureWindowTitle, (unsigned long) szName);注：免费版本此接口无效，将会显示默认值emSetPreCapture

8、WindowTransparent18 设置预截图窗口的透明度 InitParam(emSetPreCaptureWindowTransparent, 220);以下是水印设置功能，如果不需要则无需关注 emSetWatermarkPictureType20 用于设置水印图片的绘制方式此参数设置具有默认值，仅在授权版本中才可修改设置，具体见下面的水印图片说明emSetWatermarkPictu 21 用于设置水印图片的注：仅支持 PNG 格式rePath BASE64 的图片数据的图片的 Base64 的字符串 emSetWatermarkTextType22 用于设置水印文字绘制方式

9、此参数设置具有默认值，仅在授权版本中才可修改设置，具体见下面的水印文字设置说明emSetWatermarkTextValue23 用于设置水印文字注：此处传递的水印文字需要是经过BASE64 编码的，调用接口：InitParamByBase64emSetMosaicType 24 指定马赛克的样式 1 为矩形，2 为随鼠标画线的方式emSetTooltipText 25 设置工具栏图标的 TOOLTIP及完成按钮的文字此参数设置具有默认值，仅在授权版本中才可修改设置，具体见下面的工具栏按钮文字设置说明a). 水印图片设置参数说明：此处的参数值是一个字符串，以|为分割符，如：/nShowTyp

10、e|nMinWidth|nMinHeight|nMaxWidth|nMaxHeight|nShowOffset未授权时，此参数对应的设置将采用默认值，不可修改；默认支持的图片大小为200*200，超过此大小的地方，将仅显示是在 200*200 范围内的图片。各字段意义如下：参数名参数值说明备注nShowType 设置绘制类型 1 表示在中间显示水印；2 表示在右下显示水印；3 表示复合类型默认在中间添加水印，当满足宽与高大于 maxwidth及 maxheight 时同时在个角显示水印默认类型为 1 nMinWidthnMinHeight设置图片绘制水印图片的最小尺寸当图片尺寸宽或高小于

12、lInterval|nOffset|nFontSize|nIsBold|nTextWidth|nTextHeight|colorText/colorText 的值为：A,R,G,B未授权时，此参数对应的设置将采用默认值，不可修改。各字段意义如下：参数名参数值说明备注nShowType 设置绘制类型 1 表示在中间显示水印文字；2 表示在右下显示水印文字；3 表示复合类型，在图中间从上至下循环添加45 度倾斜的水印文字默认类型为 3 nMinWidthnMinHeight设置图片绘制水印图片的最小尺寸当图片尺寸宽或高小于设置时，则不会绘制水印默认 60,60nVerticalInterva

13、l 循环绘制倾斜水印文字的间隔高度此选项仅在 nShowType为 3 时有效默认 150nOffset 控制在显示水印文字时的偏移中间显示不生效在 nShowType 为 2 时有效，表示离右下角的偏移；在 nShowType 为 3 时，表示顶部起始位置的偏移默认 20nFontSize 水印文字的字号默认 20nIsBold 水印文字是否加粗默认否nTextWidth 水印文字所占的宽度，当字所占宽度超过这个宽度时，将不会显示建议在设置中测试好宽度再进行二次设置默认 150nTextHeight 水印文字所占的高度建议在设置中测试好宽度再进行二次设置默认 50colorTex

15、对应的设置将采用默认值，不可修改。各字段意义如下：参数名参数值说明备注tipRectangle 设置矩形按钮的 tooltip 默认为：“矩形工具”tipCircle 设置椭圆按钮的 tooltip 默认为：“椭圆工具”tipArrow 设置箭头按钮的 tooltip 默认为：“箭头工具”tipBrush 设置画刷按钮的 tooltip 默认为：“画刷工具”tipGlitter 设置荧光笔按钮的 tooltip 默认为：“荧光笔工具”tipMosaic 设置马赛克按钮的 tooltip 默认为：“马赛克工具”tipText 设置文字按钮的 tooltip 默认为：“文字工具”tipUndo

17、(const char* defaultName, int hideThisWindow, int nAutoCapture, int x, int y, int width, int height);此接口用于实际的截图调用，传递相关的截图控制参数，控制截图时的行为。参数说明：参数名参数类型参数说明备注defaultName 字符串用于指定在截图完成时自动保存的文件名如：111.jpg此处建议传递的后续名为 jpg 或 png，方便在网页上上传到后台的数据传输hideThisWindow int 用于指定是否要隐藏当前浏览器窗口值如下：1 表示截图时隐藏当前窗口；0 表示截图时不隐

18、藏当前窗口 autoCapture int 标识截图的方式此参数共有五个值：0：表示普通截图1：表示截取指定区域，区域由x、y、width、height 参数指定2：表示截取当前桌面3: 表示截图时先弹出一个提示窗口4: 从剪贴板中获取图片x inty intwidth intheight int指定截图的区域这 4 个值在参数autoCapture 的值为1 时表示自动截取指定区域。当 autoCapture 为 3时1). 如果全 0，则弹出预截图窗口后再选择区域2). 如果全是 1，则弹出预截图窗口后，自动截取整个桌面3). 其他情况，弹出预截图窗口后，自动截取指定的区域4. 截图完

19、成后向浏览器通知的事件CaptureFinished(int type, int x, int y, int width, int height, const char* szInfo, const char * picdata, const char * localsavepath);此事件函数用于在截图完成后仅指截图时点击完成或双击选中区域以完成截图；保存截图与取消不触发此事件，通知 Javascript 进行后续处理，Javascript 需要事先在浏览器中监听此事件，在收到事件通知后，可以获取到截图的相关数据，进行后续的上传到服务器的处理。参数说明：参数名参数类型参数说明备注t

20、ype int 回调函数的通知类型 1,表示截图完成2,表示取消截图3,表示在截图过程中另存了截图4,表示从剪贴板获取截图的事件通知在收到此通知时，请根据不同的类型值来进行判断处理x inty intwidth intheight int完成截图后返回截图的区域坐标szinfo 字符串用于传输额外的参数当 type 为 3 时，此值表示保存的路径当 type 为 4 时，此值如果为 0 则表示获取成功，否则失败picdata 字符串以 BASE64 编码的字符串形式的图片数据在 Javascript 中，可以对此数据进行Urlencode，然后通过 Ajax 发送给服务器存储。loca

21、lsavepath 字符串本次截图保存在本机的路径 5. 其他接口 GetVersion 与 GetLocation这两个接口直接返回字符串，表示控件的版本号与控件在电脑上的路径。目前仅支持 IE 或支持 npapi 的浏览器。GetCursorPosition返回当前相对于屏幕原点的鼠标坐标，此坐标用于协助希望固定截取浏览器中部分区域的坐标定位浏览器区域与屏幕区域的映射转换需要用到目前仅支持 IE 或支持 npapi 的浏览器返回值为以逗号分割的字符串，分别表示 x 坐标与 y 坐标例：alert(niuniuCapture().GetCursorPosition();SavePictur

22、e针对刚截取的图片，通过另存为窗口先把路径后保存这个接口适用于那些希望将图片另存到本地电脑的需求目前仅支持 IE 或支持 npapi 的浏览器。返回值为整型，分别表示：0：失败1：成功2：取消保存3：没有截图，无需保存例：var ret = niuniuCapture().SavePicture();其中传递的参数表示要保存的默认文件名，可传空。注：以下的截图控件的示例代码主要是用于演示如何通过JS调用控件，但调用的核心部分已经全部封装到了niuniucapture.js中，一般情况下，你不需要修改只文件内容，只需要引用，并且自己另外写JS来与UI集成即可，具体见网站中的示例代码(capturewrapper.js)。6. 调用示例牛牛截图的Web调用演示请访问地址： http:/ 在此函数中，您可以设置相关的截图的UI控制，如，画笔大小、边框颜色等等【这部分信息在niuniucapture.js中也有默认值，直接修改默认值也可】

展开阅读全文