diff --git a/index.html b/index.html index d1049c7a..8a973843 100644 --- a/index.html +++ b/index.html @@ -2117,11 +2117,11 @@ data-styled.g140[id="sc-kRRyDe"]{content:"fGGixh,"}/*!sc*/

Configuration

returns the global configuration.

Responses

Response samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "writeQueueSize": 0,
  • "udpMaxPayloadSize": 0,
  • "externalAuthenticationURL": "string",
  • "runOnConnect": "string",
  • "runOnConnectRestart": true,
  • "runOnDisconnect": "string",
  • "api": true,
  • "apiAddress": "string",
  • "apiEncryption": true,
  • "apiServerKey": "string",
  • "apiServerCert": "string",
  • "apiAllowOrigin": "string",
  • "apiTrustedProxies": [
    ],
  • "metrics": true,
  • "metricsAddress": "string",
  • "metricsEncryption": true,
  • "metricsServerKey": "string",
  • "metricsServerCert": "string",
  • "metricsAllowOrigin": "string",
  • "metricsTrustedProxies": [
    ],
  • "pprof": true,
  • "pprofAddress": "string",
  • "pprofEncryption": true,
  • "pprofServerKey": "string",
  • "pprofServerCert": "string",
  • "pprofAllowOrigin": "string",
  • "pprofTrustedProxies": [
    ],
  • "playback": true,
  • "playbackAddress": "string",
  • "playbackEncryption": true,
  • "playbackServerKey": "string",
  • "playbackServerCert": "string",
  • "playbackAllowOrigin": "string",
  • "playbackTrustedProxies": [
    ],
  • "rtsp": true,
  • "protocols": [
    ],
  • "encryption": "string",
  • "rtspAddress": "string",
  • "rtspsAddress": "string",
  • "rtpAddress": "string",
  • "rtcpAddress": "string",
  • "multicastIPRange": "string",
  • "multicastRTPPort": 0,
  • "multicastRTCPPort": 0,
  • "serverKey": "string",
  • "serverCert": "string",
  • "rtspAuthMethods": [
    ],
  • "rtmp": true,
  • "rtmpAddress": "string",
  • "rtmpEncryption": "string",
  • "rtmpsAddress": "string",
  • "rtmpServerKey": "string",
  • "rtmpServerCert": "string",
  • "hls": true,
  • "hlsAddress": "string",
  • "hlsEncryption": true,
  • "hlsServerKey": "string",
  • "hlsServerCert": "string",
  • "hlsAllowOrigin": "string",
  • "hlsTrustedProxies": [
    ],
  • "hlsAlwaysRemux": true,
  • "hlsVariant": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsPartDuration": "string",
  • "hlsSegmentMaxSize": "string",
  • "hlsDirectory": "string",
  • "hlsMuxerCloseAfter": "string",
  • "webrtc": true,
  • "webrtcAddress": "string",
  • "webrtcEncryption": true,
  • "webrtcServerKey": "string",
  • "webrtcServerCert": "string",
  • "webrtcAllowOrigin": "string",
  • "webrtcTrustedProxies": [
    ],
  • "webrtcLocalUDPAddress": "string",
  • "webrtcLocalTCPAddress": "string",
  • "webrtcIPsFromInterfaces": true,
  • "webrtcIPsFromInterfacesList": [
    ],
  • "webrtcAdditionalHosts": [
    ],
  • "webrtcICEServers2": [
    ],
  • "srt": true,
  • "srtAddress": "string"
}

patches the global configuration.

all fields are optional.

