getRecordingStatus.lua
[返回首页]

API说明

获得当前录像状态

参数

HTTP提交参数:GET; POST

通过HTTP测试该API调用 (URL):

Stream
(必需参数)

指定要获取录像状态的码流。

main

主码流

sub

子码流

测试值:

返回

返回JSON格式的结果。该JSON数据的格式如下:

{
/*对象*/

"Result":
数值

200表示OK, 其它错误码含义类似于HTTP Response.

"Status":
"字符串"

状态消息。反馈API执行的结果状态,如有错误,将描述出错的原因。

"Data": {
/*对象*/

"Stream":
"字符串"

当前码流

main

主码流

sub

子码流

"Status":
"字符串"

当前码流的录像状态

started

正在录像 [注:仅当Status为started时,后续参数才有效]

idle

空闲,没有录像

error

错误(未知的)

error.start.nodisk

没有可用的存储器

error.start.nospace

存储空间不足

error.recording.nospace

因存储空间不足,强制停止录像

error.start.not-start

码流没有开启

error.start.not-exist

指定的流不存在

error.start.no-source

没有可用的媒体源

error.start.start-fail

启动录像失败

error.status-error.update-record

更新状态时发生错

"RecordDevice":
"字符串"

录像磁盘的设备号

"SequenceID":
"字符串"

当前录像的序列号。

每次开启的一次录像称为一个“序列”,考虑到文件切割的情况,一个序列中可能有多个录像文件。SequenceID代表该序列的唯一编号。
"RecordPath":
"字符串"

录像文件存放位置(目录)。该目录同时映射在HTTP的访问目录下。

"Files": [
/*数组*/

当前序列中的所有文件清单,数组。每一个元素为以下格式:

{
/*对象*/

"Filename":
"字符串"

文件名

"Size":
整数

文件大小(KB)

}
]
"CurrentFilename":
"字符串"

当前正在录制的文件名

"CurrentSize":
整数

当前文件大小(KB)

"CurrentDuration":
整数

当前文件的持续录像时间(秒)

"CurrentStartTime":
"字符串"

当前文件的开始录像时间(yyyy-mm-dd hh:nn:ss)

"TotalSize":
整数

当前序列所有文件的大小(KB)

"TotalDuration":
整数

当前序列的持续录像时间(秒)

"StartTime":
"字符串"

整个序列的开始录像时间(yyyy-mm-dd hh:nn:ss)

"Format":
"字符串"

录像文件格式

ts

TS文件格式

mp4

MP4文件格式(暂不支持)

}
}

说明

录像文件的完整访问地址是 "RecordPath/Filename",例如 RecordPath = /media/usb/sda1/RECORD/M-20170611-150311-0001,对应文件名为 REC00000001.ts,则访问地址为 /media/usb/sda1/RECORD/M-20170611-150311-0001/REC00000001.ts,您可以通过http直接得到(下载)该文件。

其它说明

Device HTTP API, v1.0