<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/vision/gesture_recognizer.py#L215-L504) |

Class that performs gesture recognition on images.

    mp.tasks.vision.GestureRecognizer(
        lib: serial_dispatcher.SerialDispatcher,
        handle: ctypes.c_void_p,
        dispatcher: async_result_dispatcher.AsyncResultDispatcher,
        async_callback: _C_TYPES_RESULT_CALLBACK
    )

<br />

<br />

<br />

| ## Args ||
|---|---|
| `lib` | The dispatch library to use for the gesture recognizer. |
| `handle` | The C pointer to the gesture recognizer. |
| `dispatcher` | The async result handler for the gesture recognizer. |
| `async_callback` | The c callback for the gesture recognizer. |

<br />

## Methods

### `close`

[View source](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/vision/gesture_recognizer.py#L475-L482)

    close()

Closes GestureRecognizer.

### `create_from_model_path`

[View source](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/vision/gesture_recognizer.py#L243-L266)

    @classmethod
    create_from_model_path(
        model_path: str
    ) -> 'GestureRecognizer'

Creates an `GestureRecognizer` object from a TensorFlow Lite model and the default `GestureRecognizerOptions`.

Note that the created `GestureRecognizer` instance is in image mode, for
recognizing hand gestures on single image inputs.

<br />

<br />

<br />

| Args ||
|---|---|
| `model_path` | Path to the model. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `GestureRecognizer` object that's created from the model file and the default `GestureRecognizerOptions`. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If failed to create `GestureRecognizer` object from the provided file such as invalid file path. |
| `RuntimeError` | If other types of error occurred. |

<br />

### `create_from_options`

[View source](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/vision/gesture_recognizer.py#L268-L334)

    @classmethod
    create_from_options(
        options: https://developers.google.com/edge/api/mediapipe/python/mp/tasks/vision/GestureRecognizerOptions
    ) -> 'GestureRecognizer'

Creates the `GestureRecognizer` object from gesture recognizer options.

<br />

<br />

<br />

| Args ||
|---|---|
| `options` | Options for the gesture recognizer task. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `GestureRecognizer` object that's created from `options`. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If failed to create `GestureRecognizer` object from `GestureRecognizerOptions` such as missing the model. |
| `RuntimeError` | If other types of error occurred. |

<br />

### `recognize`

[View source](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/vision/gesture_recognizer.py#L336-L377)

    recognize(
        image: https://developers.google.com/edge/api/mediapipe/python/mp/Image,
        image_processing_options: Optional[https://developers.google.com/edge/api/mediapipe/python/mp/tasks/vision/ImageProcessingOptions] = None
    ) -> https://developers.google.com/edge/api/mediapipe/python/mp/tasks/vision/GestureRecognizerResult

Performs hand gesture recognition on the given image.

Only use this method when the GestureRecognizer is created with the image
running mode.

The image can be of any size with format RGB or RGBA.

support is implemented.

<br />

<br />

<br />

| Args ||
|---|---|
| `image` | MediaPipe Image. |
| `image_processing_options` | Options for image processing. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| The hand gesture recognition results. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If any of the input arguments is invalid. |
| `RuntimeError` | If gesture recognition failed to run. |

<br />

### `recognize_async`

[View source](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/vision/gesture_recognizer.py#L426-L473)

    recognize_async(
        image: https://developers.google.com/edge/api/mediapipe/python/mp/Image,
        timestamp_ms: int,
        image_processing_options: Optional[https://developers.google.com/edge/api/mediapipe/python/mp/tasks/vision/ImageProcessingOptions] = None
    ) -> None

Sends live image data to perform gesture recognition.

The results will be available via the "result_callback" provided in the
GestureRecognizerOptions. Only use this method when the GestureRecognizer
is created with the live stream running mode.

Only use this method when the GestureRecognizer is created with the live
stream running mode. The input timestamps should be monotonically increasing
for adjacent calls of this method. This method will return immediately after
the input image is accepted. The results will be available via the
`result_callback` provided in the `GestureRecognizerOptions`. The
`recognize_async` method is designed to process live stream data such as
camera input. To lower the overall latency, gesture recognizer may drop the
input images if needed. In other words, it's not guaranteed to have output
per input image.

The `result_callback` provides:
- The hand gesture recognition results.
- The input image that the gesture recognizer runs on.
- The input timestamp in milliseconds.

<br />

<br />

<br />

| Args ||
|---|---|
| `image` | MediaPipe Image. |
| `timestamp_ms` | The timestamp of the input image in milliseconds. |
| `image_processing_options` | Options for image processing. |

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If the current input timestamp is smaller than what the gesture recognizer has already processed. |

<br />

### `recognize_for_video`

[View source](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/vision/gesture_recognizer.py#L379-L424)

    recognize_for_video(
        image: https://developers.google.com/edge/api/mediapipe/python/mp/Image,
        timestamp_ms: int,
        image_processing_options: Optional[https://developers.google.com/edge/api/mediapipe/python/mp/tasks/vision/ImageProcessingOptions] = None
    ) -> https://developers.google.com/edge/api/mediapipe/python/mp/tasks/vision/GestureRecognizerResult

Performs gesture recognition on the provided video frame.

Only use this method when the GestureRecognizer is created with the video
running mode.

Only use this method when the GestureRecognizer is created with the video
running mode. It's required to provide the video frame's timestamp (in
milliseconds) along with the video frame. The input timestamps should be
monotonically increasing for adjacent calls of this method.

<br />

<br />

<br />

| Args ||
|---|---|
| `image` | MediaPipe Image. |
| `timestamp_ms` | The timestamp of the input video frame in milliseconds. |
| `image_processing_options` | Options for image processing. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| The hand gesture recognition results. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If any of the input arguments is invalid. |
| `RuntimeError` | If gesture recognition failed to run. |

<br />

### `__enter__`

[View source](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/vision/gesture_recognizer.py#L484-L486)

    __enter__()

Returns `self` upon entering the runtime context.

### `__exit__`

[View source](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/vision/gesture_recognizer.py#L488-L501)

    __exit__(
        exc_type, exc_value, traceback
    )

Closes GestureRecognizers and exits the context manager.

<br />

<br />

<br />

| Args ||
|---|---|
| `exc_type` | The exception type that caused the context manager to exit. |
| `exc_value` | The exception value that caused the context manager to exit. |
| `traceback` | The exception traceback that caused the context manager to exit. |

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `RuntimeError` | If the MediaPipe Gesture Recognizer task failed to close. |

<br />