Vision · IOS API REFERENCE

DetectHumanBodyPoseRequest

struct · iOS 18.0+ · SDK 27.1

struct DetectHumanBodyPoseRequest

A request that detects a human body pose. The framework provides the detected body pose as a ``HumanBodyPoseObservation``.

Members (11)

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+

detectsHands

TypeScript

get detectsHands(): boolean

Swift declaration

var detectsHands: Bool

Detect hands of the body in returned results if present. Requires `.revision2` The default value for this property is `true`.

set · iOS 18.0+

detectsHands

TypeScript

set detectsHands(value: boolean)

Swift declaration

var detectsHands: Bool

Detect hands of the body in returned results if present. Requires `.revision2` The default value for this property is `true`.

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

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<DetectHumanBodyPoseRequest_Revision>

Swift declaration

static let supportedRevisions: [DetectHumanBodyPoseRequest.Revision]

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

get · iOS 18.0+

supportedJointNames

TypeScript

get supportedJointNames(): Array<HumanBodyPoseObservation_JointName>

Swift declaration

var supportedJointNames: [HumanBodyPoseObservation.JointName] { get }

The joint names the request supports.

get · iOS 18.0+

supportedJointsGroupNames

TypeScript

get supportedJointsGroupNames(): Array<HumanBodyPoseObservation_JointsGroupName>

Swift declaration

var supportedJointsGroupNames: [HumanBodyPoseObservation.JointsGroupName] { get }

The joint group names the request supports.

get · iOS 18.0+

revision

TypeScript

get revision(): DetectHumanBodyPoseRequest_Revision

Swift declaration

let revision: DetectHumanBodyPoseRequest.Revision

The request's configured revision.

init · iOS 18.0+

init

TypeScript

static init(revision?: (DetectHumanBodyPoseRequest_Revision) | null): DetectHumanBodyPoseRequest

Swift declaration

init(_ revision: DetectHumanBodyPoseRequest.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 →