diff --git a/index.html b/index.html index 8a973843e0f..18044740969 100644 --- a/index.html +++ b/index.html @@ -1970,6 +1970,8 @@ data-styled.g70[id="sc-jnOGJG"]{content:"bmajMx,"}/*!sc*/ .cZRGba{color:#666;}/*!sc*/ data-styled.g71[id="sc-dZoequ"]{content:"cZRGba,"}/*!sc*/ +.gaxeXa{color:#666;word-break:break-word;}/*!sc*/ +data-styled.g72[id="sc-eZkCL"]{content:"gaxeXa,"}/*!sc*/ .cGkUZj{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/ data-styled.g73[id="sc-ggpjZQ"]{content:"cGkUZj,"}/*!sc*/ .cFvMvP{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/ @@ -2117,45 +2119,45 @@

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": [
    ],
  • "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

Response samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "writeQueueSize": 0,
  • "udpMaxPayloadSize": 0,
  • "runOnConnect": "string",
  • "runOnConnectRestart": true,
  • "runOnDisconnect": "string",
  • "authMethod": "string",
  • "authInternalUsers": [
    ],
  • "authHTTPAddress": "string",
  • "authHTTPExclude": [
    ],
  • "authJWTJWKS": "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
runOnConnect
string
runOnConnectRestart
boolean
runOnDisconnect
string
authMethod
string
Array of objects (AuthInternalUser) [ items ]
authHTTPAddress
string
Array of objects (AuthInternalUserPermission) [ items ]
authJWTJWKS
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": [
    ],
  • "webrtcHandshakeTimeout": "string",
  • "webrtcTrackGatherTimeout": "string",
  • "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,
  • "runOnConnect": "string",
  • "runOnConnectRestart": true,
  • "runOnDisconnect": "string",
  • "authMethod": "string",
  • "authInternalUsers": [
    ],
  • "authHTTPAddress": "string",
  • "authHTTPExclude": [
    ],
  • "authJWTJWKS": "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.

-
Request Body schema: application/json
name
string
source
string
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
maxReaders
integer
srtReadPassphrase
string
fallback
string
record
boolean
recordPath
string
recordFormat
string
recordPartDuration
string
recordSegmentDuration
string
recordDeleteAfter
string
publishUser
string
publishPass
string
publishIPs
Array of strings
readUser
string
readPass
string
readIPs
Array of strings
overridePublisher
boolean
srtPublishPassphrase
string
rtspTransport
string
rtspAnyPort
boolean
rtspRangeType
string
rtspRangeStart
string
sourceRedirect
string
rpiCameraCamID
integer
rpiCameraWidth
integer
rpiCameraHeight
integer
rpiCameraHFlip
boolean
rpiCameraVFlip
boolean
rpiCameraBrightness
number
rpiCameraContrast
number
rpiCameraSaturation
number
rpiCameraSharpness
number
rpiCameraExposure
string
rpiCameraAWB
string
rpiCameraAWBGains
Array of numbers 2 items [ items ]
rpiCameraDenoise
string
rpiCameraShutter
integer
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraHDR
boolean
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
number
rpiCameraIDRPeriod
integer
rpiCameraBitrate
integer
rpiCameraProfile
string
rpiCameraLevel
string
rpiCameraAfMode
string
rpiCameraAfRange
string
rpiCameraAfSpeed
string
rpiCameraLensPosition
number
rpiCameraAfWindow
string
rpiCameraTextOverlayEnable
boolean
rpiCameraTextOverlay
string
runOnInit
string
runOnInitRestart
boolean
runOnDemand
string
runOnDemandRestart
boolean
runOnDemandStartTimeout
string
runOnDemandCloseAfter
string
runOnUnDemand
string
runOnReady
string
runOnReadyRestart
boolean
runOnNotReady
string
runOnRead
string
runOnReadRestart
boolean
runOnUnread
string
runOnRecordSegmentCreate
string
runOnRecordSegmentComplete
string

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",
  • "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.

