mirror of
https://github.com/truewhile/MeBox.git
synced 2026-09-28 03:06:38 +08:00
truewhile
120 lines
5.3 KiB
Markdown
120 lines
5.3 KiB
Markdown
## 视频字幕列表
|
|
|
|
### 基本信息
|
|
|
|
| 属性 | 内容 |
|
|
|:-------------|:--------------------------------|
|
|
| 接口名称 | 视频字幕列表 |
|
|
| 接口版本 | v1.0 |
|
|
| 接口路径 | /subtitle |
|
|
| 请求方法 | GET |
|
|
| 接口状态 | 生产环境 |
|
|
|
|
### 接口说明
|
|
|
|
获取指定视频的自动载入字幕和可用字幕列表。
|
|
|
|
### 接口地址
|
|
|
|
```
|
|
https://proapi.115.com/open/video/subtitle
|
|
```
|
|
|
|
### 请求方式
|
|
|
|
```
|
|
GET
|
|
```
|
|
|
|
### 认证方式
|
|
|
|
```
|
|
Authorization: Bearer access_token
|
|
```
|
|
|
|
### 请求参数
|
|
|
|
| 参数名 | 类型 | 必填 | 默认值 | 说明 | 约束/示例 |
|
|
|:----------|:-------|:---|:----|:----------|:-----------------|
|
|
| pick_code | string | 是 | - | 视频文件提取码 | b53gu6z3hvqji8wrm |
|
|
|
|
### 请求示例
|
|
|
|
```shell
|
|
curl -G 'https://proapi.115.com/open/video/subtitle' \
|
|
-H 'Authorization: Bearer <access_token>' \
|
|
--data-urlencode 'pick_code=b53gu6z3hvqji8wrm'
|
|
```
|
|
|
|
### 响应字段说明
|
|
|
|
| 字段 | 类型 | 描述 |
|
|
|:----------------------------|:---------|:----------------------------|
|
|
| state | boolean | 操作结果状态，true：成功；false：失败 |
|
|
| message | string | 返回信息，成功时为空字符串 |
|
|
| code | int | 错误码 |
|
|
| data | object | 响应数据 |
|
|
| data.autoload | object | 默认自动载入的字幕；无可用字幕时为空数组 |
|
|
| data.autoload.sid | string | 字幕标识 |
|
|
| data.autoload.language | string | 字幕语言 |
|
|
| data.autoload.title | string | 字幕标题 |
|
|
| data.autoload.url | string | 字幕文件地址 |
|
|
| data.autoload.type | string | 字幕文件类型 |
|
|
| data.autoload.key | string | 内置字幕键，仅内置字幕返回 |
|
|
| data.autoload.sha1 | string | 字幕文件哈希值 |
|
|
| data.autoload.file_id | string | 外挂或内嵌字幕文件ID |
|
|
| data.autoload.file_name | string | 外挂或内嵌字幕文件名 |
|
|
| data.autoload.pick_code | string | 外挂或内嵌字幕文件提取码 |
|
|
| data.autoload.caption_map_id | string | 内嵌字幕映射ID |
|
|
| data.autoload.is_caption_map | int | 是否为内嵌字幕，0：否；1：是 |
|
|
| data.autoload.sync_time | float | 字幕同步时间 |
|
|
| data.autoload.from | int | 记忆字幕来源标识 |
|
|
| data.autoload.user_sub | int | 是否为用户记忆字幕，1：是 |
|
|
| data.list | object[] | 字幕列表 |
|
|
| data.list[].sid | string | 字幕标识 |
|
|
| data.list[].language | string | 字幕语言 |
|
|
| data.list[].title | string | 字幕标题 |
|
|
| data.list[].url | string | 字幕文件地址 |
|
|
| data.list[].type | string | 字幕文件类型 |
|
|
| data.list[].key | string | 内置字幕键，仅内置字幕返回 |
|
|
| data.list[].sha1 | string | 字幕文件哈希值 |
|
|
| data.list[].file_id | string | 外挂或内嵌字幕文件ID |
|
|
| data.list[].file_name | string | 外挂或内嵌字幕文件名 |
|
|
| data.list[].pick_code | string | 外挂或内嵌字幕文件提取码 |
|
|
| data.list[].caption_map_id | string | 内嵌字幕映射ID |
|
|
| data.list[].is_caption_map | int | 是否为内嵌字幕，0：否；1：是 |
|
|
| data.list[].sync_time | float | 字幕同步时间 |
|
|
| data.list[].from | int | 记忆字幕来源标识 |
|
|
| data.list[].user_sub | int | 是否为用户记忆字幕，1：是 |
|
|
|
|
### 响应示例
|
|
|
|
```json
|
|
{
|
|
"state": true,
|
|
"message": "",
|
|
"code": 0,
|
|
"data": {
|
|
"autoload": [],
|
|
"list": []
|
|
}
|
|
}
|
|
```
|
|
|
|
### 业务规则
|
|
|
|
- 用户记忆字幕不在列表中时会被前置；其余字幕按同目录同名外挂字幕、内嵌字幕、内置字幕、其他外挂字幕的顺序组合。
|
|
- 存在用户记忆字幕时优先将其作为自动载入字幕；否则依次选择内嵌字幕、同名外挂字幕或内置字幕。
|
|
- 字幕项来源不同，部分来源专属字段可能不返回。
|
|
|
|
### 注意事项
|
|
|
|
- `access_token` 通过 `Authorization` 请求头传递，请将请求示例中的占位符替换为实际访问令牌。
|
|
- 字幕文件地址具有时效性，请以本次接口返回值为准。
|
|
|
|
### 修改历史
|
|
|
|
| 修改时间 | 修改说明 |
|
|
|:-----------------------------|:-----|
|
|
| 2025年04月01日(周二) 00:00:00 | 创建文档 |
|