CameraApi. Камеры

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

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

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

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

CODE

@GET(FLAT_TREE)
suspend fun getCamerasTree(): List<VMSCameraTree>

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

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

CODE

@GET(FLAT_TREE)
suspend fun getSearchTree(@Query("search") search: String): List<VMSCamera>

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

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

CODE

@GET(CAMERAS_INFO)
suspend fun getCamera(@Path(ID) id: String): VMSCamera

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

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

CODE

@POST(CAMERAS_RENAME)
suspend fun renameCamera(
    @Path(CAMERA) id: String,
    @Body request: VMSRenameCameraRequest
): VMSCamera

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

См. VMSStatics, чтобы получить список возможных проблем в camera_issues.

Если запрос прошел успешно, вы получите пустой ResponseBody.

CODE

@POST(CAMERAS_ISSUE)
suspend fun sendReport(@Path(ISSUE_KEY) key: String, @Path(ID) id: String): ResponseBody

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

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

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

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

CODE

@GET(CAMERAS_PREVIEW)
suspend fun getCamerasPreview(
    @Path(ID) id: String,
    @Query("date") date: String? = null
): VMSUrlPreviewResponse

id - идентификатор камеры.

date - дата кадра с камеры, может быть null.