-
Request Body schema: application/json
logLevel
string
logDestinations
Array of strings
logFile
string
readTimeout
string
writeTimeout
string
writeQueueSize
integer
udpMaxPayloadSize
integer
externalAuthenticationURL
string
runOnConnect
string
runOnConnectRestart
boolean
runOnDisconnect
string
api
boolean
apiAddress
string
apiEncryption
boolean
apiServerKey
string
apiServerCert
string
apiAllowOrigin
string
apiTrustedProxies
Array of strings
metrics
boolean
metricsAddress
string
metricsEncryption
boolean
metricsServerKey
string
metricsServerCert
string
metricsAllowOrigin
string
metricsTrustedProxies
Array of strings
pprof
boolean
pprofAddress
string
pprofEncryption
boolean
pprofServerKey
string
pprofServerCert
string
pprofAllowOrigin
string
pprofTrustedProxies
Array of strings
playback
boolean
playbackAddress
string
playbackEncryption
boolean
playbackServerKey
string
playbackServerCert
string
playbackAllowOrigin
string
playbackTrustedProxies
Array of strings
rtsp
boolean
protocols
Array of strings
encryption
string
rtspAddress
string
rtspsAddress
string
rtpAddress
string
rtcpAddress
string
multicastIPRange
string
multicastRTPPort
integer
multicastRTCPPort
integer
serverKey
string
serverCert
string
rtspAuthMethods
Array of strings
rtmp
boolean
rtmpAddress
string
rtmpEncryption
string
rtmpsAddress
string
rtmpServerKey
string
rtmpServerCert
string
hls
boolean
hlsAddress
string
hlsEncryption
boolean
hlsServerKey
string
hlsServerCert
string
hlsAllowOrigin
string
hlsTrustedProxies
Array of strings
hlsAlwaysRemux
boolean
hlsVariant
string
hlsSegmentCount
integer
hlsSegmentDuration
string
hlsPartDuration
string
hlsSegmentMaxSize
string
hlsDirectory
string
hlsMuxerCloseAfter
string
webrtc
boolean
webrtcAddress
string
webrtcEncryption
boolean
webrtcServerKey
string
webrtcServerCert
string
webrtcAllowOrigin
string
webrtcTrustedProxies
Array of strings
webrtcLocalUDPAddress
string
webrtcLocalTCPAddress
string
webrtcIPsFromInterfaces
boolean
webrtcIPsFromInterfacesList
Array of strings
webrtcAdditionalHosts
Array of strings
Array of objects[ items ]
srt
boolean
srtAddress
string

Responses

Response samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "writeQueueSize": 0,
  • "udpMaxPayloadSize": 0,
  • "externalAuthenticationURL": "string",
  • "runOnConnect": "string",
  • "runOnConnectRestart": true,
  • "runOnDisconnect": "string",
  • "api": true,
  • "apiAddress": "string",
  • "apiEncryption": true,
  • "apiServerKey": "string",
  • "apiServerCert": "string",
  • "apiAllowOrigin": "string",
  • "apiTrustedProxies": [
    ],
  • "metrics": true,
  • "metricsAddress": "string",
  • "metricsEncryption": true,
  • "metricsServerKey": "string",
  • "metricsServerCert": "string",
  • "metricsAllowOrigin": "string",
  • "metricsTrustedProxies": [
    ],
  • "pprof": true,
  • "pprofAddress": "string",
  • "pprofEncryption": true,
  • "pprofServerKey": "string",
  • "pprofServerCert": "string",
  • "pprofAllowOrigin": "string",
  • "pprofTrustedProxies": [
    ],
  • "playback": true,
  • "playbackAddress": "string",
  • "playbackEncryption": true,
  • "playbackServerKey": "string",
  • "playbackServerCert": "string",
  • "playbackAllowOrigin": "string",
  • "playbackTrustedProxies": [
    ],
  • "rtsp": true,
  • "protocols": [
    ],
  • "encryption": "string",
  • "rtspAddress": "string",
  • "rtspsAddress": "string",
  • "rtpAddress": "string",
  • "rtcpAddress": "string",
  • "multicastIPRange": "string",
  • "multicastRTPPort": 0,
  • "multicastRTCPPort": 0,
  • "serverKey": "string",
  • "serverCert": "string",
  • "rtspAuthMethods": [
    ],
  • "rtmp": true,
  • "rtmpAddress": "string",
  • "rtmpEncryption": "string",
  • "rtmpsAddress": "string",
  • "rtmpServerKey": "string",
  • "rtmpServerCert": "string",
  • "hls": true,
  • "hlsAddress": "string",
  • "hlsEncryption": true,
  • "hlsServerKey": "string",
  • "hlsServerCert": "string",
  • "hlsAllowOrigin": "string",
  • "hlsTrustedProxies": [
    ],
  • "hlsAlwaysRemux": true,
  • "hlsVariant": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsPartDuration": "string",
  • "hlsSegmentMaxSize": "string",
  • "hlsDirectory": "string",
  • "hlsMuxerCloseAfter": "string",
  • "webrtc": true,
  • "webrtcAddress": "string",
  • "webrtcEncryption": true,
  • "webrtcServerKey": "string",
  • "webrtcServerCert": "string",
  • "webrtcAllowOrigin": "string",
  • "webrtcTrustedProxies": [
    ],
  • "webrtcLocalUDPAddress": "string",
  • "webrtcLocalTCPAddress": "string",
  • "webrtcIPsFromInterfaces": true,
  • "webrtcIPsFromInterfacesList": [
    ],
  • "webrtcAdditionalHosts": [
    ],
  • "webrtcICEServers2": [
    ],
  • "webrtcHandshakeTimeout": "string",
  • "webrtcTrackGatherTimeout": "string",
  • "srt": true,
  • "srtAddress": "string"
}

