Add studio API documentation

This commit is contained in:
Chocobozzz 2022-08-01 15:48:14 +02:00
parent 15eb9e5b8f
commit f9079a78bd
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
1 changed files with 87 additions and 0 deletions

View File

@ -1671,6 +1671,31 @@ paths:
'404': '404':
description: video not found description: video not found
/videos/{id}/studio/edit:
post:
summary: Create a studio task
tags:
- Video Transcoding
- Video
description: Create a task to edit a video (cut, add intro/outro etc)
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/idOrUUID'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/VideoStudioCreateTask'
responses:
'204':
description: successful operation
'400':
description: incorrect parameters
'404':
description: video not found
/videos: /videos:
get: get:
summary: List videos summary: List videos
@ -7913,6 +7938,68 @@ components:
description: User can select live latency mode if enabled by the instance description: User can select live latency mode if enabled by the instance
$ref: '#/components/schemas/LiveVideoLatencyMode' $ref: '#/components/schemas/LiveVideoLatencyMode'
VideoStudioCreateTask:
type: array
items:
anyOf:
-
title: cut
type: object
properties:
name:
type: string
enum:
- 'cut'
options:
type: object
properties:
start:
type: integer
end:
type: integer
-
title: add-intro
type: object
properties:
name:
type: string
enum:
- 'add-intro'
options:
type: object
properties:
file:
type: string
format: binary
-
title: add-outro
type: object
properties:
name:
type: string
enum:
- 'add-outro'
options:
type: object
properties:
file:
type: string
format: binary
-
title: add-watermark
type: object
properties:
name:
type: string
enum:
- 'add-watermark'
options:
type: object
properties:
file:
type: string
format: binary
LiveVideoSessionResponse: LiveVideoSessionResponse:
properties: properties:
id: id: