66 lines
2.8 KiB
YAML
66 lines
2.8 KiB
YAML
/recordings:
|
|
post:
|
|
operationId: startRecording
|
|
summary: Start a recording
|
|
description: >
|
|
Start a new recording for an OpenVidu Meet room with the specified room ID.
|
|
tags:
|
|
- Internal API - Recordings
|
|
security:
|
|
- participantTokenCookie: []
|
|
parameters:
|
|
- $ref: '../../components/parameters/internal/x-participant-role.yaml'
|
|
requestBody:
|
|
$ref: '../../components/requestBodies/internal/start-recording-request.yaml'
|
|
responses:
|
|
'201':
|
|
$ref: '../../components/responses/internal/success-start-recording.yaml'
|
|
'400':
|
|
$ref: '../../components/responses/internal/error-invalid-participant-role.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'404':
|
|
$ref: '../../components/responses/error-room-not-found.yaml'
|
|
'409':
|
|
$ref: '../../components/responses/internal/error-recording-conflict.yaml'
|
|
'422':
|
|
$ref: '../../components/responses/validation-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|
|
'503':
|
|
$ref: '../../components/responses/internal/error-service-unavailable.yaml'
|
|
/recordings/{recordingId}/stop:
|
|
post:
|
|
operationId: stopRecording
|
|
summary: Stop a recording
|
|
description: |
|
|
Stops a recording with the specified recording ID.
|
|
|
|
> **Note:** The recording must be in an `ACTIVE` state; otherwise, a 409 error is returned.
|
|
tags:
|
|
- Internal API - Recordings
|
|
security:
|
|
- participantTokenCookie: []
|
|
parameters:
|
|
- $ref: '../../components/parameters/recording-id.yaml'
|
|
- $ref: '../../components/parameters/internal/x-participant-role.yaml'
|
|
responses:
|
|
'202':
|
|
$ref: '../../components/responses/internal/success-stop-recording.yaml'
|
|
'400':
|
|
$ref: '../../components/responses/internal/error-invalid-participant-role.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'404':
|
|
$ref: '../../components/responses/error-recording-not-found.yaml'
|
|
'409':
|
|
$ref: '../../components/responses/internal/error-recording-not-active.yaml'
|
|
'422':
|
|
$ref: '../../components/responses/validation-error.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|