Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Parameters that can be defined during room composition creation.

format
string
default:mp4

The desired format of the room composition.

Example:

"mp4"

resolution
string
default:1280x720

The desired resolution (width/height in pixels) of the resulting video of the room composition. Both width and height are required to be between 16 and 1280; and width * height should not exceed 1280 * 720

Example:

"800x600"

session_id
string<uuid>

id of the room session associated with the room composition.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777b0"

video_layout
object

Describes the video layout of the room composition in terms of regions.

webhook_event_url
string<uri>

The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'.

Example:

"https://example.com"

webhook_event_failover_url
string<uri>
default:""

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'.

Example:

"https://failover.example.com"

webhook_timeout_secs
integer

Specifies how many seconds to wait before timing out a webhook.

Required range: 0 <= x <= 30
Example:

25

Response

Create room composition response.

data
object
Example: