One Logo Pool Ball
Vision · IOS API REFERENCE

AnimalBodyPoseObservation

struct · iOS 18.0+ · SDK 27.1

struct AnimalBodyPoseObservation

An observation that provides the animal body points the analysis recognizes.

Members (10)

get · iOS 18.0+

confidence

TypeScript
get confidence(): number
Swift declaration
let confidence: Float

The level of confidence normalized to `[0, 1]` where `1` is most confident. The only exception is results coming from `CoreMLRequest`, where confidence values are forwarded as is from relevant CoreML models

get · iOS 18.0+

description

TypeScript
get description(): string
Swift declaration
var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

get · iOS 18.0+

availableJointNames

TypeScript
get availableJointNames(): Array<AnimalBodyPoseObservation_JointName>
Swift declaration
var availableJointNames: [AnimalBodyPoseObservation.JointName] { get }

The names of the available joints in the observation.

get · iOS 18.0+

availableJointsGroupNames

TypeScript
get availableJointsGroupNames(): Array<AnimalBodyPoseObservation_JointsGroupName>
Swift declaration
var availableJointsGroupNames: [AnimalBodyPoseObservation.JointsGroupName] { get }

The names of the available joint groupings in the observation.

get · iOS 18.0+

originatingRequestDescriptor

TypeScript
get originatingRequestDescriptor(): (RequestDescriptor) | null
Swift declaration
let originatingRequestDescriptor: RequestDescriptor?

The descriptor of the request that produced the observation.

get · iOS 18.0+

uuid

TypeScript
get uuid(): string
Swift declaration
let uuid: UUID

The unique identifier for the observation.

method · iOS 18.0+

joint

TypeScript
joint(jointName: AnimalBodyPoseObservation_JointName): (Joint) | null
Swift declaration
func joint(for jointName: AnimalBodyPoseObservation.JointName) -> Joint?

Retrieves a joint for a given joint name.

method · iOS 18.0+

allJoints

TypeScript
allJoints(groupName?: (AnimalBodyPoseObservation_JointsGroupName) | null): NativeMap<AnimalBodyPoseObservation_JointName, Joint>
Swift declaration
func allJoints(in groupName: AnimalBodyPoseObservation.JointsGroupName? = nil) -> [AnimalBodyPoseObservation.JointName : Joint]

Retrieves a dictionary of joints for a joint group.

get · iOS 18.0+

timeRange

TypeScript
get timeRange(): (_CoreMedia_CMTimeRange) | null
Swift declaration
let timeRange: CMTimeRange?

The time range of the reported observation. When evaluating a sequence of image buffers, use this property to determine each observation’s start time and duration.

init · iOS 18.0+

init

TypeScript
static init(observation: VNAnimalBodyPoseObservation): AnimalBodyPoseObservation
Swift declaration
init(_ observation: VNAnimalBodyPoseObservation)

Skipped declarations

No declarations were skipped in this snapshot.

All Vision types →