Skip to navigation
CLOUD PLAYOUT APISimulcast

Add a simulcast target to a channel

This endpoint restreams a Cloud Playout channel to a third-party platform such as YouTube or Twitch, alongside the channel’s own playback.

How it works

  1. Get the RTMP server URL and stream key from the platform you want to restream to.

  2. Make a POST request to this endpoint with the two joined into a single url, so the stream key is the last part of it.

  3. The response returns the simulcast target, including the simulcastId you need to remove it later.

A channel can restream to at most three targets at once.

Example

A broadcaster restreams a live event to both YouTube and Twitch while it plays out on their own channel.

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 channel to restream.

Request

This endpoint expects an object.
urlstringRequired

The RTMP or RTMPS URL to restream to, with the platform's stream key as its last part. It must start with rtmp:// or rtmps://.

Response

Simulcast target added successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
dataobjectOptional