Skip to navigation
CLOUD PLAYOUT APIChannel overlays

Update an overlay on a channel

This endpoint changes how an overlay already placed on a Cloud Playout channel looks, without removing and adding it again.

How it works

  1. Make a PATCH request to this endpoint with the ID of the placement, which you can get from the get all overlays on a channel endpoint.

  2. Send only the fields you want to change. At least one field is required.

  3. The response returns the updated placement.

When the overlay runs is fixed once it is placed, so startTime, duration and untilChannelEnd cannot be changed here. To move a placement, remove it and add it again. Which overlay the placement uses is fixed too.

Set customResolution to true to send your own width and height, and position to true to send your own positionX and positionY. The upper bounds come from the channel’s own resolution, so a 1080p channel accepts a width up to 1920 and a height up to 1080.

Send repeat to change how often the overlay comes back on air, or removeRepeat set to true to stop it repeating and leave it on air for the whole placement. The two cannot be sent together.

What you can change depends on the overlay. A dynamic overlay renders its own layout, so size, position, opacity and repeat are not accepted for it. An aston or an L-band keeps the size and position the channel gives it, so only repeat can be changed on those.

Example

A broadcaster nudges its logo further from the frame edge and drops the opacity to 80 while a sponsor card is on air.

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

  • Username: Access Token ID
  • Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Path parameters

channelIdstringRequiredformat: "uuid"
The unique identifier of the loop channel the overlay is placed on.
overlayConfigIdstringRequiredformat: "uuid"

The unique identifier of the placement to update, as returned in the id field by the get all overlays on a channel endpoint.

Request

This endpoint expects an object.
customResolutionbooleanOptional

Set to true to give the overlay your own width and height. When it is false, width and height must be left out.

widthintegerOptional>=10

A new width for the overlay in pixels. Required when customResolution is true, and must not exceed the channel's own width.

heightintegerOptional>=10

A new height for the overlay in pixels. Required when customResolution is true, and must not exceed the channel's own height.

positionbooleanOptional

Set to true to give the overlay your own positionX and positionY. When it is false, positionX and positionY must be left out.

positionXintegerOptional>=0

A new distance of the overlay's left edge from the left edge of the frame, in pixels. Required when position is true.

positionYintegerOptional>=0

A new distance of the overlay's top edge from the top edge of the frame, in pixels. Required when position is true.

opacityintegerOptional1-100
A new opacity for the overlay, from 1 to 100.
repeatobjectOptional

Optional recurrence for a static overlay placement. Without it the overlay stays on air for the whole placement window.

removeRepeatbooleanOptional

Set to true to stop the overlay repeating and leave it on air for the whole placement. It cannot be sent together with repeat.

Response

Overlay updated successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
dataobjectOptional
An overlay placed on a Cloud Playout channel.