S20.AI - Capture SDK

This is the npm package for S20.AI's capture-sdk

Contents

• Overview
  • Installation
  • Usage
  • Advanced Usage
• Credits

Overview

Installation

For Proper Installation of the SDK, make sure following steps are followed:

• npm i react-native-camera react-native-vision-camera (look into setup for both packages on their respective npmjs pages)

• npm install @s20.ai/capture-sdk @react-native-camera-roll/camera-roll @react-native-community/slider react-native-fs react-native-orientation-locker react-native-vector-icons react-native-video deprecated-react-native-prop-types uuid react-native-get-random-values react-native-digest-fetch react-native-blob-util react-native-canvas react-native-webview react-native-fs @react-native-async-storage/async-storage react-native-vector-icons @s20.ai/safecam-360-rn-lite react-native-drop-shadow react-native-haptic-feedback @react-native-community/blur react-native-linear-gradient react-native-snap-carousel --legacy-peer-deps (additional setup is required for react-native-vector-icons, react-native-orientation-locker, react-native-fs)

• delete the node_modules directory created for @s20.ai/capture-sdk

• (optional) if your app does not use redux, you need to install react-redux npm i react-redux

Usage

1import SafecamCapture from "@s20.ai/capture-sdk";
2
3const MySafecamCapture = () => {
4  return (
5    <View style={{ flex: 1 }}>
6      <SafecamCapture productID={productID} sop={SOP_Config} />
7    </View>
8  );
9};
10export default MySafecamCapture;

Advanced Usage

The sdk can add dynamic slots to the given SOP, for the process to work a few steps need to be done.

• import the SafecamCaptureRef type from sdk
• create a ref and attach it to the sdk
• on the ref object, imperatively invoke the function addDynamic() with a valid SOP slot array

NOTE

• The slot array specified will be appended to the first step containing a slotType of IMPERFECTION or FEATURE
• If such a step does not exist in the provided SOP, then it will be created for you, under the title Imperfections, and the given slot array will be appended to it

1import SafecamCapture, { SafecamCaptureRef } from "@s20.ai/capture-sdk";
2
3const MySafecamCapture = () => {
4  const ref = useRef < SafecamCaptureRef > null;
5
6  useEffect(() => {
7    setTimeout(() => {
8      ref.current?.addDynamic([
9        {
10          refKey: "exterior-360-spin",
11          postprocessingServices: [
12            {
13              service_id: "hotspot_tracking",
14            },
15          ],
16          action: {
17            captureType: "Image",
18            title: "exterior-imperfection-1",
19            sourceType: "DeviceCamera",
20          },
21          slotType: "IMPERFECTION",
22          title: "windshield wiper broken",
23        },
24      ]);
25    }, 10000);
26  }, []);
27
28  return (
29    <View style={{ flex: 1 }}>
30      <SafecamCapture productID={productID} sop={SOP_Config} ref={ref} />
31    </View>
32  );
33};
34export default MySafecamCapture;

Credits

Written by [Gaurav Singh] at S20.ai