Home / Docs Center / Device API Reference / ModifyConfigurationParameters
ModifyConfigurationParameters
Project: Device API Documentation (New Version) | page_id: 277
Brief Description:
- Modify configuration parameters
Request URL:
- /xsw/modValues
Request Method:
- POST
Parameters:
| Parameter | Required | Type | Description |
|---|---|---|---|
| key1 | Yes | string | The key in config |
| value1 | Yes | string | The value corresponding to the key |
| type1 | No | string | number float bool string, string by default |
Response Example
{"code":0,"msg":""}
Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | int | 0 success, others failure |
| msg | string | Error message |
Description of Some Parameters
| Parameter | key | type | value |
|---|---|---|---|
| Manual Exposure | encode.0.vi_param.0.manualExposure | number | 0 disabled, 1 enabled |
| Exposure Time | encode.0.vi_param.0.exposure | number | 0-5391 |
| Full Color Mode | encode.0.vi_param.0.whiteLightEnable | number | 0 disabled, 1 enabled |
| Fill Light Control | encode.0.vi_param.0.lightControlMode | number | 0 off, 1 infrared fill light, 2 white light, 3 auto |
| Highlight Suppression Strength | encode.0.vi_param.0.lightDepress | number | 0-255 |
| Backlight Compensation Strength | encode.0.vi_param.0.aeBLCStrength | number | 0-10 |
| Brightness | encode.0.vi_param.0.brightness | number | 0-255 |
| Contrast | encode.0.vi_param.0.contrast | number | 0-255 |
| Saturation | encode.0.vi_param.0.saturation | number | 0-255 |
| Sharpness | encode.0.vi_param.0.sharpness | number | 0-255 |
| Max Analog Gain | encode.0.vi_param.0.maxAgain | number | 0-400 |
| Max Digital Gain | encode.0.vi_param.0.maxDgain | number | 0-256 |
Examples:
- Enable full color mode
http://192.168.0.30/xsw/modValues?key1=encode.0.vi_param.0.whiteLightEnable&value1=1&type1=number&t=1755583204&token=xxxxx
- Enable exposure and set the exposure time to 5000
http://192.168.0.30/xsw/modValues?key1=encode.0.vi_param.0.manualExposure&value1=1&type1=number&key2=encode.0.vi_param.0.exposure&value2=5000&type2=number&t=1755583204&token=xxxxx
Notes
- Modification restarts the streaming.
- A maximum of 10 parameters can be modified at the same time.
Didn't find what you need?Contact us，Talk to our engineers directly.