Get streaming settings

GET/settings/streaming/

read Read: looks, changes nothing. Scopes

What viewers see while a channel cannot start (a video, and for how long), and whether streaming servers may use their video card. Panel operators only.

Response

200 OK

down_video_enabledboolean
Viewers of a channel that cannot start watch it for a while, then their player tries the channel again. Off: the player gets an error at once.
down_video_secondsinteger
How long a viewer watches it before the player tries the channel again.
down_video_namestringrequiredread-only
Empty: the Minimus "No signal" video.
has_own_videobooleanrequiredread-only
use_video_cardboolean
NVIDIA (NVENC), Intel or AMD cards encode transcoded streams and the converted titles of created channels for a fraction of the processor. Off: the processor encodes.

Errors

401 No credential, or one that is wrong, expired or revoked.
403 The account, or the key's or app's scopes, may not do this.
429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means

cURL

curl 'https://panel.example.com/settings/streaming/' \
  -H "Authorization: Bearer $MINIMUS_API_KEY"

Python

import os
import requests

response = requests.get(
    "https://panel.example.com/settings/streaming/",
    headers={"Authorization": f"Bearer {os.environ['MINIMUS_API_KEY']}"},
)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://panel.example.com/settings/streaming/', {
  method: 'GET',
  headers: { Authorization: `Bearer ${process.env.MINIMUS_API_KEY}` },
});
if (!response.ok) throw new Error(`${response.status}`);
console.log(await response.json());

Response 200

{
  "down_video_enabled": true,
  "down_video_seconds": 1,
  "down_video_name": "string",
  "has_own_video": true,
  "use_video_card": true
}

Get streaming settings

Response#

200 OK

Errors#

Response

Errors