Breadcrumbs

CameraApi

API для получения информации о камерах.

Получение главного дерева

Получить все камеры, которые есть у пользователя.

Если запрос прошел успешно, вы увидите список объектов VMSCameraTree. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

getCamerasTree(search: String?, completion: ([VMSCameraTree]?, VMSApiError?))

Поиск камеры

Получить список камер по запросу.

Если запрос прошел успешно, вы получите список найденных объектов VMSCamera. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

getSearchCameras(search: String, completion: ([VMSCamera]?, VMSApiError?))

cancelSearchCamerasRequest() — отменить запрос, если это необходимо

Получение камеры

Получить конкретную информацию о камере по идентификатору камеры.

Если запрос прошел успешно, вы получите объект VMSCamera. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

getCamera(with cameraId: Int, completion: (VMSCamera?, VMSApiError?))

cancelCameraInfoRequest(with cameraId: Int) — отменить запрос, если это необходимо

Переименование камеры

Переименовать камеру по ее идентификатору и новому имени.

Если запрос прошел успешно, вы получите обновленный объект VMSCamera. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

renameCamera(with id: Int, name: String, completion: (VMSCamera?, VMSApiError?))

Отправить жалобу

Отправить жалобу, если с камерой что-то не так. См. StaticsApi, чтобы получить список возможных проблем.

Если запрос прошел успешно, вы получите nil. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

sendReport(info: VMSReportRequest, completion: (VMSApiError?))

VMSReportRequest

Объект с необходимой информацией для отправки отчета.

init(issueId: Int, cameraId: Int)

issueId — идентификатор сообщенной проблемы. Больше информации см. в StaticsApi

cameraId — идентификатор камеры с проблемой

Получение превью камеры

Получить превью камеры на конкретную дату. Вы получите .mp4 файл с одним кадром с камеры.

Если запрос прошел успешно, вы получите URL для загрузки фрейма. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

getCameraPreview(with cameraId: Int, date: String?, completion: (String?, VMSApiError?) -> Void) -> DataRequest?

cancelPreviewCameraRequest(with cameraId: Int) — отменить запрос, если это необходимо