Stream Configuration Table

Stream Configuration Table

Above Table

Action Column

Column Type Description
Stream text Unique, lowercase, alphanumeric stream name or identifier, linked to stream monitoring. No spaces or special characters allowed (except for ‘-’ and ‘_’). Used in output stream URLs.
Description text Brief description of stream or stream source (camera name, camera location, etc.).
Camera read-only Camera(s) to which the stream has been assigned, linked to camera configurations.
Status read-only Status of stream: “online”, “offline”, “unknown”, or “disabled”.
Home Server droplist Home server.
Source text Source URL for the stream. Must be a valid URL with a supported protocol (“udp”, “rtsp”, “rtsps”, “rtmp”, “rtmps”, “http”, “https”).
Transport droplist Transport protocol of the source stream: “TCP”, “UDP”, “MULTI”, “HTTP”, or “HTTPS”.
Always Active checkbox Stream is always ingested, even when no clients are connected. When not enabled, the stream is only ingested when requested / clients are connected.
Auth Token checkbox Token based authorization is enabled for this stream. HLS, LLHLS, and WebRTC clients must provide a valid auth token in order to access the stream.
Disabled checkbox Disable stream. The stream will not be ingested or restreamed.

Extended Stream Configuration

Extended Stream Configuration

Name Type Description
Stream text Unique, lowercase, alphanumeric stream name or identifier, linked to stream monitoring. No spaces or special characters allowed (except for ‘-’ and ‘_’). Used in output stream URLs.
Description text Brief description of stream or stream source (camera name, camera location, etc.).
Home Server droplist Home server.
Source text Source URL for the stream. Must be a valid URL with a supported protocol (“udp”, “rtsp”, “rtsps”, “rtmp”, “rtmps”, “http”, “https”).
Transport droplist Transport protocol of the source stream: “TCP”, “UDP”, “MULTI”, “HTTP”, or “HTTPS”.
Always Active droplist Always ingest stream, even when no clients are connected. When not enabled, the stream is only ingested when requested / clients are connected.
Disabled droplist Disable stream. The stream will not be ingested or restreamed.
Outbound Multicast IP text Outbound multicast IP address for the stream (optional). If not provided, the assigned server will automatically select a multicast IP address from the RTSP Multicast CIDR configured for the server. Requires that RTSP multicast be enabled on the assigned server.
Auth Token droplist Token based authorization is enabled for this stream. HLS, LLHLS, and WebRTC clients must provide a valid shared or generated auth token in order to access the stream.
Shared Secret text Shared (alphanumeric) secret used to generate / validate auth tokens and SRT passphrases for output streams. Must be 8 to 16 characters in length.
Auto Rotate Secret droplist Automatically rotate shared secret. Must also be enabled globally in the Cluster Configuration.
Conversion Type droplist Supported options: “None”, “Remux”, and “Transcode”.

When “Remux” is selected, the source stream is re-multiplexed to the selected Conversion Protocol (RTSP or RTMP) prior to restreaming.

When “Transcode” is selected, the source stream is decoded and re-encoded to H.264 using the selected H264 Preset and specified Bitrate, Width, Height and Frames Per Second, then multiplexed to the selected Conversion Protocol (RTSP or RTMP) prior to restreaming. | | Conversion Protocol | droplist | Supported options: “[auto]”, “RTMP”, and “RTSP”. | | Ingest as Realtime | droplist | Supported options: “[auto]”, “YES”, and “NO”. Optionally used in HTTP/HTTPS source stream conversion. When set to ‘YES’, the source stream is read at its native frame rate, simulating a ‘live’ stream. Can improve output stream stability when re-multiplexing file segment based source streams (e.g. HLS). Default “[auto]” is “NO”. | | Remux Window (ms) | number | Used in HTTP based protocol conversion. Maximum number of milliseconds within which to re-multiplex source stream frames. Can improve output stream stability when converting file segment based source streams (e.g. HLS). Allowed range is 1000 to 5000. Default “[auto]” is 1000. | | Output Buffer (kb) | number | Used in HTTP based protocol conversion. Size of conversion output buffer in kilobytes. Allowed range is 0 to 60000. Default “[auto]” is 0 for RTSP source streams and 3000 for other source stream types. | | H.264 Preset | droplist | H.264 (libx264) preset for stream transcoding. Supported presets: “ultrafast”, “superfast”, “veryfast”, “faster”, “fast”, “medium”, “slow”, “slower”, “veryslow”, “placebo”. Default “[auto]” is veryfast. | | Bitrate (kbps) | number | Target bitrate in kilobits per second (kbps) for stream transcoding. Allowed range is 64 to 5000. Default “[auto]” is none specified (i.e., dynamic, based on source stream and other transcoding parameters). | | Frames Per Second | number | Target frame rate in frames per second for stream transcoding. Allowed range is 5 to 60. If set to Default “[auto]” or 0, source stream frame rate is used. | | Width | number | Target width in pixels for stream transcoding. Allowed range is 64 to 3840. If set to Default “[auto]”, the source stream width is used, and the Height must also be set to Default “[auto]”. | | Height | number | Target height in pixels for stream transcoding. Allowed range is 64 to 2160. If set to Default “[auto]”, the source stream height is used, and the Width must also be set to Default “[auto]”. | | Push Targets | table | The target / destination endpoints for the stream (optional). When provided, the stream is pushed / published to these endpoints when available and active. |

Push Targets Table

Column Type Description
Endpoint text Push target URL (e.g., rtsp://user:[email protected]:554/destpath) for destination server.
Entity Name / Description text Name / description of push target / destination entity.

Next

5.4 Stream Groups

Previous

5.2 Server Configuration