Skip to content

Latest commit

 

History

History
313 lines (250 loc) · 10.1 KB

设备与APP交互指引.md

File metadata and controls

313 lines (250 loc) · 10.1 KB
Raw

VideoSDK设备与APP交互方法指引

基于信令进行双向交互

信令使用场景

  • app需要向ipc设备发送控制(镜头移动等)、查询(录像列表等)、查询设备状态是否可响应直播、获取ip设备信息 等需求可以使用信令来完成

接口及命令格式（c 层与 native 层接口名称略有区别）

SDK信令接口

同步方式
  • 接口描述:同步方式发送信令消息给camera设备并等待回复。同步阻塞方式。
int postCommandRequestSync(const char *id, const unsigned char *command, size_t cmd_len, unsigned char **recv_buf, size_t *recv_len, uint64_t timeout_us);
参数 类型 描述 输入/输出
id const char * 目标camera在app端的唯一标识符 输入
command const unsigned char * 信令控制或查询命令 输入
cmd_len size_t command参数长度 输入
recv_buf unsigned char ** 用于存放camera回复的数据 输出
recv_len size_t * camera回复的数据长度 输出
timeout_us uint64_t 命令超时时间，单位为微秒，值为0时采用默认超时(7500ms左右) 输出
返回值 描述
XP2PERRNONE 成功
XP2PERR* 失败，对应错误码
异步方式
  • 接口描述:发送信令消息给camera设备，不用等待回复。异步非阻塞方式。
int postCommandRequestWithAsync(const char *id, const unsigned char *command, size_t cmd_len);
参数 类型 描述 输入/输出
id const char * 目标camera在app端的唯一标识符 输入
command const unsigned char * 信令控制或查询命令 输入
cmd_len size_t command参数长度 输入
返回值 描述
XP2PERRNONE 成功
XP2PERR* 失败，对应错误码

ipc设备

  • 设备查询(channel固定为0)

    • 查询设备本地录像列表:

      • 按时间查询 action=inner_define&channel=0&cmd=get_record_index&start_time=000&end_time=111

        参数说明：start_time 和 end_time 秒为单位，差值不得小于5s，UNIX时间戳
设备返回的json结构：
{
    "video_list":[
	{
	    "start_time":"<unix时间戳>",
	    "end_time":"<unix时间戳>"
	},
	{
	    "start_time":"<unix时间戳>",
	    "end_time":"<unix时间戳>"
	}
    ]
}

      • 按月查询 action=inner_define&channel=0&cmd=get_month_record&time=yyyymm

        参数说明：
yyyymm中前四位是年份，后两位是月份；
xxxx：表示32位的数字，从低位到高位每一比特代表月份的第几天是否有录像；例如：8320（0010000010000000）表示8号和14号有录像；
设备返回的json结构：
{"video_list"："xxxx"}

      • 暂停回放 action=inner_define&channel=xxx&cmd=playback_pause

        设备返回的json结构：
{"status":"code"}

      • 继续回放 action=inner_define&channel=xxx&cmd=playback_resume

        设备返回的json结构：
{"status":"code"}

      • 录像进度条滑动 action=inner_define&channel=xxx&cmd=playback_seek&time=ssss

        参数说明：ssss是UNIX时间戳,单位s
设备返回的json结构：
{"status":"code"}

    • 获取ipc设备状态,判断是否可以请求视频流(type区分直播(live)和对讲(voice)):action=inner_define&channel=0&cmd=get_device_st&type=(voice/live)&quality=standard

       参数说明：app_connect_num 表示：已连接到设备的APP数量
 返回的json结构： 
 [{"status":"code"，"appConnectNum":"2"}]
      取值 含义
      0 接收请求
      1 拒绝请求
      404 错误请求
      405 连接APP数量超过最大连接数
      406 信令不支持

  • 云台控制信令(channel固定为0)

    • 控制ipc左移:action=user_define&channel=0&cmd=ptz_left
    • 控制ipc右移:action=user_define&channel=0&cmd=ptz_right
    • 控制ipc上移:action=user_define&channel=0&cmd=ptz_up
    • 控制ipc下移:action=user_define&channel=0&cmd=ptz_down

nvr设备

  • 设备查询:返回channel和devicename

    • 查询nvr设备子设备:action=inner_define&cmd=get_nvr_list&nvr=$nvrname

      返回的json结构：
 [
    {"DeviceName":"name1",
    	 "Channel":"1",
    	 "Online":"0"
 	},
    {"DeviceName":"name2",
   	  "Channel":"2",
    	 "Online":"1"
 	}
 ]

    • 查询设备本地录像列表:action=inner_define&channel=xxx&cmd=get_record_index&start_time=000&end_time=111

    • 获取ipc设备状态,判断是否可以请求视频流(type区分直播(live)和对讲(voice)):action=inner_define&channel=xxx&cmd=get_device_st&type=(voice/live)&quality=standard

  • 云台控制信令(channel通过查询指令获取)

    • 控制ipc左移:action=user_define&channel=xxx&cmd=ptz_left
    • 控制ipc右移:action=user_define&channel=xxx&cmd=ptz_right
    • 控制ipc上移:action=user_define&channel=xxx&cmd=ptz_up
    • 控制ipc下移:action=user_define&channel=xxx&cmd=ptz_down

使用示例

  • ipc设备
/* 通过云台控制ipc左移 */
char ipc_ctl_cmd[] = "action=user_define&channel=0&cmd=ptz_left";

