RTSPController

Last updated: 2025/3/7 11:12:35

Path To

Name

Description/Function

/api/rtsp

/get

Get the current configuration.

/api/rtsp

/update

Update the streaming settings.

Method

Get

Response

All the configuration.

Example

Method

Post

Body

{
  "Framerate":"30",
  "Bitrate":"10000",
  "Resolution":"1920x1080"
}

If you do not include a “value” in one or any of the above variables, the default value will be used. i.e. "Resolution":"" will default to “1920x1080”

Response

A representing the asynchronous operation.

Explanation

• Defaults

  • Framerate = 30

  • Bitrate = 10000

  • Resolution = 1920x1080

• Available Frame Rate

  • Any

• Available Bitrate

  • 1000 to 100,000

• Available Resolution

  • 640 x 480 (SD)

  • 1280 x 720 (720p)

  • 1920x1080 (1080p)

  • 3840 x 2160 (4K)

Example

Example 1

{
  "Framerate":"30",
  "Bitrate":"1000",
  "Resolution":"1920x1080"
}

Output

$ curl -X POST http://<ip>:<port>/api/rtsp/update
   -H 'Content-Type: application/json'
   -d '{ "Framerate":"30", "Bitrate":"2000", "Resolution":"1920x1080" }'

Example 2

{
  "Framerate":"30",
  "Bitrate":"2000",
}

Output

$ curl -X POST http://<ip>:<port>/api/rtsp/update
   -H 'Content-Type: application/json'
   -d '{ "Framerate":"30", "Bitrate":"2000" }'