Skip to main content

Create a room composition.

POST 

/room_compositions

Asynchronously create a room composition.

Request

Body

required

Parameters that can be defined during room composition creation.

    format stringnullable

    Default value: mp4

    The desired format of the room composition.

    resolution stringnullable

    Default value: 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

    session_id uuidnullable

    id of the room session associated with the room composition.

    video_layout

    object

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

    property name*

    VideoRegion

    x_pos integernullable

    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_pos integernullable

    Y axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport.

    z_pos integernullable

    Possible values: >= -99 and <= 99

    Regions with higher z_pos values are stacked on top of regions with lower z_pos values

    height integernullable

    Possible values: >= 16

    Height of the video region

    width integernullable

    Possible values: >= 16

    Width of the video region

    max_columns integernullable

    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.

    max_rows integernullable

    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.

    video_sources uuid[]

    Array of video recording ids to be composed in the region. Can be "*" to specify all video recordings in the session

    webhook_event_url url

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

    webhook_event_failover_url urlnullable

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

    webhook_timeout_secs integernullable

    Possible values: <= 30

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

Responses

202: Create room composition response.

Schema

    data

    object

    id uuid

    A unique identifier for the room composition.

    room_id uuid

    Identify the room associated with the room composition.

    session_id uuid

    Identify the room session associated with the room composition.

    user_id uuid

    Identify the user associated with the room composition.

    status string

    Possible values: [completed, enqueued, processing]

    Shows the room composition status.

    size_mb float

    Shows the room composition size in MB.

    download_url string

    Url to download the composition.

    duration_secs integer

    Shows the room composition duration in seconds.

    format string

    Possible values: [mp4]

    Shows format of the room composition.

    created_at datetime

    ISO 8601 timestamp when the room composition was created.

    updated_at datetime

    ISO 8601 timestamp when the room composition was updated.

    ended_at datetime

    ISO 8601 timestamp when the room composition has ended.

    started_at datetime

    ISO 8601 timestamp when the room composition has stated.

    completed_at datetime

    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_pos integernullable

    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_pos integernullable

    Y axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport.

    z_pos integernullable

    Possible values: >= -99 and <= 99

    Regions with higher z_pos values are stacked on top of regions with lower z_pos values

    height integernullable

    Possible values: >= 16

    Height of the video region

    width integernullable

    Possible values: >= 16

    Width of the video region

    max_columns integernullable

    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.

    max_rows integernullable

    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.

    video_sources uuid[]

    Array of video recording ids to be composed in the region. Can be "*" to specify all video recordings in the session

    webhook_event_url url

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

    webhook_event_failover_url urlnullable

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

    webhook_timeout_secs integernullable

    Possible values: <= 30

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

    record_type string

422: Unprocessable entity. Check the 'detail' field in response for details.

Schema

    errors

    Error[]

  • Array [

  • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Loading...