From 08f7d802faf9b1d60122374d6a7c5890639bc91a Mon Sep 17 00:00:00 2001 From: aler9 Date: Tue, 16 May 2023 18:24:37 +0000 Subject: [PATCH] deploy: adf94092a863ceb31a5bd3f83ba71e04d82b88b0 --- index.html | 819 ++++++++++++++++++++++++++------------------------- openapi.yaml | 378 +++++++++++++----------- 2 files changed, 633 insertions(+), 564 deletions(-) diff --git a/index.html b/index.html index d3bbc2da..8ed6be73 100644 --- a/index.html +++ b/index.html @@ -1743,340 +1743,343 @@ font-style: normal; color: '#666'; `;var cx=Object.defineProperty,ux=Object.getOwnPropertyDescriptor;class px extends n.PureComponent{constructor(e){super(e),this.activeItemRef=null,this.clear=()=>{this.setState({results:[],noResults:!1,term:"",activeItemIdx:-1}),this.props.marker.unmark()},this.handleKeyDown=e=>{if(27===e.keyCode&&this.clear(),40===e.keyCode&&(this.setState({activeItemIdx:Math.min(this.state.activeItemIdx+1,this.state.results.length-1)}),e.preventDefault()),38===e.keyCode&&(this.setState({activeItemIdx:Math.max(0,this.state.activeItemIdx-1)}),e.preventDefault()),13===e.keyCode){const e=this.state.results[this.state.activeItemIdx];if(e){const t=this.props.getItemById(e.meta);t&&this.props.onActivate(t)}}},this.search=e=>{const t=e.target.value;t.length<3?this.clearResults(t):this.setState({term:t},(()=>this.searchCallback(this.state.term)))},this.state={results:[],noResults:!1,term:"",activeItemIdx:-1}}clearResults(e){this.setState({results:[],noResults:!1,term:e}),this.props.marker.unmark()}setResults(e,t){this.setState({results:e,noResults:0===e.length}),this.props.marker.mark(t)}searchCallback(e){this.props.search.search(e).then((t=>{this.setResults(t,e)}))}render(){const{activeItemIdx:e}=this.state,t=this.state.results.map((e=>({item:this.props.getItemById(e.meta),score:e.score})));return t.sort(((e,t)=>t.score-e.score)),n.createElement(ox,{role:"search"},this.state.term&&n.createElement(lx,{onClick:this.clear},"×"),n.createElement(ax,null),n.createElement(ix,{value:this.state.term,onKeyDown:this.handleKeyDown,placeholder:"Search...","aria-label":"Search",type:"text",onChange:this.search}),t.length>0&&n.createElement(lf,{options:{wheelPropagation:!1}},n.createElement(sx,{"data-role":"search:results"},t.map(((t,r)=>n.createElement(Mv,{item:Object.create(t.item,{active:{value:r===e}}),onActivate:this.props.onActivate,withoutChildren:!0,key:t.item.id,"data-role":"search:result"}))))),this.state.term&&this.state.noResults?n.createElement(sx,{"data-role":"search:results"},ho("noResultsFound")):null)}}((e,t,n,r)=>{for(var o,i=ux(t,n),a=e.length-1;a>=0;a--)(o=e[a])&&(i=o(t,n,i)||i);i&&cx(t,n,i)})([La.bind,(0,La.debounce)(400)],px.prototype,"searchCallback");class dx extends n.Component{componentDidMount(){this.props.store.onDidMount()}componentWillUnmount(){this.props.store.dispose()}render(){const{store:{spec:e,menu:t,options:r,search:o,marker:i}}=this.props,a=this.props.store;return n.createElement(ba,{theme:r.theme},n.createElement(Au,{value:a},n.createElement(Ta,{value:r},n.createElement(tx,{className:"redoc-wrap"},n.createElement(ex,{menu:t,className:"menu-content"},n.createElement(Iy,{info:e.info}),!r.disableSearch&&n.createElement(px,{search:o,marker:i,getItemById:t.getItemById,onActivate:t.activateAndScroll})||null,n.createElement(Hv,{menu:t})),n.createElement(nx,{className:"api-content"},n.createElement(Cy,{store:a}),n.createElement(Ov,{items:t.items})),n.createElement(rx,null)))))}}dx.propTypes={store:Ca.instanceOf(wy).isRequired};const fx=function(e){const{spec:t,specUrl:r,options:o={},onLoaded:i}=e,a=Oo(o.hideLoading,!1),s=new _o(o);return n.createElement(Ea,null,n.createElement(Ru,{spec:t,specUrl:r,options:o,onLoaded:i},(({loading:e,store:t})=>e?a?null:n.createElement(Aa,{color:s.theme.colors.primary.main}):n.createElement(dx,{store:t}))))};var hx=Object.defineProperty,mx=Object.getOwnPropertySymbols,gx=Object.prototype.hasOwnProperty,yx=Object.prototype.propertyIsEnumerable,bx=(e,t,n)=>t in e?hx(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,vx=(e,t)=>{for(var n in t||(t={}))gx.call(t,n)&&bx(e,n,t[n]);if(mx)for(var n of mx(t))yx.call(t,n)&&bx(e,n,t[n]);return e};Lt({useProxies:"ifavailable"});const xx="2.0.0-rc.63",wx="b474d67";function kx(e){const t=function(e){const t={},n=e.attributes;for(let e=0;et.toUpperCase())),o=t[e];n[r]="theme"===e?JSON.parse(o):o}return n}function Ex(e,t={},r=Vr("redoc"),o){if(null===r)throw new Error('"element" argument is not provided and tag is not found on the page');let a,s;"string"==typeof e?a=e:"object"==typeof e&&(s=e),(0,i.render)(n.createElement(fx,{spec:s,onLoaded:o,specUrl:a,options:vx(vx({},t),kx(r))},["Loading..."]),r)}function Ox(e,t=Vr("redoc"),r){const o=wy.fromJS(e);setTimeout((()=>{(0,i.hydrate)(n.createElement(dx,{store:o}),t,r)}),0)}!function(){const e=Vr("redoc");if(!e)return;const t=e.getAttribute("spec-url");t&&Ex(t,{},e)}()}(),o}()})); -//# sourceMappingURL=redoc.standalone.js.map -

mediamtx API (1.0.0)

Download OpenAPI specification:Download

License: MIT

API of mediamtx, 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,
  • "udpMaxPayloadSize": 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",
  • "rtmpEncryption": "string",
  • "rtmpsAddress": "string",
  • "rtmpServerKey": "string",
  • "rtmpServerCert": "string",
  • "hlsDisable": true,
  • "hlsAddress": "string",
  • "hlsEncryption": true,
  • "hlsServerKey": "string",
  • "hlsServerCert": "string",
  • "hlsAlwaysRemux": true,
  • "hlsVariant": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsPartDuration": "string",
  • "hlsSegmentMaxSize": "string",
  • "hlsAllowOrigin": "string",
  • "hlsTrustedProxies": [
    ],
  • "hlsDirectory": "string",
  • "webrtcDisable": true,
  • "webrtcAddress": "string",
  • "webrtcEncryption": true,
  • "webrtcServerKey": "string",
  • "webrtcServerCert": "string",
  • "webrtcAllowOrigin": "string",
  • "webrtcTrustedProxies": [
    ],
  • "webrtcICEServers": [
    ],
  • "webrtcICEHostNAT1To1IPs": [
    ],
  • "webrtcICEUDPMuxAddress": "string",
  • "webrtcICETCPMuxAddress": "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
udpMaxPayloadSize
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
rtmpEncryption
string
rtmpsAddress
string
rtmpServerKey
string
rtmpServerCert
string
hlsDisable
boolean
hlsAddress
string
hlsEncryption
boolean
hlsServerKey
string
hlsServerCert
string
hlsAlwaysRemux
boolean
hlsVariant
string
hlsSegmentCount
integer
hlsSegmentDuration
string
hlsPartDuration
string
hlsSegmentMaxSize
string
hlsAllowOrigin
string
hlsTrustedProxies
Array of strings
hlsDirectory
string
webrtcDisable
boolean
webrtcAddress
string
webrtcEncryption
boolean
webrtcServerKey
string
webrtcServerCert
string
webrtcAllowOrigin
string
webrtcTrustedProxies
Array of strings
webrtcICEServers
Array of strings
webrtcICEHostNAT1To1IPs
Array of strings
webrtcICEUDPMuxAddress
string
webrtcICETCPMuxAddress
string
object

Responses

Request samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "readBufferCount": 0,
  • "udpMaxPayloadSize": 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",
  • "rtmpEncryption": "string",
  • "rtmpsAddress": "string",
  • "rtmpServerKey": "string",
  • "rtmpServerCert": "string",
  • "hlsDisable": true,
  • "hlsAddress": "string",
  • "hlsEncryption": true,
  • "hlsServerKey": "string",
  • "hlsServerCert": "string",
  • "hlsAlwaysRemux": true,
  • "hlsVariant": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsPartDuration": "string",
  • "hlsSegmentMaxSize": "string",
  • "hlsAllowOrigin": "string",
  • "hlsTrustedProxies": [
    ],
  • "hlsDirectory": "string",
  • "webrtcDisable": true,
  • "webrtcAddress": "string",
  • "webrtcEncryption": true,
  • "webrtcServerKey": "string",
  • "webrtcServerCert": "string",
  • "webrtcAllowOrigin": "string",
  • "webrtcTrustedProxies": [
    ],
  • "webrtcICEServers": [
    ],
  • "webrtcICEHostNAT1To1IPs": [
    ],
  • "webrtcICEUDPMuxAddress": "string",
  • "webrtcICETCPMuxAddress": "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
integer
rpiCameraWidth
integer
rpiCameraHeight
integer
rpiCameraHFlip
boolean
rpiCameraVFlip
boolean
rpiCameraBrightness
number
rpiCameraContrast
number
rpiCameraSaturation
number
rpiCameraSharpness
number
rpiCameraExposure
string
rpiCameraAWB
string
rpiCameraDenoise
string
rpiCameraShutter
integer
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
integer
rpiCameraIDRPeriod
integer
rpiCameraBitrate
integer
rpiCameraProfile
string
rpiCameraLevel
string
rpiCameraAfMode
string
rpiCameraAfRange
string
rpiCameraAfSpeed
string
rpiCameraLensPosition
number
rpiCameraAfWindow
string
rpiCameraTextOverlayEnable
boolean
rpiCameraTextOverlay
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,
  • "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",
  • "rpiCameraAfMode": "string",
  • "rpiCameraAfRange": "string",
  • "rpiCameraAfSpeed": "string",
  • "rpiCameraLensPosition": 0,
  • "rpiCameraAfWindow": "string",
  • "rpiCameraTextOverlayEnable": true,
  • "rpiCameraTextOverlay": "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
integer
rpiCameraWidth
integer
rpiCameraHeight
integer
rpiCameraHFlip
boolean
rpiCameraVFlip
boolean
rpiCameraBrightness
number
rpiCameraContrast
number
rpiCameraSaturation
number
rpiCameraSharpness
number
rpiCameraExposure
string
rpiCameraAWB
string
rpiCameraDenoise
string
rpiCameraShutter
integer
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
integer
rpiCameraIDRPeriod
integer
rpiCameraBitrate
integer
rpiCameraProfile
string
rpiCameraLevel
string
rpiCameraAfMode
string
rpiCameraAfRange
string
rpiCameraAfSpeed
string
rpiCameraLensPosition
number
rpiCameraAfWindow
string
rpiCameraTextOverlayEnable
boolean
rpiCameraTextOverlay
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,
  • "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",
  • "rpiCameraAfMode": "string",
  • "rpiCameraAfRange": "string",
  • "rpiCameraAfSpeed": "string",
  • "rpiCameraLensPosition": 0,
  • "rpiCameraAfWindow": "string",
  • "rpiCameraTextOverlayEnable": true,
  • "rpiCameraTextOverlay": "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 HLS muxers.

Responses

Response samples

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

returns all paths.

Responses

Response samples

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

returns all RTSP connections.

Responses

Response samples

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

returns all 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.

-

Responses

returns all RTSPS connections.

Responses

Response samples

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

returns all 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.

-

Responses

returns all 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.

-

Responses

returns all RTMPS connections.

Responses

Response samples

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

kicks out a RTMPS connection from the server.

path Parameters
id
required
string

the ID of the connection.

-

Responses

returns all WebRTC connections.

Responses

Response samples

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

kicks out a WebRTC connection from the server.

path Parameters
id
required
string

the ID of the session.

-

Responses

+ " fill="currentColor">

mediamtx API (1.0.0)

Download OpenAPI specification:Download

License: MIT

API of mediamtx, 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,
  • "udpMaxPayloadSize": 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",
  • "rtmpEncryption": "string",
  • "rtmpsAddress": "string",
  • "rtmpServerKey": "string",
  • "rtmpServerCert": "string",
  • "hlsDisable": true,
  • "hlsAddress": "string",
  • "hlsEncryption": true,
  • "hlsServerKey": "string",
  • "hlsServerCert": "string",
  • "hlsAlwaysRemux": true,
  • "hlsVariant": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsPartDuration": "string",
  • "hlsSegmentMaxSize": "string",
  • "hlsAllowOrigin": "string",
  • "hlsTrustedProxies": [
    ],
  • "hlsDirectory": "string",
  • "webrtcDisable": true,
  • "webrtcAddress": "string",
  • "webrtcEncryption": true,
  • "webrtcServerKey": "string",
  • "webrtcServerCert": "string",
  • "webrtcAllowOrigin": "string",
  • "webrtcTrustedProxies": [
    ],
  • "webrtcICEServers": [
    ],
  • "webrtcICEHostNAT1To1IPs": [
    ],
  • "webrtcICEUDPMuxAddress": "string",
  • "webrtcICETCPMuxAddress": "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
udpMaxPayloadSize
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
rtmpEncryption
string
rtmpsAddress
string
rtmpServerKey
string
rtmpServerCert
string
hlsDisable
boolean
hlsAddress
string
hlsEncryption
boolean
hlsServerKey
string
hlsServerCert
string
hlsAlwaysRemux
boolean
hlsVariant
string
hlsSegmentCount
integer
hlsSegmentDuration
string
hlsPartDuration
string
hlsSegmentMaxSize
string
hlsAllowOrigin
string
hlsTrustedProxies
Array of strings
hlsDirectory
string
webrtcDisable
boolean
webrtcAddress
string
webrtcEncryption
boolean
webrtcServerKey
string
webrtcServerCert
string
webrtcAllowOrigin
string
webrtcTrustedProxies
Array of strings
webrtcICEServers
Array of strings
webrtcICEHostNAT1To1IPs
Array of strings
webrtcICEUDPMuxAddress
string
webrtcICETCPMuxAddress
string
object

Responses

Request samples

Content type
application/json
{
  • "logLevel": "string",
  • "logDestinations": [
    ],
  • "logFile": "string",
  • "readTimeout": "string",
  • "writeTimeout": "string",
  • "readBufferCount": 0,
  • "udpMaxPayloadSize": 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",
  • "rtmpEncryption": "string",
  • "rtmpsAddress": "string",
  • "rtmpServerKey": "string",
  • "rtmpServerCert": "string",
  • "hlsDisable": true,
  • "hlsAddress": "string",
  • "hlsEncryption": true,
  • "hlsServerKey": "string",
  • "hlsServerCert": "string",
  • "hlsAlwaysRemux": true,
  • "hlsVariant": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": "string",
  • "hlsPartDuration": "string",
  • "hlsSegmentMaxSize": "string",
  • "hlsAllowOrigin": "string",
  • "hlsTrustedProxies": [
    ],
  • "hlsDirectory": "string",
  • "webrtcDisable": true,
  • "webrtcAddress": "string",
  • "webrtcEncryption": true,
  • "webrtcServerKey": "string",
  • "webrtcServerCert": "string",
  • "webrtcAllowOrigin": "string",
  • "webrtcTrustedProxies": [
    ],
  • "webrtcICEServers": [
    ],
  • "webrtcICEHostNAT1To1IPs": [
    ],
  • "webrtcICEUDPMuxAddress": "string",
  • "webrtcICETCPMuxAddress": "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
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
publishUser
string
publishPass
string
publishIPs
Array of strings
readUser
string
readPass
string
readIPs
Array of strings
disablePublisherOverride
boolean
fallback
string
sourceProtocol
string
sourceAnyPortEnable
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
rpiCameraDenoise
string
rpiCameraShutter
integer
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
integer
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
runOnReady
string
runOnReadyRestart
boolean
runOnRead
string
runOnReadRestart
boolean

Responses

Request samples

Content type
application/json
{
  • "source": "string",
  • "sourceFingerprint": "string",
  • "sourceOnDemand": true,
  • "sourceOnDemandStartTimeout": "string",
  • "sourceOnDemandCloseAfter": "string",
  • "publishUser": "string",
  • "publishPass": "string",
  • "publishIPs": [
    ],
  • "readUser": "string",
  • "readPass": "string",
  • "readIPs": [
    ],
  • "disablePublisherOverride": true,
  • "fallback": "string",
  • "sourceProtocol": "string",
  • "sourceAnyPortEnable": 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",
  • "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",
  • "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",
  • "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
sourceFingerprint
string
sourceOnDemand
boolean
sourceOnDemandStartTimeout
string
sourceOnDemandCloseAfter
string
publishUser
string
publishPass
string
publishIPs
Array of strings
readUser
string
readPass
string
readIPs
Array of strings
disablePublisherOverride
boolean
fallback
string
sourceProtocol
string
sourceAnyPortEnable
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
rpiCameraDenoise
string
rpiCameraShutter
integer
rpiCameraMetering
string
rpiCameraGain
number
rpiCameraEV
number
rpiCameraROI
string
rpiCameraTuningFile
string
rpiCameraMode
string
rpiCameraFPS
integer
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
runOnReady
string
runOnReadyRestart
boolean
runOnRead
string
runOnReadRestart
boolean

Responses

Request samples

Content type
application/json
{
  • "source": "string",
  • "sourceFingerprint": "string",
  • "sourceOnDemand": true,
  • "sourceOnDemandStartTimeout": "string",
  • "sourceOnDemandCloseAfter": "string",
  • "publishUser": "string",
  • "publishPass": "string",
  • "publishIPs": [
    ],
  • "readUser": "string",
  • "readPass": "string",
  • "readIPs": [
    ],
  • "disablePublisherOverride": true,
  • "fallback": "string",
  • "sourceProtocol": "string",
  • "sourceAnyPortEnable": 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",
  • "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",
  • "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",
  • "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 HLS muxers.

query Parameters
page
number
Default: 0

page number.

+
itemsPerPage
number
Default: 100

items per page.

+

Responses

Response samples

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

returns all paths.

query Parameters
page
number
Default: 0

page number.

+
itemsPerPage
number
Default: 100

items per page.

+

Responses

Response samples

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

returns all RTSP connections.

query Parameters
page
number
Default: 0

page number.

+
itemsPerPage
number
Default: 100

items per page.

+

Responses

Response samples

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

returns all RTSP sessions.

query Parameters
page
number
Default: 0

page number.

+
itemsPerPage
number
Default: 100

items per page.

+

Responses

Response samples

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

kicks out a RTSP session from the server.

path Parameters
id
required
string

the ID of the session.

+

Responses

returns all RTSPS connections.

query Parameters
page
number
Default: 0

page number.

+
itemsPerPage
number
Default: 100

items per page.

+

Responses

Response samples

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

returns all RTSPS sessions.

query Parameters
page
number
Default: 0

page number.

+
itemsPerPage
number
Default: 100

items per page.

+

Responses

Response samples

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

kicks out a RTSPS session from the server.

path Parameters
id
required
string

the ID of the session.

+

Responses

returns all RTMP connections.

query Parameters
page
number
Default: 0

page number.

+
itemsPerPage
number
Default: 100

items per page.

+

Responses

Response samples

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

kicks out a RTMP connection from the server.

path Parameters
id
required
string

the ID of the connection.

+

Responses

returns all RTMPS connections.

query Parameters
page
number
Default: 0

page number.

+
itemsPerPage
number
Default: 100

items per page.

+

Responses

Response samples

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

kicks out a RTMPS connection from the server.

path Parameters
id
required
string

the ID of the connection.

+

Responses

returns all WebRTC connections.

query Parameters
page
number
Default: 0

page number.

+
itemsPerPage
number
Default: 100

items per page.

+

Responses

Response samples

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

kicks out a WebRTC connection from the server.

path Parameters
id
required
string

the ID of the session.

+

Responses