Skip to main content

Configuration

This guide covers the configuration requirements and settings for integrating cameras with the Arvist platform.

Required Parameters​

When adding a camera to the Arvist platform, the following parameters are required:

ParameterDescriptionRequired
nameUnique identifier for the camera✅
main streamPrimary RTSP URL for recording✅
sub streamSecondary RTSP URL for detection❌
heightCamera vertical resolution (e.g., 1080). Defaults to 720❌
widthCamera horizontal resolution (e.g., 1920). Defaults to 1280❌

RTSP URL Format​

The RTSP URL follows a standard format that includes authentication and stream path:

rtsp://<user>:<password>@<ip>:554/<stream>/media.smp

Components​

  • username: Camera login username
  • password: Camera login password
  • camera-ip: IP address of the camera
  • 554: Default RTSP port (may vary by manufacturer)
  • /stream: Stream path (varies by manufacturer and stream type)

Vendor-Specific Examples​

Different camera manufacturers use different RTSP URL formats. Here are common examples:

Hikvision​

rtsp://admin:password@192.168.1.100:554/Streaming/Channels/101
  • Main stream: /Streaming/Channels/101
  • Sub stream: /Streaming/Channels/102

Dahua​

rtsp://admin:password@192.168.1.100:554/cam/realmonitor?channel=1&subtype=0
  • Main stream: subtype=0
  • Sub stream: subtype=1

Axis​

rtsp://admin:password@192.168.1.100/axis-media/media.amp
  • Axis cameras typically use /axis-media/media.amp for the main stream
Finding Your Camera's RTSP URL

Consult your camera's manual or manufacturer documentation for the exact RTSP URL format. Many manufacturers provide ONVIF support which can help auto-discover stream paths.

Special Characters in URLs​

If your password contains special characters, you must URL encode them:

CharacterURL Encoded
@%40
!%21
#%23
$%24
%%25
^%5E
&%26
*%2A
(%28
)%29

Example:

  • Password: P@ss!
  • Encoded: P%40ss%21
  • Full URL: rtsp://admin:P%40ss%21@192.168.1.100:554/stream

Stream Configuration​

For optimal performance with Arvist, configure your cameras with the following settings:

Main Stream (Recording & RTSP)​

  • Encode Mode: H.264
  • Resolution: 2688x1520 (or similar)
  • Frame Rate (FPS): 15
  • I Frame Interval: 30
  • Bitrate: Variable (VBR) or 4096 Kbps

Sub Stream (Detection)​

  • Enable: Sub Stream
  • Encode Mode: H.264
  • Resolution: 1280x720
  • Frame Rate: 5
  • I Frame Interval: 5
  • Bitrate: Variable (VBR) or 1024 Kbps
Why Two Streams?

Using a high-resolution main stream for recording and a lower-resolution sub stream for detection optimizes both video quality and system performance.

Testing Camera Configuration​

Before saving a camera configuration, test the connection:

Using VLC Media Player​

  1. Open VLC
  2. Go to Media → Open Network Stream
  3. Enter your RTSP URL
  4. Click Play

If the stream loads successfully, your RTSP URL is correct.

Using FFprobe​

ffprobe rtsp://<user>:<password>@<ip>:554/<stream>/media.smp

This command will display stream information if the connection is successful.

Using cURL​

curl -I rtsp://<user>:<password>@<ip>:554/<stream>/media.smp

A successful connection will return stream headers.

Configuration Best Practices​

  • Use descriptive names: Name cameras based on their location (e.g., "Warehouse_North_Entrance")
  • Document credentials: Keep a secure record of all camera credentials
  • Test RTSP URLs externally: Use VLC or FFprobe to verify RTSP URLs before adding cameras
  • Use sub streams: Configure and use sub streams to reduce processing load
  • Monitor bandwidth: Ensure your network can handle the combined bandwidth of all camera streams
  • Regular firmware updates: Keep camera firmware updated for security and stability

Network Configuration​

Refer to the Network Configuration documentation for detailed information about recommended camera setup, including:

  • IP camera specifications
  • HTTP-based cameras
  • USB device support

Next Steps​

After configuring your cameras:

  1. Add cameras to areas using Area Configuration
  2. Set up detection zones using Zone Configuration
  3. Configure modules for specific use cases in Modules

For camera management tasks, see the Management guide.