Standalone SDK API Doc  V1.0.4
Functions
3.09.Data-Voice.h File Reference

Detailed Description

Author
http://www.zkteco.com
Date
2017-10-01
copyright:
Copyright 2017 ZKTECO CO., LTD. All Rights Reserved.
Note

Functions

VARIANT_BOOL SetCustomizeVoice (LONG dwMachineNumber, LONG VoiceID, BSTR FileName)
 
VARIANT_BOOL DelCustomizeVoice (LONG dwMachineNumber, LONG VoiceID)
 
VARIANT_BOOL EnableCustomizeVoice (LONG dwMachineNumber, LONG VoiceID, LONG Enablel)
 
VARIANT_BOOL SetUserVerifyStyle (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG VerifyStyle, BYTE *Reserved)
 
VARIANT_BOOL GetUserVerifyStyle (LONG dwMachineNumber, BSTR dwEnrollNumber, LONG *VerifyStyle, BYTE *Reserved)
 

Function Documentation

◆ SetCustomizeVoice()

VARIANT_BOOL SetCustomizeVoice ( LONG  dwMachineNumber,
LONG  VoiceID,
BSTR  FileName 
)

To set a customized announcement based on the original announcement index.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
VoiceID LONG [in] Index of the original announcement
FileName BSTR [in] File name of the customized announcement (including the path)
Returns
Value description:
name type description of value
True BOOL Function execution success
False BOOL Function execution failure
See also
Attention
This function is a customization function. The machine must support the announcement customization function. For details, see the description of EnableCustomizeVoice.
Note
Applicable to BW

◆ DelCustomizeVoice()

VARIANT_BOOL DelCustomizeVoice ( LONG  dwMachineNumber,
LONG  VoiceID 
)

To delete a customized announcement based on the original announcement index.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
VoiceID LONG [in] Index of the original announcement of which the customized announcement is to be deleted
Returns
Value description:
name type description of value
True BOOL Function execution success
False BOOL Function execution failure
See also
Attention
This function is a customization function. The machine must support the announcement customization function. For details, see the description of EnableCustomizeVoice.
Note
Applicable to BW

◆ EnableCustomizeVoice()

VARIANT_BOOL EnableCustomizeVoice ( LONG  dwMachineNumber,
LONG  VoiceID,
LONG  Enablel 
)

To specify whether to enable the customized announcement of a specified index.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
VoiceID LONG [in] Announcement index
Enablel LONG [in] Whether to enable the customized announcement of the specified index. 1 indicates enabling the customized announcement and 0 indicates disabling it
Returns
Value description:
name type description of value
True BOOL Function execution success
False BOOL Function execution failure
See also
Attention
1. This function is a customization function. The machine must support the announcement customization function.
  1. Announcement customization function: The machine will play announcements when executing some operations. With this function, you can enable the machine to play customized announcements. For example, the machine will play the announcement with the index 1, that is, "thank you", when verification is passed. After this function is enabled, the machine will play the customized announcement when verification is passed.
    For example, EnableCustomizeVoice(1,1,1)// indicates enabling the customized announcement of announcement 1. SetCustomizeVoice(1,1,¡®C:\test.wav¡¯)// indicates setting a customized announcement for announcement 1.
Note
Applicable to BW

◆ SetUserVerifyStyle()

VARIANT_BOOL SetUserVerifyStyle ( LONG  dwMachineNumber,
BSTR  dwEnrollNumber,
LONG  VerifyStyle,
BYTE *  Reserved 
)

To set the user verification mode.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
dwEnrollNumber BSTR [in] User ID
VerifyStyle LONG [in] Verification mode
Reserved BSTR* [in] Reserved
Returns
Value description:
name type description of value
True BOOL Function execution success
False BOOL Function execution failure
See also
Attention
1. The VerifyStyle parameter specifies the verification mode. The values are described as follows:
Group Verify = 0
FP/PW/RF = 128
FP = 129
PIN = 130
PW = 131
RF = 132
FP/PW = 133
FP/RF = 134
PW/RF = 135
PIN&FP = 136
FP&PW = 137
FP&RF = 138
PW&RF = 139
FP&PW&RF = 140
PIN&FP&PW = 141
FP&RF/PIN = 142
  1. The Reserved parameter is reserved and not used at present.
Note
This interface is applicable to the new architecture firmware.

◆ GetUserVerifyStyle()

VARIANT_BOOL GetUserVerifyStyle ( LONG  dwMachineNumber,
BSTR  dwEnrollNumber,
LONG *  VerifyStyle,
BYTE *  Reserved 
)

To obtain the user verification mode.

Parameters
Parameter description:
name type param direction description of param
dwMachineNumber LONG [in] Machine ID
dwEnrollNumber BSTR [in] User ID
VerifyStyle LONG* [out] Verification mode
Reserved BSTR* [out] Reserved
Returns
Value description:
name type description of value
True BOOL Function execution success
False BOOL Function execution failure
See also
Attention
1. The VerifyStyle parameter specifies the verification mode. The values are described as follows:
Group Verify = 0
FP/PW/RF = 128
FP = 129
PIN = 130
PW = 131
RF = 132
FP/PW = 133
FP/RF = 134
PW/RF = 135
PIN&FP = 136
FP&PW = 137
FP&RF = 138
PW&RF = 139
FP&PW&RF = 140
PIN&FP&PW = 141
FP&RF/PIN = 142
  1. The Reserved parameter is reserved and not used at present.
Note
This interface is applicable to the new architecture firmware.