myvtm/Module/mod_ScannerSet/ScannerSet.xml

<?xml version="1.0" encoding="gb2312" ?>
<entity name="ScannerSet">
	<class name="ScannerService" overlap="true" exclusive="false">
    <!--接口名称和功能：打开预览-->
		<twoway name="StartPreview" overlap="true">
			<req>
        <!--参数透传，由硬件实体处理-->
        <!--0：跳过设置；1：不旋转角度；2：顺时针旋转90；3：顺时针旋转180；4：顺时针旋转270-->
				<!--0:skip; 1:top turns to positive, 2: left turns to positive, 3:bottom turns to positive, 4:right turns to positive  -->
				<param name="rotateType" type="short" />
        <!--0：跳过设置；1：全画幅；2：A4画幅；3：身份证大小画幅-->
				<!--0:skip; 1:full size, 2: A4 size, 3: IDCard size  -->
				<param name="scanType" type="short"/>
        <!--0：跳过设置；1：彩色；2：黑白-->
				<!--0:skip; 1:default model, 2: gray model  -->
				<param name="colorType" type="short" />
				<param name="reserved1" type="short"/>
				<param name="reserved2" type="short"/>
				<param name="reserved3" type="short"/>
				<param name="reserved4" type="short"/>
			</req>
			<res>
				<!--预览成功通过上下文返回。retCode用于各项参数的设置结果，非0说明参数设置有错误，或的关系：1色彩；2：角度；4：画幅-->
				<param name="retCode" type="int" />
				<param name="reserved1" type="int" />
				<param name="reserved2" type="array_int" />
			</res>
		</twoway>
    <!--接口名称和功能：关闭预览-->
		<twoway name="CancelPreview" overlap="true">
			<req>
        <!--功能集：不等于0，告诉硬件实体仅仅是隐藏；等于0：关闭预览-->
				<param name="reserved1" type="int"/>
			</req>
			<res>
			</res>
		</twoway>
    <!--接口名称和功能：请求拍照-->
		<twoway name="ScanImage" overlap="true">
			<req>
				<!--两种拍摄方式，但返回的内容都一致：0：调用硬件实体ScanImage接口；1：调用ScanImageEx接口-->
				<param name="nWay" type="int"/>
				<param name="reserved1" type="int"/>
				<param name="reserved2" type="int"/>
			</req>
			<res>
				<param name="filePath" type="string"/>
				<param name="imageData" type="blob"/>
				<param name="reserved1" type="int"/>
				<param name="reserved2" type="string"/>
			</res>
		</twoway>
    <!--接口名称和功能：设置窗口坐标和尺寸-->
		<twoway name="SetWindowPos" overlap="true">
			<req>
        <!--参数透传，由硬件实体处理-->
				<!--0:隐藏预览界面 1:显示预览界面 2:自定义，这时下面的参数才有效-->
				<param name="type" type="int"/>
				<!--默认比例16:9 reserved4保留使用，注意在 type = 2 时以下值有效-->
        <!--预览窗口将要显示的X坐标-->
				<param name="pointX" type="int"/>
        <!--预览窗口将要显示的Y坐标-->
				<param name="pointY" type="int"/>
        <!--预览窗口的宽，高由16:9的比例控制，自然得出-->
				<param name="nWidth" type="int"/>
				<param name="reserved4" type="int"/>
			</req>
			<res>
			</res>
		</twoway>
    <!--接口名称和功能：属性设置-->
		<twoway name="SetProperty" overlap="true">
			<req>
        <!--参数透传，由硬件实体处理，见上面StartPreview的参数说明，这里只是把它单独区分出来了，或者说把这个功能集成到预览中了-->
				<!--0:skip; 1:top turns to positive, 2: left turns to positive, 3:bottom turns to positive, 4:right turns to positive  -->
				<param name="rotateType" type="short" />
				<!--0:skip; 1:full size, 2: A4 size, 3: IDCard size  -->
				<param name="scanType" type="short"/>
				<!--0:skip; 1:default model, 2: gray model  -->
				<param name="colorType" type="short" />
				<param name="reserved1" type="short"/>
				<param name="reserved2" type="short"/>
				<param name="reserved3" type="short"/>
				<param name="reserved4" type="short"/>
			</req>
			<res>
				<!--failed bit: 1, 2, 4, 8 ... 预览成功通过上下文返回，retCode用于各项参数的设置结果-->
				<param name="retCode" type="int" />
				<param name="reserved1" type="int" />
				<param name="reserved2" type="array_int" />
			</res>
		</twoway>
    <!--接口名称和功能：显示属性窗口，无使用场景！！！！-->
		<twoway name="ShowProperty" overlap="true">
      <!--参数透传，由硬件实体处理-->
			<req>
			</req>
			<res>
			</res>
		</twoway>
    <!--接口名称和功能：获取硬件状态-->
		<twoway name="GetDevStatus" overlap="true">
			<req>
			</req>
			<res>
        <!--硬件是否连接：true:连接；false:未连接（这个单词写错了，Invalid是无效的意思，反了）-->
				<param name="bInvalid" type="bool" />
        <!--是否处于预览状态：true:预览；false:未预览-->
				<param name="bPreview" type="bool"/>
				<param name="reserved1" type="int"/>
				<param name="reserved2" type="int"/>
				<param name="reserved3" type="string" />
				<param name="reserved4" type="string" />
			</res>
		</twoway>
		<oneway name="Exit" overlap="true">			
		</oneway>
    <!--下线，低柜使用-->
		<twoway name="GetOnlineCameras" overlap="true">
			<req>
				<param name="reserved1" type="int"/>
			</req>
			<res>
				<param name="devCount" type="int" />
				<param name="devFriendlyNames" type="array_string" />
				<param name="devType" type="array_int"/>
				<!-- 保留字段 -->
				<param name="reserved1" type="array_int"/>
     		<param name="reserved2" type="array_string"/>
			</res>
		</twoway>
    <!--接口名称和功能：获取硬件属性（硬件通有接口），厂商适配器接口透传返回-->
		<twoway name="GetDevInfo" overlap="true" method_id="65535">
			<req>
			</req>
			<res>
				<param name="type" type="string" />
				<param name="model" type="string" />
				<param name="version" type="string" />
				<param name="state" type="int" />
			  <param name="reserved1" type="int"/>
				<param name="reserved2" type="string"/>
			</res>
		</twoway>													
	</class>
  <!--无使用场景-->
		<message name="EventMsg">
			<param name="eventType" type="int"/>
			<param name="reserved1" type="int"/>
			<param name="reserved2" type="string" />
	</message>
</entity>