51 lines
2.1 KiB
YAML
51 lines
2.1 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: 1620000800000
|
|
description: >
|
|
The date and time when the room will be deleted (must be one hour in the future or more) represented in milliseconds since the Unix epoch.
|
|
|
|
After this date, the room will be automatically deleted and no new participants can join.
|
|
|
|
If this value is set and the date has already passed, the room is marked for deletion but will only be removed after the last
|
|
participant leaves ("graceful deletion").
|
|
|
|
If this value is not defined, the room will exist indefinitely 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 to join the room. The moderator 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 to join the room. The publisher has permissions to publish audio and
|
|
video streams to the room.
|