/* 
 * 异步方式
 * 控制结果:设备端将指令执行结果发送到app端，SDK通过事先注册的回调通知到用户
 */
postCommandRequestWithAsync($id, ipc_ctl_cmd, strlen(ipc_ctl_cmd));
  • nvr设备(nvr设备发送控制信令前需发送查询信令获取channel)
/* 查询nvr设备子设备 */
char nvr_get_cmd[] = "action=inner_define&cmd=get_nvr_list";

/* 
 * 异步方式
 * 控制结果:设备端将指令执行结果发送到app端，SDK通过事先注册的回调通知到用户
 */
postCommandRequestWithAsync($id, nvr_get_cmd, strlen(nvr_get_cmd));

/* 从回调函数中获取channel */
char *channel = getChannel();

/* 通过云台控制nvr左移 */
char nvr_ctl_cmd[] = "action=user_define&channel=$channel&cmd=ptz_left";

/* 控制nvr设备左移 */
postCommandRequestWithAsync($id, nvr_ctl_cmd, strlen(nvr_ctl_cmd));

基于请求参数进行单向交互

请求参数交互使用场景

  • app需要向ipc设备发送语音数据或向设备端请求视频数据时需要告诉设备端数据格式(高清、标清等)，可以直接使用请求参数达到目的

接口及命令格式

SDK语音对讲及直播接口

语音对讲
  • 接口描述:启动向camera设备发送语音或自定义数据服务。异步非阻塞方式。
void *runSendService(const char *id, const char *params, bool crypto)
参数 类型 描述 输入/输出
id const char * 目标camera在app端的唯一标识符 输入
params const char * 请求参数采用key1=value&key2=value2格式，key不允许以下划线_开头，且key和value中间不能包含&/+=特殊字符 输入
crypto bool 否开启传输层加密 输入
返回值 描述
服务句柄 成功
NULL 失败
视频直播
  • 接口描述:向camera设备请求媒体流，异步回调方式。
void *startAvRecvService(const char *id, const char *params, bool crypto);
参数 类型 描述 输入/输出
id const char * 目标camera在app端的唯一标识符 输入
params const char * 直播(action=live)或回放(action=playback)参数 输入
crypto bool 是否开启传输层加密 输入
返回值 描述
服务句柄 成功
NULL 失败

ipc设备

  • 启动语音对讲

    • 开始语音对讲:channel=0

  • 启动直播(channel固定为0)

    • 直播标准流:ipc.flv?action=live&channel=0&quality=standard
    • 直播高清流:ipc.flv?action=live&channel=0&quality=high
    • 直播超清流:ipc.flv?action=live&channel=0&quality=super

nvr设备

  • 启动语音对讲

    • 开始语音对讲:channel=xxx

  • 启动直播(channel通过查询指令获取)

    • 直播标准流:ipc.flv?action=live&channel=xxx&quality=standard
    • 直播高清流:ipc.flv?action=live&channel=xxx&quality=high
    • 直播超清流:ipc.flv?action=live&channel=xxx&quality=super

使用示例

  • ipc设备
/* 查询设备状态 */
char ipc_state_cmd[] = "action=inner_define&channel=0&cmd=get_device_st&type=(live)&quality=high";

/* 
 * 异步方式
 * 控制结果:设备端将指令执行结果发送到app端，SDK通过事先注册的回调通知到用户
 */
postCommandRequestWithAsync($id, ipc_state_cmd, strlen(ipc_state_cmd));

/* 高清直播 */
char ipc_live_cmd[] = "ipc.flv?action=live&channel=0&quality=high";

/* 
 * 数据流:设备端将数据流发送到app端，SDK通过事先注册的回调通知到用户
 */
startAvRecvService($id, ipc_live_cmd, true);

/* 语音对讲 */
char ipc_voice_cmd[] = "channel=0";

/* 
 * 数据流:使用SDK提供的dataSend接口发送数据
 */
runSendService($id, ipc_voice_cmd, true);
  • nvr设备(nvr设备发送控制信令前需发送查询信令获取channel)
/* 查询nvr设备子设备 */
char nvr_get_cmd[] = "action=inner_define&cmd=get_nvr_list";

/* 
 * 异步方式
 * 控制结果:设备端将指令执行结果发送到app端，SDK通过事先注册的回调通知到用户
 */
postCommandRequestWithAsync($id, nvr_get_cmd, strlen(nvr_get_cmd));

/* 从回调函数中获取channel */
char *channel = getChannel();

/* 查询设备状态 */
char nvr_state_cmd[] = "action=inner_define&channel=$channel&cmd=get_device_st&type=(live)&quality=high";

/* 
 * 异步方式
 * 控制结果:设备端将指令执行结果发送到app端，SDK通过事先注册的回调通知到用户
 */
postCommandRequestWithAsync($id, nvr_state_cmd, strlen(nvr_state_cmd));

/* 高清直播 */
char nvr_live_cmd[] = "ipc.flv?action=live&channel=$channel&quality=high";

/* 
 * 数据流:设备端将数据流发送到app端，SDK通过事先注册的回调通知到用户
 */
startAvRecvService($id, nvr_live_cmd, true);

/* 语音对讲 */
char nvr_voice_cmd[] = "channel=$channel";

/* 
 * 数据流:使用SDK提供的dataSend接口发送数据
 */
runSendService($id, nvr_voice_cmd, true);