+
Request Body schema: application/json
name
string
source
string
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
maxReaders
integer
srtReadPassphrase
string
fallback
string
record
boolean
recordPath
string
recordFormat
string
recordPartDuration
string
recordSegmentDuration
string
recordDeleteAfter
string
overridePublisher
boolean
srtPublishPassphrase
string
rtspTransport
string
rtspAnyPort
boolean
rtspRangeType
string
rtspRangeStart
string
sourceRedirect
string
rpiCameraCamID
integer
rpiCameraWidth
integer
rpiCameraHeight
integer
rpiCameraHFlip
boolean
rpiCameraVFlip
boolean
rpiCameraBrightness
number
rpiCameraContrast
number
rpiCameraSaturation
number
rpiCameraSharpness
number
rpiCameraExposure
string
rpiCameraAWB
string
rpiCameraAWBGains
Array of numbers 2 items [ items ]
rpiCameraDenoise
string
rpiCameraShutter
integer
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraHDR
boolean
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
number
rpiCameraIDRPeriod
integer
rpiCameraBitrate
integer
rpiCameraProfile
string
rpiCameraLevel
string
rpiCameraAfMode
string
rpiCameraAfRange
string
rpiCameraAfSpeed
string
rpiCameraLensPosition
number
rpiCameraAfWindow
string
rpiCameraTextOverlayEnable
boolean
rpiCameraTextOverlay
string
runOnInit
string
runOnInitRestart
boolean
runOnDemand
string
runOnDemandRestart
boolean
runOnDemandStartTimeout
string
runOnDemandCloseAfter
string
runOnUnDemand
string
runOnReady
string
runOnReadyRestart
boolean
runOnNotReady
string
runOnRead
string
runOnReadRestart
boolean
runOnUnread
string
runOnRecordSegmentCreate
string
runOnRecordSegmentComplete
string

Responses

Request 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"
}

Response samples

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

returns all path configurations.

query Parameters
page
integer
Default: 0

page number.

+

Request 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",
  • "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"
}

Response samples

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

returns all path configurations.

query Parameters
page
integer
Default: 0

page number.

itemsPerPage
integer
Default: 100

items per page.

Responses

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "items": [
    ]
}

returns a path configuration.

path Parameters
name
required
string

the name of the path.

+

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "itemCount": 0,
  • "items": [
    ]
}

returns a path configuration.

path Parameters
name
required
string

the name of the path.

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"
}

adds a path configuration.

all fields are optional.

+

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",
  • "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"
}

adds a path configuration.

all fields are optional.

path Parameters
name
required
string

the name of the path.

-
Request Body schema: application/json
name
string
source
string
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
maxReaders
integer
srtReadPassphrase
string
fallback
string
record
boolean
recordPath
string
recordFormat
string
recordPartDuration
string
recordSegmentDuration
string
recordDeleteAfter
string
publishUser
string
publishPass
string
publishIPs
Array of strings
readUser
string
readPass
string
readIPs
Array of strings
overridePublisher
boolean
srtPublishPassphrase
string
rtspTransport
string
rtspAnyPort
boolean
rtspRangeType
string
rtspRangeStart
string
sourceRedirect
string
rpiCameraCamID
integer
rpiCameraWidth
integer
rpiCameraHeight
integer
rpiCameraHFlip
boolean
rpiCameraVFlip
boolean
rpiCameraBrightness
number
rpiCameraContrast
number
rpiCameraSaturation
number
rpiCameraSharpness
number
rpiCameraExposure
string
rpiCameraAWB
string
rpiCameraAWBGains
Array of numbers 2 items [ items ]
rpiCameraDenoise
string
rpiCameraShutter
integer
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraHDR
boolean
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
number
rpiCameraIDRPeriod
integer
rpiCameraBitrate
integer
rpiCameraProfile
string
rpiCameraLevel
string
rpiCameraAfMode
string
rpiCameraAfRange
string
rpiCameraAfSpeed
string
rpiCameraLensPosition
number
rpiCameraAfWindow
string
rpiCameraTextOverlayEnable
boolean
rpiCameraTextOverlay
string
runOnInit
string
runOnInitRestart
boolean
runOnDemand
string
runOnDemandRestart
boolean
runOnDemandStartTimeout
string
runOnDemandCloseAfter
string
runOnUnDemand
string
runOnReady
string
runOnReadyRestart
boolean
runOnNotReady
string
runOnRead
string
runOnReadRestart
boolean
runOnUnread
string
runOnRecordSegmentCreate
string
runOnRecordSegmentComplete
string

Responses

