diff --git a/index.html b/index.html index 54aec418..c4360f97 100644 --- a/index.html +++ b/index.html @@ -2098,28 +2098,28 @@ data-styled.g140[id="sc-ZqGJI"]{content:"ksiypn,"}/*!sc*/

returns the configuration.

Responses

Response samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "readBufferCount": 0,
  • "externalAuthenticationURL": "string",
  • "api": true,
  • "apiAddress": "string",
  • "metrics": true,
  • "metricsAddress": "string",
  • "pprof": true,
  • "pprofAddress": "string",
  • "runOnConnect": "string",
  • "runOnConnectRestart": true,
  • "rtspDisable": true,
  • "protocols": [
    ],
  • "encryption": "string",
  • "rtspAddress": "string",
  • "rtspsAddress": "string",
  • "rtpAddress": "string",
  • "rtcpAddress": "string",
  • "multicastIPRange": "string",
  • "multicastRTPPort": 0,
  • "multicastRTCPPort": 0,
  • "serverKey": "string",
  • "serverCert": "string",
  • "authMethods": [
    ],
  • "rtmpDisable": true,
  • "rtmpAddress": "string",
  • "hlsDisable": true,
  • "hlsAddress": "string",
  • "hlsAlwaysRemux": true,
  • "hlsVariant": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsPartDuration": "string",
  • "hlsSegmentMaxSize": "string",
  • "hlsAllowOrigin": "string",
  • "hlsEncryption": true,
  • "hlsServerKey": "string",
  • "hlsServerCert": "string",
  • "paths": {
    }
}

changes the configuration.

all fields are optional. paths can't be edited with this request, use /v1/config/paths/{operation}/{name} to edit them.

+

Response samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "readBufferCount": 0,
  • "externalAuthenticationURL": "string",
  • "api": true,
  • "apiAddress": "string",
  • "metrics": true,
  • "metricsAddress": "string",
  • "pprof": true,
  • "pprofAddress": "string",
  • "runOnConnect": "string",
  • "runOnConnectRestart": true,
  • "rtspDisable": true,
  • "protocols": [
    ],
  • "encryption": "string",
  • "rtspAddress": "string",
  • "rtspsAddress": "string",
  • "rtpAddress": "string",
  • "rtcpAddress": "string",
  • "multicastIPRange": "string",
  • "multicastRTPPort": 0,
  • "multicastRTCPPort": 0,
  • "serverKey": "string",
  • "serverCert": "string",
  • "authMethods": [
    ],
  • "rtmpDisable": true,
  • "rtmpAddress": "string",
  • "hlsDisable": true,
  • "hlsAddress": "string",
  • "hlsAlwaysRemux": true,
  • "hlsVariant": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsPartDuration": "string",
  • "hlsSegmentMaxSize": "string",
  • "hlsAllowOrigin": "string",
  • "hlsEncryption": true,
  • "hlsServerKey": "string",
  • "hlsServerCert": "string",
  • "paths": {
    }
}

changes the configuration.

all fields are optional. paths can't be edited with this request, use /v1/config/paths/{operation}/{name} to edit them.

Request Body schema: application/json
logLevel
string
logDestinations
Array of strings
logFile
string
readTimeout
string
writeTimeout
string
readBufferCount
integer
externalAuthenticationURL
string
api
boolean
apiAddress
string
metrics
boolean
metricsAddress
string
pprof
boolean
pprofAddress
string
runOnConnect
string
runOnConnectRestart
boolean
rtspDisable
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
authMethods
Array of strings
rtmpDisable
boolean
rtmpAddress
string
hlsDisable
boolean
hlsAddress
string
hlsAlwaysRemux
boolean
hlsVariant
string
hlsSegmentCount
integer
hlsSegmentDuration
string
hlsPartDuration
string
hlsSegmentMaxSize
string
hlsAllowOrigin
string
hlsEncryption
boolean
hlsServerKey
string
hlsServerCert
string
object

Responses

Request samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "readBufferCount": 0,
  • "externalAuthenticationURL": "string",
  • "api": true,
  • "apiAddress": "string",
  • "metrics": true,
  • "metricsAddress": "string",
  • "pprof": true,
  • "pprofAddress": "string",
  • "runOnConnect": "string",
  • "runOnConnectRestart": true,
  • "rtspDisable": true,
  • "protocols": [
    ],
  • "encryption": "string",
  • "rtspAddress": "string",
  • "rtspsAddress": "string",
  • "rtpAddress": "string",
  • "rtcpAddress": "string",
  • "multicastIPRange": "string",
  • "multicastRTPPort": 0,
  • "multicastRTCPPort": 0,
  • "serverKey": "string",
  • "serverCert": "string",
  • "authMethods": [
    ],
  • "rtmpDisable": true,
  • "rtmpAddress": "string",
  • "hlsDisable": true,
  • "hlsAddress": "string",
  • "hlsAlwaysRemux": true,
  • "hlsVariant": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsPartDuration": "string",
  • "hlsSegmentMaxSize": "string",
  • "hlsAllowOrigin": "string",
  • "hlsEncryption": true,
  • "hlsServerKey": "string",
  • "hlsServerCert": "string",
  • "paths": {
    }
}

