Controlling FPP from Vixen3 - Revision history

ErnieHorning: Replaced outdated version-specific Vixen/Falcon Player setup instructions with a general integration overview and links to the official Falcon Player and Vixen documentation.

2026-07-22T19:16:30Z

Replaced outdated version-specific Vixen/Falcon Player setup instructions with a general integration overview and links to the official Falcon Player and Vixen documentation.

Dirknerkle at 03:47, 8 October 2016

2016-10-08T03:47:56Z

Dirknerkle at 03:47, 8 October 2016

2016-10-08T03:47:29Z

Dirknerkle at 03:46, 8 October 2016

2016-10-08T03:46:47Z

Dirknerkle at 03:45, 8 October 2016

2016-10-08T03:45:13Z

Dirknerkle at 03:44, 8 October 2016

2016-10-08T03:44:34Z

Dirknerkle at 03:40, 8 October 2016

2016-10-08T03:40:10Z

Dirknerkle at 03:39, 8 October 2016

2016-10-08T03:39:39Z

Dirknerkle at 03:38, 8 October 2016

2016-10-08T03:38:29Z

Dirknerkle at 03:37, 8 October 2016

2016-10-08T03:37:47Z

@@ Line 1: / Line 1: @@
-This article was authored by mwestling. Used here with his permission.
+= Controlling Falcon Player from Vixen =
-'''Assumptions:'''
+This article describes methods for triggering Falcon Player (FPP) functions from Vixen. Common uses include starting videos, launching scripts, controlling playlists, and executing events during a synchronized lighting sequence.
-'''Setup your FPP & Scripts'''
+Current versions of both Falcon Player and Vixen continue to evolve, so specific menus and configuration procedures may differ from earlier releases. Refer to the official documentation for the latest setup instructions.
-:2. Scroll down to Media/PlayVideo.sh/Play a Video and click 'Install'.
+== Trigger Methods ==
-:3. [Optional] You will probably also want to be able to stop a video so scroll down a little further to Media/StopAnyRunningVideo.sh/Stop Any Playing Video and click 'Install'.
+Falcon Player can be controlled from Vixen using several methods, including:
-:4. It is suggested that you keep the original script as a source and edit copies of the script, so you should do the following:
+* Streaming ACN (E1.31) Events
-::A. Go to Content Setup -> File Manager, then select the Scripts tab
+* Scripts
-::B. Highlight the PlayVideo.sh entry and click the download button
+* HTTP requests (CURL/URL commands)
-:::[NOTE] Once you have done this, now would be a good time to shutdown your FPP and grab your thumbdrive as the file transfers will be faster directly to the thumbdrive
+* Playlists and scheduler integration
-:5. Once you have copied your scripts and videos to the thumbdrive, eject it from your PC and put it back into the FPP. Restart your FPP.
+The best method depends on your display architecture and the version of FPP and Vixen being used.
-'''To Trigger A Video using CURL'''
+== Typical Workflow ==
-'''To Trigger a Video using Streaming ACN E1.31 (Network connected controller wired or wireless)'''
+A typical configuration consists of:
-Ok, this is how I got mine to work. It may not be the right way, but it worked for me. After scouring the forums and asking questions this is what I came up with.
+# Configure Falcon Player and verify normal operation.
-'''Disclaimer Here:''' Your mileage may vary, may cause serious side effects, I don't warranty this, as a matter of fact, when I click post the warranty expires, has been known to increase you CLAP Addiction symptoms, price subject to change at any time, taxes and fees not included.
+== External Resources ==

@@ Line 28: / Line 28: @@
 :5. Once you have copied your scripts and videos to the thumbdrive, eject it from your PC and put it back into the FPP. Restart your FPP.
 :6. You can now test your scripts by going to Content Setup - File Manager. Highlight your script and click the 'run' button. This should trigger your video to start playing. You can stop the video by highlighting the 'StopAnyRunningVideo' script and clicking 'run'
-:7. If you are going to use CURL, you will need to copy the URL that comes up when you run the script. It will be something like <nowiki>http://&#91;[IPAddressofYourFPP]/runEvent...hp?scriptName=[NameofYourScript.sh]</nowiki>
+:7. If you are going to use CURL, you will need to copy the URL that comes up when you run the script. It will be something like <nowiki>http://&#91;IPAddressofYourFPP]/runEvent...hp?scriptName=[NameofYourScript.sh]</nowiki>
 '''To Trigger A Video using CURL'''

