Timelapse Services

Timelapse services are a set of APIs that allow you to interact with the Timelapse service.

Pre-requisite: The user has to be signed in to perform the following operations.

Get the timelapse

To get the timelapses for a space within a time range, the following method can be used:

  • spaceId (required): The space ID of the device.
  • from (required): The start of the time range, in epoch milliseconds.
  • to (required): The end of the time range, in epoch milliseconds.
InstaVision.timelapseService.getTimelapse(
  spaceId = spaceId,
  from = from,
  to = to,
  onSuccess = { timelapseResponse ->
    // The timelapse response object
  },
  onError = { error ->
    // The error object contains the error code and message
  }
)

Delete a timelapse

To delete a timelapse, the following method can be used:

  • spaceId (required): The space ID of the device.
  • deleteTimelapseRequest (required): The request object containing the details of the timelapse(s) to delete.
InstaVision.timelapseService.deleteTimelapse(
  spaceId = spaceId,
  deleteTimelapseRequest = deleteTimelapseRequest,
  onSuccess = { deleteTimelapseResponse ->
    // The delete timelapse response object
  },
  onError = { error ->
    // The error object contains the error code and message
  }
)

Get the user deleted timelapses

To get the list of timelapses deleted by the user for a space, the following method can be used:

  • spaceId (required): The space ID of the device.
InstaVision.timelapseService.getUserDeletedTimelapses(
  spaceId = spaceId,
  onSuccess = { deletedTimelapseResponse ->
    // The deleted timelapse response object
  },
  onError = { error ->
    // The error object contains the error code and message
  }
)

Update the timelapse setting

To update the timelapse setting for a device, the following method can be used:

  • spaceId (required): The space ID of the device.
  • deviceId (required): The device ID.
  • request (required): The timelapse settings to apply.
InstaVision.timelapseService.updateTimelapseSetting(
  spaceId = spaceId,
  deviceId = deviceId,
  request = request,
  onSuccess = { cloudSetting ->
    // The cloud setting object
  },
  onError = { error ->
    // The error object contains the error code and message
  }
)

This site uses Just the Docs, a documentation theme for Jekyll.