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

50 lines
1.8 KiB
YAML

MeetRoomPreferences:
type: object
properties:
chatPreferences:
$ref: '#/MeetChatPreferences'
description: Preferences for the chat feature in the room.
recordingPreferences:
$ref: '#/MeetRecordingPreferences'
description: Preferences for recording the room.
virtualBackgroundPreferences:
$ref: '#/MeetVirtualBackgroundPreferences'
description: Preferences for virtual background in the room.
MeetChatPreferences:
type: object
properties:
enabled:
type: boolean
default: true
example: true
description: If true, the room will be allowed to send and receive chat messages.
MeetRecordingPreferences:
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-publisher
default: admin-moderator-publisher
example: admin-moderator-publisher
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-publisher`: Administrators, moderators and publishers can access the recording.
MeetVirtualBackgroundPreferences:
type: object
properties:
enabled:
type: boolean
default: true
example: true
description: If true, the room will be allowed to use virtual background.