---
title: SRKeyboardMetrics
framework: sensorkit
role: symbol
role_heading: Class
path: sensorkit/srkeyboardmetrics
---

# SRKeyboardMetrics

The configuration of a device’s keyboard and its usage patterns.

## Declaration

```swift
class SRKeyboardMetrics
```

## Overview

Overview The keyboardMetrics sensor provides this class as its sample type.

## Topics

### Inspecting Keyboard Configuration and Sessions

- [duration](sensorkit/srkeyboardmetrics/duration.md)
- [keyboardIdentifier](sensorkit/srkeyboardmetrics/keyboardidentifier.md)
- [version](sensorkit/srkeyboardmetrics/version.md)
- [width](sensorkit/srkeyboardmetrics/width.md)
- [height](sensorkit/srkeyboardmetrics/height.md)
- [inputModes](sensorkit/srkeyboardmetrics/inputmodes.md)
- [sessionIdentifiers](sensorkit/srkeyboardmetrics/sessionidentifiers.md)

### Quantifying Key Use

- [totalWords](sensorkit/srkeyboardmetrics/totalwords.md)
- [totalAlteredWords](sensorkit/srkeyboardmetrics/totalalteredwords.md)
- [totalTaps](sensorkit/srkeyboardmetrics/totaltaps.md)
- [totalDrags](sensorkit/srkeyboardmetrics/totaldrags.md)
- [totalDeletes](sensorkit/srkeyboardmetrics/totaldeletes.md)
- [totalEmojis](sensorkit/srkeyboardmetrics/totalemojis.md)
- [totalPaths](sensorkit/srkeyboardmetrics/totalpaths.md)
- [totalPathTime](sensorkit/srkeyboardmetrics/totalpathtime.md)
- [totalPathLength](sensorkit/srkeyboardmetrics/totalpathlength.md)
- [totalAutoCorrections](sensorkit/srkeyboardmetrics/totalautocorrections.md)
- [totalSpaceCorrections](sensorkit/srkeyboardmetrics/totalspacecorrections.md)
- [totalRetroCorrections](sensorkit/srkeyboardmetrics/totalretrocorrections.md)
- [totalTranspositionCorrections](sensorkit/srkeyboardmetrics/totaltranspositioncorrections.md)
- [totalInsertKeyCorrections](sensorkit/srkeyboardmetrics/totalinsertkeycorrections.md)
- [totalSkipTouchCorrections](sensorkit/srkeyboardmetrics/totalskiptouchcorrections.md)
- [totalNearKeyCorrections](sensorkit/srkeyboardmetrics/totalnearkeycorrections.md)
- [totalSubstitutionCorrections](sensorkit/srkeyboardmetrics/totalsubstitutioncorrections.md)
- [totalHitTestCorrections](sensorkit/srkeyboardmetrics/totalhittestcorrections.md)
- [totalTypingDuration](sensorkit/srkeyboardmetrics/totaltypingduration.md)
- [totalPathPauses](sensorkit/srkeyboardmetrics/totalpathpauses.md)
- [totalPauses](sensorkit/srkeyboardmetrics/totalpauses.md)
- [totalTypingEpisodes](sensorkit/srkeyboardmetrics/totaltypingepisodes.md)

### Timing Key Use

