截图接口

说明

本页由企业版 OpenAPI 文档整理，模块：自动化接口/截图。

抓PNG图片-无需开启自动化

POST /openapi/captureFullScreenNoAutoByte

EC 中控3.0.0+修改为POST，之前的都是GET

请求 Body

1
{
2
    "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/captureFullScreenNoAutoByte", json=body, timeout=30)
7
print(r.status_code, len(r.content))

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/captureFullScreenNoAutoByte", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const buf = await res.arrayBuffer();
10
console.log(res.status, buf.byteLength);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/captureFullScreenNoAutoByte" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/captureFullScreenNoAutoByte", content);
6
var bytes = await res.Content.ReadAsByteArrayAsync();
7
Console.WriteLine($"{(int)res.StatusCode} {bytes.Length}");

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» deviceId	body	string	是	设备ID

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

预抓图片

POST /openapi/startPreCapScreen

EC 中控3.0.0+修改为POST，之前的都是GET

配合[抓图片流] 和 [关闭图片流接口] 使用如果不想要开启自动化，types参数设置为1

请求 Body

1
{
2
    "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
    "delay": 32,
4
    "quality": 1,
5
    "types": 10
6
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "delay": 32,
6
  "quality": 1,
7
  "types": 10
8
}
9
r = requests.post("http://127.0.0.1:8019/openapi/startPreCapScreen", json=body, timeout=30)
10
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "delay": 32,
4
  "quality": 1,
5
  "types": 10
6
};
7
const res = await fetch("http://127.0.0.1:8019/openapi/startPreCapScreen", {
8
  method: "POST",
9
  headers: { "Content-Type": "application/json" },
10
  body: JSON.stringify(body),
11
});
12
const data = await res.json();
13
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/startPreCapScreen" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","delay":32,"quality":1,"types":10}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"delay\":32,\"quality\":1,\"types\":10}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/startPreCapScreen", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		设备ID
» delay	body	integer	是		none
» quality	body	integer	是		图片质量，type=1的时候，支持 1， 50， 100，三种不同的质量标准
» types	body	integer	是	类型	10 代表PNG格式，没有任何压缩，不开自动化也能截图

详细说明

» quality: 图片质量，type=1的时候，支持 1， 50， 100，三种不同的质量标准当type =2 的时候，支持1-100图片质量

» types: 10 代表PNG格式，没有任何压缩，不开自动化也能截图 1 代表截图 jpg格式的方式1 2 代表截图 jpg格式方式2 3 代表png格式，png不支持质量参数，根据自己机器情况调用

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

重置无权限截图的环境

POST /openapi/resetCaptureScreenNoAutoEnv

对应 image.resetCaptureScreenNoAutoEnv 函数

请求 Body

1
{
2
    "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/resetCaptureScreenNoAutoEnv", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/resetCaptureScreenNoAutoEnv", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/resetCaptureScreenNoAutoEnv" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/resetCaptureScreenNoAutoEnv", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		设备ID

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

抓取JPG图片

POST /openapi/captureFullScreenJpg

EC 中控3.0.0+修改为POST，之前的都是GET

请求 Body

1
{
2
    "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/captureFullScreenJpg", json=body, timeout=30)
7
print(r.status_code, len(r.content))

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/captureFullScreenJpg", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const buf = await res.arrayBuffer();
10
console.log(res.status, buf.byteLength);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/captureFullScreenJpg" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/captureFullScreenJpg", content);
6
var bytes = await res.Content.ReadAsByteArrayAsync();
7
Console.WriteLine($"{(int)res.StatusCode} {bytes.Length}");

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		设备ID

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

抓取JPG图片扩展

POST /openapi/captureFullScreenByteEx

EC 中控3.1.0+修改为POST，之前的都是GET

请求 Body

1
{
2
    "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
    "type": "1",
4
    "quality": "50"
5
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "type": "1",
6
  "quality": "50"
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/captureFullScreenByteEx", json=body, timeout=30)
9
print(r.status_code, len(r.content))

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "type": "1",
4
  "quality": "50"
5
};
6
const res = await fetch("http://127.0.0.1:8019/openapi/captureFullScreenByteEx", {
7
  method: "POST",
8
  headers: { "Content-Type": "application/json" },
9
  body: JSON.stringify(body),
10
});
11
const buf = await res.arrayBuffer();
12
console.log(res.status, buf.byteLength);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/captureFullScreenByteEx" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","type":"1","quality":"50"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"type\":\"1\",\"quality\":\"50\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/captureFullScreenByteEx", content);
6
var bytes = await res.Content.ReadAsByteArrayAsync();
7
Console.WriteLine($"{(int)res.StatusCode} {bytes.Length}");

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» deviceId	body	string	是	设备ID
» type	body	string	是	抓图模式分别为1 和 2
» quality	body	string	是	抓图质量，type=1的时候支持 1，50，100

详细说明

» quality: 抓图质量，type=1的时候支持 1，50，100 type=2的时候支持 1 - 100

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

抓取图片流

POST /openapi/captureScreenStreamByte

请求 Body

1
{
2
    "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/captureScreenStreamByte", json=body, timeout=30)
7
print(r.status_code, len(r.content))

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/captureScreenStreamByte", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const buf = await res.arrayBuffer();
10
console.log(res.status, buf.byteLength);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/captureScreenStreamByte" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/captureScreenStreamByte", content);
6
var bytes = await res.Content.ReadAsByteArrayAsync();
7
Console.WriteLine($"{(int)res.StatusCode} {bytes.Length}");

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		设备ID

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

抓取PNG图片

POST /openapi/captureFullScreenPng

请求 Body

1
{
2
  "deviceId": "string"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "string"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/captureFullScreenPng", json=body, timeout=30)
7
print(r.status_code, len(r.content))

1
const body = {
2
  "deviceId": "string"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/captureFullScreenPng", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const buf = await res.arrayBuffer();
10
console.log(res.status, buf.byteLength);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/captureFullScreenPng" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"string"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"string\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/captureFullScreenPng", content);
6
var bytes = await res.Content.ReadAsByteArrayAsync();
7
Console.WriteLine($"{(int)res.StatusCode} {bytes.Length}");

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		设备ID

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

关闭图片流

POST /openapi/stopScreenStream

请求 Body

1
{
2
    "deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/stopScreenStream", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/stopScreenStream", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/stopScreenStream" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/stopScreenStream", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		none

返回示例

200 Response

1
{
2
  "code": 0,
3
  "data": true,
4
  "msg": "string"
5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» data	boolean	true	none	true 成功 false 失败
» msg	string	true	none	错误消息

图片流是否正常

POST /openapi/isScreenStreamOk

请求 Body

1
{
2
    "deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/isScreenStreamOk", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/isScreenStreamOk", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/isScreenStreamOk" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/isScreenStreamOk", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		none

返回示例

200 Response

1
{
2
  "code": 0,
3
  "data": true,
4
  "msg": "string"
5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» data	boolean	true	none	true 成功 false 失败
» msg	string	true	none	错误消息

开启图片流

POST /openapi/startScreenStream

请求 Body

1
{
2
    "deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/startScreenStream", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/startScreenStream", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/startScreenStream" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/startScreenStream", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		none

返回示例

200 Response

1
{
2
  "code": 0,
3
  "data": true,
4
  "msg": "string"
5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» data	boolean	true	none	true 成功 false 失败
» msg	string	true	none	错误消息