http_api |
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
http_api [2024/04/05 15:05] cflintiii [Overlay] |
http_api [2024/04/05 15:35] (current) anthony [Overlay] |
||
|---|---|---|---|
| Line 1640: | 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 1648: | 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. | ||
| - | **//rgn_idx // **//(Ambarella Specific)// Index to map overlay. The region index value can be in the range of 1 to 16 for the system(not per channel), all channels . Ambarella provides 16 total color look-up tables for Overlay, rgn_idx signifies which color look-up table(CLUT) is in use. | + | **//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. |
| <code> | <code> | ||
| TEXT type=text source=”Channel 1” instance=1 rgn_idx=1 | TEXT type=text source=”Channel 1” instance=1 rgn_idx=1 | ||
| Line 1655: | Line 1655: | ||
| </code> | </code> | ||
| - | The text will be correct on each individual channel as while using the (rgn_idx) at 1\\ | + | 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. |
| - | When changing the color of the text on the OVERLAY using the same rgn_idx=1 the last command issued will override both channels, the text will still be different but the color will be the same because they are using the same shared rgn_idx | + | |
| <code> | <code> | ||
| Line 1664: | Line 1663: | ||
| </code> | </code> | ||
| - | PNG will work in the same way but you would only want to do this for 2 of the same PNG\\ | + | 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 (CLUT is now different at the rgn_idx) | + | Using different PNGs would cause colors to go wonky due to differing CLUTs for the different PNGs. |
| - | This is because we write the entire CLUT at the rgn_idx with each overlay cmd | + | The encoder writes the entire CLUT at the rgn_idx with each overlay command. |
| - | //**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 ** (//Qualcomm and DCK//)// 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. | ||
http_api.txt · Last modified: 2024/04/05 15:35 by anthony
Page Tools
