MediaPipeTasksVision Framework Reference

HandLandmarkerOptions

class HandLandmarkerOptions : TaskOptions, NSCopying

Options for setting up a HandLandmarker.

  • Running mode of the hand landmarker task. Defaults to .image. HandLandmarker can be created with one of the following running modes:

    1. image: The mode for performing hand landmark detection on single image inputs.
    2. video: The mode for performing hand landmark detection on the decoded frames of a video.
    3. liveStream: The mode for performing hand landmark detection on a live stream of input data, such as from the camera.

    Declaration

    Swift

    var runningMode: RunningMode { get set }

  • An object that confirms to HandLandmarkerLiveStreamDelegate protocol. This object must implement handLandmarker:didFinishDetectionWithResult:timestampInMilliseconds:error: to receive the results of performing asynchronous hand landmark detection on images (i.e, when runningMode = .liveStream).

    Declaration

    Swift

    weak var handLandmarkerLiveStreamDelegate: HandLandmarkerLiveStreamDelegate? { get set }

  • The maximum number of hands that can be detected by the HandLandmarker.

    Declaration

    Swift

    var numHands: Int { get set }

  • The minimum confidence score for the hand detection to be considered successful.

    Declaration

    Swift

    var minHandDetectionConfidence: Float { get set }

  • The minimum confidence score of hand presence score in the hand landmark detection.

    Declaration

    Swift

    var minHandPresenceConfidence: Float { get set }

  • The minimum confidence score for the hand tracking to be considered successful.

    Declaration

    Swift

    var minTrackingConfidence: Float { get set }