X_NightOwl_recording
X_NightOwl_recording
JSON commands related to X_NightOwl_recording
X_NightOwl_queryEventList
Summary
X_NightOwl_queryEventList
Description
The query result is always decreasing by time, Use latest command first to get initial listNumber items and get queryID, Use next with queryID to get next listNumber items, Use previous with queryID to get previous listNumber items, Please do not respond the queryID if there is no items at all (No SD card in IPcam).
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| startTime | query | startTime | Yes | long |
| eventTypes | query | Event type (trigger values):pir, pixelChange, human, face, vehicle, animal, familiar, unfamiliar, doorbellRing, motionSensor, doorSensor, babyCry, fireAlarm, gunShot, moved, lowBattery, timelapse, continuous. | Yes | [ string ] |
| channels | query | channels | Yes | [ integer ] |
| command | query | latest:the closest events from the startTime moving backward with time, and the events are sorted by decreasing of time. previous:moving forward with time of previous listNumber items, and the events are sorted by decreasing of time. next:moving backward with time of next listNumber items, and the events are sorted by decreasing of time. | Yes | string |
| queryID | query | queryID | No | integer |
| listNumber | query | listNumber | Yes | integer |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | successful operation | X_NightOwl_queryEventListResponse |
| 400 | Bad |
X_NightOwl_startEventDownload
Summary
X_NightOwl_startEventDownload
Description
startTime:UNIX timestamp. duration unit:second. X_NightOwl_getEventDownloadCapability => produceMode => dynamic (the event file will be reproduced after receiving command X_NightOwl_startEventDownload)
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| channel | query | channel | Yes | integer |
| startTime | query | startTime | Yes | long |
| duration | query | duration | Yes | long |
| resolution | query | resolution | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | successful operation | X_NightOwl_startEventDownloadResponse |
| 400 | Bad |
X_NightOwl_getEventDownloadProgress
Summary
X_NightOwl_getEventDownloadProgress
Description
X_NightOwl_getEventDownloadProgress
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| processId | query | processId | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | successful operation | X_NightOwl_getEventDownloadProgressResponse |
| 400 | Bad |
X_NightOwl_queryRecordingCalendar
Summary
X_NightOwl_queryRecordingCalendar
Description
This command only provides the query result of events, not continuous recordings
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| resolution | query | resolution | Yes | string |
| year | query | year | Yes | integer |
| month | query | month | Yes | integer |
| day | query | day | Yes | integer |
| channels | query | channels | No | [ integer ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | successful operation | X_NightOwl_queryRecordingCalendarResponse |
| 400 | Bad |
X_NightOwl_getEventDownloadCapability
Summary
X_NightOwl_getEventDownloadCapability
Description
X_NightOwl_getEventDownloadCapability
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | successful operation | X_NightOwl_getEventDownloadCapabilityResponse |
| 400 | Bad |
X_NightOwl_startEventDownloadwithURL
Summary
X_NightOwl_startEventDownloadwithURL
Description
X_NightOwl_getEventDownloadCapability => produceMode => static (the event file has already been reproduced)
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| channel | query | channel | Yes | integer |
| startTime | query | startTime | Yes | long |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | successful operation | X_NightOwl_startEventDownloadwithURLResponse |
| 400 | Bad |
X_NightOwl_queryEventCalendar
Summary
X_NightOwl_queryEventCalendar
Description
This command only provides the query result of events, not continuous recordings
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| resolution | query | resolution | Yes | string |
| year | query | year | Yes | integer |
| month | query | month | Yes | integer |
| day | query | day | Yes | integer |
| channels | query | channels | Yes | [ integer ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | successful operation | X_NightOwl_queryEventCalendarResponse |
| 400 | Bad |
X_NightOwl_queryRecordingInterval
Summary
X_NightOwl_queryRecordingInterval
Description
This command only provides the query result of continuous recordings, not events
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| year | query | year | Yes | integer |
| month | query | month | Yes | integer |
| day | query | day | Yes | integer |
| channels | query | channels | Yes | [ integer ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | successful operation | X_NightOwl_queryRecordingIntervalResponse |
| 400 | Bad |
X_NightOwl_queryEventListWithSpecificOrder
Summary
X_NightOwl_queryEventListWithSpecificOrder
Description
The query result is always decreasing by time. Use latest command first to get initial listNumber items and get queryID. Use next with queryID to get next listNumber items. Use previous with queryID to get previous listNumber items.Please do not respond the queryID if there is no items at all (No SD card in IPcam).
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| startTime | query | startTime | Yes | long |
| order | query | Order descending:query event in descending order from startTime to earliest event. Order ascending:query event in ascending order from startTime to latest event. | Yes | string |
| eventTypes | query | Event type (trigger):pir, pixelChange, human, face, vehicle, animal, familiar, unfamiliar, doorbellRing, motionSensor, doorSensor, babyCry, fireAlarm, gunShot, moved, lowBattery. | Yes | [ string ] |
| channels | query | channels | Yes | [ integer ] |
| command | query | command | Yes | string |
| queryID | query | queryID | Yes | integer |
| listNumber | query | listNumber | Yes | integer |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | successful operation | X_NightOwl_queryEventListWithSpecificOrderResponse |
| 400 | Bad |