Request Body schema: application/json
name
string
source
string
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
maxReaders
integer
srtReadPassphrase
string
fallback
string
record
boolean
recordPath
string
recordFormat
string
recordPartDuration
string
recordSegmentDuration
string
recordDeleteAfter
string
overridePublisher
boolean
srtPublishPassphrase
string
rtspTransport
string
rtspAnyPort
boolean
rtspRangeType
string
rtspRangeStart
string
sourceRedirect
string
rpiCameraCamID
integer
rpiCameraWidth
integer
rpiCameraHeight
integer
rpiCameraHFlip
boolean
rpiCameraVFlip
boolean
rpiCameraBrightness
number
rpiCameraContrast
number
rpiCameraSaturation
number
rpiCameraSharpness
number
rpiCameraExposure
string
rpiCameraAWB
string
rpiCameraAWBGains
Array of numbers 2 items [ items ]
rpiCameraDenoise
string
rpiCameraShutter
integer
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraHDR
boolean
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
number
rpiCameraIDRPeriod
integer
rpiCameraBitrate
integer
rpiCameraProfile
string
rpiCameraLevel
string
rpiCameraAfMode
string
rpiCameraAfRange
string
rpiCameraAfSpeed
string
rpiCameraLensPosition
number
rpiCameraAfWindow
string
rpiCameraTextOverlayEnable
boolean
rpiCameraTextOverlay
string
runOnInit
string
runOnInitRestart
boolean
runOnDemand
string
runOnDemandRestart
boolean
runOnDemandStartTimeout
string
runOnDemandCloseAfter
string
runOnUnDemand
string
runOnReady
string
runOnReadyRestart
boolean
runOnNotReady
string
runOnRead
string
runOnReadRestart
boolean
runOnUnread
string
runOnRecordSegmentCreate
string
runOnRecordSegmentComplete
string

Responses

Request 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"
}

Response samples

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

patches a path configuration.

all fields are optional.

+

Request 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",
  • "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"
}

Response samples

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

patches a path configuration.

all fields are optional.

path Parameters
name
required
string

the name of the path.

-
Request Body schema: application/json
name
string
source
string
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
maxReaders
integer
srtReadPassphrase
string
fallback
string
record
boolean
recordPath
string
recordFormat
string
recordPartDuration
string
recordSegmentDuration
string
recordDeleteAfter
string
publishUser
string
publishPass
string
publishIPs
Array of strings
readUser
string
readPass
string
readIPs
Array of strings
overridePublisher
boolean
srtPublishPassphrase
string
rtspTransport
string
rtspAnyPort
boolean
rtspRangeType
string
rtspRangeStart
string
sourceRedirect
string
rpiCameraCamID
integer
rpiCameraWidth
integer
rpiCameraHeight
integer
rpiCameraHFlip
boolean
rpiCameraVFlip
boolean
rpiCameraBrightness
number
rpiCameraContrast
number
rpiCameraSaturation
number
rpiCameraSharpness
number
rpiCameraExposure
string
rpiCameraAWB
string
rpiCameraAWBGains
Array of numbers 2 items [ items ]
rpiCameraDenoise
string
rpiCameraShutter
integer
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraHDR
boolean
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
number
rpiCameraIDRPeriod
integer
rpiCameraBitrate
integer
rpiCameraProfile
string
rpiCameraLevel
string
rpiCameraAfMode
string
rpiCameraAfRange
string
rpiCameraAfSpeed
string
rpiCameraLensPosition
number
rpiCameraAfWindow
string
rpiCameraTextOverlayEnable
boolean
rpiCameraTextOverlay
string
runOnInit
string
runOnInitRestart
boolean
runOnDemand
string
runOnDemandRestart
boolean
runOnDemandStartTimeout
string
runOnDemandCloseAfter
string
runOnUnDemand
string
runOnReady
string
runOnReadyRestart
boolean
runOnNotReady
string
runOnRead
string
runOnReadRestart
boolean
runOnUnread
string
runOnRecordSegmentCreate
string
runOnRecordSegmentComplete
string

Responses

