-
牛牛截图控件桌面版调用说明
本说明文档旨在对截图控件的
p>
API
进行说明,
指导调用者顺利的将截图
控件集成
进第三方产品中,使第三方产品也能拥有完美的牛牛截图功能。
控
件
有
三
个
接
口
:
InitScreenCaptureW
,
< br>InitCaptureParamW
以
及
StartScreenCaptureW
,具体可以参考调用
NiuniuCapturedemo_Window_
< br>。
对于上述三个接口,也可
以使用不带
W
的版本,区别在于传递字符串时不使用
Unicode
编
码
,<
/p>
而
直
接
使
用
Ansi
字
符
p>
串
即
可
:
InitScreenCapture
,
In
itCaptureParam
以及
StartScreenC
apture
。
接口的具体描述如下:
1.
接口初始化接口
int
InitScreenCap
tureW
(
const
wchar_t
*
szAuth
);
此接口函数用于初
始化截图控件的授权信息,默认的授权码为:
参数说明:
参数名
szAuth
参数类型
字符串
参数说明
接
口调
用的授
权
码
备注
默认的授权码为:
2.
参数初始化接口
int
InitCaptureParamW(
int
flag,
unsigned
long
flagvalue);
此接口函数用于初始化截图各个状态下的界面的显示效果,如果不调用,则以默认值处理。
参数说明:
参数名
flag
参数类型
int
参数说明
要设置的参数项
设置的参数值
备注
此处对应的枚举
ExtendFlagTypeEnum
的整
形值
p>
根据不同的枚举来设置不同的值
flagvalue
unsigned
long
枚举定义如下
:
typedef
enum
ExtendFlagTypeEnum
{
emPensize =
1,
//
emDrawType,
//
emTrackColor,
//
emEditBorderColor,
//
emTransparent,
//
emWindowAware,
emDetectSubWindowRect,
emSetSaveName,
emSetMagnifierBkColor,
//
设置放大镜的背景色,不设置则透明
emSetMagnifierLogoText,
//
p>
设置放大镜上的
LOGO
字符,可提示快捷
键,如:牛牛截图
(CTRL + SHIFT + A)
emSetWatermarkPictureType=20
,
//
设置水印的类型
emSetWatermarkPicturePath
,
//
设置水印的路径
emSetWatermarkTextType
,
//
设置水印文字的类型
emSetWatermarkTextValue
,
//
设置水印文字
emSetMosaicType,
//
设置
马赛克类型,
1
为矩形,
2
为画
线
emSetToolbarText
,
//
设置
工具栏上的各按钮的
tooltip
及显示的
< br>文字
};
枚举项的说明如下:
枚举参数名
emPensize
emDrawType
emTrackColor
emEditBorderColor
emTransparent
emWindowAware
枚
举
对
应
p>
数
值
1
2
3
4
5
6
参数值说明
设置画笔大小
设置是腾讯风格还是<
/p>
360
风
格
<
/p>
Track
及自动识别的边框的
颜色
p>
文本输入框的边框颜色
工具栏的透明度
设置是否禁用随着<
/p>
DPI
放
大,
f
lagvalue
传递任意值
均可
备注
如不设置,默认为
2
0
表示腾讯风格,
1
表
示
p>
360
风格
如:
RGB(255, 0, 0)
如:
RGB(0,
174,
255)
默认为
220
此项设置非常重要,
相当于调用
p>
SetProcessDPIAware
,如果不设置,在高
DPI
的环境下,
截图将
会错乱
,
请在程序窗
口创建前调用
未使用
如:
const
emDetectSubWindowRe
ct
emSetSaveName
7
8
是否自动检测子窗口,暂时
无用
设置保存时的文件名称
wchar_t*
szName = L
测试名
InitCaptureParam(e
mSetSaveName,
(unsigned
long)
szName);
<
/p>
注:免费版本此接口
无效,将会显示默认
值
emSetMagnifierBkCol
or
emSetMagnifierLogoT
ext
9
10
用于设置放大镜的背景色
设
置
放
大
镜
上
的
显
示
< br>的
LOGO
文字
一般不建议设置,默
认透明即可
如:
const
wchar_t*
szLogoName = L
测试
名
InitCapt
ureParam(e
mSetMagnifierLogoT
ext,
(unsigned
long)
szLogoName);
注:免费版本此接口
无效,将会显示默认
值
此参数设置具有默认
值,仅在授权版本中
才可修改设置,具体
见下面的水印图片说
明
注:此处的路径需要
使用
Unicode
编码
以下是水印设置功能,如果不需要则无需关注
emSetWatermarkPictu
reType
20
用于设置水印图片的绘制方
式
emSetWatermarkPictu
rePath
emSetWatermarkTextT
ype
21
22
用于设置水印图片的路径
用于设置水印文字绘制方式
此参数设
置具有默认
值,仅在授权版本中
才可修改设置,具体
见下面的水印文字设
置说明
用于设置水印文字
设置马赛克类型
注:此处的文字需要
使用
Unicode
编码
1
为矩形,
2
为画线
emSetW
atermarkTextV
alue
emSetMosaicType
emSetToolbarText
23
24
25
设置工具栏图标的
tooltip
此参数设置具有默认
及完成按钮的文字,用于支
值,仅在授权版本中
持多语言环境下的截图支持
才可修改设置,具体
见
下
面
的
设
置
图
标
TOOLTIP
说明
a).
水印图片设置参数说明:
<
/p>
此处的参数值是一个字符串,以
|
为分割
符,如:
//nShowType|nMinWidth|n
MinHeight|nMaxWidth|nMaxHeight|nShowOffset
< br>
未授权时,此参数对应的设置将采用默认值,不可修改;默认支持的图片大小为
200*200
,
超过此大小的地方,
将仅显示是在
200*200
范围内的图片。
< br>
各字段意义如下:
参数名
nShowType
参数值说明
设置绘制类型
备注
1
表示在中间显示水印;
2
表示在右下显示水印;
3
表示复合类型
[
默认在
中间添加水印,当满足
宽与高大于
ma
xwidth
及
maxheight
时
同时在个
角显示水印
]
默认类型为
1
当图片尺寸宽或高小于
设置时,则不会绘制水
印
默认:
60*60
这
两
个
选
项
p>
仅
在
nShowType
< br>为
3
时有效
默认:
600*600
例如:如显示在左上角
时,此偏移表示离左边
及上边
的偏移值
默认
20
nMinWidth
nMinHeight
设置图片绘制水印图片的最小尺寸
nMaxWidth
nMaxHeight
nShowOffset
当宽度与高度大于
< br>MAX
设置时将会在
个角显示水印
控制在显示水印时的偏移
[
中间显
示不
生效
]
,同时控制各角的偏移
p>
示例:
const
wchar_t
*
szWatermarkFlag
=
L
;
b).
水印文字的设置说明:
此处的参数值是一个字符串,以
|
为分割符,
如:
//nShowType|nMinWidth|nMi
nHeight|nVerticalInterval|nOffset|nFontSize|nIsBol
d|nTextWidth|nTex
tHeight|colorText
//colorText
的值为:
A,R,G,
B
未授权时,此参数对应的设置将采用默认值,不可修改。
各字段意义如下:
参数名
nShowType
参数值说明
设置绘制类型
备注
1
表示
在中间显示水印
文字;
2
表示在右下显示水印
文字;
3
表示复合类型,
在图中
间从上至
下循环添加
45
度倾斜的水印文字
默认类型为
3
nMinWidth
nMinHeight
设置图片绘制水印图片的最小尺寸
当
图片尺寸宽或高小于
设置时,则不会绘制水
印
< br>
默认
60,60
此选项仅在
nShowType
为
3
时有效
默认
150
p>
在
nShowType
为
< br>2
时有
效,表示离右下角的偏
移
;
在
nShowType
为
3
时,
表示顶部起始位
置的偏
移
默认
20
默认
20
默认否
建议在设置中测试好宽
度再进行二次设置
默认
150
建议在设置中测试好宽
度再进行二次设置
默认
50
如:
55,255,0,0
表示透<
/p>
明度是
55
的红色
默认:
#66333333
nVerticalInterval
循环绘制倾斜水印文字的间隔高度
nOffset
控制在显示水印文字时的偏移
[
中间显
示不生效
]
nFontSize
nIsBold
nTextWidth
水印文字的字号
水印文字是否加粗
水印文字所占的宽
度,
当字所占宽度超
过这个宽度时,将不会显示
水印文字所占的高度
nTextHeight
colorText
以逗号为分隔的
ARGB
色彩设置
< br>
示例:
const
wchar_t
*
szWaterTextFlag
=
L
;
p>
c).
工具栏图标
tooltip
设置说明:
此处的参数值是一个字符串,以<
/p>
|
为分割符,如:
//tipRectangle|tipCircle|tipArrow|tipBrush|tipGl itter|tipMosaic|tipText|tipUndo|tipSave|tipC
ancel|tipFinish|txtFinish
未授权时,此参数对应的设置将采用默认值,不可修改。
各字段意义如下:
参数名
tipRectangle
tipCircle
tipArrow
tipBrush
tipGlitter
参数值说明
设置矩形按钮的
tooltip
设置椭圆按钮的
tooltip
设置箭头按钮的
tooltip
设置画刷按钮的
tooltip
设置荧光笔按钮的
tooltip
备注
默认为:
“矩形工具”
默认为:
“椭圆工具”
默认为:
“箭头工具”
默认为:
“画刷工具”
默认为:
“荧光笔工具”