Cameras

Reading and controlling an individual camera: settings, clusters, firmware, PTZ and SD card. Most calls take the Device object; their older spaceId / deviceId overloads are deprecated. The space-level calls (getDevices, getActivityZones, getLatestFirmwareForAllDevices, updateDeviceLocation, updateEmbargoSchedule, updateHuntingMode, getLullabySettings) take spaceId by design. All calls are on InstaVision.deviceServices.

Two settings models

Cameras expose their settings in one of two ways, and which one applies depends on the model:

  • Flat settingsgetDeviceSetting / updateDeviceSetting, with a fixed field per feature.
  • Clusters — a capability-driven model where the camera advertises clusters and each cluster advertises attributes. device.supportsCluster() (true when clusterVersion != "v0") tells you which model the camera uses; the SDK does not guard the calls, so use getDeviceSetting for flat cameras and getDeviceCluster for cluster cameras. The Device.is…() / supports…() extensions already branch on it.

In this section

Page Covers
Device Retrieval and Information Listing cameras, the model record, cluster support
Device Configuration and Update Name, flat settings, spotlight
Device Cloud Settings Cloud / edge AI detections, notifications, motion detection, activity zones
Device Settings Reading current settings
Device Clusters The cluster-based settings model and its extensions
PTZ Control Moving the camera, including cluster step multipliers
Firmware Management Checking, starting and tracking an upgrade; OTA schedule
Device Maintenance SD card formatting, deleting a camera

Product-specific features

Feature Product page
Manual siren, alarm / flood / guide lights, activity and radar zones Home Security → Alarm & Deterrence
Chime Home Security → Doorbell
Lullaby player Baby → Lullaby
Cry detection, temperature and humidity alerts, night lamp Baby → Nursery Monitoring
Hunting / embargo mode, GPS, timelapse, cellular Trail

Pairing session keys are covered with Pairing a Camera; the video-call records with Two-Way Calling.


Table of contents


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