Request Body schema: application/json
name
string
source
string
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
maxReaders
integer
srtReadPassphrase
string
fallback
string
record
boolean
recordPath
string
recordFormat
string
recordPartDuration
string
recordSegmentDuration
string
recordDeleteAfter
string
overridePublisher
boolean
srtPublishPassphrase
string
rtspTransport
string
rtspAnyPort
boolean
rtspRangeType
string
rtspRangeStart
string
sourceRedirect
string
rpiCameraCamID
integer
rpiCameraWidth
integer
rpiCameraHeight
integer
rpiCameraHFlip
boolean
rpiCameraVFlip
boolean
rpiCameraBrightness
number
rpiCameraContrast
number
rpiCameraSaturation
number
rpiCameraSharpness
number
rpiCameraExposure
string
rpiCameraAWB
string
rpiCameraAWBGains
Array of numbers 2 items [ items ]
rpiCameraDenoise
string
rpiCameraShutter
integer
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraHDR
boolean
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
number
rpiCameraIDRPeriod
integer
rpiCameraBitrate
integer
rpiCameraProfile
string
rpiCameraLevel
string
rpiCameraAfMode
string
rpiCameraAfRange
string
rpiCameraAfSpeed
string
rpiCameraLensPosition
number
rpiCameraAfWindow
string
rpiCameraTextOverlayEnable
boolean
rpiCameraTextOverlay
string
runOnInit
string
runOnInitRestart
boolean
runOnDemand
string
runOnDemandRestart
boolean
runOnDemandStartTimeout
string
runOnDemandCloseAfter
string
runOnUnDemand
string
runOnReady
string
runOnReadyRestart
boolean
runOnNotReady
string
runOnRead
string
runOnReadRestart
boolean
runOnUnread
string
runOnRecordSegmentCreate
string
runOnRecordSegmentComplete
string

Responses

Request 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"
}

Response samples

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

replaces all values of a path configuration.

all fields are optional.

+

Request 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",
  • "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"
}

Response samples

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

replaces all values of a path configuration.

all fields are optional.

path Parameters
name
required
string

the name of the path.

-
Request Body schema: application/json
name
string
source
string
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
maxReaders
integer
srtReadPassphrase
string
fallback
string
record
boolean
recordPath
string
recordFormat
string
recordPartDuration
string
recordSegmentDuration
string
recordDeleteAfter
string
publishUser
string
publishPass
string
publishIPs
Array of strings
readUser
string
readPass
string
readIPs
Array of strings
overridePublisher
boolean
srtPublishPassphrase
string
rtspTransport
string
rtspAnyPort
boolean
rtspRangeType
string
rtspRangeStart
string
sourceRedirect
string
rpiCameraCamID
integer
rpiCameraWidth
integer
rpiCameraHeight
integer
rpiCameraHFlip
boolean
rpiCameraVFlip
boolean
rpiCameraBrightness
number
rpiCameraContrast
number
rpiCameraSaturation
number
rpiCameraSharpness
number
rpiCameraExposure
string
rpiCameraAWB
string
rpiCameraAWBGains
Array of numbers 2 items [ items ]
rpiCameraDenoise
string
rpiCameraShutter
integer
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraHDR
boolean
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
number
rpiCameraIDRPeriod
integer
rpiCameraBitrate
integer
rpiCameraProfile
string
rpiCameraLevel
string
rpiCameraAfMode
string
rpiCameraAfRange
string
rpiCameraAfSpeed
string
rpiCameraLensPosition
number
rpiCameraAfWindow
string
rpiCameraTextOverlayEnable
boolean
rpiCameraTextOverlay
string
runOnInit
string
runOnInitRestart
boolean
runOnDemand
string
runOnDemandRestart
boolean
runOnDemandStartTimeout
string
runOnDemandCloseAfter
string
runOnUnDemand
string
runOnReady
string
runOnReadyRestart
boolean
runOnNotReady
string
runOnRead
string
runOnReadRestart
boolean
runOnUnread
string
runOnRecordSegmentCreate
string
runOnRecordSegmentComplete
string

Responses

Request Body schema: application/json
name
string
source
string
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
maxReaders
integer
srtReadPassphrase
string
fallback
string
record
boolean
recordPath
string
recordFormat
string
recordPartDuration
string
recordSegmentDuration
string
recordDeleteAfter
string
overridePublisher
boolean
srtPublishPassphrase
string
rtspTransport
string
rtspAnyPort
boolean
rtspRangeType
string
rtspRangeStart
string
sourceRedirect
string
rpiCameraCamID
integer
rpiCameraWidth
integer
rpiCameraHeight
integer
rpiCameraHFlip
boolean
rpiCameraVFlip
boolean
rpiCameraBrightness
number
rpiCameraContrast
number
rpiCameraSaturation
number
rpiCameraSharpness
number
rpiCameraExposure
string
rpiCameraAWB
string
rpiCameraAWBGains
Array of numbers 2 items [ items ]
rpiCameraDenoise
string
rpiCameraShutter
integer
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraHDR
boolean
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
number
rpiCameraIDRPeriod
integer
rpiCameraBitrate
integer
rpiCameraProfile
string
rpiCameraLevel
string
rpiCameraAfMode
string
rpiCameraAfRange
string
rpiCameraAfSpeed
string
rpiCameraLensPosition
number
rpiCameraAfWindow
string
rpiCameraTextOverlayEnable
boolean
rpiCameraTextOverlay
string
runOnInit
string
runOnInitRestart
boolean
runOnDemand
string
runOnDemandRestart
boolean
runOnDemandStartTimeout
string
runOnDemandCloseAfter
string
runOnUnDemand
string
runOnReady
string
runOnReadyRestart
boolean
runOnNotReady
string
runOnRead
string
runOnReadRestart
boolean
runOnUnread
string
runOnRecordSegmentCreate
string
runOnRecordSegmentComplete
string

