com.tencentcloudapi.faceid.v20180301.models

Class LivenessCompareRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.faceid.v20180301.models.LivenessCompareRequest

public class LivenessCompareRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
LivenessCompareRequest()
LivenessCompareRequest(LivenessCompareRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getImageBase64() Get Base64 string of the image for face comparison.
String	getImageUrl() Get URL of the image for face comparison.
String	getLivenessType() Get Liveness detection type.
String	getOptional() Get Optional configuration (a JSON string) { "BestFrameNum": 2 // Return multiple best screenshots.
String	getValidateData() Get Lip mode: set this parameter to a custom 4-digit verification code.
String	getVideoBase64() Get Base64 string of the video for liveness detection.
String	getVideoUrl() Get URL of the video for liveness detection.
void	setImageBase64(String ImageBase64) Set Base64 string of the image for face comparison.
void	setImageUrl(String ImageUrl) Set URL of the image for face comparison.
void	setLivenessType(String LivenessType) Set Liveness detection type.
void	setOptional(String Optional) Set Optional configuration (a JSON string) { "BestFrameNum": 2 // Return multiple best screenshots.
void	setValidateData(String ValidateData) Set Lip mode: set this parameter to a custom 4-digit verification code.
void	setVideoBase64(String VideoBase64) Set Base64 string of the video for liveness detection.
void	setVideoUrl(String VideoUrl) Set URL of the video for liveness detection.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LivenessCompareRequest

public LivenessCompareRequest()

LivenessCompareRequest

public LivenessCompareRequest(LivenessCompareRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getLivenessType

public String getLivenessType()

Get Liveness detection type. Valid values: LIP/ACTION/SILENT. LIP: numeric mode; ACTION: motion mode; SILENT: silent mode. You need to select a mode to input.

Returns:

LivenessType Liveness detection type. Valid values: LIP/ACTION/SILENT. LIP: numeric mode; ACTION: motion mode; SILENT: silent mode. You need to select a mode to input.

setLivenessType

public void setLivenessType(String LivenessType)

Set Liveness detection type. Valid values: LIP/ACTION/SILENT. LIP: numeric mode; ACTION: motion mode; SILENT: silent mode. You need to select a mode to input.

Parameters:

LivenessType - Liveness detection type. Valid values: LIP/ACTION/SILENT. LIP: numeric mode; ACTION: motion mode; SILENT: silent mode. You need to select a mode to input.

getImageBase64

public String getImageBase64()

Get Base64 string of the image for face comparison. The size of the Base64-encoded image data can be up to 3 MB. JPG and PNG formats are supported. Please use the standard Base64 encoding scheme (with the "=" padding). For the encoding conventions, please see RFC 4648. Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageBase64` will be used.

Returns:

ImageBase64 Base64 string of the image for face comparison. The size of the Base64-encoded image data can be up to 3 MB. JPG and PNG formats are supported. Please use the standard Base64 encoding scheme (with the "=" padding). For the encoding conventions, please see RFC 4648. Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageBase64` will be used.

setImageBase64

public void setImageBase64(String ImageBase64)

Set Base64 string of the image for face comparison. The size of the Base64-encoded image data can be up to 3 MB. JPG and PNG formats are supported. Please use the standard Base64 encoding scheme (with the "=" padding). For the encoding conventions, please see RFC 4648. Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageBase64` will be used.

Parameters:

ImageBase64 - Base64 string of the image for face comparison. The size of the Base64-encoded image data can be up to 3 MB. JPG and PNG formats are supported. Please use the standard Base64 encoding scheme (with the "=" padding). For the encoding conventions, please see RFC 4648. Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageBase64` will be used.

getImageUrl

public String getImageUrl()

Get URL of the image for face comparison. The size of the downloaded image after Base64 encoding can be up to 3 MB. JPG and PNG formats are supported. Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageBase64` will be used. We recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

Returns:

ImageUrl URL of the image for face comparison. The size of the downloaded image after Base64 encoding can be up to 3 MB. JPG and PNG formats are supported. Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageBase64` will be used. We recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

setImageUrl

public void setImageUrl(String ImageUrl)

Set URL of the image for face comparison. The size of the downloaded image after Base64 encoding can be up to 3 MB. JPG and PNG formats are supported. Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageBase64` will be used. We recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

Parameters:

ImageUrl - URL of the image for face comparison. The size of the downloaded image after Base64 encoding can be up to 3 MB. JPG and PNG formats are supported. Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageBase64` will be used. We recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

getValidateData

public String getValidateData()

Get Lip mode: set this parameter to a custom 4-digit verification code. Action mode: set this parameter to a custom action sequence (e.g., `2,1` or `1,2`). Silent mode: do not pass in this parameter.

Returns:

ValidateData Lip mode: set this parameter to a custom 4-digit verification code. Action mode: set this parameter to a custom action sequence (e.g., `2,1` or `1,2`). Silent mode: do not pass in this parameter.

setValidateData

public void setValidateData(String ValidateData)

Set Lip mode: set this parameter to a custom 4-digit verification code. Action mode: set this parameter to a custom action sequence (e.g., `2,1` or `1,2`). Silent mode: do not pass in this parameter.

Parameters:

ValidateData - Lip mode: set this parameter to a custom 4-digit verification code. Action mode: set this parameter to a custom action sequence (e.g., `2,1` or `1,2`). Silent mode: do not pass in this parameter.

getOptional

public String getOptional()

Get Optional configuration (a JSON string) { "BestFrameNum": 2 // Return multiple best screenshots. Value range: 2−10 }

Returns:

Optional Optional configuration (a JSON string) { "BestFrameNum": 2 // Return multiple best screenshots. Value range: 2−10 }

setOptional

public void setOptional(String Optional)

Set Optional configuration (a JSON string) { "BestFrameNum": 2 // Return multiple best screenshots. Value range: 2−10 }

Parameters:

Optional - Optional configuration (a JSON string) { "BestFrameNum": 2 // Return multiple best screenshots. Value range: 2−10 }

getVideoBase64

public String getVideoBase64()

Get Base64 string of the video for liveness detection. The size of the Base64-encoded video data can be up to 8 MB. MP4, AVI, and FLV formats are supported. Please use the standard Base64 encoding scheme (with the "=" padding). For the encoding conventions, please see RFC 4648. Either the `VideoUrl` or `VideoBase64` of the video must be provided. If both are provided, only `VideoBase64` will be used.

Returns:

VideoBase64 Base64 string of the video for liveness detection. The size of the Base64-encoded video data can be up to 8 MB. MP4, AVI, and FLV formats are supported. Please use the standard Base64 encoding scheme (with the "=" padding). For the encoding conventions, please see RFC 4648. Either the `VideoUrl` or `VideoBase64` of the video must be provided. If both are provided, only `VideoBase64` will be used.

setVideoBase64

public void setVideoBase64(String VideoBase64)

Set Base64 string of the video for liveness detection. The size of the Base64-encoded video data can be up to 8 MB. MP4, AVI, and FLV formats are supported. Please use the standard Base64 encoding scheme (with the "=" padding). For the encoding conventions, please see RFC 4648. Either the `VideoUrl` or `VideoBase64` of the video must be provided. If both are provided, only `VideoBase64` will be used.

Parameters:

VideoBase64 - Base64 string of the video for liveness detection. The size of the Base64-encoded video data can be up to 8 MB. MP4, AVI, and FLV formats are supported. Please use the standard Base64 encoding scheme (with the "=" padding). For the encoding conventions, please see RFC 4648. Either the `VideoUrl` or `VideoBase64` of the video must be provided. If both are provided, only `VideoBase64` will be used.

getVideoUrl

public String getVideoUrl()

Get URL of the video for liveness detection. The size of the downloaded video after Base64 encoding can be up to 8 MB. It takes no more than 4 seconds to download. MP4, AVI, and FLV formats are supported. Either the `VideoUrl` or `VideoBase64` of the video must be provided. If both are provided, only `VideoBase64` will be used. We recommend you store the video in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

Returns:

VideoUrl URL of the video for liveness detection. The size of the downloaded video after Base64 encoding can be up to 8 MB. It takes no more than 4 seconds to download. MP4, AVI, and FLV formats are supported. Either the `VideoUrl` or `VideoBase64` of the video must be provided. If both are provided, only `VideoBase64` will be used. We recommend you store the video in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

setVideoUrl

public void setVideoUrl(String VideoUrl)

Set URL of the video for liveness detection. The size of the downloaded video after Base64 encoding can be up to 8 MB. It takes no more than 4 seconds to download. MP4, AVI, and FLV formats are supported. Either the `VideoUrl` or `VideoBase64` of the video must be provided. If both are provided, only `VideoBase64` will be used. We recommend you store the video in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

Parameters:

VideoUrl - URL of the video for liveness detection. The size of the downloaded video after Base64 encoding can be up to 8 MB. It takes no more than 4 seconds to download. MP4, AVI, and FLV formats are supported. Either the `VideoUrl` or `VideoBase64` of the video must be provided. If both are provided, only `VideoBase64` will be used. We recommend you store the video in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel