Skip to content

Commit 98a0c20

Browse files
committed
局域网探测新增文档
http://tapd.oa.com/NEW_IOT/prong/stories/view/1020393192869350657 Change-Id: Ic20cac349a6980657d78155fd781d1d2b050b6fb
1 parent 1e700ca commit 98a0c20

File tree

1 file changed

+85
-1
lines changed

1 file changed

+85
-1
lines changed

sdk/video-link-android/doc/VideoSDK接口说明.md

Lines changed: 85 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,63 @@
153153
15. 获取局域网内本地代理的端口号
154154
> int getLanProxyPort(String id);
155155
156+
16. 发送一次探测广播, body 为广播内容
157+
158+
> void startSendBroadcast(WlanDetectBody body);
159+
160+
| 参数 | 类型 | 描述 |
161+
| :--- | :------------- | :----------- |
162+
| body | WlanDetectBody | 探测包体内容 |
163+
164+
WlanDetectBody 定义如下
165+
166+
| 参数 | 类型 | 描述 |
167+
| :---------- | :-------------- | :-------------------------------- |
168+
| clientToken | String | 自定义 token 用于验证接收的响应包 |
169+
| productId | String | 发送指定产品 ID 的广播包 |
170+
| deviceNames | List < String > | 发送指定设备名的广播包 |
171+
172+
17. 发送多次探测广播, body 为广播内容,times 为尝试次数
173+
174+
> void startSendBroadcast(WlanDetectBody body, int times);
175+
176+
| 参数 | 类型 | 描述 |
177+
| :---- | :------------- | :------------------- |
178+
| body | WlanDetectBody | 探测包体内容 |
179+
| times | int | 尝试发送探测包的次数 |
180+
181+
WlanDetectBody 定义如下
182+
183+
| 参数 | 类型 | 描述 |
184+
| :---------- | :-------------- | :-------------------------------- |
185+
| clientToken | String | 自定义 token 用于验证接收的响应包 |
186+
| productId | String | 发送指定产品 ID 的广播包 |
187+
| deviceNames | List < String > | 发送指定设备名的广播包 |
188+
189+
18. 设置广播的端口
190+
191+
> void setPort(int port);
192+
193+
| 参数 | 类型 | 描述 |
194+
| :--- | :--- | :----- |
195+
| port | int | 端口号 |
196+
197+
19. 中断发送广播,用于中断正在发送指定次数的广播
198+
199+
> void clearAllTask();
200+
201+
20. 设置探测响应包监听器
202+
203+
> void setOnWlanDevicesDetectedCallback(OnWlanDevicesDetectedCallback onWlanDevicesDetectedCallback);
204+
205+
| 参数 | 类型 | 描述 |
206+
| :---------------------------- | :---------------------------- | :--------------- |
207+
| onWlanDevicesDetectedCallback | OnWlanDevicesDetectedCallback | 广播响应包监听器 |
208+
156209
### 废弃接口
210+
157211
~~public static String getComandRequestWithSync(String cmd, long timeout);~~
212+
158213
* ~~函数说明:以阻塞方式向设备端发送请求资源或控制命令~~
159214
* ~~参数说明:~~
160215
* ~~cmd:命令参数,格式:`action=user_define&cmd=xxx`~~
@@ -217,11 +272,40 @@
217272
| id | String | 回传`startServiceWithXp2pInfo`接口中的`id` |
218273
| msg | String | 附加说明,json格式 |
219274

220-
5、设备向app发送自定义消息,该回调的返回值表示app向设备端回复的消息
275+
5. 设备向app发送自定义消息,该回调的返回值表示app向设备端回复的消息
276+
221277
> override fun onDeviceMsgArrived(id: String?, data: ByteArray?, len: Int): String
222278
279+
6. 设备对 app 探测包的响应包
280+
281+
> override fun onMessage(version: String, resp: WlanRespBody): Boolean
282+
283+
| 参数 | 类型 | 描述 |
284+
| :------ | :----------- | :------- |
285+
| version | String | 版本号 |
286+
| resp | WlanRespBody | 响应包体 |
287+
288+
WlanRespBody 定义如下
289+
290+
| 参数 | 类型 | 描述 |
291+
| :---------- | :--------------- | :----------------------- |
292+
| method | String | 消息类型 |
293+
| clientToken | String | 消息标识,与发送消息一致 |
294+
| timestamp | long | 消息发送的时间 |
295+
| params | DeviceServerInfo | 设备信息 |
296+
| code | int | 状态码,一般是0 |
297+
| status | String | 扩展使用 |
298+
299+
DeviceServerInfo 定义如下
300+
301+
| 参数 | 类型 | 描述 |
302+
| :--------- | :----- | :------------- |
303+
| deviceName | String | 设备的名称 |
304+
| address | String | 设备的 IP 地址 |
305+
| port | int | 设备的端口号 |
223306

224307
### 附带说明
308+
225309
* 函数接口调用顺序:
226310
* setQcloudApiCred
227311
* setCallback

0 commit comments

Comments
 (0)