Where to Find VisionCamera Documentation and API Reference

Updated

The VisionCamera documentation and API reference are both hosted on the official site at visioncamera.margelo.com. The homepage exposes two primary entry points: Get Started and API Reference, plus a search function (⌘ K) for locating specific topics. Use Get Started when you are installing the library and wiring up your first camera; use API Reference when you already have it running and need the exact props, methods, or types for a specific component.

What each entry point is for

Entry point Use it when What you get
Get Started First-time setup in a React Native project Installation and initial integration guidance
API Reference You know what you want to build and need exact interfaces Lookup of specific components, props, and methods
Search (⌘ K) You know a term but not where it lives Direct jump to the matching doc page

How to use them in practice

  1. Open visioncamera.margelo.com.
  2. If the library is not yet in your project, start with Get Started and follow it in order — it assumes you are beginning from an unconfigured app.
  3. Once the camera renders, switch to API Reference for the specific surface you are working on (for example, capture options or frame processing).
  4. When you hit a term you cannot place, press ⌘ K and search it rather than browsing the sidebar.

The expected result at each stage: after Get Started you have a working camera view; after consulting API Reference you have the correct prop or method signature for the feature you are adding.

Common sticking points

  • Skipping Get Started. Jumping straight to API Reference usually fails because the reference assumes the native setup from the getting-started flow is already done.
  • Treating the homepage as the docs. The homepage is a landing page with navigation; the actual content lives behind the two links above.
  • Guessing at interfaces. Because the site ships a searchable reference, there is no reason to infer prop names — look them up.

Related questions this answers

  • What is VisionCamera? — a React Native camera library supporting photo and video capture, QR/barcode scanning, and frame processors.
  • What features does VisionCamera support for React Native apps? — see the feature list on the site and the corresponding API Reference sections.

For anything version-specific or platform-specific, the API Reference is the authoritative source; the site does not publish pricing or account requirements on the pages referenced here.