Update a stream | FastPix Developer Documentation

curl -X PATCH https://api.fastpix.com/v1/live/streams/91a264dcc447b63da6fb79ef925cd76d \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "metadata": {
    "livestream_name": "Gaming_stream"
  },
  "reconnectWindow": 100
}'

{
  "success": true,
  "data": {
    "streamId": "fa7f8c0950ea48ebcc5ef9de8c23deaa",
    "streamKey": "3dc5d7641f918baa083a5c52a5bd9cbckfa7f8c0950ea48ebcc5ef9de8c23deaa",
    "srtSecret": "c51739512d0088d98a46925c9b74c73akfa7f8c0950ea48ebcc5ef9de8c23deaa",
    "trial": false,
    "status": "idle",
    "maxResolution": "1080p",
    "maxDuration": 28800,
    "createdAt": "2024-10-15T08:48:31.551351Z",
    "reconnectWindow": 100,
    "enableRecording": true,
    "enableDvrMode": false,
    "mediaPolicy": "public",
    "metadata": {
      "livestream_name": "Gaming_stream"
    },
    "lowLatency": true,
    "closedCaptions": false,
    "playbackIds": [
      {
        "id": "4e43ec52-4775-4f68-a3ff-a57d8a59bba8",
        "accessPolicy": "public"
      }
    ],
    "srtPlaybackResponse": {
      "srtPlaybackStreamId": "playfa7f8c0950ea48ebcc5ef9de8c23deaa",
      "srtPlaybackSecret": "490e707dd4d165c9e38d261b252f9457kfa7f8c0950ea48ebcc5ef9de8c23deaa"
    }
  }
}

This endpoint allows you to modify the parameters of an existing live stream, such as its `metadata` (title, description) or the `reconnectWindow`. It’s useful for making changes to a stream that has already been created but not yet ended. After the live stream is disabled, you cannot update a stream. The updated stream parameters and the `streamId` needs to be shared in the request, and FastPix returns the updated stream details. After the update, <a href="https://docs.fastpix.io/docs/live-events#videolive_streamupdated">video.live_stream.updated</a> webhook event notifies your system. #### Example A host realizes they need to extend the reconnect window for their live stream in case they lose connection temporarily during the event. Or suppose during a multi-day online conference, the event organizers need to update the stream title to reflect the next day"s session while keeping the same stream ID for continuity. Related guide: <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>

curl -X PATCH https://api.fastpix.com/v1/live/streams/91a264dcc447b63da6fb79ef925cd76d \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "metadata": {
    "livestream_name": "Gaming_stream"
  },
  "reconnectWindow": 100
}'

{
  "success": true,
  "data": {
    "streamId": "fa7f8c0950ea48ebcc5ef9de8c23deaa",
    "streamKey": "3dc5d7641f918baa083a5c52a5bd9cbckfa7f8c0950ea48ebcc5ef9de8c23deaa",
    "srtSecret": "c51739512d0088d98a46925c9b74c73akfa7f8c0950ea48ebcc5ef9de8c23deaa",
    "trial": false,
    "status": "idle",
    "maxResolution": "1080p",
    "maxDuration": 28800,
    "createdAt": "2024-10-15T08:48:31.551351Z",
    "reconnectWindow": 100,
    "enableRecording": true,
    "enableDvrMode": false,
    "mediaPolicy": "public",
    "metadata": {
      "livestream_name": "Gaming_stream"
    },
    "lowLatency": true,
    "closedCaptions": false,
    "playbackIds": [
      {
        "id": "4e43ec52-4775-4f68-a3ff-a57d8a59bba8",
        "accessPolicy": "public"
      }
    ],
    "srtPlaybackResponse": {
      "srtPlaybackStreamId": "playfa7f8c0950ea48ebcc5ef9de8c23deaa",
      "srtPlaybackSecret": "490e707dd4d165c9e38d261b252f9457kfa7f8c0950ea48ebcc5ef9de8c23deaa"
    }
  }
}

This endpoint allows you to modify the parameters of an existing live stream, such as its metadata (title, description) or the reconnectWindow. It’s useful for making changes to a stream that has already been created but not yet ended. After the live stream is disabled, you cannot update a stream.

The updated stream parameters and the streamId needs to be shared in the request, and FastPix returns the updated stream details. After the update, video.live_stream.updated webhook event notifies your system.

Example

A host realizes they need to extend the reconnect window for their live stream in case they lose connection temporarily during the event. Or suppose during a multi-day online conference, the event organizers need to update the stream title to reflect the next day”s session while keeping the same stream ID for continuity.

Related guide: Manage streams

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

streamIdstringRequired

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

Request

This endpoint expects an object.

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”s pairs. Dynamic metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.

reconnectWindowintegerOptional60-1800Defaults to 60

In case the software streaming the live, gets disrupted for any reason and gets disconnected from FastPix, the reconnect window defines the duration FastPix waits before automatically terminating the stream. Before starting the stream, you can set the reconnect window time which is up to 1800 seconds.

Response

Stream details updated successfully

successboolean

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

dataobject

Displays the result of the request.

$	curl -X PATCH https://api.fastpix.com/v1/live/streams/91a264dcc447b63da6fb79ef925cd76d \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"metadata": {
>	"livestream_name": "Gaming_stream"
>	},
>	"reconnectWindow": 100
>	}'

1	{
2	"success": true,
3	"data": {
4	"streamId": "fa7f8c0950ea48ebcc5ef9de8c23deaa",
5	"streamKey": "3dc5d7641f918baa083a5c52a5bd9cbckfa7f8c0950ea48ebcc5ef9de8c23deaa",
6	"srtSecret": "c51739512d0088d98a46925c9b74c73akfa7f8c0950ea48ebcc5ef9de8c23deaa",
7	"trial": false,
8	"status": "idle",
9	"maxResolution": "1080p",
10	"maxDuration": 28800,
11	"createdAt": "2024-10-15T08:48:31.551351Z",
12	"reconnectWindow": 100,
13	"enableRecording": true,
14	"enableDvrMode": false,
15	"mediaPolicy": "public",
16	"metadata": {
17	"livestream_name": "Gaming_stream"
18	},
19	"lowLatency": true,
20	"closedCaptions": false,
21	"playbackIds": [
22	{
23	"id": "4e43ec52-4775-4f68-a3ff-a57d8a59bba8",
24	"accessPolicy": "public"
25	}
26	],
27	"srtPlaybackResponse": {
28	"srtPlaybackStreamId": "playfa7f8c0950ea48ebcc5ef9de8c23deaa",
29	"srtPlaybackSecret": "490e707dd4d165c9e38d261b252f9457kfa7f8c0950ea48ebcc5ef9de8c23deaa"
30	}
31	}
32	}