myvtm/Module/mod_HSPScanner/HSPScanner.xml

<?xml version="1.0" encoding="utf-8" ?>
<entity name="HSPScanner">
	<class name="HSPScannerService" overlap="true" exclusive="false">
		<twoway name="StartPreview" overlap="true">
			<req>
				<!--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="CancelPreview" overlap="true">
			<req>
				<param name="bOnlyHide" type="bool"/>
				<param name="reserved1" type="int"/>
			</req>
			<res>
			</res>
		</twoway>
    <!--接口名称和功能：请求拍照。拍照成功后会调用硬件适配器隐藏窗口-->
		<twoway name="ScanImage" overlap="true">
			<req>
				<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="ScanImageEx" overlap="true">
			<req>
				<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="SetProperty" overlap="true">
			<req>
				<!--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="SetWinPos" overlap="true">
			<req>
				<!--0:hide 1:show 2:custom -->
				<param name="type" type="int"/>
				<!--默认比例16:9 reserved4保留使用，注意在 type = 2 时以下值有效-->
				<param name="pointX" type="int"/>
				<param name="pointY" type="int"/>
				<param name="nWidth" type="int"/>
				<param name="reserved4" type="int"/>
			</req>
			<res>
			</res>
		</twoway>
		<twoway name="ShowProperty" overlap="true">
      <!--直接调用厂商硬件适配器接口-->
			<req>
			</req>
			<res>
			</res>
		</twoway>
		<twoway name="GetDevStatus" overlap="true">
			<req>
			</req>
			<res>
				<param name="connected" type="int" />
				<param name="showing" type="int" />
				<param name="previewing" type="int"/>
				<param name="reserved1" type="array_int"/>
				<param name="reserved2" type="array_string"/>	
			</res>
		</twoway>
    <!-- 获取设备模块信息，成功时errorCode为Error_Succeed(0)，及相关数据 -->
    <!-- 1、设备未打开，errorCode为Error_DevNotAvailable,rtaCode为RTA2N01 -->
    <!-- 2、硬件未配置，errorCode为Error_NotConfig,rtaCode为RTA2N0J -->
    <!-- 3、硬件掉线，errorCode为Error_DevNotAvailable,rtaCode为RTA2N0K -->
    <twoway name="GetDevInfo" overlap="true" jsflag="true" method_id="65535">
			<req>
			</req>
			<res>
        <!--设备适配器DevCategoryInfo的szType-->
        <param name="type" type="string" />
        <!--设备适配器DevCategoryInfo的szModel-->
				<param name="model" type="string" />
        <!--设备适配器DevCategoryInfo的version-->
        <param name="version" type="string" />
        <!--硬件实体内置的状态，目前暂无使用场景，有需要在讨论如何定义-->
        <param name="state" type="int" />
			</res>
		</twoway>
		<oneway name="Exit" overlap="true">			
		</oneway>
    <!-- 预览，成功时返回Error_Succeed，及相关数据 -->
    <!-- 1、设备未打开，errorCode为Error_DevNotAvailable,rtaCode为RTA2N01 -->
    <!-- 2、硬件未配置，errorCode为Error_NotConfig,rtaCode为RTA2N0J -->
    <!-- 3、硬件掉线，errorCode为Error_DevNotAvailable,rtaCode为RTA2N0K -->
    <!-- 4、调用硬件-预览失败，errorCode为Error_Unexpect,rtaCode为RTA2N03 -->
    <!-- 5、调用硬件-设置角度失败，errorCode为Error_Unexpect,rtaCode为RTA2N0Y -->
    <!-- 6、调用硬件-设置画幅失败，errorCode为Error_Unexpect,rtaCode为RTA2N0Z -->
    <!-- 7、调用硬件-设置色彩失败，errorCode为Error_Unexpect,rtaCode为RTA2N0W -->
    <!-- 8、调用硬件-设置坐标大小失败，errorCode为Error_Unexpect,rtaCode为RTA2N07 -->
    <!-- 9、调用硬件-显示预览窗口失败（预览&隐藏的状态），errorCode为Error_Unexpect,rtaCode为RTA2N0R -->
    <!-- 说明补充：
     * 如需设置参数，将在预览前设置，设置参数失败则提前返回，无论当时是否已经处于预览状态
     * 处于预览但隐藏（关于隐藏，见下方对取消预览的说明）状态，则会直接显示窗口，如果其他参数有值，仍然优先设置参数（失败则提前返回），再显示窗口
    -->
    <twoway name="StartPreviewJS" jsflag="true" overlap="true">
      <req>
        <!--0：跳过角度设置，不生效；1：不旋转角度；2：顺时针旋转90；3：顺时针旋转180；4：顺时针旋转270-->
        <param name="rotate" type="short" />
        <!--0：跳过画幅设置，不生效；1：全画幅；2：A4画幅；3：身份证大小画幅-->
        <param name="scan" type="short"/>
        <!--0：跳过色彩设置，不生效；1：彩色；2：黑白-->
        <param name="color" type="short" />
        <!--0：跳过坐标&大小设置，不生效；1：设置预览窗口坐标，只有此值为1时才会读取pos_x|y|w-->
        <param name="pos" type="short"/>
        <!--设置预览窗口坐标的X轴坐标，当pos不为0时该值才有效-->
        <param name="pos_x" type="short"/>
        <!--设置预览窗口坐标的Y轴坐标，当pos不为0时该值才有效-->
        <param name="pos_y" type="short"/>
        <!--设置预览窗口的窗口宽度，当pos不为0时该值才有效-->
        <param name="pos_w" type="short"/>
        <param name="reserved1" type="int"/>
      </req>
      <res>
      </res>
    </twoway>
    <!-- 取消预览，成功时返回Error_Succeed(0)，及相关数据 -->
    <!-- 1、设备未打开，errorCode为Error_DevNotAvailable,rtaCode为RTA2N01 -->
    <!-- 2、硬件未配置，errorCode为Error_NotConfig,rtaCode为RTA2N0J -->
    <!-- 3、硬件掉线，errorCode为Error_DevNotAvailable,rtaCode为RTA2N0K -->
    <!-- 4、调用硬件-取消预览失败，errorCode为Error_Unexpect,rtaCode为RTA2N04 -->
    <!-- 5、调用硬件-隐藏预览窗口失败，errorCode为Error_Unexpect,rtaCode为RTA2N0Q -->
    <!-- 说明补充：
     * 当要求仅为隐藏预览窗口时：1）预览&隐藏状态时直接返回成功；2）预览&非隐藏时调用隐藏；3）非预览时返回无效操作，errorCode为Error_InvalidState，rtaCode为RTA2N0V
     * 当直接关闭预览时：1）非预览时直接返回成功；2）预览&隐藏状态时调用硬件取消预览
    -->
    <twoway name="CancelPreviewJS" jsflag="true" overlap="true">
      <req>
        <!--是否仅为隐藏预览窗口，如果为false，表示调用硬件关闭摄像头，true表示仅为隐藏预览窗口不关闭摄像头，默认是关闭摄像头-->
        <param name="hide" type="bool"/>
      </req>
      <res>
      </res>
    </twoway>
    <!--拍照，成功时返回Error_Succeed(0)，及相关数据-->
    <!-- 1、设备未打开，errorCode为Error_DevNotAvailable,rtaCode为RTA2N01 -->
    <!-- 2、硬件未配置，errorCode为Error_NotConfig,rtaCode为RTA2N0J -->
    <!-- 3、硬件掉线，errorCode为Error_DevNotAvailable,rtaCode为RTA2N0K -->
    <!-- 4、非预览状态无法拍照，errorCode为Error_InvalidState,rtaCode为RTA2N0V -->
    <!-- 5、调用硬件-拍照失败，errorCode为Error_Unexpect,rtaCode为RTA2N05 -->
    <!-- 6、调用硬件-隐藏预览窗口失败，errorCode为Error_Unexpect,rtaCode为RTA2N0Q -->
    <!-- 7、拍照成功后，压缩照片失败，errorCode为Error_Unexpect,rtaCode为RTA2N0N -->
    <!-- 说明补充：
     * 当需要隐藏时，前提是【拍照成功】才会调用隐藏预览窗口，如果隐藏窗口失败，一样扔定为拍照不成功
     * 只要处于预览状态中，就认为可进行拍照，不区分是否隐藏预览窗口
     * 调用拍照成功，但是硬件没有返回图片数据，仍认为成功。只有需要压缩时（应用介入），会因为压缩图片失败而报错返回
    -->
    <twoway name="ScanImageJS" jsflag="true" overlap="true">
      <req>
        <!--拍照后是否自动隐藏预览窗口，如果为false，表示仅为拍照不做其他操作，true表示拍照后自动隐藏预览窗口，底层默认是拍照后自动隐藏预览窗口-->
        <param name="hide" type="bool"/>
        <!-- 是否压缩图片和压缩的阈值，单位KB，为0表示不压缩，业务目前定的是500KB -->
        <param name="compress" type="int" />
        <param name="reserved1" type="int" />
      </req>
      <res>
        <!--返回照片的数据流-->
        <param name="imageData" type="blob"/>
      </res>
    </twoway>
    <!-- 设置参数，成功时返回Error_Succeed(0)，及相关数据 -->
    <!-- 1、设备未打开，errorCode为Error_DevNotAvailable,rtaCode为RTA2N01 -->
    <!-- 2、硬件未配置，errorCode为Error_NotConfig,rtaCode为RTA2N0J -->
    <!-- 3、硬件掉线，errorCode为Error_DevNotAvailable,rtaCode为RTA2N0K -->
    <!-- 4、调用硬件-设置角度失败，errorCode为Error_Unexpect,rtaCode为RTA2N0Y -->
    <!-- 5、调用硬件-设置画幅失败，errorCode为Error_Unexpect,rtaCode为RTA2N0Z -->
    <!-- 6、调用硬件-设置色彩失败，errorCode为Error_Unexpect,rtaCode为RTA2N0W -->
    <!-- 7、调用硬件-设置坐标大小失败，errorCode为Error_Unexpect,rtaCode为RTA2N07 -->
    <!-- 说明补充：
     * 除以上第1-3种情况，在其他任何状态中都支持设置参数，成功与否由调用硬件结果决定
    -->
    <twoway name="SetParamJS" jsflag="true" overlap="true">
      <req>
        <!--0：跳过设置，不生效；1：不旋转角度；2：顺时针旋转90；3：顺时针旋转180；4：顺时针旋转270-->
        <param name="rotate" type="short" />
        <!--0：跳过设置，不生效；1：全画幅；2：A4画幅；3：身份证大小画幅-->
        <param name="scan" type="short"/>
        <!--0：跳过设置，不生效；1：彩色；2：黑白-->
        <param name="color" type="short" />
        <!--0：跳过设置，不生效；1：设置预览窗口坐标，只有此值为1时才会读取pos_x|y|w-->
        <param name="pos" type="short"/>
        <!--设置预览窗口坐标的X轴坐标，当pos不为0时该值才有效-->
        <param name="pos_x" type="short"/>
        <!--设置预览窗口坐标的Y轴坐标，当pos不为0时该值才有效-->
        <param name="pos_y" type="short"/>
        <!--设置预览窗口的窗口宽度，当pos不为0时该值才有效-->
        <param name="pos_w" type="short"/>
        <param name="reserved1" type="int"/>
      </req>
      <res>
      </res>
    </twoway>
	</class>
		<message name="StatusMsg">
			<param name="status" type="int"/>
			<param name="description" type="string" />
	</message>
</entity>