# PoseDetection

public class **PoseDetection** extends [Object](https://developer.android.com/reference/java/lang/Object.html)  
Entry point to get a `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector`
for finding `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/Pose` in a supplied
image.

A `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector`
is created via `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetection#getClient(com.google.mlkit.vision.pose.PoseDetectorOptionsBase)`. For example:

     PoseDetector poseDetector = PoseDetection.getClient(options); 

To perform pose detection in an image, you first need to create an instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage` from a `https://developer.android.com/reference/android/graphics/Bitmap.html`, `https://developer.android.com/reference/java/nio/ByteBuffer.html`, `https://developer.android.com/reference/android/media/Image.html` etc. See `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage` documentation for more details. For example, the code below creates an `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage` from a `https://developer.android.com/reference/android/graphics/Bitmap.html`.

     InputImage image = InputImage.fromBitmap(bitmap, rotationDegrees); 

Then the code below can detect `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/Pose` in the supplied `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`.

     Task<Pose> task = poseDetector.process(image);
     task.addOnSuccessListener(...).addOnFailureListener(...); 

### Public Method Summary

|---|---|
| static [PoseDetector](https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector) | [getClient](https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetection#getClient(com.google.mlkit.vision.pose.PoseDetectorOptionsBase))([PoseDetectorOptionsBase](https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetectorOptionsBase) options) Creates an instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector` that detects human body pose in a supplied image. |

### Inherited Method Summary

From class java.lang.Object

|---|---|
| [Object](https://developer.android.com/reference/java/lang/Object.html) | clone() |
| boolean | equals([Object](https://developer.android.com/reference/java/lang/Object.html) arg0) |
| void | finalize() |
| final [Class](https://developer.android.com/reference/java/lang/Class.html)\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| [String](https://developer.android.com/reference/java/lang/String.html) | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Methods

#### public static [PoseDetector](https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector)
**getClient** ([PoseDetectorOptionsBase](https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetectorOptionsBase) options)

Creates an instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector`
that detects human body pose in a supplied image.

To release the resources associated with a `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector`,
you need to ensure that `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector#close()`
is called on the resulting `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector`
instance once it will no longer be used.

Detector initialization work is triggered in the background when the `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector`
instance is created. Optionally, you can use the `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector#getInitTask()`
to track the initialization progress. The first `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector#process(com.google.mlkit.vision.common.InputImage)` or `https://developers.google.com/android/reference/com/google/mlkit/vision/pose/PoseDetector#process(com.google.android.odml.image.MlImage)` call will wait for the initialization to be
finished.