docs/api: add info about subtitle bool in local processing response
This commit is contained in:
11
docs/api.md
11
docs/api.md
@@ -121,11 +121,12 @@ the response will always be a JSON object containing the `status` key, which is
|
|||||||
| `isHLS` | `boolean` | whether the output is in HLS format (optional) |
|
| `isHLS` | `boolean` | whether the output is in HLS format (optional) |
|
||||||
|
|
||||||
#### output object
|
#### output object
|
||||||
| key | type | value |
|
| key | type | value |
|
||||||
|:-----------|:---------|:----------------------------------------------------------------------------------|
|
|:------------|:----------|:----------------------------------------------------------------------------------|
|
||||||
| `type` | `string` | mime type of the output file |
|
| `type` | `string` | mime type of the output file |
|
||||||
| `filename` | `string` | filename of the output file |
|
| `filename` | `string` | filename of the output file |
|
||||||
| `metadata` | `object` | metadata associated with the file (optional, [see below](#outputmetadata-object)) |
|
| `metadata` | `object` | metadata associated with the file (optional, [see below](#outputmetadata-object)) |
|
||||||
|
| `subtitles` | `boolean` | whether tunnels include a subtitle file |
|
||||||
|
|
||||||
#### output.metadata object
|
#### output.metadata object
|
||||||
all keys in this table are optional.
|
all keys in this table are optional.
|
||||||
|
|||||||
Reference in New Issue
Block a user