- [SRKeyboardMetrics.ProbabilityMetric](sensorkit/srkeyboardmetrics/probabilitymetric.md)
- [touchDownUp](sensorkit/srkeyboardmetrics/touchdownup.md)
- [touchUpDown](sensorkit/srkeyboardmetrics/touchupdown.md)
- [spaceTouchDownUp](sensorkit/srkeyboardmetrics/spacetouchdownup.md)
- [deleteTouchDownUp](sensorkit/srkeyboardmetrics/deletetouchdownup.md)
- [shortWordCharKeyTouchDownUp](sensorkit/srkeyboardmetrics/shortwordcharkeytouchdownup.md)
- [touchDownDown](sensorkit/srkeyboardmetrics/touchdowndown.md)
- [charKeyToPrediction](sensorkit/srkeyboardmetrics/charkeytoprediction.md)
- [shortWordCharKeyToCharKey](sensorkit/srkeyboardmetrics/shortwordcharkeytocharkey.md)
- [charKeyToAnyTapKey](sensorkit/srkeyboardmetrics/charkeytoanytapkey.md)
- [anyTapToCharKey](sensorkit/srkeyboardmetrics/anytaptocharkey.md)
- [spaceToCharKey](sensorkit/srkeyboardmetrics/spacetocharkey.md)
- [charKeyToSpaceKey](sensorkit/srkeyboardmetrics/charkeytospacekey.md)
- [spaceToDeleteKey](sensorkit/srkeyboardmetrics/spacetodeletekey.md)
- [deleteToSpaceKey](sensorkit/srkeyboardmetrics/deletetospacekey.md)
- [spaceToSpaceKey](sensorkit/srkeyboardmetrics/spacetospacekey.md)
- [spaceToShiftKey](sensorkit/srkeyboardmetrics/spacetoshiftkey.md)
- [spaceToPlaneChangeKey](sensorkit/srkeyboardmetrics/spacetoplanechangekey.md)
- [spaceToPredictionKey](sensorkit/srkeyboardmetrics/spacetopredictionkey.md)
- [deleteToCharKey](sensorkit/srkeyboardmetrics/deletetocharkey.md)
- [charKeyToDelete](sensorkit/srkeyboardmetrics/charkeytodelete.md)
- [deleteToDelete](sensorkit/srkeyboardmetrics/deletetodelete.md)
- [deleteToDeletes](sensorkit/srkeyboardmetrics/deletetodeletes.md)
- [deleteToShiftKey](sensorkit/srkeyboardmetrics/deletetoshiftkey.md)
- [deleteToPlaneChangeKey](sensorkit/srkeyboardmetrics/deletetoplanechangekey.md)
- [anyTapToPlaneChangeKey](sensorkit/srkeyboardmetrics/anytaptoplanechangekey.md)
- [planeChangeToAnyTap](sensorkit/srkeyboardmetrics/planechangetoanytap.md)
- [charKeyToPlaneChangeKey](sensorkit/srkeyboardmetrics/charkeytoplanechangekey.md)
- [planeChangeKeyToCharKey](sensorkit/srkeyboardmetrics/planechangekeytocharkey.md)
- [deleteToPath](sensorkit/srkeyboardmetrics/deletetopath.md)
- [pathToDelete](sensorkit/srkeyboardmetrics/pathtodelete.md)
- [spaceToPath](sensorkit/srkeyboardmetrics/spacetopath.md)
- [pathToSpace](sensorkit/srkeyboardmetrics/pathtospace.md)
- [pathToPath](sensorkit/srkeyboardmetrics/pathtopath.md)
- [longWordTouchDownUp](sensorkit/srkeyboardmetrics/longwordtouchdownup.md)
- [longWordTouchDownDown](sensorkit/srkeyboardmetrics/longwordtouchdowndown.md)
- [longWordTouchUpDown](sensorkit/srkeyboardmetrics/longwordtouchupdown.md)
- [pathTypingSpeed](sensorkit/srkeyboardmetrics/pathtypingspeed.md)
- [typingSpeed](sensorkit/srkeyboardmetrics/typingspeed.md)

### Measuring Key Use

- [longWordUpErrorDistance](sensorkit/srkeyboardmetrics/longworduperrordistance.md)
- [longWordDownErrorDistance](sensorkit/srkeyboardmetrics/longworddownerrordistance.md)
- [upErrorDistance](sensorkit/srkeyboardmetrics/uperrordistance.md)
- [downErrorDistance](sensorkit/srkeyboardmetrics/downerrordistance.md)
- [spaceUpErrorDistance](sensorkit/srkeyboardmetrics/spaceuperrordistance.md)
- [spaceDownErrorDistance](sensorkit/srkeyboardmetrics/spacedownerrordistance.md)
- [deleteUpErrorDistance](sensorkit/srkeyboardmetrics/deleteuperrordistance.md)
- [deleteDownErrorDistance](sensorkit/srkeyboardmetrics/deletedownerrordistance.md)
- [shortWordCharKeyUpErrorDistance](sensorkit/srkeyboardmetrics/shortwordcharkeyuperrordistance.md)
- [shortWordCharKeyDownErrorDistance](sensorkit/srkeyboardmetrics/shortwordcharkeydownerrordistance.md)
- [pathErrorDistanceRatio](sensorkit/srkeyboardmetrics/patherrordistanceratio.md)

### Inferring Sentiment

- [wordCount(for:)](sensorkit/srkeyboardmetrics/wordcount(for:).md)
- [emojiCount(for:)](sensorkit/srkeyboardmetrics/emojicount(for:).md)
- [SRKeyboardMetrics.SentimentCategory](sensorkit/srkeyboardmetrics/sentimentcategory.md)

## Relationships

### Inherits From

- [NSObject](objectivec/nsobject-swift.class.md)

### Conforms To

- [CVarArg](swift/cvararg.md)
- [CustomDebugStringConvertible](swift/customdebugstringconvertible.md)
- [CustomStringConvertible](swift/customstringconvertible.md)
- [Equatable](swift/equatable.md)
- [Hashable](swift/hashable.md)
- [NSObjectProtocol](objectivec/nsobjectprotocol.md)
- [Sendable](swift/sendable.md)
- [SendableMetatype](swift/sendablemetatype.md)

## See Also

### Interpreting data

- [SRAmbientLightSample](sensorkit/srambientlightsample.md)
- [SRDeviceUsageReport](sensorkit/srdeviceusagereport.md)
- [SRMediaEvent](sensorkit/srmediaevent.md)
- [SRMessagesUsageReport](sensorkit/srmessagesusagereport.md)
- [SRPhoneUsageReport](sensorkit/srphoneusagereport.md)
- [SRVisit](sensorkit/srvisit.md)
- [SRWristDetection](sensorkit/srwristdetection.md)