获取截图 - Publish Helper API

请求参数

Query 参数

path

string

必需

视频路径（也可以是上级文件夹）

示例值:

D:/viedo/1.mp4

screenshotStoragePath

string

可选

图片储存路径（文件夹）（如果为空，则自动从后台读取）

示例值:

D:/pic

screenshotNumber

string

可选

获取的图片数量（0-5）（如果为空，则自动从后台读取）

示例值:

3

screenshotThreshold

string

可选

关键帧复杂度（不建议大于50）（如果为空，则自动从后台读取）

示例值:

30.0

screenshotStartPercentage

string

可选

截图开始位置的百分比（小数表示）（如果为空，则自动从后台读取）

示例值:

0.08

screenshotEndPercentage

string

可选

截图结束位置的百分比（小数表示）（如果为空，则自动从后台读取）

示例值:

0.92

screenshotMinInterval

string

可选

最小帧间隔百分比，默认0.01（小数表示）（如果为空，则自动从后台读取）

示例值:

0.01

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '127.0.0.1:5372/api/getScreenshot?path=D:/viedo/1.mp4&screenshotStoragePath=D:/pic&screenshotNumber=3&screenshotThreshold=30.0&screenshotStartPercentage=0.08&screenshotEndPercentage=0.92&screenshotMinInterval=0.01'

返回响应

🟢200成功

application/json

Body

data

object

数据

必需

包含返回数据

screenshotNumber

string

图片数量

必需

实际获得的截图数量

screenshotPath

array[string]

图片路径

必需

实际获得的截图的路径

videoPath

string

视频路径

必需

实际截图的视频路径

message

string

提示信息

必需

用于返回提示信息

statusCode

enum<string>

状态码

必需

提示程序运行状态

枚举值:

OKFILE_PATH_ERRORVALUE_RANGE_ERRORVALUE_RELATIONSHIP_ERRORMISSING_REQUIRED_PARAMETERPARAMETER_RANGE_ERRORBACKEND_PROCESSING_ERRORUNAUTHORIZED_ACCESS_ERRORGENERAL_ERROR

示例

{
  "data": {
    "screenshotNumber": "3",
    "screenshotPath": "D:/pic/20240327-231438-764218.png\nD:/pic/20240327-231438-589603.png\nD:/pic/20240327-231439-743102.png",
    "videoPath": "D:/video/1.mp4"
  },
  "message": "获取截图成功。",
  "statusCode": "OK"
}

🟠400请求有误