Initiating Image/Video Shoot | iOS SDK Integration

Initiating Image Shoot

Step 1: Start Images Shoot

Call startImageShoot method as follow,

Note: frameNumber can be any positive integer value as per your configuration plan.

Parameters:

  • presentingByViewController: Reference of the current UIViewController.
  • apiKey: Your Spyne API key.
  • uniqueUserId: Any alphanumeric identifier.
  • uniqueShootId: VIN number or another identifier.
  • frameNumber: Number of exterior images to capture.
  • spyneAutomobileDelegate: Callback delegate for handling responses.

Resuming Draft Shoot

Overview: In certain scenarios, a shoot may begin successfully, and multiple images may be captured, but the process might get interrupted due to unexpected events such as:

  1. App crashes
  2. Incoming calls
  3. Device restarts
  4. Accidental app closures
  5. Manual Shoot Exit

To enhance the user experience and minimize data loss, the SDK provides a Draft Shoot Resume Mechanism. This feature ensures that users can resume their shoot session from the exact point where they left off, without needing to start over.

Step 1: Initiate Draft Shoot

To resume a draft shoot, call the method with the same uniqueShootId:

Note: frameNumber can be any positive integer value as per your configuration plan.

Add / Reshoot (Replace) Images

The Spyne SDK provides a Add/Reshoot Flow that allows users to retake or add images of Vehicle Shoots that were previously marked as completed This feature is particularly useful in scenarios where:

  1. The user wants to improve clarity, framing, or lighting for better output.
  2. User wants to add more images to the existing shoot.

Step 1: Initiate Add/Reshoot Image Flow

To add or replace images, pass a valid spyneSkuId and set addReplaceImages: true:

Note: frameNumber can be any positive integer value as per your configuration plan.

QC Reshoot

Overview: The SDK allows a functionality for users to reshoot the images marked as rejected by the QC team due to any reason which may be hampering the output.

  1. The QC (Quality Check) team rejects specific images that require reshooting.
    Note: This feature is only available for clients opting in for Spyne Assured.

Step 1: Initiate QC Reshoot Flow

For QC reshoot, pass a valid spyneSkuId and set isReshoot: true:

Note: frameNumber can be any positive integer value as per your configuration plan.

Resume pending images upload

Invoke this function on your app start to resume image upload if pending any, due to app being closed user after shoot completion or in the middle of shoot

Invoke this function on your app start to resume image upload if pending any, due to app being closed user after shoot completion or in the middle of shoot

Initiate Video Shoot

Step 1: Call startVideoShoot method

On invoking this function, spin-360 shoot flow will start

On invoking this function, spin-360 shoot flow will start

Note: frameNumber can be any positive integer value as per your configuration plan.

Draft Shoot

Step 1: Initiate Draft Shoot

To resume a draft shoot, call the method with the same uniqueShootId:

Note: frameNumber can be any positive integer value as per your configuration plan.

Reshoot Failed Video Shoot

Overview:

Step 1: Resume Failed Video Shoot

To reshoot failed video shoot, pass a valid spyneSkuId and set isReshoot: true:

Note: frameNumber can be any positive integer value as per your configuration plan.

Exterior Tagging

Step 1: Initiate Exterior Tagging Flow

For exterior tagging, pass enableHotspot: true

Note: frameNumber can be any positive integer value as per your configuration plan.

Resume pending images upload

Invoke this function on your app start to resume video upload if pending any, due to app being closed user after shoot completion or in the middle of shoot

Invoke this function on your app start to resume video upload if pending any, due to app being closed user after shoot completion or in the middle of shoot