Responses

Request 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"
}

Response samples

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

removes a path configuration.

path Parameters
name
required
string

the name of the path.

+

Request 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",
  • "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"
}

Response samples

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

removes a path configuration.

path Parameters
name
required
string

the name of the path.

Responses

Responses

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "items": [
    ]
}

returns a HLS muxer.

path Parameters
name
required
string

name of the muxer.

+

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "itemCount": 0,
  • "items": [
    ]
}

returns a HLS muxer.

path Parameters
name
required
string

name of the muxer.

Responses

Responses

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "items": [
    ]
}

returns a path.

path Parameters
name
required
string

name of the path.

+

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "itemCount": 0,
  • "items": [
    ]
}

returns a path.

path Parameters
name
required
string

name of the path.

Responses

Responses

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "items": [
    ]
}

returns a RTSP connection.

path Parameters
id
required
string

ID of the connection.

+

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "itemCount": 0,
  • "items": [
    ]
}

returns a RTSP connection.

path Parameters
id
required
string

ID of the connection.

Responses

Responses

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "items": [
    ]
}

returns a RTSP session.

path Parameters
id
required
string

ID of the connection.

+

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "itemCount": 0,
  • "items": [
    ]
}

returns a RTSP session.

path Parameters
id
required
string

ID of the connection.

Responses

Responses

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "items": [
    ]
}

returns a RTSPS connection.

path Parameters
id
required
string

ID of the connection.

+

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "itemCount": 0,
  • "items": [
    ]
}

returns a RTSPS connection.

path Parameters
id
required
string

ID of the connection.

Responses

Responses

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "items": [
    ]
}

returns a RTSPS session.

path Parameters
id
required
string

ID of the connection.

+

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "itemCount": 0,
  • "items": [
    ]
}

returns a RTSPS session.

path Parameters
id
required
string

ID of the connection.

Responses

Responses

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "items": [
    ]
}

returns a RTMP connection.

path Parameters
id
required
string

ID of the connection.

+

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "itemCount": 0,
  • "items": [
    ]
}

returns a RTMP connection.

path Parameters
id
required
string

ID of the connection.

Responses

Responses

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "items": [
    ]
}

returns a RTMPS connection.

path Parameters
id
required
string

ID of the connection.

+

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "itemCount": 0,
  • "items": [
    ]
}

returns a RTMPS connection.

path Parameters
id
required
string

ID of the connection.

Responses

Responses

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "items": [
    ]
}

returns a SRT connection.

path Parameters
id
required
string

ID of the connection.

+

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "itemCount": 0,
  • "items": [
    ]
}

returns a SRT connection.

path Parameters
id
required
string

