Camera Configuration Table
Above Table
Action Column
View camera stream (play button)
Edit camera (pencil button)
Clone camera (clipboard button)
Reboot camera (power button)
Delete camera (bin button)
| Column | Type | Description |
|---|---|---|
| Camera | text | Unique, lowercase, alphanumeric camera name or identifier, linked to camera monitoring. No spaces or special characters allowed (except for ‘-’ and ‘_’). |
| Description | text | Brief description of camera (optional). |
| Assigned Streams | dialog | Ordered list of streams assigned to camera (optional). Assignment is required to use web UI player with embedded PTZ controls. The dialog supports the selection / assignment of one or more streams to the camera, the addition of new stream configurations, and the editing of existing stream configurations. |
| Proxy Port | number | HTTP/S listening port used to route / proxy camera control commands from other applications (optional). |
| Control Protocol | droplist | Protocol used for camera monitoring and control: “None” or ‘ONVIF’. |
| Control Disabled | checkbox | Disable all communication with camera. |
| Host | text | Host or IP address of camera. Required if selected protocol is not ‘none’. |
| Port | number | HTTP/S port of camera. Required if selected protocol is not ‘none’. |
| HTTPS | checkbox | Use HTTPS (TLS) for camera communication. |
| Username | text | Username for camera communication. Optional, but required by most cameras. |
| Password | text | Password for camera communication. Optional, but required by most cameras. |
| Relative Move Support | checkbox | Relative move supported by camera. |
Assigned Streams Dialog
Assigned Streams Dialog, New Stream Configuration
Assigned Streams Dialog, Edit 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 URL | 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. |
| Disabled | checkbox | 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. Note that RTSP multicast must be enabled on the assigned server. |
| Auth Token | checkbox | Token based authentication is enabled for this stream. HLS and WebRTC clients must provide a valid 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]”. |
Extended Camera Configuration
| Name | Type | Description |
|---|---|---|
| Camera | text | Unique, lowercase, alphanumeric camera name or identifier, linked to camera monitoring. No spaces or special characters allowed (except for ‘-’ and ‘_’). |
| Description | text | Brief description of camera (optional). |
| Proxy Port | number | HTTP/S listening port used to route / proxy camera control commands from other applications (optional). |
| Protocol | droplist | Protocol used for camera monitoring and control: “None” or ‘ONVIF’. |
| Disabled | droplist | Disable all communication with camera. |
| Host | text | Host or IP address of camera. Required if selected protocol is not ‘none’. |
| Port | number | HTTP/S port of camera. Required if selected protocol is not ‘none’. |
| Use HTTPS | checkbox | Use HTTPS (TLS) for camera communication. |
| Username | text | Username for camera communication. Optional, but required by most cameras. |
| Password | text | Password for camera communication. Optional, but required by most cameras. |
| Relative Move | checkbox | Relative move supported by camera. |
| Active Preset Tour | droplist | Supported options: “None” or configured preset tour. |
| Auto Home | droplist | Supported options: “ENABLED” or “DISABLED”. When set to ‘ENABLED’, the camera will be instructed to return to its home position after the specified Auto Home Inactivity Period has elapsed. |
| Inactivity Period (m) | number | The period of camera control inactivity (in minutes) that must elapse before the camera is automatically instructed to return to its home position. |
| Preset Tours | table | The preset tours for the camera (optional). |
| Assigned Streams | dialog | Ordered list of streams assigned to camera (optional). Assignment is required to use web UI player with embedded PTZ controls. The dialog supports the selection / assignment of one or more streams to the camera, the addition of new stream configurations, and the editing of existing stream configurations. |
| Stream Templates | multiselect | Ordered list of stream templates (optional). |
When configured, a new profile is created and maintained in the camera for each stream template, with the name ‘xflow-<stream template name>’ and an encoder configuration that matches the stream template’s settings (framerate, bitrate, resolution, etc.) as closely as supported by the camera.
**Important: If no streams are assigned to the camera, and no streams exist with the same IP address as the camera, the platform will automatically create a new stream for each assigned stream template.
If a single stream and single stream template is assigned to a camera, the platform will automatically update / maintain that stream’s configuration to use the source URL provided by the camera for the assigned stream template. If multiple streams or multiple stream templates are assigned to a camera, each stream name must incorporate the corresponding stream template name as a suffix (i.e., ‘<original stream name>-<stream template name>‘) to enable this automation.** | | Modify In Use Encoders | droplist | When one or more stream templates are selected, use / modify encoders already in use by existing profiles. Often required when a camera has a small number of encoders. | | Throttle Unused Encoders | droplist | When one or more stream templates are selected, throttle (minimize) the configuration of each encoder not assigned to a profile. Sometimes required when a camera has modest CPU resources (to conserve resources). | | Delete Non-Fixed Profiles | droplist | When one or more stream templates are selected, remove non-fixed (previously added / custom) profiles. Sometimes required when a camera has modest CPU resources (to conserve resources). | | Location Description | text | Brief description of camera location (optional). | | Latitude | number | Latitude of camera location (optional). | | Longitude | number | Longitude of camera location (optional). | | Roadway | text | Roadway name or identifier (optional). |
Preset Tours Table
| --- | --- | --- |
PTZ Player, Suspend Auto Move (i.e., Auto Home, Preset Tour)
PTZ Player, Resume Auto Move (i.e., Auto Home, Preset Tour)
Next
Previous