View a list of room compositions.
GET/room_compositions
Request
Query Parameters
ISO 8601 date for filtering room compositions created on that date.
ISO 8601 date for filtering room compositions created after that date.
ISO 8601 date for filtering room compositions created before that date.
The session_id for filtering room compositions.
Possible values: [completed
, processing
, enqueued
]
The status for filtering room compositions.
Possible values: >= 1
and <= 250
Default value: 20
The size of the page.
Possible values: >= 1
Default value: 1
The page number to load.
Responses
200: List room compositions response.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
A unique identifier for the room composition.
Identify the room associated with the room composition.
Identify the room session associated with the room composition.
Identify the user associated with the room composition.
Possible values: [completed
, enqueued
, processing
]
Shows the room composition status.
Shows the room composition size in MB.
Url to download the composition.
Shows the room composition duration in seconds.
Possible values: [mp4
]
Shows format of the room composition.
ISO 8601 timestamp when the room composition was created.
ISO 8601 timestamp when the room composition was updated.
ISO 8601 timestamp when the room composition has ended.
ISO 8601 timestamp when the room composition has stated.
ISO 8601 timestamp when the room composition has completed.
video_layout
object
Describes the video layout of the room composition in terms of regions. Limited to 2 regions.
property name*
VideoRegion
X axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport.
Y axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport.
Possible values: >= -99
and <= 99
Regions with higher z_pos values are stacked on top of regions with lower z_pos values
Possible values: >= 16
Height of the video region
Possible values: >= 16
Width of the video region
Possible values: >= 1
and <= 1000
Maximum number of columns of the region's placement grid. By default, the region has as many columns as needed to layout all the specified video sources.
Possible values: >= 1
and <= 1000
Maximum number of rows of the region's placement grid. By default, the region has as many rows as needed to layout all the specified video sources.
Array of video recording ids to be composed in the region. Can be "*" to specify all video recordings in the session
The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'.
The failover URL where webhooks related to this room composition will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
Possible values: <= 30
Specifies how many seconds to wait before timing out a webhook.
meta
object
{
"data": [
{
"completed_at": "2022-02-25T05:39:56.377426Z",
"download_url": null,
"duration_secs": 84,
"ended_at": "2022-02-24T23:22:24.577677Z",
"format": "mp4",
"id": "7103dc53-ee59-4b54-a58b-c77d99ceb037",
"record_type": "composition",
"resolution": "1280x720",
"room_id": "f981dbb3-228a-44e9-ac54-e87f0e2658b0",
"session_id": "8f728d7b-00e2-4c59-8c27-f564b828df87",
"size_mb": 6,
"started_at": "2022-02-24T23:21:00.077209Z",
"status": "enqueued",
"user_id": "12a04ec9-0f91-4a91-9f3a-a19d9931182e",
"video_layout": {
"first": {
"height": 720,
"video_sources": [
"*"
],
"width": 1280,
"x_pos": 0,
"y_pos": 0,
"z_pos": 0
}
},
"webhook_event_url": "https://webhook.site/544663ce-b692-4f9c-80ed-e5ad97cd5c02"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}