adds the configuration of a path.

all fields are optional.

+

Request samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "readBufferCount": 0,
  • "externalAuthenticationURL": "string",
  • "api": true,
  • "apiAddress": "string",
  • "metrics": true,
  • "metricsAddress": "string",
  • "pprof": true,
  • "pprofAddress": "string",
  • "runOnConnect": "string",
  • "runOnConnectRestart": true,
  • "rtspDisable": true,
  • "protocols": [
    ],
  • "encryption": "string",
  • "rtspAddress": "string",
  • "rtspsAddress": "string",
  • "rtpAddress": "string",
  • "rtcpAddress": "string",
  • "multicastIPRange": "string",
  • "multicastRTPPort": 0,
  • "multicastRTCPPort": 0,
  • "serverKey": "string",
  • "serverCert": "string",
  • "authMethods": [
    ],
  • "rtmpDisable": true,
  • "rtmpAddress": "string",
  • "hlsDisable": true,
  • "hlsAddress": "string",
  • "hlsAlwaysRemux": true,
  • "hlsVariant": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsPartDuration": "string",
  • "hlsSegmentMaxSize": "string",
  • "hlsAllowOrigin": "string",
  • "hlsEncryption": true,
  • "hlsServerKey": "string",
  • "hlsServerCert": "string",
  • "paths": {
    }
}

adds the configuration of a path.

all fields are optional.

path Parameters
name
required
string

the name of the path.

-
Request Body schema: application/json
source
string
sourceProtocol
string
sourceAnyPortEnable
boolean
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
sourceRedirect
string
disablePublisherOverride
boolean
fallback
string
rpiCameraCamID
number
rpiCameraWidth
number
rpiCameraHeight
number
rpiCameraFPS
number
rpiCameraIDRPeriod
number
rpiCameraBitrate
number
rpiCameraProfile
string
rpiCameraLevel
string
publishUser
string
publishPass
string
publishIPs
Array of strings
readUser
string
readPass
string
readIPs
Array of strings
runOnInit
string
runOnInitRestart
boolean
runOnDemand
string
runOnDemandRestart
boolean
runOnDemandStartTimeout
string
runOnDemandCloseAfter
string
runOnReady
string
runOnReadyRestart
boolean
runOnRead
string
runOnReadRestart
boolean

Responses

Request Body schema: application/json
source
string
sourceProtocol
string
sourceAnyPortEnable
boolean
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
sourceRedirect
string
disablePublisherOverride
boolean
fallback
string
rpiCameraCamID
number
rpiCameraWidth
number
rpiCameraHeight
number
rpiCameraHFlip
boolean
rpiCameraVFlip
boolean
rpiCameraBrightness
number
rpiCameraContrast
number
rpiCameraSaturation
number
rpiCameraSharpness
number
rpiCameraExposure
string
rpiCameraAWB
string
rpiCameraDenoise
string
rpiCameraShutter
number
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
number
rpiCameraIDRPeriod
number
rpiCameraBitrate
number
rpiCameraProfile
string
rpiCameraLevel
string
publishUser
string
publishPass
string
publishIPs
Array of strings
readUser
string
readPass
string
readIPs
Array of strings
runOnInit
string
runOnInitRestart
boolean
runOnDemand
string
runOnDemandRestart
boolean
runOnDemandStartTimeout
string
runOnDemandCloseAfter
string
runOnReady
string
runOnReadyRestart
boolean
runOnRead
string
runOnReadRestart
boolean

Responses

Request samples

