50 lines
2.0 KiB
YAML
50 lines
2.0 KiB
YAML
type: object
|
|
properties:
|
|
roomId:
|
|
type: string
|
|
example: 'room-123'
|
|
description: >
|
|
The unique identifier of the room. This ID is generated when the room is created.
|
|
roomIdPrefix:
|
|
type: string
|
|
example: 'room'
|
|
description: >
|
|
The prefix used for the room ID. This prefix is used to generate the room ID.
|
|
creationDate:
|
|
type: number
|
|
example: 1620000000000
|
|
description: >
|
|
The creation date of the room in milliseconds since the Unix epoch.
|
|
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.
|
|
preferences:
|
|
$ref: meet-room-preferences.yaml#/MeetRoomPreferences
|
|
description: The preferences for the room.
|
|
# 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.
|
|
moderatorURL:
|
|
type: string
|
|
example: 'http://localhost:6080/room/room-123?secret=123456'
|
|
description: >
|
|
The URL for the moderator participants to join the room. The moderator role has special permissions to manage the
|
|
room and participants.
|
|
publisherURL:
|
|
type: string
|
|
example: 'http://localhost:6080/room/room-123?secret=654321'
|
|
description: >
|
|
The URL for the publisher participants to join the room. The publisher role has permissions to publish audio and
|
|
video streams to the room.
|