Surveillance Station API
The SurveillanceStation API is an AuthenticatedAPI, that means the user needs to be authenticated before using this API.
Fortunately, the AuthenticatedAPI is smart enough to automatically log the user.
The syno object uses the ss (or surveillanceStation alias) property to interact with the SurveillanceStation API.
Provide Surveillance Station information.
| Method Name | Description | Required params |
|---|---|---|
getSurveillanceStationInfo(callback) |
Provide Surveillance Station information | - |
This API provides a set of methods to acquire camera-related information and to enable/disable cameras.
| Method Name | Description | Required params |
|---|---|---|
listCameras(params, callback) |
List all cameras | - |
getCameraInfo(params, callback) |
Get specific camera settings | cameraIds |
getCameraCapability(params, callback) |
Get capability of a specific camera model |
vendor model
|
getCameraCapabilityById(params, callback) |
Get capability of a specific camera by its camera Id | cameraId |
listCameraGroups(params, callback) |
List all camera group information | - |
enableCamera(params, callback) |
Enable cameras | cameraId |
disableCamera(params, callback) |
Disable cameras | cameraId |
| Method Name | Description | Required params |
|---|---|---|
getCameraSnapshot(params, callback) |
Get the up-to-date snapshot of the selected camera in JPEG format | cameraId |
This API provides a set of methods to execute PTZ action, and to acquire PTZ related information such as patrol list or patrol schedule of a camera.
| Method Name | Description | Required params |
|---|---|---|
movePTZCamera(params, callback) |
Move camera lens |
cameraId direction
|
zoomPTZCamera(params, callback) |
Zoom in or zoom out |
cameraId control
|
listPTZCameraPresets(params, callback) |
List all presets | cameraId |
goPTZCameraToPreset(params, callback) |
Move to pre-defined preset position | cameraId |
listPTZCameraPatrols(params, callback) |
Enumerate the patrol list | cameraId |
runPTZCameraPatrol(params, callback) |
Execute the specific patrol |
cameraId patrolId
|
getPTZCameraPatrolsSchedule(params, callback) |
Get the patrol schedule table | cameraId |
focusPTZCamera(params, callback) |
Focus in or focus out |
cameraId control
|
irisPTZCamera(params, callback) |
Iris in or iris out |
cameraId control
|
autoFocusPTZCamera(params, callback) |
Adjust focus automatically | cameraId |
movePTZCameraToAbsolutePosition(params, callback) |
Move lens to an absolute position on screen |
cameraId posX posY
|
This API provides methods to start or stop external recording of a camera.
| Method Name | Description | Required params |
|---|---|---|
recordCamera(params, callback) |
Start or stop external recording |
cameraId action
|
This API provides method to query event information.
| Method Name | Description | Required params |
|---|---|---|
queryEvents(params, callback) |
Query event list | - |
deleteMultiEvents(params, callback) |
Delete multi-events | idList |
deleteEventFilter(params, callback) |
Delete events by specific filter conditions | - |
deleteAllEvents(params, callback) |
Delete all events that the user has authorized | - |
This API provides methods to get device information such as Visual Station and Slave DS.
| Method Name | Description | Required params |
|---|---|---|
listVisualStationsDevices(params, callback) |
List all installed Visual Stations | - |
listSlaveDSDevices(params, callback) |
List all installed Slave DSs | - |
getServiceSettingDevice(params, callback) |
Get the setting of Centralized Management and Visual Station service | - |
This API provides methods to get information about user-defined E-Maps.
| Method Name | Description | Required params |
|---|---|---|
listEmaps(params, callback) |
List of all E-Maps | - |
getEmapInfo(params, callback) |
Get specific E-Map settings | emapIds |
| Method Name | Description | Required params |
|---|---|---|
getEmapImage(params, callback) |
Get the image of the selected E-Map in its original format | emapId |
NOT IMPLEMENTED
NOT IMPLEMENTED
NOT IMPLEMENTED
This API provides a method to get authorized token of DS, and user can register push service by this token.
| Method Name | Description | Required params |
|---|---|---|
getNotificationRegisterToken(params, callback) |
Get the authorized token of DS | - |