Create a simulcast | FastPix Developer Documentation

How it works

Change to: When you call this endpoint, provide the parent streamId along with the simulcast target details (such as platform and credentials). The API returns a unique simulcastId, which you can use to manage the simulcast later.
To notify your application about the status of simulcast related events check for the webhooks for simulcast target events.

Example

An event manager sets up a live stream for a virtual conference and wants to simulcast the stream on YouTube and Facebook Live. They first create the primary live stream in FastPix, ensuring it’s in the idle state. Then, they use the API to create a simulcast target for YouTube.

Related guide: Simulcast to 3rd party platforms

Creates a simulcast for a parent live stream. Simulcasting allows you to broadcast a live stream to multiple social platforms simultaneously (for example, YouTube, Facebook, or Twitch). This helps expand your audience reach across platforms. A simulcast can only be created when the parent live stream is in the idle state (not currently live or disabled). Only one simulcast target can be created per API call. #### How it works 1. Change to: When you call this endpoint, provide the parent `streamId` along with the simulcast target details (such as platform and credentials). The API returns a unique `simulcastId`, which you can use to manage the simulcast later. 2. To notify your application about the status of simulcast related events check for the <a href="https://docs.fastpix.io/docs/webhooks-collection#simulcast-target-events">webhooks for simulcast</a> target events. #### Example An event manager sets up a live stream for a virtual conference and wants to simulcast the stream on YouTube and Facebook Live. They first create the primary live stream in FastPix, ensuring it's in the idle state. Then, they use the API to create a simulcast target for YouTube. Related guide: <a href="https://docs.fastpix.io/docs/simulcast-to-3rd-party-platforms">Simulcast to 3rd party platforms</a>

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

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. - <b>Username:</b> Access Token ID - <b>Password:</b> Secret Key Activate your FastPix account to generate your API credentials. <a href="https://docs.fastpix.io/docs/activate-account" target="_blank">See the guide here</a>

Path parameters

streamIdstringRequired

After creating a new live stream, FastPix assigns a unique identifier to the stream.

Request

This endpoint expects an object.

urlstringRequiredDefaults to rtmp://example.com/

The RTMPS hostname, combined with the application name, is crucial for connecting to third-party live streaming services and transmitting the live stream.

streamKeystringRequiredDefaults to d851d91d5b768b36k61a264dcc447b

A unique stream key is generated for streaming, allowing the user to start streaming on any third-party platform using this key.

metadatamap from strings to stringsOptional

You can search for videos with specific key-value pairs using metadata, when you tag a video in “key”:“value” pairs.

Response

New Simulcast created successfully

successboolean

Shows the request status. Returns true for success and false for failure.

dataobject

Displays the result of the request.

How it works

Change to: When you call this endpoint, provide the parent streamId along with the simulcast target details (such as platform and credentials). The API returns a unique simulcastId, which you can use to manage the simulcast later.
To notify your application about the status of simulcast related events check for the webhooks for simulcast target events.

Example

Related guide: Simulcast to 3rd party platforms

$	curl -X POST https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/simulcast \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"url": "rtmp://hyd01.contribute.live-video.net/app/",
>	"streamKey": "live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk",
>	"metadata": {
>	"livestream_name": "Tech-Connect Summit"
>	}
>	}'

1	{
2	"success": true,
3	"data": {
4	"simulcastId": "8717422d89288ad5958d4a86e9afe2a2",
5	"url": "rtmp://hyd01.contribute.live-video.net/app/",
6	"streamKey": "live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk",
7	"isEnabled": true,
8	"metadata": {
9	"livestream_name": "Tech-Connect Summit"
10	}
11	}
12	}