Room

A shared audio space containing zero or more session members.
View as Markdown

A Room is a shared audio resource identified by room_id. Room playback and a room Recording are reflected in the full resource returned by the get method.

Methods

The list method returns RoomSummary projections. Use the get method when you need the complete Room representation shown below.

Resource representation

The Room resource
1{
2 "created_at": "2023-01-01T00:00:00Z",
3 "member_count": 0,
4 "playback_operation_uuid": "string",
5 "playback_status": "stopped",
6 "playback_urls": [
7 "string"
8 ],
9 "playback_volume": 0,
10 "room_id": "string"
11}

Properties

created_atdatetimeRequired
member_countintegerRequired
Current number of members in the room.
playback_operation_uuidstringRequired
playback_statusenumRequired
Allowed values:
playback_urlslist of stringsRequired
playback_volumeintegerRequired0-200Defaults to 0
room_idstringRequired