VideoStreamFaceDetectionFeature

class oci.ai_vision.models.VideoStreamFaceDetectionFeature(**kwargs)

Bases: oci.ai_vision.models.video_stream_feature.VideoStreamFeature

Video stream face detection feature

Attributes

FEATURE_TYPE_FACE_DETECTION str(object=’’) -> str
FEATURE_TYPE_OBJECT_DETECTION str(object=’’) -> str
FEATURE_TYPE_OBJECT_TRACKING str(object=’’) -> str
feature_type [Required] Gets the feature_type of this VideoStreamFeature.
max_results Gets the max_results of this VideoStreamFaceDetectionFeature.
min_confidence Gets the min_confidence of this VideoStreamFaceDetectionFeature.
should_return_landmarks Gets the should_return_landmarks of this VideoStreamFaceDetectionFeature.

Methods

__init__(**kwargs) Initializes a new VideoStreamFaceDetectionFeature object with values from keyword arguments.
get_subtype(object_dictionary) Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
FEATURE_TYPE_FACE_DETECTION = 'FACE_DETECTION'
FEATURE_TYPE_OBJECT_DETECTION = 'OBJECT_DETECTION'
FEATURE_TYPE_OBJECT_TRACKING = 'OBJECT_TRACKING'
__init__(**kwargs)

Initializes a new VideoStreamFaceDetectionFeature object with values from keyword arguments. The default value of the feature_type attribute of this class is FACE_DETECTION and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • feature_type (str) – The value to assign to the feature_type property of this VideoStreamFaceDetectionFeature. Allowed values for this property are: “OBJECT_TRACKING”, “FACE_DETECTION”, “OBJECT_DETECTION”
  • max_results (int) – The value to assign to the max_results property of this VideoStreamFaceDetectionFeature.
  • should_return_landmarks (bool) – The value to assign to the should_return_landmarks property of this VideoStreamFaceDetectionFeature.
  • min_confidence (float) – The value to assign to the min_confidence property of this VideoStreamFaceDetectionFeature.
feature_type

[Required] Gets the feature_type of this VideoStreamFeature. The feature of video analysis. Allowed values are: - OBJECT_TRACKING: Object tracking feature(OT). - FACE_DETECTION: Face detection feature(FD). - OBJECT_DETECTION: Object detection feature(OD)

Allowed values for this property are: “OBJECT_TRACKING”, “FACE_DETECTION”, “OBJECT_DETECTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The feature_type of this VideoStreamFeature.
Return type:str
static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

max_results

Gets the max_results of this VideoStreamFaceDetectionFeature. The maximum number of results to return.

Returns:The max_results of this VideoStreamFaceDetectionFeature.
Return type:int
min_confidence

Gets the min_confidence of this VideoStreamFaceDetectionFeature. The minimum confidence score, between 0 and 1, when the value is set, results with lower confidence will not be returned.

Returns:The min_confidence of this VideoStreamFaceDetectionFeature.
Return type:float
should_return_landmarks

Gets the should_return_landmarks of this VideoStreamFaceDetectionFeature. Whether or not return face landmarks.

Returns:The should_return_landmarks of this VideoStreamFaceDetectionFeature.
Return type:bool