Content type
application/json
{
  • "source": "string",
  • "sourceProtocol": "string",
  • "sourceAnyPortEnable": true,
  • "sourceFingerprint": "string",
  • "sourceOnDemand": true,
  • "sourceOnDemandStartTimeout": "string",
  • "sourceOnDemandCloseAfter": "string",
  • "sourceRedirect": "string",
  • "disablePublisherOverride": true,
  • "fallback": "string",
  • "rpiCameraCamID": 0,
  • "rpiCameraWidth": 0,
  • "rpiCameraHeight": 0,
  • "rpiCameraFPS": 0,
  • "rpiCameraIDRPeriod": 0,
  • "rpiCameraBitrate": 0,
  • "rpiCameraProfile": "string",
  • "rpiCameraLevel": "string",
  • "publishUser": "string",
  • "publishPass": "string",
  • "publishIPs": [
    ],
  • "readUser": "string",
  • "readPass": "string",
  • "readIPs": [
    ],
  • "runOnInit": "string",
  • "runOnInitRestart": true,
  • "runOnDemand": "string",
  • "runOnDemandRestart": true,
  • "runOnDemandStartTimeout": "string",
  • "runOnDemandCloseAfter": "string",
  • "runOnReady": "string",
  • "runOnReadyRestart": true,
  • "runOnRead": "string",
  • "runOnReadRestart": true
}

changes the configuration of a path.

all fields are optional.

+

Request samples

Content type
application/json
{
  • "source": "string",
  • "sourceProtocol": "string",
  • "sourceAnyPortEnable": true,
  • "sourceFingerprint": "string",
  • "sourceOnDemand": true,
  • "sourceOnDemandStartTimeout": "string",
  • "sourceOnDemandCloseAfter": "string",
  • "sourceRedirect": "string",
  • "disablePublisherOverride": true,
  • "fallback": "string",
  • "rpiCameraCamID": 0,
  • "rpiCameraWidth": 0,
  • "rpiCameraHeight": 0,
  • "rpiCameraHFlip": true,
  • "rpiCameraVFlip": true,
  • "rpiCameraBrightness": 0,
  • "rpiCameraContrast": 0,
  • "rpiCameraSaturation": 0,
  • "rpiCameraSharpness": 0,
  • "rpiCameraExposure": "string",
  • "rpiCameraAWB": "string",
  • "rpiCameraDenoise": "string",
  • "rpiCameraShutter": 0,
  • "rpiCameraMetering": "string",
  • "rpiCameraGain": 0,
  • "rpiCameraEV": 0,
  • "rpiCameraROI": "string",
  • "rpiCameraTuningFile": "string",
  • "rpiCameraMode": "string",
  • "rpiCameraFPS": 0,
  • "rpiCameraIDRPeriod": 0,
  • "rpiCameraBitrate": 0,
  • "rpiCameraProfile": "string",
  • "rpiCameraLevel": "string",
  • "publishUser": "string",
  • "publishPass": "string",
  • "publishIPs": [
    ],
  • "readUser": "string",
  • "readPass": "string",
  • "readIPs": [
    ],
  • "runOnInit": "string",
  • "runOnInitRestart": true,
  • "runOnDemand": "string",
  • "runOnDemandRestart": true,
  • "runOnDemandStartTimeout": "string",
  • "runOnDemandCloseAfter": "string",
  • "runOnReady": "string",
  • "runOnReadyRestart": true,
  • "runOnRead": "string",
  • "runOnReadRestart": true
}

changes the configuration of a path.

all fields are optional.

path Parameters
name
required
string

the name of the path.

-
Request Body schema: application/json
source
string
sourceProtocol
string
sourceAnyPortEnable
boolean
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
sourceRedirect
string
disablePublisherOverride
boolean
fallback
string
rpiCameraCamID
number
rpiCameraWidth
number
rpiCameraHeight
number
rpiCameraFPS
number
rpiCameraIDRPeriod
number
rpiCameraBitrate
number
rpiCameraProfile
string
rpiCameraLevel
string
publishUser
string
publishPass
string
publishIPs
Array of strings
readUser
string
readPass
string
readIPs
Array of strings
runOnInit
string
runOnInitRestart
boolean
runOnDemand
string
runOnDemandRestart
boolean
runOnDemandStartTimeout
string
runOnDemandCloseAfter
string
runOnReady
string
runOnReadyRestart
boolean
runOnRead
string
runOnReadRestart
boolean

Responses

Request Body schema: application/json
source
string
sourceProtocol
string
sourceAnyPortEnable
boolean
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
sourceRedirect
string
disablePublisherOverride
boolean
fallback
string
rpiCameraCamID
number
rpiCameraWidth
number
rpiCameraHeight
number
rpiCameraHFlip
boolean
rpiCameraVFlip
boolean
rpiCameraBrightness
number
rpiCameraContrast
number
rpiCameraSaturation
number
rpiCameraSharpness
number
rpiCameraExposure
string
rpiCameraAWB
string
rpiCameraDenoise
string
rpiCameraShutter
number
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
number
rpiCameraIDRPeriod
number
rpiCameraBitrate
number
rpiCameraProfile
string
rpiCameraLevel
string
publishUser
string
publishPass
string
publishIPs
Array of strings
readUser
string
readPass
string
readIPs
Array of strings
runOnInit
string
runOnInitRestart
boolean
runOnDemand
string
runOnDemandRestart
boolean
runOnDemandStartTimeout
string
runOnDemandCloseAfter
string
runOnReady
string
runOnReadyRestart
boolean
runOnRead
string
runOnReadRestart
boolean

