API Reference

Authorization

ApiKeyAuth

Authorization<token>

Use Bearer br_live_....

In: header

Path Parameters

projectId*string

timelineItemId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

position_preset?string

Value in

"center"
"fullscreen"
"top-half"
"bottom-half"
"pip-top-left"
"pip-top-right"
"pip-bottom-left"
"pip-bottom-right"

position_x?number

Range-2000 <= value <= 2000

position_y?number

Range-2000 <= value <= 2000

width_px?number

Range1 <= value

height_px?number

Range1 <= value

keep_aspect_ratio?boolean

scale?number

Range0.1 <= value <= 3

opacity?number

Range0 <= value <= 1

animation_preset?string

Value in

"none"
"fadeIn"
"fadeOut"
"zoomIn"
"zoomOut"
"slideLeft"
"slideRight"
"slideUp"
"slideDown"
"popIn"
"bounce"
"spin"

remove_animations?boolean

blurred_background?boolean

volume?number

Range0 <= value <= 2

Response Body

`application/json`

curl -X PATCH "https://example.com/projects/string/timeline/media/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "success": true,  "timelineItemId": "string",  "updated": {    "positionX": 0,    "positionY": 0,    "widthPx": 0,    "heightPx": 0,    "keepAspectRatio": true,    "opacity": 0,    "blurredBackground": true,    "volume": 0  },  "animationApplied": "string",  "keyframeCount": 0,  "warnings": [    "string"  ],  "message": "string"}

Update audio timeline item PATCH

Update a zoom effect PATCH

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`