patches the global configuration.

all fields are optional.

+
Request Body schema: application/json
logLevel
string
logDestinations
Array of strings
logFile
string
readTimeout
string
writeTimeout
string
writeQueueSize
integer
udpMaxPayloadSize
integer
externalAuthenticationURL
string
runOnConnect
string
runOnConnectRestart
boolean
runOnDisconnect
string
api
boolean
apiAddress
string
apiEncryption
boolean
apiServerKey
string
apiServerCert
string
apiAllowOrigin
string
apiTrustedProxies
Array of strings
metrics
boolean
metricsAddress
string
metricsEncryption
boolean
metricsServerKey
string
metricsServerCert
string
metricsAllowOrigin
string
metricsTrustedProxies
Array of strings
pprof
boolean
pprofAddress
string
pprofEncryption
boolean
pprofServerKey
string
pprofServerCert
string
pprofAllowOrigin
string
pprofTrustedProxies
Array of strings
playback
boolean
playbackAddress
string
playbackEncryption
boolean
playbackServerKey
string
playbackServerCert
string
playbackAllowOrigin
string
playbackTrustedProxies
Array of strings
rtsp
boolean
protocols
Array of strings
encryption
string
rtspAddress
string
rtspsAddress
string
rtpAddress
string
rtcpAddress
string
multicastIPRange
string
multicastRTPPort
integer
multicastRTCPPort
integer
serverKey
string
serverCert
string
rtspAuthMethods
Array of strings
rtmp
boolean
rtmpAddress
string
rtmpEncryption
string
rtmpsAddress
string
rtmpServerKey
string
rtmpServerCert
string
hls
boolean
hlsAddress
string
hlsEncryption
boolean
hlsServerKey
string
hlsServerCert
string
hlsAllowOrigin
string
hlsTrustedProxies
Array of strings
hlsAlwaysRemux
boolean
hlsVariant
string
hlsSegmentCount
integer
hlsSegmentDuration
string
hlsPartDuration
string
hlsSegmentMaxSize
string
hlsDirectory
string
hlsMuxerCloseAfter
string
webrtc
boolean
webrtcAddress
string
webrtcEncryption
boolean
webrtcServerKey
string
webrtcServerCert
string
webrtcAllowOrigin
string
webrtcTrustedProxies
Array of strings
webrtcLocalUDPAddress
string
webrtcLocalTCPAddress
string
webrtcIPsFromInterfaces
boolean
webrtcIPsFromInterfacesList
Array of strings
webrtcAdditionalHosts
Array of strings
Array of objects[ items ]
webrtcHandshakeTimeout
string
webrtcTrackGatherTimeout
string
srt
boolean
srtAddress
string

Responses

