http_api |
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
http_api [2024/02/27 16:15] cflintiii [Overlay] |
http_api [2024/04/05 15:35] (current) anthony [Overlay] |
||
|---|---|---|---|
| Line 834: | Line 834: | ||
| zoom_wide_std | zoom_wide_std | ||
| zoom_wide_var p (0 (Low) .. 7 (High)) | zoom_wide_var p (0 (Low) .. 7 (High)) | ||
| + | |||
| + | </code> | ||
| + | |||
| + | Tau2 Specific | ||
| + | |||
| + | <code python> | ||
| + | The Color are done in the FPGA: | ||
| + | |||
| + | OFF: | ||
| + | SetColorPallette+off | ||
| + | |||
| + | RESET: | ||
| + | SetColorPallette+reset | ||
| + | |||
| + | COLORS: | ||
| + | SetColorPallette+blackhot | ||
| + | SetColorPallette+whitehot | ||
| + | SetColorPallette+sepia | ||
| + | SetColorPallette+rainbow | ||
| + | SetColorPallette+rain | ||
| + | SetColorPallette+ironbow2 | ||
| + | SetColorPallette+ironbow1 | ||
| + | SetColorPallette+icefire | ||
| + | SetColorPallette+glowbow | ||
| + | SetColorPallette+fusion | ||
| + | SetColorPallette+color2 | ||
| + | SetColorPallette+color1 | ||
| </code> | </code> | ||
| Line 852: | Line 879: | ||
| ---- | ---- | ||
| + | |||
| ==== ClearHistory ==== | ==== ClearHistory ==== | ||
| Line 1612: | Line 1640: | ||
| ---- | ---- | ||
| - | Add/Update the overlay values in the Database. | + | Display text or a PNG overlayed on the video feed for a given Channel. |
| == Parameters: == | == Parameters: == | ||
| Line 1620: | Line 1648: | ||
| //**chn**// Get the encoder channel number. The default is encoder channel 1. Select between encoder channels. Possible values: 1, 2, 3, or 4. | //**chn**// Get the encoder channel number. The default is encoder channel 1. Select between encoder channels. Possible values: 1, 2, 3, or 4. | ||
| - | **Ambarella Specific** \\ | + | **//rgn_idx // **//(Ambarella Specific)// Region Index, index to map overlay. The region index value is system-wide and can be in the range of 1 to 16. Ambarella provides 16 total color look-up tables for Overlay (for all Channels), rgn_idx signifies which color look-up table(CLUT) is in use. |
| - | **//rgn_idx//** Index to map overlay. The region index value can be in the range of 1 to 16. Ambarella provides 16 total color look-up tables for Overlay, rgn_idx signifies which color look-up table is in use. | + | <code> |
| + | TEXT type=text source=”Channel 1” instance=1 rgn_idx=1 | ||
| + | type=text source=”Channel 2” instance=2 rgn_idx=1 | ||
| + | |||
| + | </code> | ||
| + | |||
| + | In the above example, identical region indices are used, effectively reusing the CLUT. The text will be correct on each channel. When changing the color of the text, when using identical region indices, the last Overlay command issued will override all Overlay instances that are using the same region index, the text will still be different but the color will be the same because they are using the same shared rgn_idx. | ||
| + | |||
| + | <code> | ||
| + | PNG type=png source=”/opt/config/images/image.png” instance=1 rgn_idx=2 | ||
| + | type=png source=”/opt/config/images/image.png” instance=2 rgn_idx=2 | ||
| + | |||
| + | </code> | ||
| + | |||
| + | PNG overlay will work in the same way as text overlay when re-using region indices, but this is only helpful when overlaying identical PNGs.\\ | ||
| + | Using different PNGs would cause colors to go wonky due to differing CLUTs for the different PNGs. | ||
| + | |||
| + | The encoder writes the entire CLUT at the rgn_idx with each overlay command. | ||
| - | **Qualcomm and HiSilicon** \\ | + | //**rgn_idx ** (//Qualcomm and DCK//)// Index to map overlay. The region index value can be in the range of 0 to 128, per channel. |
| - | //**rgn_idx**// Index to map overlay.The region index value can be in the range of 0 to 128, per channel. | + | |
| //**type**// Type of overlay to be used possible values: text or png. | //**type**// Type of overlay to be used possible values: text or png. | ||
| Line 9848: | Line 9892: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| //**interface**// TEXT, | //**interface**// TEXT, | ||
| Line 9865: | Line 9909: | ||
| ---- | ---- | ||
| + | |||
| ==== GetCronJobs ==== | ==== GetCronJobs ==== | ||
| Line 9882: | Line 9927: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| **//enable//** INTEGER, | **//enable//** INTEGER, | ||
| Line 9905: | Line 9950: | ||
| ---- | ---- | ||
| + | |||
| ==== GetNFSMount ==== | ==== GetNFSMount ==== | ||
| Line 9922: | Line 9968: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| **//mounted//** TEXT, | **//mounted//** TEXT, | ||
| ---- | ---- | ||
| + | |||
| ==== aspect_info ==== | ==== aspect_info ==== | ||
| Line 9945: | Line 9992: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| //**numerator**// INTEGER, | //**numerator**// INTEGER, | ||
| Line 9952: | Line 9999: | ||
| ---- | ---- | ||
| + | |||
| ==== boardinfo ==== | ==== boardinfo ==== | ||
| Line 9969: | Line 10017: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| //**logo_enable**// TEXT, | //**logo_enable**// TEXT, | ||
| Line 9988: | Line 10036: | ||
| ---- | ---- | ||
| + | |||
| ==== cam_state ==== | ==== cam_state ==== | ||
| Line 10005: | Line 10054: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| //**preset**// TEXT, | //**preset**// TEXT, | ||
| Line 10018: | Line 10067: | ||
| ---- | ---- | ||
| + | |||
| ==== camera ==== | ==== camera ==== | ||
| Line 10036: | Line 10086: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| //**zoom_direct_value**// INTEGER. | //**zoom_direct_value**// INTEGER. | ||
| Line 10131: | Line 10181: | ||
| ---- | ---- | ||
| + | |||
| ==== camera_exposure ==== | ==== camera_exposure ==== | ||
| Line 10149: | Line 10200: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| //**ae_mode**// TEXT, | //**ae_mode**// TEXT, | ||
| Line 10182: | Line 10233: | ||
| ---- | ---- | ||
| + | |||
| ==== camera_monitor_mode ==== | ==== camera_monitor_mode ==== | ||
| Line 10200: | Line 10252: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| //**modes**// TEXT. | //**modes**// TEXT. | ||
| Line 10207: | Line 10259: | ||
| ---- | ---- | ||
| + | |||
| ==== dec ==== | ==== dec ==== | ||
| Line 10225: | Line 10278: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| //**preset**// TEXT. | //**preset**// TEXT. | ||
| Line 10264: | Line 10317: | ||
| ---- | ---- | ||
| + | |||
| ==== download ==== | ==== download ==== | ||
| Line 10284: | Line 10338: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| //**FileName**// TEXT. | //**FileName**// TEXT. | ||
| Line 10293: | Line 10347: | ||
| ---- | ---- | ||
| + | |||
| ==== drs_tamarisk_settings ==== | ==== drs_tamarisk_settings ==== | ||
| Line 10311: | Line 10366: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| //**color_pallette**// TEXT. | //**color_pallette**// TEXT. | ||
| Line 10320: | Line 10375: | ||
| ---- | ---- | ||
| + | |||
| ==== enc ==== | ==== enc ==== | ||
| Line 10338: | Line 10394: | ||
| JSON formatted table with values below | JSON formatted table with values below | ||
| - | //**ret**// Custom return code of the HTTP POST request. 0 on success, -1 on failure. | + | //**ret**// Custom return code of the HTTP GET request. 0 on success, -1 on failure. |
| //**preset**// TEXT, | //**preset**// TEXT, | ||
| Line 10535: | Line 10591: | ||
| ---- | ---- | ||
| + | |||
| ==== filepicker ==== | ==== filepicker ==== | ||
http_api.1709050550.txt.gz · Last modified: 2024/02/27 16:15 by cflintiii
Page Tools