ID of the connection.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created": "string",
  • "remoteAddr": "string",
  • "state": "idle",
  • "path": "string",
  • "query": "string",
  • "packetsSent": 0,
  • "packetsReceived": 0,
  • "packetsSentUnique": 0,
  • "packetsReceivedUnique": 0,
  • "packetsSendLoss": 0,
  • "packetsReceivedLoss": 0,
  • "packetsRetrans": 0,
  • "packetsReceivedRetrans": 0,
  • "packetsSentACK": 0,
  • "packetsReceivedACK": 0,
  • "packetsSentNAK": 0,
  • "packetsReceivedNAK": 0,
  • "packetsSentKM": 0,
  • "packetsReceivedKM": 0,
  • "usSndDuration": 0,
  • "packetsSendDrop": 0,
  • "packetsReceivedDrop": 0,
  • "packetsReceivedUndecrypt": 0,
  • "bytesSent": 0,
  • "bytesReceived": 0,
  • "bytesSentUnique": 0,
  • "bytesReceivedUnique": 0,
  • "bytesReceivedLoss": 0,
  • "bytesRetrans": 0,
  • "bytesReceivedRetrans": 0,
  • "bytesSendDrop": 0,
  • "bytesReceivedDrop": 0,
  • "bytesReceivedUndecrypt": 0,
  • "usPacketsSendPeriod": 0,
  • "packetsFlowWindow": 0,
  • "packetsFlightSize": 0,
  • "msRTT": 0,
  • "mbpsSendRate": 0,
  • "mbpsReceiveRate": 0,
  • "mbpsLinkCapacity": 0,
  • "bytesAvailSendBuf": 0,
  • "bytesAvailReceiveBuf": 0,
  • "mbpsMaxBW": 0,
  • "byteMSS": 0,
  • "packetsSendBuf": 0,
  • "bytesSendBuf": 0,
  • "msSendBuf": 0,
  • "msSendTsbPdDelay": 0,
  • "packetsReceiveBuf": 0,
  • "bytesReceiveBuf": 0,
  • "msReceiveBuf": 0,
  • "msReceiveTsbPdDelay": 0,
  • "packetsReorderTolerance": 0,
  • "packetsReceivedAvgBelatedTime": 0,
  • "packetsSendLossRate": 0,
  • "packetsReceivedLossRate": 0
}

kicks out a SRT connection from the server.

path Parameters
id
required
string

ID of the connection.

+

Response samples

Content type
application/json
{
  • "id": "string",
  • "created": "string",
  • "remoteAddr": "string",
  • "state": "idle",
  • "path": "string",
  • "query": "string",
  • "packetsSent": 0,
  • "packetsReceived": 0,
  • "packetsReceivedBelated": 0,
  • "packetsSentUnique": 0,
  • "packetsReceivedUnique": 0,
  • "packetsSendLoss": 0,
  • "packetsReceivedLoss": 0,
  • "packetsRetrans": 0,
  • "packetsReceivedRetrans": 0,
  • "packetsSentACK": 0,
  • "packetsReceivedACK": 0,
  • "packetsSentNAK": 0,
  • "packetsReceivedNAK": 0,
  • "packetsSentKM": 0,
  • "packetsReceivedKM": 0,
  • "usSndDuration": 0,
  • "packetsSendDrop": 0,
  • "packetsReceivedDrop": 0,
  • "packetsReceivedUndecrypt": 0,
  • "bytesSent": 0,
  • "bytesReceived": 0,
  • "bytesReceivedBelated": 0,
  • "bytesSentUnique": 0,
  • "bytesReceivedUnique": 0,
  • "bytesReceivedLoss": 0,
  • "bytesRetrans": 0,
  • "bytesReceivedRetrans": 0,
  • "bytesSendDrop": 0,
  • "bytesReceivedDrop": 0,
  • "bytesReceivedUndecrypt": 0,
  • "usPacketsSendPeriod": 0,
  • "packetsFlowWindow": 0,
  • "packetsFlightSize": 0,
  • "msRTT": 0,
  • "mbpsSendRate": 0,
  • "mbpsReceiveRate": 0,
  • "mbpsLinkCapacity": 0,
  • "bytesAvailSendBuf": 0,
  • "bytesAvailReceiveBuf": 0,
  • "mbpsMaxBW": 0,
  • "byteMSS": 0,
  • "packetsSendBuf": 0,
  • "bytesSendBuf": 0,
  • "msSendBuf": 0,
  • "msSendTsbPdDelay": 0,
  • "packetsReceiveBuf": 0,
  • "bytesReceiveBuf": 0,
  • "msReceiveBuf": 0,
  • "msReceiveTsbPdDelay": 0,
  • "packetsReorderTolerance": 0,
  • "packetsReceivedAvgBelatedTime": 0,
  • "packetsSendLossRate": 0,
  • "packetsReceivedLossRate": 0
}

kicks out a SRT connection from the server.

path Parameters
id
required
string

ID of the connection.

Responses

Responses

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "items": [
    ]
}

returns a WebRTC session.

path Parameters
id
required
string

ID of the session.

+

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "itemCount": 0,
  • "items": [
    ]
}

returns a WebRTC session.

path Parameters
id
required
string

ID of the session.

Responses

Responses

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "items": [
    ]
}

returns recordings for a path.

path Parameters
name
required
string

name of the path.

+

Response samples

Content type
application/json
{
  • "pageCount": 0,
  • "itemCount": 0,
  • "items": [
    ]
}

returns recordings for a path.

path Parameters
name
required
string

name of the path.

Responses

Response samples

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