Skip to content

Advanced Options

RTSP Authentication

The device service allows for rtsp stream authentication using the rtsp-simple-server. Authentication is enabled by default.

Secret Configuration

To configure the username and password for rtsp authentication when building your own images, edit the fields in the 'configuration.yaml'.


This should only be used when you are in non-secure mode.


Be careful when storing any potentially important information in cleartext on files in your computer. In this case, the credentials for the stream are stored in cleartext in the configuration.yaml file on your system. InsecureSecrets is for non-production use only.


Leaving the fields blank will NOT disable authentication. The stream will not be able to be authenticated until credentials are provided.

Snippet from configuration.yaml

    LogLevel: "INFO"
            SecretName: rtspauth
                username: "<enter-username>"
                password: "<enter-password>"

Authentication Server Configuration

  • You can configure the authentication server to run from a different port by editing the externalAuthenticationURL value in the Dockerfile.
  • To disable authentication entirely, comment out the externalAuthenticationURL line in the Dockerfile.

externalAuthenticationURL line from the Dockerfile

RUN sed -i 's,externalAuthenticationURL:,externalAuthenticationURL: http://localhost:8000/rtspauth,g' rtsp-simple-server.yml

Video options

There are two types of options: - The options start with Input prefix are used for the camera, such as specifying the image size and pixel format.
- The options start with Output prefix are used for the output video, such as specifying aspect ratio and quality.

These options can be passed in through object value when calling StartStreaming.

Query parameter:
- device name: The name of the camera

Example StartStreaming Command

curl -X PUT -d '{
    "StartStreaming": {
    "InputImageSize": "640x480",
    "OutputVideoQuality": "5"
}' http://localhost:59882/api/v3/device/name/<device name>/StartStreaming

Supported Input options:

  • InputFps: Ignore original timestamps and instead generate timestamps assuming constant frame rate fps. (default - same as source)
  • InputImageSize: Specifies the image size of the camera. The format is wxh, for example "640x480". (default - automatically selected by FFmpeg)
  • InputPixelFormat: Set the preferred pixel format (for raw video). (default - automatically selected by FFmpeg)

Supported Output options:

  • OutputFrames: Set the number of video frames to output. (default - no limitation on frames)
  • OutputFps: Duplicate or drop input frames to achieve constant output frame rate fps. (default - same as InputFps)
  • OutputImageSize: Performs image rescaling. The format is wxh, for example "640x480". (default - same as InputImageSize)
  • OutputAspect: Set the video display aspect ratio specified by aspect. For example "4:3", "16:9". (default - same as source)
  • OutputVideoCodec: Set the video codec. For example "mpeg4", "h264". (default - mpeg4)
  • OutputVideoQuality: Use fixed video quality level. Range is a integer number between 1 to 31, with 31 being the worst quality. (default - dynamically set by FFmpeg)

You can also set default values for these options by adding additional attributes to the device resource StartStreaming. The attribute name consists of a prefix "default" and the option name.

Snippet from device.yaml

- name: "StartStreaming"
    description: "Start streaming process."
    { command: "VIDEO_START_STREAMING",
        defaultInputFrameSize: "320x240",
        defaultOutputVideoQuality: "31"
    valueType: "Object"
    readWrite: "W"


It's NOT recommended to set default video options in the 'cmd/res/profiles/' as they may not be supported by every camera.

Keep the paths of existing camera up to date

The paths (/dev/video*) of the connected cameras may change whenever the cameras are re-connected or the system restarts. To ensure the paths of the existing cameras are up to date, the device service scans all the existing cameras to check whether their serial numbers match the connected cameras. If there is a mismatch between them, the device service will scan all paths to find the matching device and update the existing device with the correct path.

This check can also be triggered by using the Device Service API /refreshdevicepaths.

curl -X POST http://localhost:59983/api/v3/refreshdevicepaths

It's recommended to trigger a check after re-plugging cameras.

Configurable RTSP server hostname and port

The hostname and port of the RTSP server to which the device service publishes video streams can be configured in the [Driver] section of the service configuration located in the cmd/res/configuration.yaml file.

Snippet from configuration.yaml

    RtspServerHostName: "localhost"
    RtspTcpPort: "8554"
    RtspAuthenticationServer: "localhost:8000"

CameraStatus Command

Use the following query to determine the status of the camera. URL parameter:

  • DeviceName: The name of the camera
  • InputIndex: indicates the current index of the video input (if a camera only has one source for video, the index needs to be set to '0')

Example CameraStatus Command

curl -X GET http://localhost:59882/api/v3/device/name/<DeviceName>/CameraStatus?InputIndex=0 | jq -r '"CameraStatus: " + (.event.readings[].value|tostring)'

Example Output:

CameraStatus: 0

Response meanings:

Response Description
0 Ready
1 No Power
2 No Signal
3 No Color