Scoreboard OCR

There are several ways how to send data from Scoreboard OCR to vMix:

1. Using vMx API v2. It is recommended to use this method, because it will provide the smallest delay and can be easily used between two computers.
2. Using vMx API (older communication version provided for backward compatibility)
3. Using XML output
4. Using CSV output. Not recommended, see below why.
5. Using HTTP Feed output
6. Using Browser Window

Watch the video tutorial or read instructions below

1. Make sure you have at least vMix version 25.09.25 installed
2. Make sure that vMix API is enabled: Settings → Web controller → Enable | Restart vMIx after that
3. Make sure that vMix → Settings → Web Controller → “Enable enhanced security on Web and TCP API” is DISABLED (unchecked)
4. 
5. Choose “vMix API v2” in Scoreboard OCR and enter:
   1. host - the computer on which vMix is runing (use “localhost” if you are running Scoreboard OCR on the same computer as vMix). If you are running vMix on a different computer, use the IP address of that computer, for example “192.168.1.10”. Make sure the Windows Firewall on vMix computer is not blocking vMix API (if it is not working, you can always disable the firewall to makes sure it is not causing the problem)
   2. port - enter “8088” (vMIx Web controller port)
6. Use the same field names in Scoreboard OCR that are present in vMix XAML/GT template
7. Check if status of the output status is green and use your mouse to move over the output to see what field names were received from vMix
8. Use the same field names in Scoreboard OCR that are defined in vMix, you can select the field name from drop-down box when you add a new field or edit existing field
9. 
10. If you have more than one template in vMix with identical field names, Scoreboard OCR will send data to all templates at the same time

localhost:8088

192.168.1.10:8088

Here is how Scoreboard OCR will communicate with vMix:
Get the list of all field names:

http://localhost:8088/api

Update field values:

tcp://localhost:8099

FUNCTION SetText Input=[instanceID]&SelectedName=Clock&Value=6:31

Watch the video tutorial or read instructions below

1. Make sure you have at least vMix version 22.0.0.68 installed (previous versions introduce latency when receiving data 10x a second and some users have reported render time spikes when using older versions)
2. Make sure that vMix API is enabled: Settings → Web controller → Enable | Restart vMIx after that
3. Make sure that vMix → Settings → Web Controller → Enable enhanced security on Web and TCP API is DISABLED (unchecked)
4. 
5. Choose “vMix API” in Scoreboard OCR and enter:
   1. host - the computer on which vMix is runing (use “localhost” if you are running Scoreboard OCR on the same computer as vMix). If you are running vMix on a different computer, use the IP address of that computer, for example “192.168.1.10”. Make sure the Windows Firewall on vMix computer is not blocking vMix API (if it is not working, you can always disable the firewall to makes sure it is not causing the problem)
   2. port - enter “8099” (this is the default vMix API port number and I dont think it can be changed, do not mix up with vMIx Web controller which uses port 8088)
   3. input_id - enter input id of the vMix XAML/GT template (if its the first input in vMix, then just enter 1)
6. Use the same field names in Scoreboard OCR that are present in vMix XAML/GT template (for example if you have a field “Clock.Text” in vMix template, use the same name in Scoreboard OCR for match time). Field names are case sensitive!
7. If you have more than one template in vMix, make sure you add multiple vMix outputs in Scoreboard OCR. Each output will correspond to the vMix input number of the template
8. If you are using vMix GT templates, makes sure you add “.Text” and the end of the field name, for example “CLOCK.Text”
   1. Some of the templates use spaces in field names, for example “Away Score.Text”
   2. Field names are case sensitive
9. If you need to send data to several gfx inputs in vMix, just add additional outputs in Scoreboard OCR

localhost:8099/1

192.168.1.10:8099/1

Here is what Scoreboard OCR will send to vMix:

FUNCTION SetText Input=1&SelectedName=Clock&Value=6:31

1. prepare a folder on your computer with the PNG images that you would like to display (such as fouls, serve direction, etc)
2. in vMix Title Designer add an image field to your scorebug, for example, 'fouls_a'
3. make sure you have Scoreboard OCR version at least 2020.10.09 installed
4. add a Script type field such as 'fouls_a.Source' (make sure to add '.Source' part)
5. add a Custom type field that will be used to recognize a digit on the scoreboard, such as 'fouls_a'
6. draw the rectangle around the foul count
7. use a sample script from one of the scripts below (make sure to adjust field names, image folder path) and copy it to the Script field 'fouls_a.Source':
   1. display a certain image for every foul count
   2. display background image for penalty clock if it is active
   3. display an image if score increases by +3
   4. display red background for shot clock during last 5 seconds of the attack time
   5. display voleyball serve direction

If Scoreboard OCR sees that you are sending path to png, jpg, jpeg, gif or bmp file, it will also send the following command to vMix, which will cause image of the titles to update:

FUNCTION SetImage Input=1&SelectedName=Logo Image.Source&Value=C:\Samples\penalty_background.png

1. Choose XML output in Scoreboard OCR
2. Make sure you dont use field names with spaces, they are not allowed for XML output. For example, 'Score Home' will not work, you must use “ScoreHome”
3. Choose XML data source in vMix and enter “/root” in xmlpath and then you will be able map any of Scoreboard OCR fields to any of vMix XAML/GT template fields. You will also be able to use multiple XAMLs/GTs at the same time.
4. Make sure you change “Update data every” from 1sec to 100ms, if you want to correctly display 1/10 of a second match time and decrease latency

1. Choose CSV output in Scoreboard OCR
2. Choose CSV data source in vMix
3. Make sure you change “Update data every” from 1sec to 100ms, if you want to correctly display 1/10 of a second match time and decrease latency
4. We have come across a problem when Scoreboard OCR outputs “47.3”, but vMix displays “47,3” (and “47.0” would get truncated to “47” in vMix). This is because vMix formats the numbers according to the system locale. This could be changed in Windows regional settings by changing the delimiter from comma to point, but could also cause problems for other applications.

1. Choose HTTP Feed output in Scoreboard OCR
2. Copy/paste the HTTP Feed Output URL from Scoreboard OCR to vMix and enter “/root” in xmlpath and then you will be able map any of Scoreboard OCR fields to any of vMix XAML/GT template fields. You will also be able to use multiple XAMLs/GTs at the same time.
3. Make sure you change “Update data every” from 1sec to 100ms, if you want to correctly display 1/10 of a second match time and decrease latency

If your graphics engine by default does not support reading data from sources at least 10x a second (which is crucial for some sports such as basketball), most probably you can use an alternative approach - add scoreboard data using a Browser Window.

vMix is not receiving any data from Scoreboard OCR using vMix API
Check if the field names in Scoreboard OCR are exactly the same as in vMix.
Here you can download vMix preset and Scorebaord OCR preset for working vMix GT Scoreboard sample

For example, vMix GT scoreboard field names are the following:

1. Home Score.Text
2. Away Score.Text
3. CLOCK.Text

Take look at Title Editor for correct field names:

Usual mistakes:

1. There is a space before “Score”
2. You have to include the “.Text” part
3. There is no space before the “.Text” part