Request samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "writeQueueSize": 0,
  • "udpMaxPayloadSize": 0,
  • "externalAuthenticationURL": "string",
  • "runOnConnect": "string",
  • "runOnConnectRestart": true,
  • "runOnDisconnect": "string",
  • "api": true,
  • "apiAddress": "string",
  • "apiEncryption": true,
  • "apiServerKey": "string",
  • "apiServerCert": "string",
  • "apiAllowOrigin": "string",
  • "apiTrustedProxies": [
    ],
  • "metrics": true,
  • "metricsAddress": "string",
  • "metricsEncryption": true,
  • "metricsServerKey": "string",
  • "metricsServerCert": "string",
  • "metricsAllowOrigin": "string",
  • "metricsTrustedProxies": [
    ],
  • "pprof": true,
  • "pprofAddress": "string",
  • "pprofEncryption": true,
  • "pprofServerKey": "string",
  • "pprofServerCert": "string",
  • "pprofAllowOrigin": "string",
  • "pprofTrustedProxies": [
    ],
  • "playback": true,
  • "playbackAddress": "string",
  • "playbackEncryption": true,
  • "playbackServerKey": "string",
  • "playbackServerCert": "string",
  • "playbackAllowOrigin": "string",
  • "playbackTrustedProxies": [
    ],
  • "rtsp": true,
  • "protocols": [
    ],
  • "encryption": "string",
  • "rtspAddress": "string",
  • "rtspsAddress": "string",
  • "rtpAddress": "string",
  • "rtcpAddress": "string",
  • "multicastIPRange": "string",
  • "multicastRTPPort": 0,
  • "multicastRTCPPort": 0,
  • "serverKey": "string",
  • "serverCert": "string",
  • "rtspAuthMethods": [
    ],
  • "rtmp": true,
  • "rtmpAddress": "string",
  • "rtmpEncryption": "string",
  • "rtmpsAddress": "string",
  • "rtmpServerKey": "string",
  • "rtmpServerCert": "string",
  • "hls": true,
  • "hlsAddress": "string",
  • "hlsEncryption": true,
  • "hlsServerKey": "string",
  • "hlsServerCert": "string",
  • "hlsAllowOrigin": "string",
  • "hlsTrustedProxies": [
    ],
  • "hlsAlwaysRemux": true,
  • "hlsVariant": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsPartDuration": "string",
  • "hlsSegmentMaxSize": "string",
  • "hlsDirectory": "string",
  • "hlsMuxerCloseAfter": "string",
  • "webrtc": true,
  • "webrtcAddress": "string",
  • "webrtcEncryption": true,
  • "webrtcServerKey": "string",
  • "webrtcServerCert": "string",
  • "webrtcAllowOrigin": "string",
  • "webrtcTrustedProxies": [
    ],
  • "webrtcLocalUDPAddress": "string",
  • "webrtcLocalTCPAddress": "string",
  • "webrtcIPsFromInterfaces": true,
  • "webrtcIPsFromInterfacesList": [
    ],
  • "webrtcAdditionalHosts": [
    ],
  • "webrtcICEServers2": [
    ],
  • "srt": true,
  • "srtAddress": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

returns the default path configuration.

Responses

Request samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "writeQueueSize": 0,
  • "udpMaxPayloadSize": 0,
  • "externalAuthenticationURL": "string",
  • "runOnConnect": "string",
  • "runOnConnectRestart": true,
  • "runOnDisconnect": "string",
  • "api": true,
  • "apiAddress": "string",
  • "apiEncryption": true,
  • "apiServerKey": "string",
  • "apiServerCert": "string",
  • "apiAllowOrigin": "string",
  • "apiTrustedProxies": [
    ],
  • "metrics": true,
  • "metricsAddress": "string",
  • "metricsEncryption": true,
  • "metricsServerKey": "string",
  • "metricsServerCert": "string",
  • "metricsAllowOrigin": "string",
  • "metricsTrustedProxies": [
    ],
  • "pprof": true,
  • "pprofAddress": "string",
  • "pprofEncryption": true,
  • "pprofServerKey": "string",
  • "pprofServerCert": "string",
  • "pprofAllowOrigin": "string",
  • "pprofTrustedProxies": [
    ],
  • "playback": true,
  • "playbackAddress": "string",
  • "playbackEncryption": true,
  • "playbackServerKey": "string",
  • "playbackServerCert": "string",
  • "playbackAllowOrigin": "string",
  • "playbackTrustedProxies": [
    ],
  • "rtsp": true,
  • "protocols": [
    ],
  • "encryption": "string",
  • "rtspAddress": "string",
  • "rtspsAddress": "string",
  • "rtpAddress": "string",
  • "rtcpAddress": "string",
  • "multicastIPRange": "string",
  • "multicastRTPPort": 0,
  • "multicastRTCPPort": 0,
  • "serverKey": "string",
  • "serverCert": "string",
  • "rtspAuthMethods": [
    ],
  • "rtmp": true,
  • "rtmpAddress": "string",
  • "rtmpEncryption": "string",
  • "rtmpsAddress": "string",
  • "rtmpServerKey": "string",
  • "rtmpServerCert": "string",
  • "hls": true,
  • "hlsAddress": "string",
  • "hlsEncryption": true,
  • "hlsServerKey": "string",
  • "hlsServerCert": "string",
  • "hlsAllowOrigin": "string",
  • "hlsTrustedProxies": [
    ],
  • "hlsAlwaysRemux": true,
  • "hlsVariant": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsPartDuration": "string",
  • "hlsSegmentMaxSize": "string",
  • "hlsDirectory": "string",
  • "hlsMuxerCloseAfter": "string",
  • "webrtc": true,
  • "webrtcAddress": "string",
  • "webrtcEncryption": true,
  • "webrtcServerKey": "string",
  • "webrtcServerCert": "string",
  • "webrtcAllowOrigin": "string",
  • "webrtcTrustedProxies": [
    ],
  • "webrtcLocalUDPAddress": "string",
  • "webrtcLocalTCPAddress": "string",
  • "webrtcIPsFromInterfaces": true,
  • "webrtcIPsFromInterfacesList": [
    ],
  • "webrtcAdditionalHosts": [
    ],
  • "webrtcICEServers2": [
    ],
  • "webrtcHandshakeTimeout": "string",
  • "webrtcTrackGatherTimeout": "string",
  • "srt": true,
  • "srtAddress": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

