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

30 lines
1.3 KiB
YAML

type: object
properties:
autoDeletionDate:
type: [number, 'null']
example: 1900000000000
description: |
The timestamp (in milliseconds since the Unix epoch) specifying when the room will be automatically deleted.
This must be at least one hour in the future.
After this time, the room is closed to new participants and scheduled for deletion.
It will be removed after the last participant leaves (graceful deletion).
If not set, the room remains active until manually deleted.
roomIdPrefix:
type: string
example: 'room'
description: >
A prefix to be used for the room ID. The room ID will be generated by concatenating this prefix with an unique identifier.
The maximum length of the room ID is 50 characters.
# maxParticipants:
# type: integer
# example: 10
# description: >
# The maximum number of participants allowed in the room. If the number of participants exceeds
# this limit, new participants will not be allowed to join.
preferences:
$ref: './meet-room-preferences.yaml#/MeetRoomPreferences'
description: >
The preferences for the room. These preferences will be used to configure the room's settings.