One Logo Pool Ball
Vision · IOS API REFERENCE

DetectHumanHandPoseRequest

struct · iOS 18.0+ · SDK 27.1

struct DetectHumanHandPoseRequest

A request that detects a human hand pose. The framework provides the detected hand pose as a ``HumanHandPoseObservation``.

Members (11)

get · iOS 18.0+

maximumHandCount

TypeScript
get maximumHandCount(): number
Swift declaration
var maximumHandCount: Int

The maximum number of hands to detect in an image. The request orders detected hands by relative size, with only the largest ones having key points determined. The default value is 2.

set · iOS 18.0+

maximumHandCount

TypeScript
set maximumHandCount(value: number)
Swift declaration
var maximumHandCount: Int

The maximum number of hands to detect in an image. The request orders detected hands by relative size, with only the largest ones having key points determined. The default value is 2.

get · iOS 18.0+

descriptor

TypeScript
get descriptor(): RequestDescriptor
Swift declaration
var descriptor: RequestDescriptor { get }

An enum that identifies the request and request revision.

get · iOS 18.0+

regionOfInterest

TypeScript
get regionOfInterest(): NormalizedRect
Swift declaration
var regionOfInterest: NormalizedRect

The region of the image in which Vision will perform the request. The rectangle is normalized to the dimensions of the processed image. Its origin is specified relative to the image's lower-left corner. By default, the region of interest will be the full image.

set · iOS 18.0+

regionOfInterest

TypeScript
set regionOfInterest(value: NormalizedRect)
Swift declaration
var regionOfInterest: NormalizedRect

The region of the image in which Vision will perform the request. The rectangle is normalized to the dimensions of the processed image. Its origin is specified relative to the image's lower-left corner. By default, the region of interest will be the full image.

method · iOS 18.0+

setComputeDevice

TypeScript
setComputeDevice(computeDevice: (_CoreML_MLComputeDevice) | null, computeStage: ComputeStage): void
Swift declaration
mutating func setComputeDevice(_ computeDevice: MLComputeDevice?, for computeStage: ComputeStage)

Assigns a compute device for a compute stage. If the parameter `computeDevice` is `nil`, the framework removes any explicit compute device assignment and allows the framework to select the device. Configure any compute device for a given compute stage. When performing a request, the system makes a validity check. Use `supportedComputeStageDevices` to get valid compute devices for a request’s compute stages. - Parameters: - `computeDevice: `The compute device to assign to the compute stage. - `computeStage: `The compute stage.

get · iOS 18.0+

supportedRevisions

TypeScript
static get supportedRevisions(): Array<DetectHumanHandPoseRequest_Revision>
Swift declaration
static let supportedRevisions: [DetectHumanHandPoseRequest.Revision]

The collection of currently-supported revisions for `DetectHumanHandPoseRequest`.

get · iOS 18.0+

supportedJointNames

TypeScript
get supportedJointNames(): Array<HumanHandPoseObservation_JointName>
Swift declaration
var supportedJointNames: [HumanHandPoseObservation.JointName] { get }

The joint names the request supports.

get · iOS 18.0+

supportedJointsGroupNames

TypeScript
get supportedJointsGroupNames(): Array<HumanHandPoseObservation_JointsGroupName>
Swift declaration
var supportedJointsGroupNames: [HumanHandPoseObservation.JointsGroupName] { get throws }

The joint group names the request supports.

get · iOS 18.0+

revision

TypeScript
get revision(): DetectHumanHandPoseRequest_Revision
Swift declaration
let revision: DetectHumanHandPoseRequest.Revision

The request's configured revision.

init · iOS 18.0+

init

TypeScript
static init(revision?: (DetectHumanHandPoseRequest_Revision) | null): DetectHumanHandPoseRequest
Swift declaration
init(_ revision: DetectHumanHandPoseRequest.Revision? = nil)

- Parameters: - revision: The specific algorithm or implementation revision that's used to perform the request.

Skipped declarations

No declarations were skipped in this snapshot.

All Vision types →