diff --git a/index.html b/index.html index 1ca746da..483bfff0 100644 --- a/index.html +++ b/index.html @@ -362,7 +362,7 @@ data-styled.g140[id="sc-avest"]{content:"kHtonc,"}/*!sc*/ -
Documentation Powered by ReDoc
Documentation Powered by ReDoc

rtsp-simple-server API (1.0.0)

Download OpenAPI specification:Download

License: MIT

API of rtsp-simple-server, a server and proxy that supports various protocols.

returns the configuration.

Responses

Response samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "readBufferCount": 0,
  • "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": [
    ],
  • "readBufferSize": 0,
  • "rtmpDisable": true,
  • "rtmpAddress": "string",
  • "hlsDisable": true,
  • "hlsAddress": "string",
  • "hlsAlwaysRemux": true,
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsAllowOrigin": "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,
  • "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": [
    ],
  • "readBufferSize": 0,
  • "rtmpDisable": true,
  • "rtmpAddress": "string",
  • "hlsDisable": true,
  • "hlsAddress": "string",
  • "hlsAlwaysRemux": true,
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsAllowOrigin": "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
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
readBufferSize
integer
rtmpDisable
boolean
rtmpAddress
string
hlsDisable
boolean
hlsAddress
string
hlsAlwaysRemux
boolean
hlsSegmentCount
integer
hlsSegmentDuration
string
hlsAllowOrigin
string
object

Responses

Request samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "readBufferCount": 0,
  • "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": [
    ],
  • "readBufferSize": 0,
  • "rtmpDisable": true,
  • "rtmpAddress": "string",
  • "hlsDisable": true,
  • "hlsAddress": "string",
  • "hlsAlwaysRemux": true,
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsAllowOrigin": "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,
  • "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": [
    ],
  • "readBufferSize": 0,
  • "rtmpDisable": true,
  • "rtmpAddress": "string",
  • "hlsDisable": true,
  • "hlsAddress": "string",
  • "hlsAlwaysRemux": true,
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsAllowOrigin": "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
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
runOnPublish
string
runOnPublishRestart
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",
  • "publishUser": "string",
  • "publishPass": "string",
  • "publishIPs": [
    ],
  • "readUser": "string",
  • "readPass": "string",
  • "readIPs": [
    ],
  • "runOnInit": "string",
  • "runOnInitRestart": true,
  • "runOnDemand": "string",
  • "runOnDemandRestart": true,
  • "runOnDemandStartTimeout": "string",
  • "runOnDemandCloseAfter": "string",
  • "runOnPublish": "string",
  • "runOnPublishRestart": 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",
  • "publishUser": "string",
  • "publishPass": "string",
  • "publishIPs": [
    ],
  • "readUser": "string",
  • "readPass": "string",
  • "readIPs": [
    ],
  • "runOnInit": "string",
  • "runOnInitRestart": true,
  • "runOnDemand": "string",
  • "runOnDemandRestart": true,
  • "runOnDemandStartTimeout": "string",
  • "runOnDemandCloseAfter": "string",
  • "runOnPublish": "string",
  • "runOnPublishRestart": 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
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
runOnPublish
string
runOnPublishRestart
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",
  • "publishUser": "string",
  • "publishPass": "string",
  • "publishIPs": [
    ],
  • "readUser": "string",
  • "readPass": "string",
  • "readIPs": [
    ],
  • "runOnInit": "string",
  • "runOnInitRestart": true,
  • "runOnDemand": "string",
  • "runOnDemandRestart": true,
  • "runOnDemandStartTimeout": "string",
  • "runOnDemandCloseAfter": "string",
  • "runOnPublish": "string",
  • "runOnPublishRestart": 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",
  • "publishUser": "string",
  • "publishPass": "string",
  • "publishIPs": [
    ],
  • "readUser": "string",
  • "readPass": "string",
  • "readIPs": [
    ],
  • "runOnInit": "string",
  • "runOnInitRestart": true,
  • "runOnDemand": "string",
  • "runOnDemandRestart": true,
  • "runOnDemandStartTimeout": "string",
  • "runOnDemandCloseAfter": "string",
  • "runOnPublish": "string",
  • "runOnPublishRestart": 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.

+

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.

Responses

returns all active RTSPS sessions.

Responses

Response samples

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

kicks out a RTSPS session from the server.

path Parameters
id
required
string

the ID of the session.

+

Response samples

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

kicks out a RTSPS session from the server.

path Parameters
id
required
string

the ID of the session.

Responses

returns all active RTMP connections.

Responses

Response samples

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

kicks out a RTMP connection from the server.

path Parameters
id
required
string

the ID of the connection.

+

Response samples

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

kicks out a RTMP connection from the server.

path Parameters
id
required
string

the ID of the connection.

Responses

+

returns all active HLS muxers.

Responses

Response samples

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