Skip to main content
PUT
Update video streaming setting check configuration.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

information for a network setting

enabled
boolean

This field is for enabling or disabling the video streaming feature.

customSlateUrl
string | null

URL of the custom slate image shown while a stream is not live. null clears it and falls back to the default slate.

viewerCountDisplayMode
enum<string>
default:always

Client directive for showing the live viewer count. always shows it, hidden never shows it, above-minimum shows it only when the viewer count reaches viewerCountDisplayMinimum. Not enforced by the backend.

Available options:
always,
hidden,
above-minimum
viewerCountDisplayMinimum
integer
default:50

Inclusive threshold used with viewerCountDisplayMode: above-minimum; clients display the count when viewers >= this value.

Required range: 1 <= x <= 1000
moderation
object

This field is for moderation configuration.

Response

Video Streaming setting check configuration

Response for video streaming setting

enabled
boolean

This field is for enabling or disabling the video streaming feature.

customSlateUrl
string | null

URL of the custom slate image shown while a stream is not live. null clears it and falls back to the default slate.

viewerCountDisplayMode
enum<string>
default:always

Client directive for showing the live viewer count. always shows it, hidden never shows it, above-minimum shows it only when the viewer count reaches viewerCountDisplayMinimum. Not enforced by the backend.

Available options:
always,
hidden,
above-minimum
viewerCountDisplayMinimum
integer
default:50

Inclusive threshold used with viewerCountDisplayMode: above-minimum; clients display the count when viewers >= this value.

Required range: 1 <= x <= 1000
moderation
object

This field is for moderation configuration.