Responses

Request samples

Content type
application/json
{
  • "source": "string",
  • "sourceProtocol": "string",
  • "sourceAnyPortEnable": true,
  • "sourceFingerprint": "string",
  • "sourceOnDemand": true,
  • "sourceOnDemandStartTimeout": "string",
  • "sourceOnDemandCloseAfter": "string",
  • "sourceRedirect": "string",
  • "disablePublisherOverride": true,
  • "fallback": "string",
  • "rpiCameraCamID": 0,
  • "rpiCameraWidth": 0,
  • "rpiCameraHeight": 0,
  • "rpiCameraFPS": 0,
  • "rpiCameraIDRPeriod": 0,
  • "rpiCameraBitrate": 0,
  • "rpiCameraProfile": "string",
  • "rpiCameraLevel": "string",
  • "publishUser": "string",
  • "publishPass": "string",
  • "publishIPs": [
    ],
  • "readUser": "string",
  • "readPass": "string",
  • "readIPs": [
    ],
  • "runOnInit": "string",
  • "runOnInitRestart": true,
  • "runOnDemand": "string",
  • "runOnDemandRestart": true,
  • "runOnDemandStartTimeout": "string",
  • "runOnDemandCloseAfter": "string",
  • "runOnReady": "string",
  • "runOnReadyRestart": true,
  • "runOnRead": "string",
  • "runOnReadRestart": true
}

removes the configuration of a path.

path Parameters
name
required
string

the name of the path.

+

Request samples

Content type
application/json
{
  • "source": "string",
  • "sourceProtocol": "string",
  • "sourceAnyPortEnable": true,
  • "sourceFingerprint": "string",
  • "sourceOnDemand": true,
  • "sourceOnDemandStartTimeout": "string",
  • "sourceOnDemandCloseAfter": "string",
  • "sourceRedirect": "string",
  • "disablePublisherOverride": true,
  • "fallback": "string",
  • "rpiCameraCamID": 0,
  • "rpiCameraWidth": 0,
  • "rpiCameraHeight": 0,
  • "rpiCameraHFlip": true,
  • "rpiCameraVFlip": true,
  • "rpiCameraBrightness": 0,
  • "rpiCameraContrast": 0,
  • "rpiCameraSaturation": 0,
  • "rpiCameraSharpness": 0,
  • "rpiCameraExposure": "string",
  • "rpiCameraAWB": "string",
  • "rpiCameraDenoise": "string",
  • "rpiCameraShutter": 0,
  • "rpiCameraMetering": "string",
  • "rpiCameraGain": 0,
  • "rpiCameraEV": 0,
  • "rpiCameraROI": "string",
  • "rpiCameraTuningFile": "string",
  • "rpiCameraMode": "string",
  • "rpiCameraFPS": 0,
  • "rpiCameraIDRPeriod": 0,
  • "rpiCameraBitrate": 0,
  • "rpiCameraProfile": "string",
  • "rpiCameraLevel": "string",
  • "publishUser": "string",
  • "publishPass": "string",
  • "publishIPs": [
    ],
  • "readUser": "string",
  • "readPass": "string",
  • "readIPs": [
    ],
  • "runOnInit": "string",
  • "runOnInitRestart": true,
  • "runOnDemand": "string",
  • "runOnDemandRestart": true,
  • "runOnDemandStartTimeout": "string",
  • "runOnDemandCloseAfter": "string",
  • "runOnReady": "string",
  • "runOnReadyRestart": true,
  • "runOnRead": "string",
  • "runOnReadRestart": true
}

removes the configuration of a path.

path Parameters
name
required
string

the name of the path.

Responses

returns all active paths.

Responses

Response samples

Content type
application/json
{
  • "items": {
    }
}

returns all active RTSP sessions.

Responses

Response samples

Content type
application/json
{
  • "items": {
    }
}

returns all active RTSP sessions.

Responses

Response samples

Content type
application/json
{
  • "items": {
    }
}

kicks out a RTSP session from the server.

path Parameters
id
required
string

the ID of the session.

@@ -2152,7 +2152,7 @@ data-styled.g140[id="sc-ZqGJI"]{content:"ksiypn,"}/*!sc*/

Response samples

Content type
application/json
{
  • "items": {
    }
}