openvidu/backend/openapi/components/schemas/meet-room-config.yaml

50 lines
1.7 KiB
YAML

MeetRoomConfig:
type: object
properties:
chat:
$ref: '#/MeetChatConfig'
description: Config for the chat feature in the room.
recording:
$ref: '#/MeetRecordingConfig'
description: Config for recording the room.
virtualBackground:
$ref: '#/MeetVirtualBackgroundConfig'
description: Config for virtual background in the room.
MeetChatConfig:
type: object
properties:
enabled:
type: boolean
default: true
example: true
description: If true, the room will be allowed to send and receive chat messages.
MeetRecordingConfig:
type: object
properties:
enabled:
type: boolean
default: true
example: true
description: If true, the room will be allowed to record the video of the participants.
allowAccessTo:
type: string
enum:
- admin
- admin_moderator
- admin_moderator_speaker
default: admin_moderator_speaker
example: admin_moderator_speaker
description: |
Defines who can access the recording. Options are:
- `admin`: Only administrators can access the recording.
- `admin_moderator`: Administrators and moderators can access the recording.
- `admin_moderator_speaker`: Administrators, moderators and speakers can access the recording.
MeetVirtualBackgroundConfig:
type: object
properties:
enabled:
type: boolean
default: true
example: true
description: If true, the room will be allowed to use virtual background.