跳转至

素材文件

/api/v1/materials

DELETE

Summary:

删除素材库

Description:

删除素材库

Parameters
Name Located in Description Required Schema
data body uids No dto.MaterialBasicDeleteReq
Responses
Code Description Schema
200 {"code": 200, "message": "success"} response.Response
Security
Security Schema Scopes
Bearer

GET

Summary:

分页素材库列表数据

Description:

素材库列表

Parameters
Name Located in Description Required Schema
displayName query 素材名称 No string
type query 类型 No string
page query 页条数 No integer
limit query 页码 No integer
Responses
Code Description Schema
200 {"code": 200, "data": [...]} response.Response & object
Security
Security Schema Scopes
Bearer

POST

Summary:

创建素材库

Description:

创建素材库

Parameters
Name Located in Description Required Schema
data body data Yes dto.MaterialBasicInsertReq
Responses
Code Description Schema
200 {"code": 200, "message": "success"} response.Response
Security
Security Schema Scopes
Bearer

/api/v1/materials/{uid}

GET

Summary:

查询素材库

Description:

查询素材库

Parameters
Name Located in Description Required Schema
uid path uid No string
Responses
Code Description Schema
200 {"code": 200, "data": [...]} response.Response & object
Security
Security Schema Scopes
Bearer

PUT

Summary:

更新素材库

Description:

更新素材库

Parameters
Name Located in Description Required Schema
data body body Yes dto.MaterialBasicUpdateReq
Responses
Code Description Schema
200 {"code": 200, "message": "success"} response.Response
Security
Security Schema Scopes
Bearer

dto.MaterialBasicDeleteReq

Name Type Description Required
uids [ string ] No

dto.MaterialBasicInsertReq

Name Type Description Required
bucket string 素材存储桶 No
cloudProviderType integer 设置类型 No
description string 素材描述 No
displayName string 素材名称 No
duration number 媒体时长 ms No
fileUri string 素材存储地址 No
format string 素材格式 No
internalWorkflowParam common.InternalWorkflowParam 内置工作流参数 No
size integer 素材大小 No
thumbnail string 素材封面地址 No
type integer 素材类型 0=未知 1=视频

dto.MaterialBasicUpdateReq

Name Type Description Required
description string 素材描述 No
displayName string 素材名称 No
duration number 媒体时长 ms No
fileUri string 素材存储地址 No
format string 素材格式 No
size integer 素材大小 No
thumbnail string 素材封面地址 No
type integer 素材类型 0=未知 1=视频
uid string uid No

common.ConfigSwitch

Name Type Description Required
enable integer No

common.InternalWorkflowParam

Name Type Description Required
audit common.ConfigSwitch 技审 No
mediainfo common.ConfigSwitch 视频信息 No
poster common.ConfigSwitch 封面图 No
proxy common.ConfigSwitch 转低码 No
snapshot common.SnapShotConfig 视频截图 No

common.SnapShotConfig

Name Type Description Required
enable integer No
height integer No
interval integer No
start integer No
tileOut common.TileConfig No
type string No
width integer No

common.TileConfig

Name Type Description Required
columns integer No
lines integer No