returns the default path configuration.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "source": "string",
  • "sourceFingerprint": "string",
  • "sourceOnDemand": true,
  • "sourceOnDemandStartTimeout": "string",
  • "sourceOnDemandCloseAfter": "string",
  • "maxReaders": 0,
  • "srtReadPassphrase": "string",
  • "fallback": "string",
  • "record": true,
  • "recordPath": "string",
  • "recordFormat": "string",
  • "recordPartDuration": "string",
  • "recordSegmentDuration": "string",
  • "recordDeleteAfter": "string",
  • "publishUser": "string",
  • "publishPass": "string",
  • "publishIPs": [
    ],
  • "readUser": "string",
  • "readPass": "string",
  • "readIPs": [
    ],
  • "overridePublisher": true,
  • "srtPublishPassphrase": "string",
  • "rtspTransport": "string",
  • "rtspAnyPort": true,
  • "rtspRangeType": "string",
  • "rtspRangeStart": "string",
  • "sourceRedirect": "string",
  • "rpiCameraCamID": 0,
  • "rpiCameraWidth": 0,
  • "rpiCameraHeight": 0,
  • "rpiCameraHFlip": true,
  • "rpiCameraVFlip": true,
  • "rpiCameraBrightness": 0,
  • "rpiCameraContrast": 0,
  • "rpiCameraSaturation": 0,
  • "rpiCameraSharpness": 0,
  • "rpiCameraExposure": "string",
  • "rpiCameraAWB": "string",
  • "rpiCameraAWBGains": [
    ],
  • "rpiCameraDenoise": "string",
  • "rpiCameraShutter": 0,
  • "rpiCameraMetering": "string",
  • "rpiCameraGain": 0,
  • "rpiCameraEV": 0,
  • "rpiCameraROI": "string",
  • "rpiCameraHDR": true,
  • "rpiCameraTuningFile": "string",
  • "rpiCameraMode": "string",
  • "rpiCameraFPS": 0,
  • "rpiCameraIDRPeriod": 0,
  • "rpiCameraBitrate": 0,
  • "rpiCameraProfile": "string",
  • "rpiCameraLevel": "string",
  • "rpiCameraAfMode": "string",
  • "rpiCameraAfRange": "string",
  • "rpiCameraAfSpeed": "string",
  • "rpiCameraLensPosition": 0,
  • "rpiCameraAfWindow": "string",
  • "rpiCameraTextOverlayEnable": true,
  • "rpiCameraTextOverlay": "string",
  • "runOnInit": "string",
  • "runOnInitRestart": true,
  • "runOnDemand": "string",
  • "runOnDemandRestart": true,
  • "runOnDemandStartTimeout": "string",
  • "runOnDemandCloseAfter": "string",
  • "runOnUnDemand": "string",
  • "runOnReady": "string",
  • "runOnReadyRestart": true,
  • "runOnNotReady": "string",
  • "runOnRead": "string",
  • "runOnReadRestart": true,
  • "runOnUnread": "string",
  • "runOnRecordSegmentCreate": "string",
  • "runOnRecordSegmentComplete": "string"
}

patches the default path configuration.

all fields are optional.

@@ -2308,7 +2308,7 @@ data-styled.g140[id="sc-kRRyDe"]{content:"fGGixh,"}/*!sc*/

Response samples

Content type
application/json
{
  • "error": "string"
}