Atlas Knowledge Base
Dashboard
RTSP Service

RTSP Service


Overview

The RTSP Service runs and supervises the video engine that SBN uses for camera streaming. It starts the engine when the service starts, keeps the required number of each kind of video process running, and shuts them all down cleanly when the service stops. On each pass of its timer it re-checks the running set against what you have configured and performs a health check, so a process that has stopped unexpectedly is brought back without anyone having to intervene.

The video engine is made up of several cooperating parts, and you choose how many of each to run: a broker that ties the parts together, a proxy that handles incoming requests, camera stream processes that pull video from the cameras, recording processes, and peer processes that deliver video to viewers in a browser. Instance counts can be changed while the service is running, so capacity can be adjusted without a restart. This service supervises video processes rather than reading from SBN, so it does not need an SBN data-server connection — but the video engine must be installed alongside it, and the ports it is configured to use must be free when it starts.

Dashboard

Installing and managing this service is done from the SBN Services Dashboard &mdash; see <a href="/help/SBN-Services/Dashboard">here</a>.

Service Properties

Only properties specific to this service are listed here. Common service properties (SBN Server connection, Logging, SMTP) are found <a href="/help/SBN-Services/Common-Properties">here</a>.

Timer (In Seconds)

How often the service checks the health of the video engine and re-applies the configured instance counts.

Instances

How many of each kind of video process to run: Broker, API Proxy, Camera Stream, Recording Peer, WebRTC Peer, and APIEngine - AlarmLog. These can be changed without restarting the service &mdash; the next pass of the timer brings the running set into line.

Logging

Controls the logging produced by the video processes themselves, separately from the service's own log. Logging Level sets how much detail is recorded, Verbose logging adds the fullest detail, Log to console also writes messages to the console window, and Logging UDP Port is the local port the video processes use to pass their log messages back to the service.

Video Engine &mdash; Watchdog

Timer (In Seconds) sets how often the engine checks its own processes are still healthy.

Video Engine &mdash; Broker

Listening URL and Listening Port are where the broker accepts connections from the other video processes, Monitoring Port is the separate port used to check its health, Connection Timeout (In Seconds) is how long a connection attempt is allowed to take, and Authorization Token is the shared secret the other processes must present.

Video Engine &mdash; API Proxy

Listening URL and Listening Port are where the proxy accepts video requests, and Allow Origins controls which web addresses are permitted to make those requests.

Video Engine &mdash; Camera Stream

Retry delay (in seconds) is how long to wait before reconnecting to a camera that did not answer, Closing delay (in seconds) is how long an idle stream is held open before being torn down, Garbage collection (in seconds) is how often unused resources are cleaned up, and RTP debugging and RTSP debugging add detailed diagnostics for the camera connection when a stream is being investigated.

Video Engine &mdash; WebRTC Peer

TURN Servers and STUN Servers are the helper servers used to establish a video connection through to a viewer's browser. Each is given its URLs, and the TURN servers additionally take a Username and Credential to sign in with.



Was this helpful?