Skip to content

Guides ​

Everything you need to use react-native-pose-detection in your app.

Building on the library? You're in the right place. Working on the library? See docs/.

Start here ​

1. Getting startedInstall → live skeleton in five minutes
2. InstallationExpo, bare RN, EAS, release builds
3. Camera controlSwitching, pausing, the three toggles
4. TriggersBusiness logic that runs natively
5. Data deliveryGetting landmarks out without paying for them

Going further ​

Photos and video filesLandmarks from a file, and painted copies of one
What you can buildTrigger syntax, feasibility, honest limits
PerformanceProfiles, the governor, thermal ladder, app size
TroubleshootingWhen something doesn't work, and the log channel

API reference ​

<PoseCamera> propsEvery prop and its default
EventsEvery callback, payload, and error code
Ref methodsswitchCamera, snapshot, getState, …
FunctionsdetectOnImage, exportPose, setLogLevel, every other export
TypesPoseFrame, JointName, wire format
Trigger schemaConditions, emit modes, validation
Camera permissionuseCameraPermission, and why blocked is not denied
Config pluginapp.json options
CLIfetch-model, doctor, clear-cache

Getting the best performance ​

Four decisions are yours and they dominate everything else:

DecisionImpactWhere
Keep data.mode: 'off' and use triggers60 bridge crossings/sec → ~1 per eventdata delivery
Pick the right modellite adds ~5.5 MB, heavy ~29.2 MBperformance
Use select to trim the payloadthree joints is 48 bytes a frame, not 528data delivery
Set active={isFocused}camera off when the screen isn't visiblecamera control

Everything else, the delegate, the frame rate, the resolutions and the thermal response, is measured and chosen for you, and every one of those choices can still be overridden per axis.

MIT licensed. Built from the guides in the repository.