@@ Line 28: / Line 28: @@
 :5. Once you have copied your scripts and videos to the thumbdrive, eject it from your PC and put it back into the FPP. Restart your FPP.
 :6. You can now test your scripts by going to Content Setup - File Manager. Highlight your script and click the 'run' button. This should trigger your video to start playing. You can stop the video by highlighting the 'StopAnyRunningVideo' script and clicking 'run'
-:7. If you are going to use CURL, you will need to copy the URL that comes up when you run the script. It will be something like <nowiki>[http://&#91;IPAddressofYourFPP]/runEvent...hp?scriptName=[NameofYourScript.sh]</nowiki>
+:7. If you are going to use CURL, you will need to copy the URL that comes up when you run the script. It will be something like <nowiki>http://&#91;[IPAddressofYourFPP]/runEvent...hp?scriptName=[NameofYourScript.sh]</nowiki>
 '''To Trigger A Video using CURL'''

@@ Line 28: / Line 28: @@
 :5. Once you have copied your scripts and videos to the thumbdrive, eject it from your PC and put it back into the FPP. Restart your FPP.
 :6. You can now test your scripts by going to Content Setup - File Manager. Highlight your script and click the 'run' button. This should trigger your video to start playing. You can stop the video by highlighting the 'StopAnyRunningVideo' script and clicking 'run'
-:7. If you are going to use CURL, you will need to copy the URL that comes up when you run the script. It will be something like [http://&#91;IPAddressofYourFPP]/runEvent...hp?scriptName=[NameofYourScript.sh]
+:7. If you are going to use CURL, you will need to copy the URL that comes up when you run the script. It will be something like <nowiki>[http://&#91;IPAddressofYourFPP]/runEvent...hp?scriptName=[NameofYourScript.sh]</nowiki>
 '''To Trigger A Video using CURL'''

@@ Line 28: / Line 28: @@
 :5. Once you have copied your scripts and videos to the thumbdrive, eject it from your PC and put it back into the FPP. Restart your FPP.
 :6. You can now test your scripts by going to Content Setup - File Manager. Highlight your script and click the 'run' button. This should trigger your video to start playing. You can stop the video by highlighting the 'StopAnyRunningVideo' script and clicking 'run'
-:7. If you are going to use CURL, you will need to copy the URL that comes up when you run the script. It will be something like http://&#91;IPAddressofYourFPP]/runEvent...hp?scriptName=[NameofYourScript.sh]
+:7. If you are going to use CURL, you will need to copy the URL that comes up when you run the script. It will be something like [http://&#91;IPAddressofYourFPP]/runEvent...hp?scriptName=[NameofYourScript.sh]
 '''To Trigger A Video using CURL'''

@@ Line 31: / Line 31: @@
 '''To Trigger A Video using CURL'''
-. Install CURL (Install thread: http://stackoverflow.com/questions/9...l-on-a-windows)
+:1. Install CURL (Install thread: http://stackoverflow.com/questions/9...l-on-a-windows)
-. In Vixen, setup an Element 'Video'. Then setup a 'Command Controller' controller with one channel
+:2. In Vixen, setup an Element 'Video'. Then setup a 'Command Controller' controller with one channel
-. Patch the Video element to the Controller Channel
+:3. Patch the Video element to the Controller Channel
-. Create a new vixen sequence, associate the audio you seperated earlier to the sequence
+:4. Create a new vixen sequence, associate the audio you seperated earlier to the sequence
-. Add in a 'Launcher' Device Action from the 'Effects' and then highlight the effect.
+:5. Add in a 'Launcher' Device Action from the 'Effects' and then highlight the effect.
-. In the Launcher configuration Effect Editor, give the effect a description
+:6. In the Launcher configuration Effect Editor, give the effect a description
-. In the Executable section, browse to where you installed CURL and select Curl.exe
+:7. In the Executable section, browse to where you installed CURL and select Curl.exe
-. In the Arguments section, copy and paste the URL from step 7 in the setup section
+:8. In the Arguments section, copy and paste the URL from step 7 in the setup section
-. Save your sequence and test.
+:9. Save your sequence and test.
-[NOTE: You may need to add some blank space in your audio file as this method has a slight delay from when you call the script to when the video starts. I found mine to be about 1.5 seconds]
+:[NOTE: You may need to add some blank space in your audio file as this method has a slight delay from when you call the script to when the video starts. I found mine to be about 1.5 seconds]
-To Trigger a Video using Streaming ACN E1.31 (Network connected controller wired or wireless)
+'''To Trigger a Video using Streaming ACN E1.31 (Network connected controller wired or wireless)'''
-. In FPP, navigate to Status/Control -> Events
+:1. In FPP, navigate to Status/Control -> Events
-. Click on 'Add Event'. Give the event an ID of 1/1 (Major/Minor) using the dropdown. In the script dropdown, choose the script you want to run. Click 'Save' and this event should now show up in the Events list.
+:2. Click on 'Add Event'. Give the event an ID of 1/1 (Major/Minor) using the dropdown. In the script dropdown, choose the script you want to run. Click 'Save' and this event should now show up in the Events list.
-[Optional: Add another event with an ID of 10/10 and associate the StopAnyRunningVideo.sh script to this event so you can stop your video with a command from Vixen]
+::[Optional: Add another event with an ID of 10/10 and associate the StopAnyRunningVideo.sh script to this event so you can stop your video with a command from Vixen]
-. In Vixen, setup an Element 'Video' with two channels. [Mine are V1 and V2]. Add a Streaming ACN (E1.31) Controller with two channels. [Start =1, On = Checked, Universe = 1, Size = 2, Destination = Unicast to your FPP IP Address]
+:3. In Vixen, setup an Element 'Video' with two channels. [Mine are V1 and V2]. Add a Streaming ACN (E1.31) Controller with two channels. [Start =1, On = Checked, Universe = 1, Size = 2, Destination = Unicast to your FPP IP Address]
-. Patch your two Video elements to your two E1.31 channels
+:4. Patch your two Video elements to your two E1.31 channels
-. Create a new vixen sequence, associate the audio you separated earlier into the sequence
+:5. Create a new vixen sequence, associate the audio you separated earlier into the sequence
-. Add a 'Custom Value' effect into each of the two video channels. In the first channel configuration, ensure '8 Bit Value' is chosen as the Data Type and assign it a value of 10. In the second channel Custom Value, assign it a value of 10
+:6. Add a 'Custom Value' effect into each of the two video channels. In the first channel configuration, ensure '8 Bit Value' is chosen as the Data Type and assign it a value of 10. In the second channel Custom Value, assign it a value of 10
-[NOTE: You have to use a 10x multiplier to the event Major/Minor control channels. i.e 1/1 = 10/10, 3/5 = 30/50. Don't ask me why but that is how FPP automagically translates what you send to a Major/Minor event id]
+::[NOTE: You have to use a 10x multiplier to the event Major/Minor control channels. i.e 1/1 = 10/10, 3/5 = 30/50. Don't ask me why but that is how FPP automagically translates what you send to a Major/Minor event id]
-. Next, navigate to Status/Control -> Status and change the FFPD Mode to Bridge. This will tell FPP to listen for E1.31 commands and execute them. You should see a Bytes Transferred screen with Universe, Start Address, and Bytes Transferred values.
+:7. Next, navigate to Status/Control -> Status and change the FFPD Mode to Bridge. This will tell FPP to listen for E1.31 commands and execute them. You should see a Bytes Transferred screen with Universe, Start Address, and Bytes Transferred values.
-. Save your Vixen sequence and run it. It should trigger the video to play with the sound coming from your computer.
+:8. Save your Vixen sequence and run it. It should trigger the video to play with the sound coming from your computer.
-[NOTE: I noticed sometimes that even though I entered a value into the Custom Value value section it would revert back to 0. What helped most of the time is once I entered the value, I would tab out of that field and it would stick most of the time]
+::[NOTE: I noticed sometimes that even though I entered a value into the Custom Value value section it would revert back to 0. What helped most of the time is once I entered the value, I would tab out of that field and it would stick most of the time]
 Ok, this is how I got mine to work. It may not be the right way, but it worked for me. After scouring the forums and asking questions this is what I came up with.
-Disclaimer Here: Your mileage may vary, may cause serious side effects, I don't warranty this, as a matter of fact, when I click post the warranty expires, has been known to increase you CLAP Addiction symptoms, price subject to change at any time, taxes and fees not included.
+'''Disclaimer Here:''' Your mileage may vary, may cause serious side effects, I don't warranty this, as a matter of fact, when I click post the warranty expires, has been known to increase you CLAP Addiction symptoms, price subject to change at any time, taxes and fees not included.