Update Splashscreen (Countdown background image)

Request to update the splashscreen (countdown background image) image of the stream.

Request

Property	Value
Method	`POST`
URL	`https://api.stormstreaming.com/api/request/stream/{stream_key}/set-splashscreen`
Authentication	`x-api-key`

URL Parameters:

Parameter	Description
`{stream_key}`	The stream key of the stream you wish to modify

Request

bash

curl -X POST "https://api.stormstreaming.com/api/request/stream/{stream_key}/set-splashscreen" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "splashscreenFile=@/path/to/splashscreen.jpg"

Request Body

Field	Default	Required	Validation	Description
`splashscreenFile`	-	No	jpeg, png, jpg, gif, webp. Max 8192KB	The splashscreen (waiting room image) will be displayed as a background behind the countdown timer

Request Body

text

splashscreenFile: [binary image file]

Response

Parameter	Type	Description
`message`	string	Response status message

Successful Response (200)

json

{
  "message": "Stream has been updated."
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.